sugarjar 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2abc9bd19f20ab7da08bb9617490eeeec7019367ecc869309122929005ddf40f
-  data.tar.gz: 010b62db181cf3b8e0c26cec49c0342107a2b0e18c151e66000a1c119332d7bd
+  metadata.gz: 56cbf17ade9b12f891a658d7224a4571890da6517d9ea77a6f3688b4ff593261
+  data.tar.gz: c0c51ce8312f592cc8fd0fe273c563c2c7d3b2e033776ba64d267767755bd720
 SHA512:
-  metadata.gz: b5ba7da0c8d3acacfe3f02dd479c77ab721fc3bc31cd70d0845ae3d0d9efe849de765d1d652ef3b70aa4f8643014837ab9d6361ad8231c7713e8ef10c07a3744
-  data.tar.gz: 6f34096847e760ab6cc346121bf3ee18b7b8490e458fefd9a68692b81e71ae0c8b3d2d84b39f2549efb18acbe033908f0dcf002b58ab2d6907455c9f102b125f
+  metadata.gz: 3d49efb6124a04112ab8bd80b145a2459bdeb56f79c468524e0c89bbc9ef183dfce001fe199b8274562083b338aa2d81073e818676cd6fb9a43250c7be80c736
+  data.tar.gz: 0acc7fb90fed326a8976a1f029e3f5a9720259c855df686e8fb52aa70f8dc009f500f1bb36ef1c5957b7291b5d36cd3e4e59e902582fc23ed66409a58f73869a

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,18 +1,21 @@
 # SugarJar
 
