sugarjar 0.0.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1c65749738fac53cfb69c3ec42007433f7598e3e43dd36e33217c8c0efbbb2e
-  data.tar.gz: 50288abc1d21962e793731a937a8dd886bd2674db269ed62fbb0f89bb4121850
+  metadata.gz: 95e4979017c0ed58f99c446d9215a6b64aec7d5ebc22694a95903710d5af9d7e
+  data.tar.gz: b4b7a648bc7e8002e46dfbaa73cc52749cd38258b5782a2b33a6d66db98facfc
 SHA512:
-  metadata.gz: 97ca2433bccc9e15d8c86ab141fa74e8f441f62cdb2be16e3131e2dcf71b37319ed0399990a96cb8c34ee4c55e75f1eca8a652cd5c7031f272493eec3fdb0f9a
-  data.tar.gz: 5395379c1ca16bc50c900cd75a4b72665c0079dfe48f8717d38640d4ba610cc571c5f407333e088c0c387f19dc620039e3a406f03d6d6ea4a72a7348b98e7a41
+  metadata.gz: 0e34735382f6646bf5fe1577eb6637ad7aaceaa9ccf2d2dad024d4a95f3e2a0e8ec080fe086fd5dae7354b3f15f83d26e6ae8b067a1fae9fb5b3da777f9e1f86
+  data.tar.gz: 155d1aa1c7148f2d7181678f64ef64b17fb5efc90386ce3bd27c2bcc7b256113680b4e69a16558790ab3c77080325fc36a56c9f3cc76cf4962f8f575cd00d5d7

data/README.md

