sugarjar 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b12b221b467eca9aeba30396d059870a82608120ce1739ded50b4aef55ce7ba
-  data.tar.gz: c84bcab24de60fc61a0241f7c2940d6da6d78bc7416fa3fb92500528a447f9c8
+  metadata.gz: 7f4c70f80f34b048ba0d6b526e5eb20fcc51164b8ef78412a38ad5c953296898
+  data.tar.gz: 53958fab72a6c93d35617b63ffdb178cddcf1f97837a321533836896b0336c8b
 SHA512:
-  metadata.gz: e041cd65eb939ea1d2153bf13a8a019e05f194fcf6ce4326c69d62a2de9e34e1d036cf759c5ea17b5b42d8e7e159fc99d65ee75470580a4ed15a854fffc7c87f
-  data.tar.gz: 2c47c2920b6a774ffb83ef16761183ac7dbfcc808a6885335bbeeee5470a29ceff343df4e3748897ab4e8e681e7c7d8b9a5fc3c7ed4d44fafaa40dda6c08b300
+  metadata.gz: 5b3c546fe02babc8b186cf4f5de2d6a2716e371228af676dd5550d56b1f17db9d310d135f47a1905e77a98ed32ebd6716292bc19059a1e6e9e4733f725422900
+  data.tar.gz: 37df61e3b4161c2737dcf6392b5db3dcb8feef5d402868b48d6f28db9cb2254ddaf9b39d2719ea88071c4f37feb32efd9d327c105c3dcde428f495957e85913e

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2020-present Phil Dibowitz
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -3,10 +3,11 @@
 [![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.
+Welcome to SugarJar - a git/github helper. It needs one of the GitHub CLI's:
+the current default is [hub](https://hub.github.com/), but there is
+experimental support for [gh](https://cli.github.com/). So you will need one of
+those two installed.
 
 SugarJar is inspired by [arcanist](https://github.com/phacility/arcanist), and
 its replacement at Facebook, JellyFish. Many of the features they provide for
@@ -19,6 +20,24 @@ 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!
 
+## Installation
+
+Sugarjar is packaged in a variety of Linux distributions - see if it's on the
+list here, and if so, use your package manager (or `gem`) to install it:
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/sugarjar.svg)](https://repology.org/project/sugarjar/versions)
+
+Another option is to use our [omnibus
+packages](https://github.com/jaymzh/sugarjar/releases). We keep Omnibus
+packages for most distros that do not package Sugarjar. Omnibus packages are
+distro packages (deb, rpm, etc.) that have all dependencies bundled up together
+(including Ruby), and install in `/opt/sugarjar` allowing you to manage the
+installation with your package manager, but with as a hermetically sealed app
+that doesn't depend on the rest of your distro.
+
+Finally, if none of those work for you, you can clone this repo and run it
+directly from there.
+
 ## Auto cleanup squash-merged branches
 
 It is common for a PR to go back and forth with a variety of nits, lint fixes,
@@ -73,7 +92,7 @@ This will:
 * Clone your fork
 * Add the original as an 'upstream' remote
 
-Note that it takes `hub`s short-names for repos. No need to specify a full URL,
+Note that it takes short names for repos. No need to specify a full URL,
 just a $org/$repo.
 
 Like `git clone`, `sj sclone` will accept an additional argument as the
@@ -198,6 +217,15 @@ smartlog` or `sj sl` for short.
 
 ![smartlog screenshot](https://github.com/jaymzh/sugarjar/blob/master/smartlog.png)
 
+## Pulling in suggestions from the web
+
+When someone 'suggests' a change in the GitHub WebUI, once you choose to commit
+them, your origin and local branches are no longer in-sync. The
+`pullsuggestions` command will attempt to merge in any remote commits to your
+local branch. This command will show a diff and ask for confirmation before
+attempting the merge and  - if allowed to continue - will use a fast-forward
+merge.
+
 ## And more!
 
 See `sj help` for more commands!
@@ -205,8 +233,11 @@ 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.
+(which passes commands **it** doesn't know to `git`). If you have configured
+SugarJar to use `gh` instead of `hub`, then it will pass commands straight to
+`git` since `gh` doesn't act as a `git` wrapper.
+
+As such you can alias it to `git` and just have a super-git.
 
 ```shell
 $ alias git=sj
@@ -244,8 +275,8 @@ yaml file is a straight key-value pair of options without their '--'. For
 example:
 
 ```yaml
-debug: true
-github-user: jaymzh
+log_level: debug
+github_user: jaymzh
 ```
 
 In addition, the environment variable `SUGARJAR_DEBUG` can be defined to set
@@ -258,9 +289,15 @@ Sugarjar looks for a `.sugarjar.yaml` in the root of the repository to tell it
 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
-  rubocop or pyflake.
+  rubocop or pyflake. Linters will be run from the root of the repo.
+* `lint_list_cmd` - A command to run which will print out linters to run, one
+  per line. Takes precedence over `lint`. The command (and the resulting
+  linters) will be run from the root of the repo.
 * `unit` - A list of scripts to run on `sj unit`. These should be unittest
-  runners like rspec or pyunit.
+  runners like rspec or pyunit. Test will be run fro mthe root of the repo.
+* `unit_list_cmd` - A command to run which will print out the unit tests to
+  run, one more line. Takes precedence over `unit`. The command (and the
+  resulting unit tests) will be run from the root of the repo.
 * `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
@@ -312,6 +349,16 @@ 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..
 
+## Support for `gh`
+
+As of version 0.11 there is experimental support for the `gh` CLI (instead of
+`hub`). If you would like to use `gh`, install it and then add the following
+to your configuration:
+
+```yaml
+github_cli: gh
+```
+
 ## FAQ
 
 Why the name SugarJar?
@@ -324,6 +371,19 @@ and github, it seemed appropriate.
 
 Why did you use `hub` instead of the newer `gh` CLI?
 
-`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.
+When I originally wrote SugarJar, `gh` was in early development, and `hub` had
+many more features. Now that `gh` has matured, we have experimental support for
+`gh` and will switch it to the default at some point.
+
+In addition, 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.
+
+I'd like to package SugarJar for my favorite distro/OS, is that OK?
+
+Of course! But I'd appreciate you emailing me to give me a heads up. Doing so
+will allow me to make sure it shows up in the Repology badge above as well as
+stop building Omnibus packages for whatever distro.
+
+Does it work on Windows/Mac?
+
+It should! Though I will admit I don't regularly test on non-Linux OSes.

data/bin/sj

@@ -33,8 +33,13 @@ parser = OptionParser.new do |opts|
     options['fallthru'] = fallthru
   end
 
-  opts.on('--github-user USER', 'Github username') do |user|
-    options['github_user'] = user
+  opts.on(
+    '--github-cli CLI',
+    %w{gh cli},
+    'Github CLI to use ("gh" or "hub"). Note that support for "gh" is ' +
+    'currently experimental. default: "hub"',
+  ) do |cli|
+    options['github_cli'] = cli
   end
 
   opts.on(
@@ -48,6 +53,10 @@ parser = OptionParser.new do |opts|
     options['github_host'] = host
   end
 
+  opts.on('--github-user USER', 'Github username') do |user|
+    options['github_user'] = user
+  end
+
   opts.on('-h', '--help', 'Print this help message') do
     puts opts
     exit
@@ -128,6 +137,11 @@ COMMANDS:
   lint
               Run any linters configured in .sugarjar.yaml.
 
+  pullsuggestions, ps
+              Pull any suggestions *that have been committed* in the GitHub UI.
+              This will show the diff and prompt for confirmation before
+              merging. Note that a fast-forward merge will be used.
+
   smartclone, sclone
               A smart wrapper to "git clone" that handles forking and managing
               remotes for you.
@@ -182,19 +196,23 @@ extra_opts = []
 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) }
+possible_valid_command = ARGV.any? do |arg|
+  valid_commands.include?(arg.to_s.to_sym)
+end
 
 # 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
+if config['fallthru'] && !possible_valid_command
   SugarJar::Log.debug(
     'Skipping option parsing: fall-thru is set and we do not recognize ' +
     'any subcommands',
   )
 else
+  SugarJar::Log.debug(
+    'We MIGHT have a valid command... parse-command line options',
+  )
   # 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.
@@ -240,6 +258,7 @@ 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
+is_valid_command = valid_commands.include?(subcommand.to_sym)
 argv_copy.delete(subcommand)
 SugarJar::Log.debug("subcommand is #{subcommand}")
 
@@ -260,7 +279,13 @@ if is_valid_command
   sj.send(subcommand.to_sym, *extra_opts)
 elsif options['fallthru']
   SugarJar::Log.debug("Falling thru to: hub #{ARGV.join(' ')}")
-  exec('hub', *ARGV)
+  if options['github_cli'] == 'hub'
+    exec('hub', *ARGV)
+  else
+    # If we're using 'gh', it doesn't have 'git fall thru' support, so
+    # we pass thru directly to 'git'
+    exec('git', *ARGV)
+  end
 else
   SugarJar::Log.error("No such subcommand: #{subcommand}")
 end

data/lib/sugarjar/commands.rb

@@ -12,28 +12,34 @@ class SugarJar
   class Commands
     include SugarJar::Util
 
+    MAIN_BRANCHES = %w{master main}.freeze
+
     def initialize(options)
       SugarJar::Log.debug("Commands.initialize options: #{options}")
       @ghuser = options['github_user']
       @ghhost = options['github_host']
+      @cli = options['github_cli']
       @ignore_dirty = options['ignore_dirty']
       @ignore_prerun_failure = options['ignore_prerun_failure']
       @repo_config = SugarJar::RepoConfig.config
       @color = options['color']
+      @checks = {}
+      @main_branch = nil
+      @main_remote_branches = {}
       return if options['no_change']
 
-      set_hub_host if @ghhost
+      set_hub_host
       set_commit_template if @repo_config['commit_template']
     end
 
     def feature(name, base = nil)
       assert_in_repo
       SugarJar::Log.debug("Feature: #{name}, #{base}")
-      die("#{name} already exists!") if all_branches.include?(name)
-      base ||= most_master
+      die("#{name} already exists!") if all_local_branches.include?(name)
+      base ||= most_main
       base_pieces = base.split('/')
-      hub('fetch', base_pieces[0]) if base_pieces.length > 1
-      hub('checkout', '-b', name, base)
+      git('fetch', base_pieces[0]) if base_pieces.length > 1
+      git('checkout', '-b', name, base)
       SugarJar::Log.info(
         "Created feature branch #{color(name, :green)} based on " +
         color(base, :green),
@@ -56,9 +62,9 @@ class SugarJar
     def bcleanall
       assert_in_repo
       curr = current_branch
-      all_branches.each do |branch|
-        if branch == 'master'
-          SugarJar::Log.debug('Skipping master')
+      all_local_branches.each do |branch|
+        if MAIN_BRANCHES.include?(branch)
+          SugarJar::Log.debug("Skipping #{branch}")
           next
         end
 
@@ -73,28 +79,28 @@ class SugarJar
         end
       end
 
-      # Return to the branch we were on, or master
-      if all_branches.include?(curr)
-        hub('checkout', curr)
+      # Return to the branch we were on, or main
+      if all_local_branches.include?(curr)
+        git('checkout', curr)
       else
-        hub('checkout', 'master')
+        checkout_main_branch
       end
     end
 
     def co(*args)
       assert_in_repo
-      s = hub('checkout', *args)
+      s = git('checkout', *args)
       SugarJar::Log.info(s.stderr + s.stdout.chomp)
     end
 
     def br
       assert_in_repo
-      SugarJar::Log.info(hub('branch', '-v').stdout.chomp)
+      SugarJar::Log.info(git('branch', '-v').stdout.chomp)
     end
 
     def binfo
       assert_in_repo
-      SugarJar::Log.info(hub(
+      SugarJar::Log.info(git(
         'log', '--graph', '--oneline', '--decorate', '--boundary',
         "#{tracked_branch}.."
       ).stdout.chomp)
@@ -103,9 +109,9 @@ class SugarJar
     # binfo for all branches
     def smartlog
       assert_in_repo
-      SugarJar::Log.info(hub(
+      SugarJar::Log.info(git(
         'log', '--graph', '--oneline', '--decorate', '--boundary',
-        '--branches', "#{most_master}.."
+        '--branches', "#{most_main}.."
       ).stdout.chomp)
     end
 
@@ -113,13 +119,22 @@ class SugarJar
 
     def up
       assert_in_repo
+      # get a copy of our current branch, if rebase fails, we won't
+      # be able to determine it without backing out
+      curr = current_branch
       result = gitup
-      if result
-        SugarJar::Log.info(
-          "#{color(current_branch, :green)} rebased on #{result}",
+      if result['so'].error?
+        die(
+          "#{color(curr, :red)}: Failed to rebase on " +
+          "#{result['base']}. Leaving the repo as-is. You can get out of " +
+          'this with a `git rebase --abort`. Output from failed rebase is: ' +
+          "\nSTDOUT:\n#{result['so'].stdout.lines.map { |x| "\t#{x}" }.join}" +
+          "\nSTDERR:\n#{result['so'].stderr.lines.map { |x| "\t#{x}" }.join}",
         )
       else
-        die("#{color(current_branch, :red)}: Failed to rebase")
+        SugarJar::Log.info(
+          "#{color(current_branch, :green)} rebased on #{result['base']}",
+        )
       end
     end
 
@@ -131,28 +146,29 @@ class SugarJar
 
     def qamend(*args)
       assert_in_repo
-      SugarJar::Log.info(hub('commit', '--amend', '--no-edit', *args).stdout)
+      SugarJar::Log.info(git('commit', '--amend', '--no-edit', *args).stdout)
     end
 
     alias amendq qamend
 
     def upall
       assert_in_repo
-      all_branches.each do |branch|
-        next if branch == 'master'
+      all_local_branches.each do |branch|
+        next if MAIN_BRANCHES.include?(branch)
 
-        hub('checkout', branch)
+        git('checkout', branch)
         result = gitup
-        if result
-          SugarJar::Log.info(
-            "#{color(branch, :green)} rebased on #{color(result, :green)}",
-          )
-        else
+        if result['so'].error?
           SugarJar::Log.error(
             "#{color(branch, :red)} failed rebase. Reverting attempt and " +
-            'moving to next branch',
+            'moving to next branch. Try `sj up` manually on that branch.',
+          )
+          git('rebase', '--abort')
+        else
+          SugarJar::Log.info(
+            "#{color(branch, :green)} rebased on " +
+            color(result['base'], :green).to_s,
           )
-          hub('rebase', '--abort')
         end
       end
     end
@@ -164,28 +180,57 @@ class SugarJar
 
       reponame = File.basename(repo, '.git')
       dir ||= reponame
+
       SugarJar::Log.info("Cloning #{reponame}...")
-      hub('clone', canonicalize_repo(repo), dir, *args)
 
+      # GH's 'fork' command (with the --clone arg) will fork, if necessary,
+      # then clone, and then setup the remotes with the appropriate names. So
+      # we just let it do all the work for us and return.
+      if gh?
+        ghcli('repo', 'fork', '--clone', canonicalize_repo(repo), dir, *args)
+        SugarJar::Log.info('Remotes "origin" and "upstream" configured.')
+        return
+      end
+
+      # For 'hub', first we clone, using git, as 'hub' always needs a repo
+      # to operate on.
+      git('clone', canonicalize_repo(repo), dir, *args)
+
+      # Then we go into it and attempt to use the 'fork' capability
       Dir.chdir dir do
         # Now that we have a repo, if we have a hub host set it.
-        set_hub_host if @ghhost
+        set_hub_host
 
         org = extract_org(repo)
         SugarJar::Log.debug("Comparing org #{org} to ghuser #{@ghuser}")
         if org == @ghuser
           puts 'Cloned forked or self-owned repo. Not creating "upstream".'
+          SugarJar::Log.info('Remotes "origin" and "upstream" configured.')
           return
         end
 
-        s = hub_nofail('fork', '--remote-name=origin')
+        s = ghcli_nofail('repo', 'fork', '--remote-name=origin')
         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', forked_repo(repo, @ghuser))
+          if s.stdout.include?('SAML enforcement')
+            SugarJar::Log.info(
+              'Forking the repo failed because the repo requires SAML ' +
+              "authentication. Full output:\n\n\t#{s.stdout}",
+            )
+            exit(1)
+          else
+            # gh as well as old versions of hub, it would fail if the upstream
+            # fork already existed. If we got an error, but didn't recognize
+            # that, we'll assume that's what happened and try to add the remote
+            # ourselves.
+            SugarJar::Log.info("Fork (#{@ghuser}/#{reponame}) detected.")
+            SugarJar::Log.debug(
+              'The above is a bit of a lie. "hub" failed to fork and it was ' +
+              'not a SAML error, so our best guess is that a fork exists ' +
+              'and so we will try to configure it.',
+            )
+            git('remote', 'rename', 'origin', 'upstream')
+            git('remote', 'add', 'origin', forked_repo(repo, @ghuser))
+          end
         else
           SugarJar::Log.info("Forked #{reponame} to #{@ghuser}")
         end
@@ -221,11 +266,15 @@ class SugarJar
 
     def version
       puts "sugarjar version #{SugarJar::VERSION}"
-      puts hub('version').stdout
+      puts ghcli('version').stdout
+      # 'hub' prints the 'git' version, but gh doesn't, so if we're on 'gh'
+      # print out the git version directly
+      puts git('version').stdout if gh?
     end
 
-    def smartpullrequest
+    def smartpullrequest(*args)
       assert_in_repo
+      assert_common_main_branch
       if dirty?
         SugarJar::Log.warn(
           'Your repo is dirty, so I am not going to create a pull request. ' +
@@ -233,12 +282,61 @@ class SugarJar
         )
         exit(1)
       end
-      system(which('hub'), 'pull-request')
+      if gh?
+        SugarJar::Log.trace("Running: gh pr create #{args.join(' ')}")
+        system(which('gh'), 'pr', 'create', *args)
+      else
+        SugarJar::Log.trace("Running: hub pull-request #{args.join(' ')}")
+        system(which('hub'), 'pull-request', *args)
+      end
     end
 
     alias spr smartpullrequest
     alias smartpr smartpullrequest
 
+    def pullsuggestions
+      assert_in_repo
+
+      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
+
+      src = "origin/#{current_branch}"
+      fetch('origin')
+      diff = git('diff', src).stdout
+      return unless diff && !diff.empty?
+
+      puts "Will merge the following suggestions:\n\n#{diff}"
+
+      loop do
+        $stdout.print("\nAre you sure? [y/n] ")
+        ans = $stdin.gets.strip
+        case ans
+        when /^[Yy]$/
+          system(which('git'), 'merge', '--ff', "origin/#{current_branch}")
+          break
+        when /^[Nn]$/, /^[Qq](uit)?/
+          puts 'Not merging at user request...'
+          break
+        else
+          puts "Didn't understand '#{ans}'."
+        end
+      end
+    end
+
+    alias ps pullsuggestions
+
     private
 
     def _smartpush(remote, branch, force)
@@ -276,11 +374,11 @@ class SugarJar
 
       args = ['push', remote, branch]
       args << '--force-with-lease' if force
-      puts hub(*args).stderr
+      puts git(*args).stderr
     end
 
     def dirty?
-      s = hub_nofail('diff', '--quiet')
+      s = git_nofail('diff', '--quiet')
       s.error?
     end
 
@@ -317,9 +415,9 @@ class SugarJar
     end
 
     def set_hub_host
-      return unless in_repo
+      return unless hub? && in_repo && @ghhost
 
-      s = hub_nofail('config', '--local', '--get', 'hub.host')
+      s = git_nofail('config', '--local', '--get', 'hub.host')
       if s.error?
         SugarJar::Log.info("Setting repo hub.host = #{@ghhost}")
       else
@@ -337,7 +435,7 @@ class SugarJar
         end
         return
       end
-      hub('config', '--local', '--add', 'hub.host', @ghhost)
+      git('config', '--local', '--add', 'hub.host', @ghhost)
     end
 
     def set_commit_template
@@ -358,7 +456,7 @@ class SugarJar
         )
       end
 
-      s = hub_nofail('config', '--local', 'commit.template')
+      s = git_nofail('config', '--local', 'commit.template')
       unless s.error?
         current = s.stdout.strip
         if current == @repo_config['commit_template']
@@ -376,18 +474,60 @@ class SugarJar
         'Setting repo-specific commit template to ' +
         "#{@repo_config['commit_template']} per sugarjar repo config.",
       )
-      hub(
+      git(
         '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")
-        return true
+    def get_checks_from_command(type)
+      return nil unless @repo_config["#{type}_list_cmd"]
+
+      cmd = @repo_config["#{type}_list_cmd"]
+      short = cmd.split.first
+      unless File.exist?(short)
+        SugarJar::Log.error(
+          "Configured #{type}_list_cmd #{short} does not exist!",
+        )
+        return false
+      end
+      s = Mixlib::ShellOut.new(cmd).run_command
+      if s.error?
+        SugarJar::Log.error(
+          "#{type}_list_cmd (#{cmd}) failed: #{s.format_for_exception}",
+        )
+        return false
+      end
+      s.stdout.split("\n")
+    end
+
+    # determine if we're using the _list_cmd and if so run it to get the
+    # checks, or just use the directly-defined check, and cache it
+    def get_checks(type)
+      return @checks[type] if @checks[type]
+
+      ret = get_checks_from_command(type)
+      if ret
+        SugarJar::Log.debug("Found #{type}s: #{ret}")
+        @checks[type] = ret
+      # if it's explicitly false, we failed to run the command
+      elsif ret == false
+        @checks[type] = false
+      # otherwise, we move on (basically: it's nil, there was no _list_cmd)
+      else
+        SugarJar::Log.debug("[#{type}]: using listed linters: #{ret}")
+        @checks[type] = @repo_config[type] || []
       end
+      @checks[type]
+    end
+
+    def run_check(type)
       Dir.chdir repo_root do
-        @repo_config[type].each do |check|
+        checks = get_checks(type)
+        # if we failed to determine the checks, the the checks have effectively
+        # failed
+        return false unless checks
+
+        checks.each do |check|
           SugarJar::Log.debug("Running #{type} #{check}")
 
           short = check.split.first
@@ -405,7 +545,7 @@ class SugarJar
             SugarJar::Log.warn(
               "The linter modified the repo. Here's the diff:\n",
             )
-            puts hub('diff').stdout
+            puts git('diff').stdout
             loop do
               $stdout.print(
                 "\nWould you like to\n\t[q]uit and inspect\n\t[a]mend the " +
@@ -457,29 +597,82 @@ class SugarJar
       exit(1)
     end
 
+    def assert_common_main_branch
+      upstream_branch = main_remote_branch(upstream)
+      unless main_branch == upstream_branch
+        die(
+          "The local main branch is '#{main_branch}', but the main branch " +
+          "of the #{upstream} remote is '#{upstream_branch}'. You probably " +
+          "want to rename your local branch by doing:\n\t" +
+          "git branch -m #{main_branch} #{upstream_branch}\n\t" +
+          "git fetch #{upstream}\n\t" +
+          "git branch -u #{upstream}/#{upstream_branch} #{upstream_branch}\n" +
+          "\tgit remote set-head #{upstream} -a",
+        )
+      end
+      return if upstream_branch == 'origin'
+
+      origin_branch = main_remote_branch('origin')
+      return if origin_branch == upstream_branch
+
+      die(
+        "The main branch of your upstream (#{upstream_branch}) and your " +
+        "fork/origin (#{origin_branch}) are not the same. You should go " +
+        "to https://#{@ghhost || 'github.com'}/#{@ghuser}/#{repo_name}/" +
+        'branches/ and rename the \'default\' branch to ' +
+        "'#{upstream_branch}'. It will then give you some commands to " +
+        'run to update this clone.',
+      )
+    end
+
     def assert_in_repo
       die('sugarjar must be run from inside a git repo') unless in_repo
     end
 
+    def determine_main_branch(branches)
+      branches.include?('main') ? 'main' : 'master'
+    end
+
+    def main_branch
+      @main_branch = determine_main_branch(all_local_branches)
+    end
+
+    def main_remote_branch(remote)
+      @main_remote_branches[remote] ||=
+        determine_main_branch(all_remote_branches(remote))
+    end
+
+    def checkout_main_branch
+      git('checkout', main_branch)
+    end
+
     def clean_branch(name)
-      die('Cannot remove master branch') if name == 'master'
+      die("Cannot remove #{name} branch") if MAIN_BRANCHES.include?(name)
       SugarJar::Log.debug('Fetch relevant remote...')
       fetch_upstream
       return false unless safe_to_clean(name)
 
       SugarJar::Log.debug('branch deemed safe to delete...')
-      hub('checkout', 'master')
-      hub('branch', '-D', name)
+      checkout_main_branch
+      git('branch', '-D', name)
       gitup
       true
     end
 
-    def all_branches
+    def all_remote_branches(remote = 'origin')
       branches = []
-      hub('branch', '--format', '%(refname)').stdout.lines.each do |line|
-        next if line == 'master'
+      git('branch', '-r', '--format', '%(refname)').stdout.lines.each do |line|
+        next unless line.start_with?("refs/remotes/#{remote}/")
+
+        branches << branch_from_ref(line.strip, :remote)
+      end
+      branches
+    end
 
-        branches << line.strip.split('/')[2]
+    def all_local_branches
+      branches = []
+      git('branch', '--format', '%(refname)').stdout.lines.each do |line|
+        branches << branch_from_ref(line.strip)
       end
       branches
     end
@@ -488,7 +681,7 @@ class SugarJar
       # cherry -v will output 1 line per commit on the target branch
       # prefixed by a - or + - anything with a - can be dropped, anything
       # else cannot.
-      out = hub(
+      out = git(
         'cherry', '-v', tracked_branch, branch
       ).stdout.lines.reject do |line|
         line.start_with?('-')
@@ -502,24 +695,24 @@ class SugarJar
 
       # if the "easy" check didn't work, it's probably because there
       # was a squash-merge. To check for that we make our own squash
-      # merge to upstream/master and see if that has any delta
+      # merge to upstream/main and see if that has any delta
 
       # First we need a temp branch to work on
       tmpbranch = "_sugar_jar.#{Process.pid}"
 
-      hub('checkout', '-b', tmpbranch, tracked_branch)
-      s = hub_nofail('merge', '--squash', branch)
+      git('checkout', '-b', tmpbranch, tracked_branch)
+      s = git_nofail('merge', '--squash', branch)
       if s.error?
         cleanup_tmp_branch(tmpbranch, branch)
         SugarJar::Log.debug(
-          'Failed to merge changes into current master. This means we could ' +
+          'Failed to merge changes into current main. 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.",
         )
         return false
       end
 
-      s = hub('diff', '--staged')
+      s = git('diff', '--staged')
       out = s.stdout
       SugarJar::Log.debug("Squash-merged diff: #{out}")
       cleanup_tmp_branch(tmpbranch, branch)
@@ -530,34 +723,37 @@ class SugarJar
         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 main',
         )
         false
       end
     end
 
     def cleanup_tmp_branch(tmp, backto)
-      hub('reset', '--hard', tracked_branch)
-      hub('checkout', backto)
-      hub('branch', '-D', tmp)
+      git('reset', '--hard', tracked_branch)
+      git('checkout', backto)
+      git('branch', '-D', tmp)
     end
 
     def current_branch
-      hub('symbolic-ref', 'HEAD').stdout.strip.split('/')[2]
+      branch_from_ref(git('symbolic-ref', 'HEAD').stdout.strip)
     end
 
     def fetch_upstream
       us = upstream
-      hub('fetch', us) if us
+      fetch(us) if us
+    end
+
+    def fetch(remote)
+      git('fetch', remote)
     end
 
     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}"
+      if !MAIN_BRANCHES.include?(curr) && 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 ' +
@@ -566,34 +762,38 @@ class SugarJar
           'to do a "git branch -u upstream".',
         )
       end
-      s = hub_nofail('rebase', base)
-      s.error? ? nil : base
+      SugarJar::Log.debug('Rebasing')
+      s = git_nofail('rebase', base)
+      {
+        'so' => s,
+        'base' => base,
+      }
     end
 
     def tracked_branch
-      s = hub_nofail(
+      s = git_nofail(
         'rev-parse', '--abbrev-ref', '--symbolic-full-name', '@{u}'
       )
       if s.error?
-        most_master
+        most_main
       else
         s.stdout.strip
       end
     end
 
-    def most_master
+    def most_main
       us = upstream
       if us
-        "#{us}/master"
+        "#{us}/#{main_branch}"
       else
-        master
+        main_branch
       end
     end
 
     def upstream
       return @remote if @remote
 
-      s = hub('remote')
+      s = git('remote')
 
       remotes = s.stdout.lines.map(&:strip)
       SugarJar::Log.debug("remotes is #{remotes}")
@@ -611,6 +811,13 @@ class SugarJar
       @remote
     end
 
+    def branch_from_ref(ref, type = :local)
+      # local branches are refs/head/XXXX
+      # remote branches are refs/remotes/<remote>/XXXX
+      base = type == :local ? 2 : 3
+      ref.split('/')[base..].join('/')
+    end
+
     def color(string, *colors)
       if @color
         pastel.decorate(string, *colors)
@@ -625,5 +832,21 @@ class SugarJar
         Pastel.new
       end
     end
+
+    def hub?
+      @cli == 'hub'
+    end
+
+    def gh?
+      @cli == 'gh'
+    end
+
+    def ghcli_nofail(*args)
+      gh? ? gh_nofail(*args) : hub_nofail(*args)
+    end
+
+    def ghcli(*args)
+      gh? ? gh(*args) : hub(*args)
+    end
   end
 end

data/lib/sugarjar/config.rb

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

data/lib/sugarjar/util.rb

@@ -26,11 +26,25 @@ class SugarJar
       exit(1)
     end
 
-    def hub_nofail(*args)
+    def git_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: git #{args.join(' ')}")
+      Mixlib::ShellOut.new([which('git')] + args).run_command
+    end
+
+    def git(*args)
+      s = git_nofail(*args)
+      s.error!
+      s
+    end
+
+    def hub_nofail(*args)
+      # this allows us to use 'hub' stuff that's top-level, but is under
+      # repo for this.
+      args.delete_at(0) if args[0] == 'repo'
       SugarJar::Log.trace("Running: hub #{args.join(' ')}")
       s = Mixlib::ShellOut.new([which('hub')] + args).run_command
       if s.error?
@@ -84,13 +98,43 @@ class SugarJar
       s
     end
 
+    def gh_nofail(*args)
+      SugarJar::Log.trace("Running: gh #{args.join(' ')}")
+      s = Mixlib::ShellOut.new([which('gh')] + args).run_command
+      if s.error? && s.stderr.include?('gh auth')
+        SugarJar::Log.info(
+          'gh was run but no github token exists. Will run "gh auth login" ' +
+          "to force\ngh to authenticate...",
+        )
+        unless system(which('gh'), 'auth', 'login', '-p', 'ssh')
+          SugarJar::Log.fatal(
+            'That failed, I will bail out. Hub needs to get a github ' +
+            'token. Try running "gh auth login" (will list info about ' +
+            'your account) and try this again when that works.',
+          )
+          exit(1)
+        end
+      end
+      s
+    end
+
+    def gh(*args)
+      s = gh_nofail(*args)
+      s.error!
+      s
+    end
+
     def in_repo
-      s = hub_nofail('rev-parse', '--is-inside-work-tree')
+      s = git_nofail('rev-parse', '--is-inside-work-tree')
       !s.error? && s.stdout.strip == 'true'
     end
 
     def repo_root
-      hub('rev-parse', '--show-toplevel').stdout.strip
+      git('rev-parse', '--show-toplevel').stdout.strip
+    end
+
+    def repo_name
+      repo_root.split('/').last
     end
   end
 end

data/lib/sugarjar/version.rb

@@ -1,3 +1,3 @@
 class SugarJar
-  VERSION = '0.0.9'.freeze
+  VERSION = '0.0.11'.freeze
 end

data/sugarjar.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mixlib-log'
   spec.add_dependency 'mixlib-shellout'
   spec.add_dependency 'pastel'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Phil Dibowitz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-21 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - phil@ipom.com
 executables:
@@ -78,8 +78,9 @@ files:
 homepage: https://github.com/jaymzh/sugarjar
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A git/github helper script
 test_files: []