-![CI](https://github.com/jaymzh/sugarjar/workflows/CI/badge.svg)
+[![Lint](https://github.com/jaymzh/sugarjar/workflows/Lint/badge.svg)](https://github.com/jaymzh/sugarjar/actions?query=workflow%3ALint)
+[![Unittest](https://github.com/jaymzh/sugarjar/workflows/Unittests/badge.svg)](https://github.com/jaymzh/sugarjar/actions?query=workflow%3AUnittests)
+[![DCO](https://github.com/jaymzh/sugarjar/workflows/DCO%20Check/badge.svg)](https://github.com/jaymzh/sugarjar/actions?query=workflow%3A%22DCO+Check%22)
+[![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.
 
 SugarJar is inspired by [arcanist](https://github.com/phacility/arcanist), and
-it's replacement at Facebook, JellyFish. Many of the features they provide for
+its replacement at Facebook, JellyFish. Many of the features they provide for
 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.
 
-If you miss Mondrian or Phabrictor - this is the tool for you!
+If you miss Mondrian or Phabricator - this is the tool for you!
 
 If you don't, there's a ton of useful stuff for everyone!
 
@@ -20,12 +23,12 @@ If you don't, there's a ton of useful stuff for everyone!
 
 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>`
+when they accept a pull request. However, 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.
 
-Enter `sj bclean` - it determines of the contents of your branch has been merge
+Enter `sj bclean` - it determines if the contents of your branch has been merge
 and safely deletes if so.
 
 ``` shell
@@ -73,7 +76,7 @@ This will:
 Note that it takes `hub`s short-names for repos. No need to specify a full URL,
 just a $org/$repo.
 
-Like `git clone`, `sj sclone` will accept an additional arguement as the
+Like `git clone`, `sj sclone` will accept an additional argument as the
 destination directory to clone to. It will also pass any other unknown options
 to `git clone` under the hood.
 
@@ -117,7 +120,7 @@ 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.
 
-You can configure SugarJar to tell how how to run both lints and unittests for
+You can configure SugarJar to tell it how to run both lints and unittests for
 a given repo and if one or both should be run prior to pushing.
 
 The details on the config file format is below, but we provide three commands:
@@ -144,7 +147,7 @@ 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
+defaults for push. So if you `sj spush` with no arguments, it uses the
 `origin` remote and the same branch name you're on as the remote branch.
 
 ## Cleaning up your own history
@@ -155,11 +158,11 @@ 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
+amend`. It will amend 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
+So now you've rebased or amended, pushing becomes challenging. 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
@@ -173,7 +176,7 @@ 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.
+additional argument to base it off of something else.
 
 ```shell
 $ git branch
@@ -245,17 +248,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:
 
@@ -266,8 +271,17 @@ 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

data/bin/sj

@@ -0,0 +1,266 @@
+#!/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 = { 'color' => true }
+# 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(
+    '--ignore-dirty',
+    'Tell command that check for a dirty repo to carry on anyway.',
+  ) do
+    options['ignore_dirty'] = true
+  end
+
+  opts.on(
+    '--ignore-prerun-failure',
+    'Ignore preprun failure on *push commands.',
+  ) do
+    options['ignore_prerun_failure'] = true
+  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('--[no-]use-color', 'Enable color. [default: true]') do |color|
+    options['color'] = color
+  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.
+
+  smartlog, sl
+              Inspired by Facebook's "sl" extension to Mercurial, this command
+              will show you a tree of all your local branches relative to your
+              upstream.
+
+  smartpullrequest, smartpr, spr
+              A smart wrapper to "hub pull-request" that checks if your repo
+              is dirty before creating the pull request.
+
+  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.
+
+  version
+              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

@@ -1,3 +1,5 @@
+require 'mixlib/shellout'
+
 require_relative 'util'
 require_relative 'repoconfig'
 require_relative 'log'
@@ -11,10 +13,17 @@ class SugarJar
     include SugarJar::Util
 
     def initialize(options)
+      SugarJar::Log.debug("Commands.initialize options: #{options}")
       @ghuser = options['github_user']
       @ghhost = options['github_host']
+      @ignore_dirty = options['ignore_dirty']
+      @ignore_prerun_failure = options['ignore_prerun_failure']
       @repo_config = SugarJar::RepoConfig.config
+      @color = options['color']
+      return if options['no_change']
+
       set_hub_host if @ghhost
+      set_commit_template if @repo_config['commit_template']
     end
 
     def feature(name, base = nil)
@@ -25,42 +34,62 @@ class SugarJar
       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}")
+      SugarJar::Log.info(
+        "Created feature branch #{color(name, :green)} based on " +
+        color(base, :green),
+      )
     end
 
     def bclean(name = nil)
       assert_in_repo
       name ||= current_branch
-      # rubocop:disable Style/GuardClause
-      unless clean_branch(name)
-        die("Cannot clean #{name} - there are unmerged commits")
+      if clean_branch(name)
+        SugarJar::Log.info("#{name}: #{color('reaped', :green)}")
+      else
+        die(
+          "#{color("Cannot clean #{name}", :red)}! there are unmerged " +
+          "commits; use 'git branch -D #{name}' to forcefully delete it.",
+        )
       end
-      # rubocop:enable Style/GuardClause
     end
 
     def bcleanall
       assert_in_repo
+      curr = current_branch
       all_branches.each do |branch|
-        next if branch == 'master'
+        if branch == 'master'
+          SugarJar::Log.debug('Skipping master')
+          next
+        end
 
-        # rubocop:disable Style/Next
-        unless clean_branch(branch)
-          SugarJar::Log.info(
-            "Skipping branch #{branch} - there are unmerged commits",
+        if clean_branch(branch)
+          SugarJar::Log.info("#{branch}: #{color('reaped', :green)}")
+        else
+          SugarJar::Log.info("#{branch}: skipped")
+          SugarJar::Log.debug(
+            "There are unmerged commits; use 'git branch -D #{branch}' to " +
+            'forcefully delete it)',
           )
         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(*args)
       assert_in_repo
-      hub('checkout', *args)
+      s = hub('checkout', *args)
+      SugarJar::Log.info(s.stderr + s.stdout.chomp)
     end
 
     def br
       assert_in_repo
-      puts hub('branch', '-v').stdout
+      SugarJar::Log.info(hub('branch', '-v').stdout.chomp)
     end
 
     def binfo
@@ -68,16 +97,29 @@ class SugarJar
       SugarJar::Log.info(hub(
         'log', '--graph', '--oneline', '--decorate', '--boundary',
         "#{tracked_branch}.."
-      ).stdout)
+      ).stdout.chomp)
     end
 
+    # binfo for all branches
+    def smartlog
+      assert_in_repo
+      SugarJar::Log.info(hub(
+        'log', '--graph', '--oneline', '--decorate', '--boundary',
+        '--branches', "#{most_master}.."
+      ).stdout.chomp)
+    end
+
+    alias sl smartlog
+
     def up
       assert_in_repo
       result = gitup
       if result
-        SugarJar::Log.info("Rebased branch on #{result}")
+        SugarJar::Log.info(
+          "#{color(current_branch, :green)} rebased on #{result}",
+        )
       else
-        die('Failed to rebase current branch')
+        die("#{color(current_branch, :red)}: Failed to rebase")
       end
     end
 
@@ -102,11 +144,13 @@ class SugarJar
         hub('checkout', branch)
         result = gitup
         if result
-          SugarJar::Log.info("Rebased #{branch} on #{result}")
+          SugarJar::Log.info(
+            "#{color(branch, :green)} rebased on #{color(result, :green)}",
+          )
         else
           SugarJar::Log.error(
-            "Failed to rebase #{branch}, aborting that and moving to next " +
-            'branch',
+            "#{color(branch, :red)} failed rebase. Reverting attempt and " +
+            'moving to next branch',
           )
           hub('rebase', '--abort')
         end
@@ -127,9 +171,10 @@ class SugarJar
         # Now that we have a repo, if we have a hub host set it.
         set_hub_host if @ghhost
 
-        org = File.basename(File.dirname(repo))
+        org = extract_org(repo)
+        SugarJar::Log.debug("Comparing org #{org} to ghuser #{@ghuser}")
         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
 
@@ -137,9 +182,10 @@ class SugarJar
         if s.error?
           # if the fork command failed, we already have one, so we have
           # to swap the remote names ourselves
+          # newer 'hub's don't fail and do the right thing...
           SugarJar::Log.info("Fork (#{@ghuser}/#{reponame}) detected.")
           hub('remote', 'rename', 'origin', 'upstream')
-          hub('remote', 'add', 'origin', repo.gsub("#{org}/", "#{@ghuser}/"))
+          hub('remote', 'add', 'origin', forked_path(repo, @ghuser))
         else
           SugarJar::Log.info("Forked #{reponame} to #{@ghuser}")
         end
@@ -150,38 +196,25 @@ class SugarJar
     alias sclone smartclone
 
     def lint
+      assert_in_repo
       exit(1) unless run_check('lint')
     end
 
     def unit
-      exit(1) unless run_check('lint')
+      assert_in_repo
+      exit(1) unless run_check('unit')
     end
 
     def smartpush(remote = nil, branch = nil)
-      unless remote && branch
-        remote ||= 'origin'
-        branch ||= current_branch
-      end
-
-      if run_prepush
-        puts hub('push', remote, branch).stderr
-      else
-        SugarJar::Log.error('Pre-push checks failed. Not pushing.')
-      end
+      assert_in_repo
+      _smartpush(remote, branch, false)
     end
 
     alias spush smartpush
 
     def forcepush(remote = nil, branch = nil)
-      unless remote && branch
-        remote ||= 'origin'
-        branch ||= current_branch
-      end
-      if run_prepush
-        puts hub('push', '--force-with-lease', remote, branch).stderr
-      else
-        SugarJar::Log.error('Pre-push checks failed. Not pushing.')
-      end
+      assert_in_repo
+      _smartpush(remote, branch, true)
     end
 
     alias fpush forcepush
@@ -191,8 +224,86 @@ class SugarJar
       puts hub('version').stdout
     end
 
+    def smartpullrequest
+      assert_in_repo
+      if dirty?
+        SugarJar::Log.warn(
+          'Your repo is dirty, so I am not going to create a pull request. ' +
+          'You should commit or amend and push it to your remote first.',
+        )
+        exit(1)
+      end
+      system(which('hub'), 'pull-request')
+    end
+
+    alias spr smartpullrequest
+    alias smartpr smartpullrequest
+
     private
 
+    def _smartpush(remote, branch, force)
+      unless remote && branch
+        remote ||= 'origin'
+        branch ||= current_branch
+      end
+
+      if dirty?
+        if @ignore_dirty
+          SugarJar::Log.warn(
+            'Your repo is dirty, but --ignore-dirty was specified, so ' +
+            'carrying on anyway.',
+          )
+        else
+          SugarJar::Log.error(
+            'Your repo is dirty, so I am not going to push. Please commit ' +
+            'or amend first.',
+          )
+          exit(1)
+        end
+      end
+
+      unless run_prepush
+        if @ignore_prerun_failure
+          SugarJar::Log.warn(
+            'Pre-push checks failed, but --ignore-prerun-failure was ' +
+            'specified, so carrying on anyway',
+          )
+        else
+          SugarJar::Log.error('Pre-push checks failed. Not pushing.')
+          exit(1)
+        end
+      end
+
+      args = ['push', remote, branch]
+      args << '--force-with-lease' if force
+      puts hub(*args).stderr
+    end
+
+    def dirty?
+      s = hub_nofail('diff', '--quiet')
+      s.error?
+    end
+
+    def extract_org(path)
+      if path.start_with?('http')
+        File.basename(File.dirname(path))
+      elsif path.start_with?('git@')
+        path.split(':')[1].split('/')[0]
+      else
+        # assume they passed in a hub-friendly name
+        path.split('/').first
+      end
+    end
+
+    def forked_path(path, username)
+      repo = if path.start_with?('http', 'git@')
+               File.basename(path)
+             else
+               "#{File.basename(path)}.git"
+             end
+      "git@github.com:#{username}/#{repo}"
+    end
+
     def set_hub_host
       return unless in_repo
 
@@ -201,7 +312,7 @@ class SugarJar
         SugarJar::Log.info("Setting repo hub.host = #{@ghhost}")
       else
         current = s.stdout
-        if current == @ghost
+        if current == @ghhost
           SugarJar::Log.debug('Repo hub.host already set correctly')
         else
           # Even though we have an explicit config, in most cases, it
@@ -217,6 +328,47 @@ class SugarJar
       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,17 +376,26 @@ class SugarJar
       end
       Dir.chdir repo_root do
         @repo_config[type].each do |check|
-          SugarJar::Log.info("Running #{type} #{check}")
+          SugarJar::Log.debug("Running #{type} #{check}")
 
-          unless File.exist?(check)
+          unless File.exist?(check.split.first)
             SugarJar::Log.error("Configured #{type} #{check} does not exist!")
             return false
           end
           s = Mixlib::ShellOut.new(check).run_command
-          if s.error?
-            SugarJar::Log.info("#{type} #{check} failed\n#{s.stdout}")
-            return false
+          unless s.error?
+            SugarJar::Log.info(
+              "[#{type}] #{check}: #{color('OK', :green)}",
+            )
+            next
           end
+
+          SugarJar::Log.info(
+            "[#{type}] #{check} #{color('failed', :red)}, output follows " +
+            "(see debug for more)\n#{s.stdout}",
+          )
+          SugarJar::Log.debug(s.format_for_exception)
+          return false
         end
       end
     end
@@ -243,7 +404,7 @@ class SugarJar
       @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.")
+          SugarJar::Log.info("[prepush]: #{item} #{color('failed', :red)}.")
           return false
         end
       end
@@ -269,7 +430,6 @@ class SugarJar
       hub('checkout', 'master')
       hub('branch', '-D', name)
       gitup
-      SugarJar::Log.info("Reaped branch #{name}")
       true
     end
 
@@ -310,7 +470,7 @@ class SugarJar
       s = hub_nofail('merge', '--squash', branch)
       if s.error?
         cleanup_tmp_branch(tmpbranch, branch)
-        SugarJar::Log.error(
+        SugarJar::Log.debug(
           '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.",
@@ -353,8 +513,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
@@ -399,5 +569,20 @@ class SugarJar
       end
       @remote
     end
+
+    def color(string, *colors)
+      if @color
+        pastel.decorate(string, *colors)
+      else
+        string
+      end
+    end
+
+    def pastel
+      @pastel ||= begin
+        require 'pastel'
+        Pastel.new
+      end
+    end
   end
 end

data/lib/sugarjar/config.rb

@@ -6,14 +6,14 @@ class SugarJar
   # This is stuff like log level, github-user, etc.
   class Config
     DEFAULTS = {
-      'ghuser' => ENV['USER'],
+      'github_user' => ENV['USER'],
       'fallthru' => true,
     }.freeze
 
     def self._find_ordered_files
       [
         '/etc/sugarjar/config.yaml',
-        "#{ENV['HOME']}/.config/sugarjar/config.yaml"
+        "#{ENV['HOME']}/.config/sugarjar/config.yaml",
       ].select { |f| File.exist?(f) }
     end
 

data/lib/sugarjar/util.rb

@@ -27,8 +27,54 @@ class SugarJar
     end
 
     def hub_nofail(*args)
+      if %w{diff log grep branch}.include?(args[0]) &&
+         args.none? { |x| x.include?('color') }
+        args << (@color ? '--color' : '--no-color')
+      end
       SugarJar::Log.trace("Running: hub #{args.join(' ')}")
-      Mixlib::ShellOut.new([which('hub')] + args).run_command
+      s = Mixlib::ShellOut.new([which('hub')] + args).run_command
+      if s.error?
+        # depending on hub version and possibly other things, STDERR
+        # is either "Requires authentication" or "Must authenticate"
+        case s.stderr
+        when /^(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
+        when /^fatal: could not read Username/
+          # On http(s) URLs, git may prompt for username/passwd
+          SugarJar::Log.info(
+            'Hub was run but git prompted for authentication. This probably ' +
+            "means you have\nused an http repo URL instead of an ssh one. It " +
+            "is recommended you reclone\nusing 'sj sclone' to setup your " +
+            "remotes properly. However, in the meantime,\nwe'll go ahead " +
+            "and re-run the command in a shell so you can type in the\n" +
+            'credentials.',
+          )
+          unless system(which('hub'), *args)
+            SugarJar::Log.fatal(
+              'That failed, I will bail out. You can either manually change ' +
+              'your remotes, or simply create a fresh clone with ' +
+              '"sj smartclone".',
+            )
+            exit(1)
+          end
+          SugarJar::Log.info('Re-running original hub command...')
+          s = Mixlib::ShellOut.new([which('hub')] + args).run_command
+        end
+      end
+      s
     end
 
     def hub(*args)

data/lib/sugarjar/version.rb

@@ -1,3 +1,3 @@
 class SugarJar
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.8'.freeze
 end

data/sugarjar.gemspec

@@ -0,0 +1,23 @@
+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'
+  spec.required_ruby_version = '>= 2.6.0'
+  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'
+  spec.add_dependency 'pastel'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -39,41 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pastel
   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
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -83,20 +55,26 @@ dependencies:
 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
@@ -109,15 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A git/github helper script