sugarjar 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c4dd59aaf4843033f5c38df43b3fdfa556298708bc7f437f2923e00f9133c8
-  data.tar.gz: 5edeeb730db94059fd10b115b192ed239782b797473eb3b1fcf5aa749ca23e95
+  metadata.gz: 2820df2090fc51cb383edb67d4f4f450d659bed13da44cdf34c6fc9242084a10
+  data.tar.gz: 6571f45c6609aa80441cea9102da98f85fef8056bfe1e7bce1d566a6ce6e1bb3
 SHA512:
-  metadata.gz: 3869512549691df320f1dc344424b65944cd8cb501e25cd1a982f9b8d4d92cf608531147a8c5eb7a7437eee7644683ef9cf57e6035c44b61e4d247eec3331e03
-  data.tar.gz: 159e663e59a6c2aa939a5e9aecb90ce811bb9a168476d842ced28eab7a9968b760daec22661455a7bdaf3ac75ecc11a1c706e2ea07a6368ab653bcc3a222a597
+  metadata.gz: 953d1400363c4ddddf92fb4c0f0cbbe239c60b0c19c9a47726e99c8f8bca48008079b903e9c921886a26dfe0b4c0d4495d89ae15cd32a298cfa7b5bf78317bc5
+  data.tar.gz: bea7b4b10e735797c288b3bece8ddad975f0ebc35f264e732bdda2d583d9380f719b7f471d1df1640f1bcd6e76a3d39e36456fa18d8ede04a10de0c40355784a

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'appbundler'
+gem 'sugarjar', :path => '.'
+
+group :test do
+  gem 'mdl'
+  gem 'rspec'
+  gem 'rubocop'
+end

data/README.md

