Merge pull request #9 from jfouse/cmd-line-options

Command line options for dry run and verbose output

Author: brysgo

README.md

@@ -6,13 +6,13 @@ Manage bundle and migrations automatically while you use git!
 For example:
 
 - If you pull down code from your remote and there are new or updated gems
- * it will run `bundle` for you
+  * it will run `bundle` for you
 - If you checkout a branch that uses a different set of migrations
- * it will roll back the old set and apply the new ones
+  * it will roll back the old set and apply the new ones
 - If you rebase and there are new gems and migrations
- * it will run `bundle` and `rake db:migrate test:prepare`
+  * it will run `bundle` and `rake db:migrate test:prepare`
 - If you don't like automagical git hooks
- * run `git_rails` and it will try and find out where you came from and run the same check
+  * run `git_rails` and it will try and find out where you came from and run the same check
 
 ### Install
 
@@ -43,6 +43,19 @@ Or if you really know what you are doing and you want to pretend like you are on
 
 Migrations that were added between `REF_YOU_CAME_FROM` and `REF_YOU_ARE_GOING_TO` that do not exist on your current `HEAD` will not be applied because they don't exist!!
 
+#### Options
+
+The following command line options are supported:
+
+* -v, --verbose
+  * Display pending changes, prompt to continue, display command output
+* -y, --auto_confirm
+  * Use in conjunction with verbose mode to apply pending changes without prompting
+* -d, --dry_run
+  * Display pending changes and exit
+* -h, --help
+  * Display usage and exit
+
 #### Hooks
 
 You shouldn't have to think about the hooks once they are installed. Just pull, checkout, and rebase as normal and they should work fine. If you find that `git_rails` hasn't fired when it should follow the command instructions to run it manually.

bin/git_rails

@@ -1,4 +1,72 @@
 #!/bin/bash
+
+function help {
+  echo -e "\nUsage:"
+  echo -e "\tgit-rails [-d] [-v] [-y] [src_ref] [dest_ref]"
+  echo -e "\tgit-rails -h"
+  echo "Flags:"
+  echo -e "\t-d\tdry-run: display pending changes and exit"
+  echo -e "\t-v\tverbose: display pending changes, prompt to continue, display command output"
+  echo -e "\t-y\tauto-confirm: in verbose mode, apply pending changes without prompting"
+  echo
+  echo -e "\tsrc_ref\t\tBranch/ref you're coming from; defaults to ORIG_HEAD"
+  echo
+  echo -e "\tdest_ref\tBranch/ref you're ending at; defaults to HEAD"
+  echo -e "\t\t\tUse with care; see README for more details"
+  echo
+  echo -e "Web: https://github.com/brysgo/git-rails"
+  echo
+  exit 0
+}
+
+dry_run=0
+verbose=0
+confirm=0
+out_target="/dev/null"
+
+optspec=":vdyh-:"
+while getopts "$optspec" optchar; do
+  case "${optchar}" in
+    -)
+      case "${OPTARG}" in
+        dry-run | dry_run)
+          dry_run=1
+          verbose=1
+          ;;
+        verbose)
+          verbose=1
+          confirm=1
+          out_target="/dev/stdout"
+          ;;
+        auto-confirm | auto_confirm)
+          confirm_opt=0
+          ;;
+        help)
+          help
+          ;;
+      esac;;
+    d)
+      dry_run=1
+      verbose=1
+      ;;
+    v)
+      verbose=1
+      confirm=1
+      out_target="/dev/stdout"
+      ;;
+    y)
+      confirm_opt=0
+      ;;
+    h)
+      help
+      ;;
+  esac
+done
+if [ "$verbose" -eq 1 -a ! -z "$confirm_opt" ]; then
+  confirm=$confirm_opt
+fi
+shift $((OPTIND -1))
+
 old_ref=$1
 new_ref=$2
 
@@ -14,12 +82,49 @@ files_changed=`git diff $old_ref $new_ref --name-status`
 
 # CHECK IF WE NEED TO DO A BUNDLE
 bundle_changed=`echo "$files_changed" | grep $'M\tGemfile.lock'`
+
+# CHECK IF WE NEED TO SPIN SOME YARN
+yarn_changed=`echo "$files_changed" | grep $'M\tyarn.lock'`
+
+migrations=`git diff --name-status $old_ref $new_ref -- db/migrate | grep '^[AD]'`
+
+if [ "$verbose" -eq 1 ]; then
+  if [ ! -z "$bundle_changed" -o ! -z "$yarn_changed" ]; then
+    echo -e "\nPrep needed:"
+    if [ ! -z "$bundle_changed" ]; then
+      echo -e "\t- bundle"
+    fi
+    if [ ! -z "$yarn_changed" ]; then
+      echo -e "\t- yarn"
+    fi
+  fi
+  if [ ! -z "$migrations" ]; then
+    echo -e "\nMigrations needed:\n${migrations}"
+  fi
+  if [ -z "$bundle_changed" -a -z "$yarn_changed" -a -z "$migrations" ]; then
+    echo -e "\nNo changes necessary\n"
+    exit 0
+  fi
+  echo
+  if [ "$dry_run" -eq 1 ]; then
+    exit 0
+  elif [ "$confirm" -eq 1 ]; then
+    read -p "Continue? [Yn]: " confirm
+    [[ $confirm =~ ^[Nn] ]] && echo && exit 0
+  fi
+fi
+
+# okay, now actually run whatever's needed
 if [ ! -z "$bundle_changed" ]; then
   echo "Your Gemfile.lock has changed, running bundle"
   bundle
 fi
 
-migrations=`git diff --name-status $old_ref $new_ref -- db/migrate | grep '^[AD]'`
+if [ ! -z "$yarn_changed" ]; then
+  echo "Your yarn.lock has changed, running yarn"
+  yarn
+fi
+
 if [ ! -z "$migrations" ]; then
   echo "Running migrations!"
   for migration in $migrations
@@ -49,7 +154,9 @@ if [ ! -z "$migrations" ]; then
   done
 
   # RUN THE MIGRATIONS (AND TEST PREPARE)
-  echo "$migrate_commands" | bundle exec rails c > /dev/null
+  {
+    echo "$migrate_commands" | bundle exec rails c
+  } > $out_target
 
   # CLEAN UP DOWN MIGRATIONS
   if [ ! -z "$migration_cleanup" ]; then