Updating WORKSPACE example

Author: kigster

README.md

@@ -61,9 +61,6 @@ Note: we have a short guide on [Building your first Ruby Project](https://github
 ```python
 workspace(name = "my_ruby_project")
 
-load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
-bazel_skylib_workspace()
-
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
 
@@ -74,7 +71,7 @@ load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
 git_repository(
     name = "bazelruby_rules_ruby",
     remote = "https://github.com/bazelruby/rules_ruby.git",
-    branch = "develop",
+    branch = "develop"
 )
 
 load(
@@ -90,14 +87,17 @@ rules_ruby_dependencies()
 # RBENV installation if the Ruby version matches.
 #———————————————————————————————————————————————————————————————————————
 
+load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
+bazel_skylib_workspace()
+
 rules_ruby_select_sdk(version = "2.7.0")
 
 #———————————————————————————————————————————————————————————————————————
 # Now, load the ruby_bundle rule & install gems specified in the Gemfile
 #———————————————————————————————————————————————————————————————————————
 
 load(
-    "@bazelruby_rules_ruby//ruby:defs.bzl", 
+    "@bazelruby_rules_ruby//ruby:defs.bzl",
     "ruby_bundle",
 )
 

bin/deps

@@ -11,7 +11,7 @@ fi
 # shellcheck disable=SC1090
 source "${BashMatic}/init.sh" 1>/dev/null 2>&1
 
-__version::detect() {
+__version.detect() {
   local file="$1"
   if [[ -f ${file} ]]; then
     /bin/cat "${file}" | head -1
@@ -26,9 +26,9 @@ __version::detect() {
 }
 
 # Application Constants
-export RulesRuby__RulesVersion=$(__version::detect .rules_version)
+export RulesRuby__RulesVersion=$(__version.detect .rules_version)
 export RulesRuby__RubyVersion=2.7.0
-export RulesRuby__BazelVersion=$(__version::detect .bazelversion)
+export RulesRuby__BazelVersion=$(__version.detect .bazelversion)
 
 bazel-sha() {
   bazel info | grep output_path | awk 'BEGIN{FS="/"}{ for(i = 1; i <= NF; i++) { if (length($i) == 32) print $i; } }'
@@ -46,18 +46,18 @@ help-example() {
   printf "    ${bldpur}$*${clr}"
 }
 
-deps::start-clock() {
+deps.start-clock() {
   export __start=$(millis)
 }
 
-deps::print-duration() {
+deps.print-duration() {
   local finish=$(millis)
   local duration=$(( finish - __start ))
-  info "Total running time for was ${bldylw}$(lib::time::duration::millis-to-secs ${duration}) seconds.\n\n"
+  info "Total running time for was ${bldylw}$(lib.time.duration.millis-to-secs ${duration}) seconds.\n\n"
 }
 
 
-run::set-all abort-on-error
+run.set-all abort-on-error
 
 # ensure we can exit with Ctrl-C
 trap exit 1 INT

bin/linter

@@ -11,34 +11,34 @@ source "bin/deps"
 [[ -n $(command -v rubocop) ]] || {
   # shellcheck disable=SC1091
   source bin/setup
-  setup::main gems
+  setup.main gems
 }
 
 export __git_pre="/tmp/rules-ruby-git-status-before-commit.$$"
 export __git_post="/tmp/rules-ruby-git-status-after-commit.$$"
 
-__lint::cleanup() {
+__lint.cleanup() {
   for f in "${__git_pre}" "${__git_post}"; do
     [[ -f "${f}" ]] && rm -f "${f}"
   done
 }
 
-deps::start-clock
-run::set-all abort-on-error
+deps.start-clock
+run.set-all abort-on-error
 
-__lint::actions() {
+__lint.actions() {
   local sep="${1:-', '}"
-  printf "${bldylw}$(lib::array::join "${sep}" $(lib::util::functions-matching "lint::" | sed 's/ main//g'))${clr}"
+  printf "${bldylw}$(lib.array.join "${sep}" $(lib.util.functions-matching "lint." | sed 's/ main//g'))${clr}"
 }
 
-lint::help() {
+lint.help() {
   printf "
 $(help-header USAGE)
   ${bldblk}# without any arguments runs a complete setup.${clr}
 $(help-usage "bin/linter")
 
   ${bldblk}# alternatively, a partial linter name can be passed:${clr}
-$(help-usage "bin/linter [ $(__lint::actions " | ") ]")
+$(help-usage "bin/linter [ $(__lint.actions " | ") ]")
 
 $(help-header DESCRIPTION:)
   Runs various linters either all serially, or by name based on
@@ -59,17 +59,17 @@ $(help-example bin/linter buildifier)
  exit 0
 }
 
-lint::rubocop() {
-  h2::green "Running Rubocop, please wait..."
+lint.rubocop() {
+  h2.green "Running Rubocop, please wait..."
   run "rubocop || rubocop -a"
   inf "Rubocop completed."
   ok:
 }
 
 # runs buildifer from the PATH if it exists, otherwise bazel target
 # we want before-commit to be as fast as possible.
-lint::buildifier() {
-  h2::green "Buildifier"
+lint.buildifier() {
+  h2.green "Buildifier"
   if [[ -n $(command -v buildifier) ]]; then
     info "Running $(command -v buildifier).."
     run "find . -name 'BUILD*' -o -name 'WORKSPACE' -o -name '*.bzl'  | grep -v '.git' | xargs buildifier -v"
@@ -79,25 +79,25 @@ lint::buildifier() {
   fi
 }
 
-lint::all() {
+lint.all() {
   # number of modified files
   local changes_before=$(git status -s | md5)
-  trap __lint::cleanup EXIT
+  trap __lint.cleanup EXIT
   git status -s >"${__git_pre}"
 
   set -e
-  run::set-all abort-on-error
-  lint::rubocop
+  run.set-all abort-on-error
+  lint.rubocop
 
   set -e
-  run::set-all abort-on-error
-  lint::buildifier
+  run.set-all abort-on-error
+  lint.buildifier
 
   git status -s >"${__git_post}"
 
   local changes_after=$(git status -s | md5)
   if [[ ${changes_before} != "${changes_after}" ]]; then
-    hl::subtle "Git status -s output changed after before-commit hook."
+    hl.subtle "Git status -s output changed after before-commit hook."
     info "Changes before before-commit hook:"
     hr
     diff "${pre}" "${post}"
@@ -113,32 +113,32 @@ lint::all() {
 }
 
 
-lint::main() {
+lint.main() {
   local action="$1"
   [[ "${action}" == "-h" || ${action} == "--help" ]] && action="help"
-  local func="lint::${action}"
+  local func="lint.${action}"
 
   if [[ -n ${action} ]]; then
-    if lib::util::is-a-function "${func}"; then
+    if lib.util.is-a-function "${func}"; then
       [[ ${action} != "help" ]] && h2 "Executing partial linting for ${bldylw}${action}"
       shift
       ${func} "$@"
       local code=$?
       [[ ${code} -eq 0 ]] && success "Linter ${action} was successful"
       [[ ${code} -ne 0 ]] && error "Linter failed for ${action}"
-      deps::print-duration
+      deps.print-duration
       exit ${code}
     else
-      h1 "Invalid action provided." "Valid lint actions are: $(__lint::actions)"
+      h1 "Invalid action provided." "Valid lint actions are: $(__lint.actions)"
       exit 1
     fi
   else
     set +e
-    lint::all
-    deps::print-duration
+    lint.all
+    deps.print-duration
   fi
 }
 
-lint::main "$@"
+lint.main "$@"
 
 exit 0

bin/setup

@@ -11,23 +11,23 @@ source "bin/deps"
 # Private Functions
 #—————————————————————————————————————————————————————————————————————————————————————————————————————————————
 
-__setup::actions() {
+__setup.actions() {
   local sep="${1}"
-  printf "${bldylw}$(lib::array::join "${sep}" $(lib::util::functions-matching "setup::" | sed 's/ main//g'))${clr}"
+  printf "${bldylw}$(lib.array.join "${sep}" $(lib.util.functions-matching "setup." | sed 's/ main//g'))${clr}"
 }
 
 #—————————————————————————————————————————————————————————————————————————————————————————————————————————————
 # Public Functions
 #—————————————————————————————————————————————————————————————————————————————————————————————————————————————
 
-setup::help() {
+setup.help() {
   printf "
 $(help-header USAGE)
   ${bldblk}# without any arguments runs a complete setup.${clr}
 $(help-usage "bin/setup")
 
   ${bldblk}# alternatively, a sub-setup function name can be passed:${clr}
-$(help-usage "bin/setup [ $(__setup::actions " | ") ]")
+$(help-usage "bin/setup [ $(__setup.actions " | ") ]")
 
 $(help-header DESCRIPTION:)
   Runs full setup without any arguments.
@@ -49,13 +49,13 @@ etc.
  "
 }
 
-setup::gems() {
+setup.gems() {
   for gem in rubocop relaxed-rubocop rubocop-performance; do
-    lib::gem::install ${gem}
+    lib.gem.install ${gem}
   done
 }
 
-setup::remove-git-hook() {
+setup.remove-git-hook() {
   set -e
   [[ -L .git/hooks/pre-commit ]] && {
     info 'Removing git commit hook...'
@@ -65,7 +65,7 @@ setup::remove-git-hook() {
   set +e
 }
 
-setup::git-hook() {
+setup.git-hook() {
   set -e
   if [[ ! -L .git/hooks/pre-commit ]]; then
     info 'Installing git pre-commit hook'
@@ -76,7 +76,7 @@ setup::git-hook() {
   set +e
 }
 
-setup::os-specific() {
+setup.os-specific() {
   local os=$(uname -s | tr '[:upper:]' '[:lower:]')
   local setup_script
   setup_script="./bin/setup-${os}"
@@ -86,7 +86,7 @@ setup::os-specific() {
     # shellcheck disable=SC1090
     source "${setup_script}"
     # run it's main function
-    eval "setup::${os} \"$*\""
+    eval "setup.${os} \"$*\""
     echo
     if [[ -z ${CI} ]]; then
       h2 "Please note — to print your Bazel environment run " "${bldylw}bin/show-env"
@@ -100,13 +100,13 @@ setup::os-specific() {
   return 0
 }
 
-setup::main() {
+setup.main() {
   local action="$1"
   [[ "${action}" == "-h" || ${action} == "--help" ]] && action="help"
-  local func="setup::${action}"
+  local func="setup.${action}"
 
   if [[ -n ${action} ]]; then
-    if lib::util::is-a-function "${func}"; then
+    if lib.util.is-a-function "${func}"; then
       [[ ${action} != "help" ]] && h2 "Executing partial setup for action ${bldylw}${action}"
       shift
       ${func} "$@"
@@ -115,16 +115,16 @@ setup::main() {
       [[ ${code} -ne 0 ]] && error "Error setting up ${action}"
       exit ${code}
     else
-      h1 "Invalid action provided." "Valid actions are: $(__setup::actions " | ")"
+      h1 "Invalid action provided." "Valid actions are: $(__setup.actions " | ")"
       exit 1
     fi
   else
     set +e
     h2 "Installing required development dependencies for working with rules_ruby and Bazel."
-    setup::gems
-    [[ -z ${CI} ]] && setup::git-hook
-    setup::os-specific "$@"
+    setup.gems
+    [[ -z ${CI} ]] && setup.git-hook
+    setup.os-specific "$@"
   fi
 }
 
-setup::main "$@"
+setup.main "$@"