@@ -1,6 +1,7 @@
-# SugjarJar
+# SugarJar
 
 ![CI](https://github.com/jaymzh/sugarjar/workflows/CI/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/sugarjar.svg)](https://badge.fury.io/rb/sugarjar)
 
 Welcome to SugarJar - a git/github helper. It leverages the amazing GitHub cli,
 [hub](https://hub.github.com/), so you'll need that installed.
@@ -12,84 +13,219 @@ the Phabricator workflow this aims to bring to the GitHub workflow.
 In particular there are a lot of helpers for using a squash-merge workflow that
 is poorly handled by the standard toolsets.
 
-## Commands
+If you miss Mondrian or Phabrictor - this is the tool for you!
 
-### amend
+If you don't, there's a ton of useful stuff for everyone!
 
-Amend the current commit. Alias for `git commit --amend`.  Accepts other
-arguments such as `-a` or files.
+## Auto cleanup squash-merged branches
 
-### amendq, qamend
+It is common for a PR to go back and forth with a variety of nits, lint fixes,
+typos, etc. that can muddy history. So many projects will "squash and merge"
+when they accept a pull request. Howevet, that means `git branch -d <branch>`
+doesn't work. Git will tell you the branch isn't fully merged. You can, of
+course `git branch -D <branch>`, but that does no safety checks at all, it
+forces the deletion.
 
-Same as `amend` but without changing the message. Alias for `git commit --amend
---no-edit`.
+Enter `sj bclean` - it determines of the contents of your branch has been merge
+and safely deletes if so.
 
-### bclean
+``` shell
+sj bclean
+```
 
-If safe, delete the current branch. Unlike `git branch -d`, bclean can handle
-squash-merged branches. Think of it as a smarter `git branch -d`.
+Will delete a branch, if it has been merged, **even if it was squash-merged**.
 
-### bcleanall
+You can pass it a branch if you'd like (it defaults to the branch you're on):
+`sj bclean <branch>`.
 
-Walk all branches, and try to delete them if it's safe. See `bclean` for
-details.
+But it gets better! You can use `sj bcleanall` to remove all branches that have
+been merged:
 
-### binfo
+```shell
+$ git branch
+* argparse
+  master
+  feature
+  hubhost
+$ git bcleanall
+Skipping branch argparse - there are unmerged commits
+Reaped branch feature
+Reaped branch hubhost
+```
 
-Verbose information about the current branch.
+## Smarter clones and remotes
 
-### br
+There's a pattern to every new repo we want to contribute to. First we fork,
+then we clone the fork, then we add a remote of the upstream repo. It's
+monotonous. SugarJar does this for you:
 
-Verbose branch list. An alias for `git branch -v`.
+```shell
+sj smartclone jaymzh/sugarjar
+```
 
-### feature
+(also `sj sclone`)
 
-Create a "feature branch." It's morally equivalent to `git checkout -b` except
-it defaults to creating it based on some form of 'master' instead of your
-current branch. In order of preference it will be `upstream/master`,
-`origin/master`, or `master`, depending upon what remotes are available.
+This will:
 
-### forcepush, fpush
+* Make a fork of the repo, if you don't already have one
+* Clone your fork
+* Add the original as an 'upstream' remote
 
-The same as `smartpush`, but uses `--force-with-lease`. This is a "safer" way
-of doing force-pushes and is the recommended way to push after rebasing or
-amending. Never do this to shared branches. Very convenient for keeping the
-branch behind a pull-request clean.
+Note that it takes `hub`s short-names for repos. No need to specify a full URL,
+just a $org/$repo.
 
-### lint
+Like `git clone`, `sj sclone` will accept an additional arguement as the
+destination directory to clone to. It will also pass any other unknown options
+to `git clone` under the hood.
 
-Run any linters configured in `.sugarjar.yaml`.
+## Work with stacked branches more easily
 
-### smartclone, sclone
+It's important to break changes into reviewable chunks, but working with
+stacked branches can be confusing. Enter `binfo` - it gives you a view of your
+current branch all the way up to master. In this example imagine we have a
+branch structure like:
 
-A smart wrapper to `git clone` that handles forking and managing remotes for
-you.  It will clone a git repository using hub-style short name (`$org/$repo`).
-If the org of the repository is not the same as your github-user then it will
-fork the repo for you to your account (if not already done) and then setup your
-remotes so that `origin` is your fork and `upstream` is the upstream.
+```text
+                      +- test2.1
+                     /
+master --- test --- test2 --- test3
+```
 
-### smartpush, spush
+This is what `binfo` on test3 looks like:
 
-A smart wrapper to `git push` that runs whatever is defined in `on_push` in
-`.sugarjar.yml`, and only pushes if they succeed.
+```shell
+$ sj binfo
+* e451865 (HEAD -> test3) test3
+* e545b41 (test2) test2
+* c808eae (test1) test1
+o 44cf9e2 (origin/master, origin/HEAD, master) Lint/gemspec cleanups
+```
 
-It will also allow you to not specify a remote or branch, and will default to
-`origin` and whatever your current local branch name is.
+while `binfo` on test2.1 looks like:
 
-### unit
+```shell
+$ sj binfo
+* 36d0136 (HEAD -> test2.1) test2.1
+* e545b41 (test2) test2
+* c808eae (test1) test1
+o 44cf9e2 (origin/master, origin/HEAD, master) Lint/gemspec cleanups
+```
 
-Run any unitests configured in `.sugarjar.yaml`.
+## Have a better lint/unittest experience!
 
-### up
+Ever made a PR, only to find out later that it failed tests because of some
+small lint issue? Not anymore! SJ can be configured to run things before
+pushing. For example,in the SugarJar repo, we have it run Rubocop (ruby lint)
+and Markdownlint "on_push". If those fail, it lets you know and doesn't push.
 
-Rebase the current branch on the branch it's tracking, or if it's tracking one
-then, otherise `upstream/master` if it exists, or `origin/master`.
+You can configure SugarJar to tell how how to run both lints and unittests for
+a given repo and if one or both should be run prior to pushing.
 
-### upall
+The details on the config file format is below, but we provide three commands:
 
-Same as `up`, but for all branches.
+```shell
+git lint
+```
 
-## User Configuration
+Run all linters.
+
+```shell
+git unit
+```
+
+Run all unittests.
+
+```shell
+git smartpush # or spush
+```
+
+Run configured push-time actions (nothing, lint, unit, both), and do not
+push if any of them fail.
+
+## Better push defaults
+
+In addition to running pre-push tests for you `smartpush` also picks smart
+defaults for push. So if you `sj spush` with no arguements, it uses the
+`origin` remote and the same branch name you're on as the remote branch.
+
+## Cleaning up your own history
+
+Perhaps you contribute to a project that prefers to use merge commits, so you
+like to clean up your own history. This is often difficult to get right - a
+combination of rebases, amends and force pushes. We provide two commands here
+to help.
+
+The first is pretty straight forward and is basically just an alias: `sj
+amend`. It will ammend whatever you want to the most recent commit (just an
+alias for `git commit --amend`). It has a partner `qamend` (or `amendq` if you
+prefer) that will do so without prompting to update your commit message.
+
+So now you've rebased or amended, pushing becomes challening. You can `git push
+--force`, but everyone knows that's incredibly dangerous. Is there a better
+way? There is! Git provides `git push --force-with-lease` - it checks to make
+sure you're up-to-date with the remote before forcing the push. But man that
+command is a mouthful! Enter `sj fpush`. It has all the smarts of `sj
+smartpush` (runs configured pre-push actions), but adds `--force-with-lease` to
+the command!
+
+## Better feature branches
+
+When you want to start a new feature, you want to start developing against
+latest. That's why `sj feature` defaults to creating a branch against what we
+call "most master". That is, `upstream/master` if it exists, otherwise
+`origin/master` if that exists, otherwise `master`. You can pass in an
+additional arguement to base it off of something else.
+
+```shell
+$ git branch
+  master
+  test1
+  test2
+* test2.1
+  test3
+$ sj feature test-branch
+Created feature branch test-branch based on origin/master
+$ sj feature dependent-feature test-branch
+Created feature branch dependent-feature based on test-branch
+```
+
+## And more!
+
+See `sj help` for more commands!
+
+## Using SugarJar as a git wrapper
+
+SugarJar, by default, will pass any command it doesn't know straight to `hub`
+(which passes commands **it** doesn't know to `git`). As such you can alias it
+to `git` and just have a super-git.
+
+```shell
+$ alias git=sj
+$ git config -l | grep color
+color.diff=auto
+color.status=auto
+color.branch=auto
+color.branch.current=yellow reverse
+color.branch.local=yellow
+color.branch.remote=green
+$ git br
+* dependent-feature 44cf9e2 Lint/gemspec cleanups
+  master            44cf9e2 Lint/gemspec cleanups
+  test-branch       44cf9e2 Lint/gemspec cleanups
+  test1             c808eae [ahead 1] test1
+  test2             e545b41 test2
+  test2.1           c1831b3 test2.1
+  test3             e451865 test3
+```
+
+It's for this reason that SugarJar doesn't have conflicting command names. You
+can turn off fallthru by setting `fallthru: false` in your config.
+
+The only command we "override" is `version`, in which case we not only print
+our version, but also call `hub version` which prints its version and calls
+`git version` too!
+
+## Configuration
 
 Sugarjar will read in both a system-level config file
 (`/etc/sugarjar/config.yaml`) and a user-level config file
@@ -110,17 +246,19 @@ troubleshoot configuration parsing.
 ## Repository Configuration
 
 Sugarjar looks for a `.sugarjar.yaml` in the root of the repository to tell it
-how to handle repo-specific things. Currently there are only three
-configurations accepted:
+how to handle repo-specific things. Currently there options are:
 
-* lint - A list of scripts to run on `sj lint`. These should be linters like
+* `lint` - A list of scripts to run on `sj lint`. These should be linters like
   rubocop or pyflake.
-* unit - A list of scripts to run on `sj unit`. These should be unittest
+* `unit` - A list of scripts to run on `sj unit`. These should be unittest
   runners like rspec or pyunit.
-* on_push - A list of types (`lint`, `unit`) of checks to run before pushing.
+* `on_push` - A list of types (`lint`, `unit`) of checks to run before pushing.
   It is highly recommended this is only `lint`. The goal here is to allow for
   the user to get quick stylistic feedback before pushing their branch to avoid
   the push-fix-push-fix loop.
+* `commit_template` - A path to a commit template to set in the `commit.template`
+  git config for this repo. Should be either a fully-qualified path, or a path
+  relative to the repo root.
 
 Example configuration:
 
@@ -131,19 +269,52 @@ unit:
   - scripts/unit
 on_push:
   - lint
+commit_template: .commit-template.txt
+```
+
+### Commit Templates
+
+While GitHub provides a way to specify a pull-request template by putting the
+right file into a repo, there is no way to tell git to automatically pick up a
+commit template by dropping a file in the repo. Users must do something like:
+`git config commit.template <file>`. Making each developer do this is error
+prone, so this setting will automatically set this up for each developer.
+
+## Enterprise GitHub
+
+Like `hub`, SugarJar supports GitHub Enterprise. In fact, we provide extra
+features just for it.
+
+We recommend the global or user config specify the `github_host`. However, most
+users will also have a few repos from upstream so always specifying a
+`github_host` is sub-optimal.
+
+So, when you overwrite the `github_host` on the command line, we go ahead and
+set the `hub.host` git config in that single repo so that it'll "just work"
+from there on out.
+
+In other words, assuming your global SJ config has `github_host:
+github.sample.com`, and the you clone sugarjar with:
+
+```shell
+sj clone jaymzh/sugarjar --github-host githuh.com
 ```
 
+We will add the `hub.host` to the `sugarjar` clone so that future `hub` or `sj`
+commands work without needing to specify..
+
 ## FAQ
 
 Why the name SugarJar?
 
-It's mostly a backranym. Like jellyfish, I wanted two letters that were on
-home row on different sides of the keyboard to make it easy to type. I looked
-at the possible options that where there and not taken and tried to find one
-I could make an appropriate name out of. Since this utility adds lots of sugar
-to git and github, it seemed appropriate.
+It's mostly a backranym. Like jellyfish, I wanted two letters that were on home
+row on different sides of the keyboard to make it easy to type. I looked at the
+possible options that where there and not taken and tried to find one I could
+make an appropriate name out of. Since this utility adds lots of sugar to git
+and github, it seemed appropriate.
 
 Why did you use `hub` instead of the newer `gh` CLI?
 
-`gh` is less feature-rich (currently). I'm also considering making this optionally
-act as a wrapper to `hub` the way `hub` can be a wrapper to `git`.
+`gh` is still new and not yet as feature rich as `hub`. Also I wanted SugarJar
+to be able to be a git wrapper, and so wrapping `hub` allows us to do that but
+wrapping `gh` does not.

data/bin/sj

@@ -0,0 +1,239 @@
+#!/usr/bin/env ruby
+# SugarJar
+
+require 'optparse'
+require 'mixlib/shellout'
+require_relative '../lib/sugarjar/commands'
+require_relative '../lib/sugarjar/config'
+require_relative '../lib/sugarjar/log'
+require_relative '../lib/sugarjar/util'
+require_relative '../lib/sugarjar/version'
+
+SugarJar::Log.level = Logger::INFO
+
+# Don't put defaults here, put them in SugarJar::Config - otherwise
+# these defaults overwrite whatever is in config files.
+options = {}
+# If ENV['SUGARJAR_DEBUG'] is set, it overrides the config file,
+# but not the command line options, so set that one here. Also
+# start the logger at that level, in case we are debugging option loading
+# itself
+if ENV['SUGARJAR_LOGLEVEL']
+  options['log_level'] = SugarJar::Log.level = ENV['SUGARJAR_LOGLEVEL'].to_sym
+end
+parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: sj <command> [<args>] [<options>]'
+
+  opts.separator ''
+  opts.separator 'Command, args, and options, can appear in any order.'
+  opts.separator ''
+  opts.separator 'OPTIONS:'
+
+  opts.on('--[no-]fallthru', 'Fall-thru to git') do |fallthru|
+    options['fallthru'] = fallthru
+  end
+
+  opts.on('--github-user USER', 'Github username') do |user|
+    options['github_user'] = user
+  end
+
+  opts.on(
+    '--github-host HOST',
+    'The host for "hub". Note that we will set this in the local repo ' +
+    'config so there is no need to have multiple config files for multiple ' +
+    'github servers. Put your default one in your config file, and simply ' +
+    'specify this option the first time you clone or touch a repo and it ' +
+    'will be part of that repo until changed.',
+  ) do |host|
+    options['github_host'] = host
+  end
+
+  opts.on('-h', '--help', 'Print this help message') do
+    puts opts
+    exit
+  end
+
+  opts.on(
+    '--log-level LEVEL',
+    'Set logging level (fatal, error, warning, info, debug, trace). Default: ' +
+    'info',
+  ) do |level|
+    options['log_level'] = level
+  end
+
+  opts.on('--version') do
+    puts SugarJar::VERSION
+    exit
+  end
+
+  # rubocop:disable Layout/HeredocIndentation
+  opts.separator <<COMMANDS
+
+COMMANDS:
+  amend
+              Amend the current commit. Alias for "git commit --amend".
+              Accepts other arguments such as "-a" or files.
+
+  amendq, qamend
+              Same as "amend" but without changing the message. Alias for
+              "git commit --amend --no-edit".
+
+  bclean
+              If safe, delete the current branch. Unlike "git branch -d",
+              bclean can handle squash-merged branches. Think of it as
+              a smarter "git branch -d".
+
+  bcleanall
+              Walk all branches, and try to delete them if it's safe. See
+              "bclean" for details.
+
+  binfo
+              Verbose information about the current branch.
+
+  br
+              Verbose branch list. An alias for "git branch -v".
+
+  feature
+              Create a "feature" branch. It's morally equivalent to
+              "git checkout -b" except it defaults to creating it based on
+              some form of 'master' instead of your current branch. In order
+              of preference it will be upstream/master, origin/master, master,
+              depending upon what remotes are available.
+
+  forcepush, fpush
+              The same as "smartpush", but uses "--force-with-lease". This is
+              a "safer" way of doing force-pushes and is the recommended way
+              to push after rebasing or amending. Never do this to shared
+              branches. Very convenient for keeping the branch behind a pull-
+              request clean.
+
+  lint
+              Run any linters configured in .sugarjar.yaml.
+
+  smartclone, sclone
+              A smart wrapper to "git clone" that handles forking and managing
+              remotes for you.
+              It will clone a git repository using hub-style short name
+              ("$org/$repo"). If the org of the repository is not the same
+              as your github-user then it will fork the repo for you to
+              your account (if not already done) and then setup your remotes
+              so that "origin" is your fork and "upstream" is the upstream.
+
+  smartpush, spush
+              A smart wrapper to "git push" that runs whatever is defined in
+              "on_push" in .sugarjar.yml, and only pushes if they succeed.
+
+  unit
+              Run any unitests configured in .sugarjar.yaml.
+
+  up
+              Rebase the current branch on upstream/master or origin/master.
+
+  upall
+              Same as "up", but for all branches.
+
+  verson
+              Print the version of sugarjar, and then run 'hub version'
+              to show the hub and git versions.
+COMMANDS
+
+  # rubocop:enable Layout/HeredocIndentation
+end
+
+# we make a copy of these because we will assign back to the ARGV
+# we parse later. We also need a pristine copy in case we want to
+# run git as we were called.
+argv_copy = ARGV.dup
+
+# We don't have options yet, but we need an instance of SJ in order
+# to list public methods. We will recreate it
+sj = SugarJar::Commands.new(options.merge({ 'no_change' => true }))
+extra_opts = []
+
+# as with above, this can't go into 'options', until after we parse
+# the command line args
+config = SugarJar::Config.config
+
+valid_commands = sj.public_methods - Object.public_methods
+
+is_valid_command = ARGV.any? { |arg| valid_commands.include?(arg.to_s.to_sym) }
+
+# if we're configured to fall thru and the subcommand isn't one
+# we recognize, don't parse the options as they may be different
+# than git's. For example `git config -l` - we error because we
+# require an arguement to `-l`.
+if config['fallthru'] && !is_valid_command
+  SugarJar::Log.debug(
+    'Skipping option parsing: fall-thru is set and we do not recognize ' +
+    'any subcommands',
+  )
+else
+  # We want to allow people to pass in extra args to be passed to
+  # git commands, but OptionParser doesn't easily allow this. So we
+  # loop over it, catching exceptions.
+  begin
+    # HOWEVER, anytime it throws an exception, for some reason, it clears
+    # out all of ARGV, or whatever you passed to as ARGV.
+    #
+    # This not only prevents further parsing, but also means we lose
+    # any non-option arguements (like the subcommand!)
+    #
+    # So we save a copy, and if we throw an exception, save the option that
+    # caused it, remove that option from our copy, and then re-populate argv
+    # with what's left.
+    #
+    # By doing this we not only get to parse all the options properly and
+    # save unknown ones, but non-option arguements, which OptionParser
+    # normally leaves in ARGV stay in ARGV.
+    saved_argv = argv_copy.dup
+    parser.parse!(argv_copy)
+  rescue OptionParser::InvalidOption => e
+    SugarJar::Log.debug("Saving unknown argument #{e.args}")
+    extra_opts += e.args
+
+    # e.args is an array, but it's only ever one arguement per exception
+    saved_argv.delete(e.args.first)
+    argv_copy = saved_argv.dup
+    SugarJar::Log.debug(
+      "Continuing option parsing with remaining ARGV: #{argv_copy}",
+    )
+    retry
+  end
+end
+
+if ARGV.empty?
+  puts parser
+  exit
+end
+
+options = config.merge(options)
+
+# Recreate SJ with all of our options
+SugarJar::Log.level = options['log_level'].to_sym if options['log_level']
+sj = SugarJar::Commands.new(options)
+
+subcommand = argv_copy.reject { |x| x.start_with?('-') }.first
+argv_copy.delete(subcommand)
+SugarJar::Log.debug("subcommand is #{subcommand}")
+
+# Extra options we got, plus any left over arguements are what we
+# pass to Commands so they can be passed to git as necessary
+extra_opts += argv_copy
+SugarJar::Log.debug("extra unknown options: #{extra_opts}")
+
+if subcommand == 'help'
+  puts parser
+  exit
+end
+
+if is_valid_command
+  SugarJar::Log.debug(
+    "running #{subcommand}; extra opts: #{extra_opts.join(', ')}",
+  )
+  sj.send(subcommand.to_sym, *extra_opts)
+elsif options['fallthru']
+  SugarJar::Log.debug("Falling thru to: hub #{ARGV.join(' ')}")
+  exec('hub', *ARGV)
+else
+  SugarJar::Log.error("No such subcommand: #{subcommand}")
+end

data/lib/sugarjar/commands.rb

@@ -11,10 +11,14 @@ class SugarJar
     include SugarJar::Util
 
     def initialize(options)
+      SugarJar::Log.debug("Commands.initialize options: #{options}")
       @ghuser = options['github_user']
       @ghhost = options['github_host']
       @repo_config = SugarJar::RepoConfig.config
+      return if options['no_change']
+
       set_hub_host if @ghhost
+      set_commit_template if @repo_config['commit_template']
     end
 
     def feature(name, base = nil)
@@ -22,6 +26,8 @@ class SugarJar
       SugarJar::Log.debug("Feature: #{name}, #{base}")
       die("#{name} already exists!") if all_branches.include?(name)
       base ||= most_master
+      base_pieces = base.split('/')
+      hub('fetch', base_pieces[0]) if base_pieces.length > 1
       hub('checkout', '-b', name, base)
       SugarJar::Log.info("Created feature branch #{name} based on #{base}")
     end
@@ -38,22 +44,30 @@ class SugarJar
 
     def bcleanall
       assert_in_repo
+      curr = current_branch
       all_branches.each do |branch|
         next if branch == 'master'
 
         # rubocop:disable Style/Next
         unless clean_branch(branch)
           SugarJar::Log.info(
-            "Skipping branch #{branch} - there are unmerged commits"
+            "Skipping branch #{branch} - there are unmerged commits",
           )
         end
         # rubocop:enable Style/Next
       end
+
+      # Return to the branch we were on, or master
+      if all_branches.include?(curr)
+        hub('checkout', curr)
+      else
+        hub('checkout', 'master')
+      end
     end
 
-    def co(name)
+    def co(*args)
       assert_in_repo
-      hub('checkout', name)
+      hub('checkout', *args)
     end
 
     def br
@@ -82,7 +96,7 @@ class SugarJar
     def amend(*args)
       assert_in_repo
       # This cannot use shellout since we need a full terminal for the editor
-      exit(system('/usr/bin/git', 'commit', '--amend', *args))
+      exit(system(which('git'), 'commit', '--amend', *args))
     end
 
     def qamend(*args)
@@ -104,7 +118,7 @@ class SugarJar
         else
           SugarJar::Log.error(
             "Failed to rebase #{branch}, aborting that and moving to next " +
-            'branch'
+            'branch',
           )
           hub('rebase', '--abort')
         end
@@ -127,7 +141,7 @@ class SugarJar
 
         org = File.basename(File.dirname(repo))
         if org == @ghuser
-          put 'Cloned forked or self-owned repo. Not creating "upstream".'
+          puts 'Cloned forked or self-owned repo. Not creating "upstream".'
           return
         end
 
@@ -152,7 +166,7 @@ class SugarJar
     end
 
     def unit
-      exit(1) unless run_check('lint')
+      exit(1) unless run_check('unit')
     end
 
     def smartpush(remote = nil, branch = nil)
@@ -202,14 +216,60 @@ class SugarJar
         if current == @ghost
           SugarJar::Log.debug('Repo hub.host already set correctly')
         else
-          SugarJar::Log.info(
-            "Overwriting repo hub.host from #{current} to #{@ghhost}"
+          # Even though we have an explicit config, in most cases, it
+          # comes from a global or user config, but the config in the
+          # local repo we likely set. So we'd just constantly revert that.
+          SugarJar::Log.debug(
+            "Not overwriting repo hub.host. Already set to #{current}. " +
+            "To change it, run `git config --local --add hub.host #{@ghhost}`",
           )
         end
+        return
       end
       hub('config', '--local', '--add', 'hub.host', @ghhost)
     end
 
+    def set_commit_template
+      unless in_repo
+        SugarJar::Log.debug('Skipping set_commit_template: not in repo')
+        return
+      end
+
+      realpath = if @repo_config['commit_template'].start_with?('/')
+                   @repo_config['commit_template']
+                 else
+                   "#{repo_root}/#{@repo_config['commit_template']}"
+                 end
+      unless File.exist?(realpath)
+        die(
+          "Repo config specifies #{@repo_config['commit_template']} as the " +
+          'commit template, but that file does not exist.',
+        )
+      end
+
+      s = hub_nofail('config', '--local', 'commit.template')
+      unless s.error?
+        current = s.stdout.strip
+        if current == @repo_config['commit_template']
+          SugarJar::Log.debug('Commit template already set correctly')
+          return
+        else
+          SugarJar::Log.warn(
+            "Updating repo-specific commit template from #{current} " +
+            "to #{@repo_config['commit_template']}",
+          )
+        end
+      end
+
+      SugarJar::Log.debug(
+        'Setting repo-specific commit template to ' +
+        "#{@repo_config['commit_template']} per sugarjar repo config.",
+      )
+      hub(
+        'config', '--local', 'commit.template', @repo_config['commit_template']
+      )
+    end
+
     def run_check(type)
       unless @repo_config[type]
         SugarJar::Log.debug("No #{type} configured. Returning success")
@@ -224,16 +284,20 @@ class SugarJar
             return false
           end
           s = Mixlib::ShellOut.new(check).run_command
-          if s.error?
-            SugarJar::Log.info("#{type} #{check} failed\n#{s.stdout}")
-            return false
-          end
+          next unless s.error?
+
+          SugarJar::Log.info(
+            "#{type} #{check} failed, output follows (use debug for more)\n" +
+            s.stdout.to_s,
+          )
+          SugarJar::Log.debug(s.format_for_exception)
+          return false
         end
       end
     end
 
     def run_prepush
-      @repo_config['on_push'].each do |item|
+      @repo_config['on_push']&.each do |item|
         SugarJar::Log.debug("Running on_push check type #{item}")
         unless send(:run_check, item)
           SugarJar::Log.info("Push check #{item} failed.")
@@ -287,7 +351,7 @@ class SugarJar
       end
       if out.length.zero?
         SugarJar::Log.debug(
-          "cherry-pick shows branch #{branch} obviously safe to delete"
+          "cherry-pick shows branch #{branch} obviously safe to delete",
         )
         return true
       end
@@ -303,10 +367,10 @@ class SugarJar
       s = hub_nofail('merge', '--squash', branch)
       if s.error?
         cleanup_tmp_branch(tmpbranch, branch)
-        error(
+        SugarJar::Log.error(
           'Failed to merge changes into current master. This means we could ' +
           'not figure out if this is merged or not. Check manually and use ' +
-          "'git branch -D #{branch}' if it is safe to do so."
+          "'git branch -D #{branch}' if it is safe to do so.",
         )
         return false
       end
@@ -317,12 +381,12 @@ class SugarJar
       cleanup_tmp_branch(tmpbranch, branch)
       if out.empty?
         SugarJar::Log.debug(
-          'After squash-merging, this branch appears safe to delete'
+          'After squash-merging, this branch appears safe to delete',
         )
         true
       else
         SugarJar::Log.debug(
-          'After squash-merging, this branch is NOT fully merged to master'
+          'After squash-merging, this branch is NOT fully merged to master',
         )
         false
       end
@@ -346,8 +410,18 @@ class SugarJar
     def gitup
       SugarJar::Log.debug('Fetching upstream')
       fetch_upstream
+      curr = current_branch
       SugarJar::Log.debug('Rebasing')
       base = tracked_branch
+      if curr != 'master' && base == "origin/#{curr}"
+        SugarJar::Log.warn(
+          "This branch is tracking origin/#{curr}, which is probably your " +
+          'downstream (where you push _to_) as opposed to your upstream ' +
+          '(where you pull _from_). This means that "sj up" is probably ' +
+          'rebasing on the wrong thing and doing nothing. You probably want ' +
+          'to do a "git branch -u upstream".',
+        )
+      end
       s = hub_nofail('rebase', base)
       s.error? ? nil : base
     end

data/lib/sugarjar/config.rb

@@ -6,7 +6,7 @@ class SugarJar
   # This is stuff like log level, github-user, etc.
   class Config
     DEFAULTS = {
-      'ghuser' => ENV['USER'],
+      'github_user' => ENV['USER'],
       'fallthru' => true,
     }.freeze
 
@@ -22,7 +22,9 @@ class SugarJar
       c = DEFAULTS.dup
       _find_ordered_files.each do |f|
         SugarJar::Log.debug("Loading config #{f}")
-        c.merge!(YAML.safe_load(File.read(f)))
+        data = YAML.safe_load(File.read(f))
+        # an empty file is a `nil` which you can't merge
+        c.merge!(YAML.safe_load(File.read(f))) if data
         SugarJar::Log.debug("Modified config: #{c}")
       end
       c

data/lib/sugarjar/util.rb

@@ -3,9 +3,51 @@ require_relative 'log'
 class SugarJar
   # Some common methods needed by other classes
   module Util
+    # Finds the first entry in the path for a binary and checks
+    # to make sure it's not us (i.e. we may be linked to as 'git'
+    # or 'hub', but when we are calling that, we don't want ourselves.
+    def which_nofail(cmd)
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |dir|
+        p = File.join(dir, cmd)
+        # if it exists, and it is executable and is not us...
+        if File.exist?(p) && File.executable?(p) &&
+           File.basename(File.realpath(p)) != 'sj'
+          return p
+        end
+      end
+      false
+    end
+
+    def which(cmd)
+      path = which_nofail(cmd)
+      return path if path
+
+      SugarJar::Log.fatal("Could not find #{cmd} in your path")
+      exit(1)
+    end
+
     def hub_nofail(*args)
       SugarJar::Log.trace("Running: hub #{args.join(' ')}")
-      Mixlib::ShellOut.new(['/usr/bin/hub'] + args).run_command
+      s = Mixlib::ShellOut.new([which('hub')] + args).run_command
+      # depending on hub version and possibly other things, STDERR
+      # is either "Requires authentication" or "Must authenticate"
+      if s.error? && s.stderr =~ /^(Must|Requires) authenticat/
+        SugarJar::Log.info(
+          'Hub was run but no github token exists. Will run "hub api user" ' +
+          "to force\nhub to authenticate...",
+        )
+        unless system(which('hub'), 'api', 'user')
+          SugarJar::Log.fatal(
+            'That failed, I will bail out. Hub needs to get a github ' +
+            'token. Try running "hub api user" (will list info about ' +
+            'your account) and try this again when that works.',
+          )
+          exit(1)
+        end
+        SugarJar::Log.info('Re-running original hub command...')
+        s = Mixlib::ShellOut.new([which('hub')] + args).run_command
+      end
+      s
     end
 
     def hub(*args)

data/lib/sugarjar/version.rb

@@ -1,3 +1,3 @@
 class SugarJar
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.6'.freeze
 end

data/sugarjar.gemspec

@@ -0,0 +1,21 @@
+require_relative 'lib/sugarjar/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sugarjar'
+  spec.version = SugarJar::VERSION
+  spec.summary = 'A git/github helper script'
+  spec.authors = ['Phil Dibowitz']
+  spec.email = ['phil@ipom.com']
+  spec.license = 'Apache-2.0'
+  spec.homepage = 'https://github.com/jaymzh/sugarjar'
+  docs = %w{README.md LICENSE Gemfile sugarjar.gemspec}
+  spec.extra_rdoc_files = docs
+  spec.executables << 'sj'
+  spec.files =
+    Dir.glob('lib/sugarjar/*.rb') +
+    Dir.glob('bin/*') +
+    docs
+
+  spec.add_dependency 'mixlib-log'
+  spec.add_dependency 'mixlib-shellout'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -38,79 +38,29 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: yaml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mdl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - phil@ipom.com
-executables: []
+executables:
+- sj
 extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
+- Gemfile
+- sugarjar.gemspec
 files:
+- Gemfile
 - LICENSE
 - README.md
+- bin/sj
 - lib/sugarjar/commands.rb
 - lib/sugarjar/config.rb
 - lib/sugarjar/log.rb
 - lib/sugarjar/repoconfig.rb
 - lib/sugarjar/util.rb
 - lib/sugarjar/version.rb
+- sugarjar.gemspec
 homepage: https://github.com/jaymzh/sugarjar
 licenses:
 - Apache-2.0
@@ -130,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A git/github helper script