Sight facelift to shell files: (#35)

* Sight facelift to shell files:

 This is mostly a collection of various stashes combined together.

 * making setup-linux a bit less unsafe
 * adding a diagram
 * printing all sorts of veresions in the bin/setup
 * making **gemfile** mandatory for `bundle_install`.

* Minor fixes to setup-linux to make CI work

Author: kigster

.gitignore

@@ -1,2 +1,3 @@
 **/bazel-*
 **/.idea
+**/.vscode

.rules_version

@@ -0,0 +1 @@
+0.1.1

README.md

@@ -20,11 +20,12 @@
 
 Ruby rules for [Bazel](https://bazel.build).
 
-## Status
+## Status:
 
-Work in progress.
+**Work in progress.**
 
-## How to use
+
+## USAGE
 
 Add `ruby_rules_dependencies` and `ruby_register_toolchains` into your `WORKSPACE` file.
 
@@ -79,6 +80,11 @@ ruby_test(
 
 ## Rules
 
+The following diagram attempts to capture the implementation behind `ruby_library` that depends on the result of `bundle install`, and a `ruby_binary` that depends on both:
+
+![Ruby Rules](docs/img/ruby_rules.png)
+
+
 ### `ruby_library`
 
 <pre>

bin/deps

@@ -3,9 +3,15 @@
 
 export BashMatic="${HOME}/.bashmatic"
 
-[[ -s ${BashMatic}/init.sh ]] || {
+if [[ ! -f "${BashMatic}/init.sh" ]]; then
+  printf "Please wait a minute while we install required dependencies...\n"
   rm -rf "${BashMatic}" 2>/dev/null
-  git clone https://github.com/kigster/bashmatic "${BashMatic}" 2>&1 1>/dev/null
-}
+  git clone https://github.com/kigster/bashmatic "${BashMatic}" 1>/dev/null 2>&1
+fi
 
+# shellcheck disable=SC1090
 source "${BashMatic}/init.sh"
+
+# Application Constants
+export RulesRuby__Version=$(cat .rules_version)
+export RulesRuby__BazelVersion=$(cat .bazelversion)

bin/setup

@@ -1,8 +1,10 @@
 #!/usr/bin/env bash
 
-[[ -x bin/deps ]] && source bin/deps
+[[ -n "${DEBUG}" ]] && set -x
 
-[[ -z ${BashMatic} ]] && {
+[[ -x bin/deps ]] && source "bin/deps"
+
+[[ -z "${BashMatic}" ]] && {
   echo "Failed to initialize BASH library."
   exit 1
 }
@@ -27,9 +29,39 @@ function setup::detect-bazel-version() {
   printf "%s" "${version}"
 }
 
-#——————————————————————————————  main ———————————————————————————————————————————
+function setup::header() {
+  h2 "Installing required development dependencies for working with rules_ruby and Bazel." \
+    "Please wait...."
+}
+
+# prints first argument as the key, right arligned, the second left aligned.
+function setup::table-rows() {
+  local value="$2"
+  value="$(printf "%s" "${value}" | head -1 | tr -C -d '[:digit:][:punct:]' | sed 's/([0-9]+.[0-9]+.[0+9]+)//g;s/[()]/-/g')"
+  printf "${bldylw}%12.12s : ${bldblu}%20.20s     ${txtpur}%s\n${clr}" "$1" "${value}" "$3"
+
+}
+
+function setup::print-versions() {
+  local bazelisk_version="$(ls -ls "$(command -v bazel)" | grep bazelisk | awk 'BEGIN{FS="/"}{print $8}')"
+
+  set +e
+  hl::subtle "Your Current Runtime Environment:"
+  setup::table-rows 'Bazel' "$(bazel --version)" "$(command -v bazel)"
+  setup::table-rows 'Bazelisk' "${bazelisk_version}"
+  setup::table-rows 'Python ' "$(python --version 2>&1)" "$(command -v python) -> $(readlink "$(command -v python)")"
+  setup::table-rows 'Python2' "$(python2 --version 2>&1)" "$(command -v python2)"
+  setup::table-rows 'Python3' "$(python3 --version 2>&1)" "$(command -v python3)"
+  setup::table-rows 'Ruby' "$(ruby --version | sed -E 's/p[0-9]+.*$//g' 2>&1)" "$(command -v ruby)"
+  setup::table-rows 'BASH' "$(bash --version 2>/dev/null | tr -d ',')" "$(command -v bash)"
+  setup::table-rows 'CC' "$(cc --version 2>/dev/null)" "$(cc --version | grep clang)"
+  setup::table-rows 'GO' "$(go version 2>/dev/null)" "$(command -v go)"
+  set -e
+  hr
+}
 
 function setup::main() {
+  setup::header
   setup::gem::dependencies
   [[ -z ${CI} ]] && setup::git::commit-hook
 
@@ -38,13 +70,36 @@ function setup::main() {
 
   script="./bin/setup-${os}"
 
-  if [[ -x ${script} ]]; then
-    "${script}" "$(setup::detect-bazel-version)"
+  if [[ -x "${script}" ]]; then
+    run::set-all show-output-on abort-on-error
+    run "${script} $(setup::detect-bazel-version)"
+    success 'Setup Completed ✅ '
   else
-    echo "Operating system $(uname -s) is not currently supported." >&2
-    return 1
+    error "Operating system $(uname -s) is not currently supported." >&2
   fi
+
+  hr
+
+  setup::print-versions
 }
 
-setup::main "$@"
+if [[ "$1" =~ "-h" ]]; then
+  printf "
+${bldblu}USAGE: ${clr}
+  bin/setup
+
+${bldblu}DESCRIPTION:${clr}
+  Installs Bazel via bazelisk on Mac, and directly on Linux.
+
+  Both MacOSX and Linux are supported.
 
+  Additionally sets up the git commit hook to check styles.
+
+${bldblu}DO I HAVE TO RUN IT?:${clr}
+
+  ${bldred}RUNNING REQUIRED PRIOR TO USING THE REPO.${clr}
+
+"
+  exit 0
+fi
+setup::main "$@"

bin/setup-darwin

@@ -18,26 +18,30 @@ function setup::brew-validate() {
 function setup::brew-install-jdk() {
   # The JDK homebrew cask is a required to install the java dependencies for Bazel
   if ! brew cask list | grep -q openjdk; then
-    brew cask install homebrew/cask-versions/adoptopenjdk8
+    run "brew cask install homebrew/cask-versions/adoptopenjdk8"
   fi
 }
 
 function setup::brew-deps() {
   if ! brew list | grep -q xz; then
-    brew install xz
+    "brew install xz"
   fi
 }
 
 function setup::osx-deps() {
   # xcode command line tools are required, specifically gcc
   # if xcode already exists, this command will error, otherwise prompt the user
-  if [[ -n $(xcode-select --install 2>&1 | grep 'already installed') ]]; then
-    echo "xcode-select tools are already installed."
+  if [[ -n $(xcode-select --install 2>&1) ]]; then
+    hl::subtle "Good News! xcode-select tools are already installed."
   fi
 }
+function setup::is-bazelisk-installed() {
+  ls -al "$(command -v bazel)" | grep -q bazelisk
+}
 
 function setup::bazelisk-install() {
-  brew install bazelbuild/tap/bazelisk
+  setup::is-bazelisk-installed ||
+    run "brew install bazelbuild/tap/bazelisk"
 }
 
 function setup::darwin() {

bin/setup-linux

@@ -2,14 +2,29 @@
 
 [[ -x bin/deps ]] && source bin/deps
 
+[[ -n ${DISABLE_COLOR} ]] && lib::color::disable
+
 [[ -z "${BashMatic}" ]] && {
   echo "Failed to initialize BASH library."
   exit 1
 }
 
+function setup::linux::deps() {
+  [[ -n $(command -v curl) && -n $(command -v wget) ]] && return 0
+
+  if [[ -z $(command -v apt-get) ]]; then
+    error "Unable to find the right packaging tool to install dependencies."
+    exit 1
+  fi
+
+  [[ -n $(command -v curl) && -n $(command -v wget) ]] || {
+    error "curl and wget must be pre-installed."
+    exit 2
+  }
+}
+
 function setup::linux() {
-  local version
-  version="${1}"
+  local version="${1}"
 
   [[ -z "${version}" && -f .bazelversion ]] && version=$(cat .bazelversion | tr -d '\n')
 
@@ -20,25 +35,34 @@ function setup::linux() {
     hl::subtle "Installing Bazel version ${version}"
   fi
 
-  local installer=bazel-${version}-installer-linux-x86_64.sh
-  local release_base_uri=https://github.com/bazelbuild/bazel/releases/download/${version}
+  # Ensure we have the tools like curl and wget installe d
+  setup::linux::deps
+
+  local installer="bazel-${version}-installer-linux-x86_64.sh"
+  local release_base_uri="https://github.com/bazelbuild/bazel/releases/download/${version}"
   local require_install=true
-  if test -x ${HOME}/local/${installer}; then
-    cd ${HOME}/local
-    if curl ${release_base_uri}/${installer}.sha256 | sha256sum -c; then
+
+  local installer_path="${HOME}/.ruby_local"
+  local installer_exe="${installer_path}/${installer}"
+
+  if [[ -x "${installer_exe}" ]]; then
+    if curl -q "${release_base_uri}/${installer}.sha256" | sha256sum -c; then
       require_install=false
     fi
   fi
 
   if ${require_install}; then
-    run "rm -rf ${HOME}/local"
-    run "mkdir ${HOME}/local"
-    run "cd ${HOME}/local"
-    run "wget ${release_base_uri}/${installer}"
+    run "rm -rf ${installer_path}"
+    run "mkdir -p ${installer_path}"
+    run "cd ${installer_path}"
+    run "wget ${release_base_uri}/${installer} 2>&1"
     run "chmod +x ${installer}"
 
-    run::set-next show-output-on
-    run "./${installer} --prefix=${HOME}/local --base=${HOME}/.bazel"
+    hl::subtle 'Running Bazel Installer...'
+    run::set-next show-output-on abort-on-error
+
+    run "${installer_exe} --prefix=${installer_path} --base=${HOME}/.bazel 2>&1"
+    success 'Bazel installer completed successfully ✅ '
   fi
 }
 

docs/faq.md

@@ -0,0 +1,5 @@
+# FAQ — Frequently Asked Questions
+
+Coming soon.
+
+Also see: [Troubleshooting](troubleshooting.md).

docs/img/ruby_rules.png

@@ -0,0 +1,5 @@
+This is the document that represents the current state of things in the `rules_ruby` repository, and will be updated as major changes happen.
+
+Check back here often 
+
+# Ruby Rules Architecture & Design