@@ -3,10 +3,17 @@
 [![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.
+> [!IMPORTANT]
+> You probably want to use [Sapling](https://sapling-scm.com/)
+> instead of this! This was written as a stop-gap to approximate some features
+> of the Facebook/Meta internal development tools before they were released.
+> Now that those tools have been open-sourced and work with GitHub, this is
+> likely to be deprecated at some point. Sapling is far more feature rich,
+> faster, and have more development resources behind them.
+
+Welcome to SugarJar - a git/github helper. It needs one of the GitHub CLI's:
+either [gh](https://cli.github.com/) or the older [hub](https://hub.github.com/).
 
 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 +26,30 @@ 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)
+
+For Ubuntu users, Sugarjar will likely be available starting in the upcoming
+23.04 release. Until then, for supported LTS releases starting 20.04 (focal)
+and the latest non-LTS release, you can use [this PPA](
+https://launchpad.net/~michel-slm/+archive/ubuntu/sugarjar) maintained by the
+Debian package maintainer.
+
+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 +104,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 +229,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 +245,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
@@ -248,8 +291,8 @@ log_level: debug
 github_user: jaymzh
 ```
 
-In addition, the environment variable `SUGARJAR_DEBUG` can be defined to set
-debug on. This is primarily used as a way to turn debug on earlier in order to
+In addition, the environment variable `SUGARJAR_LOGLEVEL` can be defined to set
+a log level. This is primarily used as a way to turn debug on earlier in order to
 troubleshoot configuration parsing.
 
 ## Repository Configuration
@@ -258,9 +301,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 from the 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,34 +361,40 @@ 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..
 
-## Installing
-
-There are many ways to install SugarJar. The easiest is to use one of the
-packages we provide in the
-[releases](https://github.com/jaymzh/sugarjar/releases) section. Currently we
-provide packages for Fedora, CentOS, Debian, and Ubuntu, but if you want
-others, file an Issue. Since these packages are
-[omnibus](https://github.com/chef/omnibus) packages which means they are bundled
-with all of their dependencies. This means these packages will likely work as-is
-on later releases of these distros or any similar distros.
+## Choosing a GitHub CLI
 
-We also distribute SugarJar via [RubyGems](https://rubygems.org/gems/sugarjar/),
-so you can install it as a gem either via system ruby or via rvm/rbenv.
-
-Finally you can clone the git repo and run it from within the repo if you'd like.
+SugarJar will use `gh` if it is available or otherwise fall back to `hub`. You
+can override this by specifying `--github-cli` on the command line or setting
+`github_cli` to either `gh` or `hub` (it defaults to `auto`) in your
+configuration.
 
 ## FAQ
 
-Why the name SugarJar?
+**Why the name SugarJar?**
 
-It's mostly a backranym. Like jellyfish, I wanted two letters that were on home
+It's mostly a backronym. 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?
+**Why did you originally use `hub` instead of the newer `gh` CLI?**
+
+When I originally wrote SugarJar, `gh` was in early development, and `hub` had
+many more features. In addition, I wrote SugarJar to be a wrapper for git/hub,
+and `hub` allows this but `gh` does not.
+
+When `gh` matured, we added experimental `gh` support in 0.0.11, and switched the
+default to prefer `gh` in 1.0.0.
+
+**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.
+
+**What platforms does it work on?**
 
-`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.
+Since it's Ruby, it should work across all platforms, however, it's developed
+and primarily tested on Linux as well as regularly used on Mac. I've not tested
+it on Windows, but I'll happily accept patches for Windows compatibility.

data/bin/sj

@@ -29,12 +29,22 @@ parser = OptionParser.new do |opts|
   opts.separator ''
   opts.separator 'OPTIONS:'
 
-  opts.on('--[no-]fallthru', 'Fall-thru to git') do |fallthru|
+  opts.on('--[no-]fallthru', 'Fall-thru to git. [default: true]') do |fallthru|
     options['fallthru'] = fallthru
   end
 
-  opts.on('--github-user USER', 'Github username') do |user|
-    options['github_user'] = user
+  opts.on('--feature-prefix', 'Prefix to use for feature branches') do |prefix|
+    options['feature_prefix'] = prefix
+  end
+
+  opts.on(
+    '--github-cli CLI',
+    %w{gh cli},
+    'Github CLI to use ("gh" or "hub" or "auto"). Auto (the default) will ' +
+    'prefer "gh" if it is available but will fall back to "hub." ' +
+    '[default: "auto"]',
+  ) do |cli|
+    options['github_cli'] = cli
   end
 
   opts.on(
@@ -48,6 +58,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
@@ -55,22 +69,24 @@ parser = OptionParser.new do |opts|
 
   opts.on(
     '--ignore-dirty',
-    'Tell command that check for a dirty repo to carry on anyway.',
+    'Tell command that check for a dirty repo to carry on anyway. ' +
+    '[default: false]',
   ) do
     options['ignore_dirty'] = true
   end
 
   opts.on(
     '--ignore-prerun-failure',
-    'Ignore preprun failure on *push commands.',
+    'Ignore preprun failure on *push commands. [default: false]',
   ) do
     options['ignore_prerun_failure'] = true
   end
 
   opts.on(
     '--log-level LEVEL',
-    'Set logging level (fatal, error, warning, info, debug, trace). Default: ' +
-    'info',
+    'Set logging level (fatal, error, warning, info, debug, trace). This can ' +
+    'also be set via the SUGARJAR_LOGLEVEL environment variable. [default: ' +
+    'info]',
   ) do |level|
     options['log_level'] = level
   end
@@ -118,6 +134,12 @@ COMMANDS:
               of preference it will be upstream/master, origin/master, master,
               depending upon what remotes are available.
 
+              Note that you can specify "--feature-prefix" (or add
+              "feature_prefix" to your config) to have all features created
+              with a prefix. This is useful for branch-based workflows where
+              developers are expected to create branches names that, for
+              example, start with their username.
+
   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
@@ -128,6 +150,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.
@@ -162,6 +189,10 @@ COMMANDS:
   version
               Print the version of sugarjar, and then run 'hub version'
               to show the hub and git versions.
+
+Be sure to checkout Sapling (https://sapling-scm.com/)! This was written as
+a stop-gap to get Sapling features before it was open-sourced, and as such
+I may deprecate this in the future.
 COMMANDS
 
   # rubocop:enable Layout/HeredocIndentation
@@ -232,7 +263,9 @@ else
   end
 end
 
-if ARGV.empty?
+subcommand = argv_copy.reject { |x| x.start_with?('-') }.first
+
+if ARGV.empty? || !subcommand
   puts parser
   exit
 end
@@ -243,7 +276,6 @@ options = config.merge(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
 is_valid_command = valid_commands.include?(subcommand.to_sym)
 argv_copy.delete(subcommand)
 SugarJar::Log.debug("subcommand is #{subcommand}")
@@ -265,7 +297,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

@@ -22,20 +22,29 @@ class SugarJar
       @ignore_prerun_failure = options['ignore_prerun_failure']
       @repo_config = SugarJar::RepoConfig.config
       @color = options['color']
+      @feature_prefix = options['feature_prefix']
+      @checks = {}
+      @main_branch = nil
+      @main_remote_branches = {}
       return if options['no_change']
 
-      set_hub_host if @ghhost
+      # technically this doesn't "change" things, but we won't have this
+      # option on the no_change call
+      @cli = determine_cli(options['github_cli'])
+
+      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)
+      name = fprefix(name)
+      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),
@@ -45,6 +54,7 @@ class SugarJar
     def bclean(name = nil)
       assert_in_repo
       name ||= current_branch
+      name = fprefix(name) unless all_local_branches.include?(name)
       if clean_branch(name)
         SugarJar::Log.info("#{name}: #{color('reaped', :green)}")
       else
@@ -58,7 +68,7 @@ class SugarJar
     def bcleanall
       assert_in_repo
       curr = current_branch
-      all_branches.each do |branch|
+      all_local_branches.each do |branch|
         if MAIN_BRANCHES.include?(branch)
           SugarJar::Log.debug("Skipping #{branch}")
           next
@@ -76,8 +86,8 @@ class SugarJar
       end
 
       # Return to the branch we were on, or main
-      if all_branches.include?(curr)
-        hub('checkout', curr)
+      if all_local_branches.include?(curr)
+        git('checkout', curr)
       else
         checkout_main_branch
       end
@@ -85,18 +95,18 @@ class SugarJar
 
     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)
@@ -105,7 +115,7 @@ 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_main}.."
       ).stdout.chomp)
@@ -142,24 +152,24 @@ 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|
+      all_local_branches.each do |branch|
         next if MAIN_BRANCHES.include?(branch)
 
-        hub('checkout', branch)
+        git('checkout', branch)
         result = gitup
         if result['so'].error?
           SugarJar::Log.error(
             "#{color(branch, :red)} failed rebase. Reverting attempt and " +
             'moving to next branch. Try `sj up` manually on that branch.',
           )
-          hub('rebase', '--abort')
+          git('rebase', '--abort')
         else
           SugarJar::Log.info(
             "#{color(branch, :green)} rebased on " +
@@ -176,21 +186,42 @@ class SugarJar
 
       reponame = File.basename(repo, '.git')
       dir ||= reponame
+      org = extract_org(repo)
+
       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.
+      #
+      # Unless the repo is in our own org and cannot be forked, then it
+      # will fail.
+      if gh? && org != @ghuser
+        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.
+      #
+      # Or for 'gh' when we can't fork...
+      git('clone', canonicalize_repo(repo), dir, *args)
+
+      # Then we go into it and attempt to use the 'fork' capability
+      # or if not
       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 s.stdout.include?('SAML enforcement')
             SugarJar::Log.info(
@@ -199,18 +230,18 @@ class SugarJar
             )
             exit(1)
           else
-            # In 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.
+            # 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.',
             )
-            hub('remote', 'rename', 'origin', 'upstream')
-            hub('remote', 'add', 'origin', forked_repo(repo, @ghuser))
+            git('remote', 'rename', 'origin', 'upstream')
+            git('remote', 'add', 'origin', forked_repo(repo, @ghuser))
           end
         else
           SugarJar::Log.info("Forked #{reponame} to #{@ghuser}")
@@ -247,11 +278,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. ' +
@@ -259,14 +294,73 @@ 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 fprefix(name)
+      return name unless @feature_prefix
+
+      newname = "#{@feature_prefix}#{name}"
+      SugarJar::Log.debug(
+        "Munging feature name: #{name} -> #{newname} due to feature prefix",
+      )
+      newname
+    end
+
     def _smartpush(remote, branch, force)
       unless remote && branch
         remote ||= 'origin'
@@ -302,11 +396,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
 
@@ -343,9 +437,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
@@ -363,7 +457,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
@@ -384,7 +478,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']
@@ -402,18 +496,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
@@ -431,7 +567,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 " +
@@ -483,16 +619,53 @@ 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 = all_branches.include?('main') ? 'main' : 'master'
+      @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
-      hub('checkout', main_branch)
+      git('checkout', main_branch)
     end
 
     def clean_branch(name)
@@ -503,15 +676,25 @@ class SugarJar
 
       SugarJar::Log.debug('branch deemed safe to delete...')
       checkout_main_branch
-      hub('branch', '-D', name)
+      git('branch', '-D', name)
       gitup
       true
     end
 
-    def all_branches
+    def all_remote_branches(remote = 'origin')
+      branches = []
+      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
+
+    def all_local_branches
       branches = []
-      hub('branch', '--format', '%(refname)').stdout.lines.each do |line|
-        branches << line.strip.split('/')[2]
+      git('branch', '--format', '%(refname)').stdout.lines.each do |line|
+        branches << branch_from_ref(line.strip)
       end
       branches
     end
@@ -520,12 +703,12 @@ 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?('-')
       end
-      if out.length.zero?
+      if out.empty?
         SugarJar::Log.debug(
           "cherry-pick shows branch #{branch} obviously safe to delete",
         )
@@ -539,8 +722,8 @@ class SugarJar
       # 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(
@@ -551,7 +734,7 @@ class SugarJar
         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)
