Merge pull request #50 from bazelruby/kig/buildifer-git-hook

Adding auto-fix buildifier and auto-fix rubocop

Author: kigster

BUILD.bazel

@@ -2,11 +2,11 @@ load("@com_github_bazelbuild_buildtools//buildifier:def.bzl", "buildifier")
 
 buildifier(
     name = "buildifier",
-    exclude_patterns = [".git/**"],
+    exclude_patterns = ["./.git/**/*"],
 )
 
 buildifier(
     name = "buildifier-check",
-    exclude_patterns = [".git/**"],
+    exclude_patterns = ["./.git/**/*"],
     mode = "check",
 )

README.md

@@ -436,16 +436,51 @@ To get the initial stuff setup required by this repo, please run the script:
 bin/setup
 ```
 
-Whenever you'll commit something, a pre-commit hook will run as well.
+This script does a couple of very useful things, including setting up a git commit
+hook that performs rubocop fixes and buildifier fixes of the Bazel build files.
+
+You can run partial setup comamnds like so:
+
+```bash
+❯ bin/setup -h
+
+USAGE:
+  bin/setup [ gems | git-hook | help | install | main | no-git-hook ]
+
+DESCRIPTION:
+  Runs full setup without any arguments.
+
+  Accepts one argument — one of the actions that typically run
+  as part of setup.
+
+  For instance, to perform full setup:
+
+    bin/setup
+
+  Or, to run only one of the sub-functions (actions), pass
+  it as an argument:
+
+    bin/setup help
+    bin/setup no-git-hook
+
+  etc.
+```
+
+Whenever you'll commit something, a pre-commit hook will run as well. If it
+finds anything that needs fixing, it will attempt to fix it. If the resulting
+git state is different than before the commit, the commit is aborted and the user
+should add any auto-fixed modifications to the list of staged files for commit.
 
 ### Running Tests
 
-We have a handy script you can use to run all tests:
+We have a pretty useful script you can use to run all tests in the repo that run on CI:
 
 ```bash
 bin/ci
 ```
 
+On a MacBook Pro it takes about 3 minutes to run.
+
 ## Copyright
 
 © 2018-2019 Yuki Yugui Sonoda & BazelRuby Authors

bin/ci

@@ -14,16 +14,20 @@ export BAZEL_BUILD_OPTS="--curses=no --verbose_failures -j 15 --show_progress_ra
 export BAZEL_TEST_OPTS="--verbose_failures --test_output=streamed --test_verbose_timeout_warnings "
 export RUBY_VERSION=$(cat .ruby-version)
 
+export BashMatic__Expr="
+  source ${SHELL_INIT}
+  [[ -f ${HOME}/.bashmatic/init.sh ]] && source ${HOME}/.bashmatic/init.sh
+  set -e
+"
+
 [[ -n ${DEBUG} ]] && set -x
 
 trap exit 1 INT
 
 # Runs Rubocop Tests
 test::rubocop() {
   /usr/bin/env bash -c " 
-    source ${SHELL_INIT}
-    [[ -f ${HOME}/.bashmatic/init.sh ]] && source  ${HOME}/.bashmatic/init.sh
-    set -e
+    ${BashMatic__Expr}
     h2 'Running target: rubocop'
     bundle install --path=${BUNDLE_PATH}
     bundle exec rubocop -E -D .rubocop.yml --force-exclusion
@@ -33,22 +37,17 @@ test::rubocop() {
 # Runs Buildifier
 test::buildifier() {
   /usr/bin/env bash -c "
-    source ${SHELL_INIT}
-    [[ -f ${HOME}/.bashmatic/init.sh ]] && source  ${HOME}/.bashmatic/init.sh
+    ${BashMatic__Expr}
     h2 'Running target: buildifier'
-    set -e
     bazel run :buildifier-check
   "
 }
 
 # Builds and runs workspace inside examples/simple_script
 test::simple-script() {
   /usr/bin/env bash -c "
-    source ${SHELL_INIT}
-    [[ -f ${HOME}/.bashmatic/init.sh ]] && source  ${HOME}/.bashmatic/init.sh
+    ${BashMatic__Expr}
     h2 'Testing target: simple-script'
-    set -e
-    cd examples/simple_script
     bazel ${BAZEL_OPTS} info
     bazel ${BAZEL_OPTS} build ${BAZEL_BUILD_OPTS} -- //...
     bazel ${BAZEL_OPTS} test ${BAZEL_BUILD_OPTS} ${BAZEL_TEST_OPTS} -- //...
@@ -58,10 +57,8 @@ test::simple-script() {
 
 test::workspace() {
   /usr/bin/env bash -c "
-    source ${SHELL_INIT}
-    [[ -f ${HOME}/.bashmatic/init.sh ]] && source  ${HOME}/.bashmatic/init.sh
+    ${BashMatic__Expr}
     h2 'Testing target: workspace'
-    set -e
     bazel ${BAZEL_OPTS} build ${BAZEL_BUILD_OPTS} -- //...
     bazel ${BAZEL_OPTS} test ${BAZEL_BUILD_OPTS} ${BAZEL_TEST_OPTS} -- //...
   "
@@ -70,10 +67,8 @@ test::workspace() {
 # Private 
 test::bazel-info() {
   /usr/bin/env bash -c "
-    source ${SHELL_INIT}
-    [[ -f ${HOME}/.bashmatic/init.sh ]] && source  ${HOME}/.bashmatic/init.sh
+    ${BashMatic__Expr}
     h2 'Testing target: bazel-info'
-    set -e
     bazel ${BAZEL_OPTS} version
     bazel ${BAZEL_OPTS} info
     bazel ${BAZEL_OPTS} fetch --curses=no -- '//ruby/...'

bin/pre-commit

@@ -2,7 +2,8 @@
 #
 # Main dependency shell script that installs BashMatic Library in ~/.bashmatic folder.
 
-export COLUMNS=90
+export COLUMNS=75
+
 set -e
 # shellcheck disable=SC1091
 source "bin/deps"
@@ -13,10 +14,68 @@ source "bin/deps"
   setup::main gems
 }
 
-info "Running Rubocop, please wait..."
-run "rubocop -F -D || rubocop -a -D -P || true"
-run::set-next show-output-on
-run "rubocop -D -P"
+run::set-all abort-on-error
+
+fix::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 pre-commit to be as fast as possible.
+fix::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"
+  else
+    info "Running ${bldylw}bazel run :buildifier..."
+    run "bazel run :buildifier"
+  fi
+}
+
+__fix::cleanup() {
+  h2::green "Cleaning up..."
+  for f in "${__git_pre}" "${__git_post}"; do
+    [[ -f ${f} ]] && run "rm -f ${f}"
+  done
+}
+
+export __git_pre="/tmp/rules-ruby-git-status-pre-commit.$$"
+export __git_post="/tmp/rules-ruby-git-status-post-commit.$$"
+
+trap __fix::cleanup EXIT
+
+fix() {
+  # number of modified files
+  local changes_before=$(git status -s | md5)
+
+  git status -s >"${__git_pre}"
+
+  fix::rubocop
+  fix::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 pre-commit hook."
+    info "Changes before pre-commit hook:"
+    hr
+    diff "${pre}" "${post}"
+    hr
+    echo
+    info "ACTION: ${bldylw}Please add any respective files to the commit and retry."
+    exit 1
+  else
+    hr
+    info "No changes detected, commit will proceed."
+    exit 0
+  fi
+}
 
-success "RuboCop ran successfully."
+fix "$@"
 
+exit 0

bin/setup

@@ -1,17 +1,68 @@
 #!/usr/bin/env bash
-
+#
+#
+# 
 set -e
 # shellcheck disable=SC1091
 source "bin/deps"
 
+__setup::actions() {
+  local sep="${1:-', '}"
+  printf "${bldylw}$(lib::array::join "${sep}" $(lib::util::functions-matching setup::))"
+}
+
+setup::help() {
+  printf "
+${bldpur}USAGE:${clr}
+  bin/setup [ $(__setup::actions " | ")${clr} ]
+
+${bldpur}DESCRIPTION:${clr}
+  Runs full setup without any arguments. 
+
+  Accepts one argument — one of the actions that typically run
+  as part of setup.
+
+  For instance, to perform full setup:
+
+    ${bldylw}bin/setup${clr}
+
+  Or, to run only one of the sub-functions (actions), pass 
+  it as an argument:
+    
+    ${bldylw}bin/setup help${clr}
+    ${bldylw}bin/setup no-git-hook${clr}
+
+  etc.
+ "
+}
+
+
+
 setup::gems() {
   for gem in rubocop relaxed-rubocop rubocop-performance; do
     lib::gem::install ${gem}
   done
 }
 
-setup::git() {
-  [[ -L .git/hooks/pre-commit ]] || run "ln -nfs bin/pre-commit .git/hooks/pre-commit"
+setup::no-git-hook() {
+  set -e
+  [[ -L .git/hooks/pre-commit ]] && {
+    info 'Removing git commit hook...'
+    run "rm -f .git/hooks/pre-commit"
+    echo
+  }
+  set +e
+}
+
+setup::git-hook() {
+  set -e
+  if [[ ! -L .git/hooks/pre-commit ]]; then
+    info 'Installing git pre-commit hook'
+    run "cd .git/hooks && ln -nfs ../../bin/pre-commit pre-commit && cd -"
+  else
+    info: "git pre-commit hook is already installed."
+  fi
+  set +e
 }
 
 setup::install() {
@@ -32,27 +83,35 @@ setup::install() {
       /usr/bin/env bash bin/show-env || true
     fi
   else
-    error "Operating system $(uname -s) is not currently supported." >&2
+    error "Operating system ${os} is not currently supported." >&2
   fi
   echo
   return 0
 }
 
 setup::main() {
   local action="$1"
+  [[ "${action}" == "-h" || ${action} == "--help" ]] && action="help"
   local func="setup::${action}"
 
-  if lib::util::is-a-function "${func}"; then
-    h2 "Executing partial setup for action ${bldylw}${action}"
-    shift
-    ${func} "$@"
+  if [[ -n ${action} ]] ; then
+    if lib::util::is-a-function "${func}"; then
+      [[ ${action} != "help" ]] && h2 "Executing partial setup for action ${bldylw}${action}"
+      shift
+      ${func} "$@"
+    else
+      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
+    [[ -z ${CI} ]] && setup::git-hook
     setup::install "$@"
   fi
 }
 
 setup::main "$@"
+
+

bin/setup-darwin

@@ -25,11 +25,7 @@ __setup::brew-install-jdk() {
 }
 
 __setup::brew-deps() {
-  if ! brew list | grep -q xz; then
-    "brew install xz"
-  else
-    info: "Found brew package xz."
-  fi
+  lib::brew::install::packages 'xz' 'ydiff'
 }
 
 __setup::is-bazelisk-installed() {

ruby/private/toolchains/BUILD.runtime.tpl

@@ -9,8 +9,8 @@ package(default_visibility = ["//visibility:public"])
 ruby_toolchain(
     name = "toolchain",
     interpreter = "//:ruby_bin",
-    runtime = "//:runtime",
     rules_ruby_workspace = "{rules_ruby_workspace}",
+    runtime = "//:runtime",
     # TODO(yugui) Extract platform info from RbConfig
     # exec_compatible_with = [],
     # target_compatible_with = [],
@@ -25,14 +25,14 @@ sh_binary(
 cc_import(
     name = "libruby",
     hdrs = glob({hdrs}),
-    static_library = {static_library},
     shared_library = {shared_library},
+    static_library = {static_library},
 )
 
 cc_library(
     name = "headers",
-    includes = {includes},
     hdrs = glob({hdrs}),
+    includes = {includes},
 )
 
 filegroup(