@@ -569,18 +752,22 @@ class SugarJar
     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
@@ -598,7 +785,7 @@ class SugarJar
         )
       end
       SugarJar::Log.debug('Rebasing')
-      s = hub_nofail('rebase', base)
+      s = git_nofail('rebase', base)
       {
         'so' => s,
         'base' => base,
@@ -606,7 +793,7 @@ class SugarJar
     end
 
     def tracked_branch
-      s = hub_nofail(
+      s = git_nofail(
         'rev-parse', '--abbrev-ref', '--symbolic-full-name', '@{u}'
       )
       if s.error?
@@ -628,7 +815,7 @@ class SugarJar
     def upstream
       return @remote if @remote
 
-      s = hub('remote')
+      s = git('remote')
 
       remotes = s.stdout.lines.map(&:strip)
       SugarJar::Log.debug("remotes is #{remotes}")
@@ -646,6 +833,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)
@@ -660,5 +854,44 @@ class SugarJar
         Pastel.new
       end
     end
+
+    def determine_cli(cli)
+      return cli if %w{gh hub}.include?(cli)
+
+      die("'github_cli' has unknown setting: #{cli}") unless cli == 'auto'
+
+      SugarJar::Log.debug('github_cli set to auto')
+
+      if which_nofail('gh')
+        SugarJar::Log.debug('Found "gh"')
+        return 'gh'
+      end
+      if which_nofail('hub')
+        SugarJar::Log.debug('Did not find "gh" but did find "hub"')
+        return 'hub'
+      end
+
+      die(
+        'Neither "gh" nor "hub" found in PATH, please ensure at least one ' +
+        'of these utilities is in the PATH. If both are available you can ' +
+        'specify which to use with --github-cli',
+      )
+    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' => 'auto',
+      '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.10'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 1.0.0
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A git/github helper script