sugarjar 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 017705b23c86a5a5c6f1695c5e7dabca591409d2f99039c592d9db14822d7cd2
-  data.tar.gz: e41d40f68013573e5074772d061aa8c55fc69f860d6f63688219a995ab409abc
+  metadata.gz: 4263a42ebb922645e2e0735c3ca33ad94df880fb01f881b2cacb602d733c533e
+  data.tar.gz: 616fb99c535c491324c1dcc4906b37c8cb424566b62dc64377c61b9a5ef5fd49
 SHA512:
-  metadata.gz: 54d411046b2f5cab10e97d740e0c4c335a17ec9c4cefcd363720f06660ba4a3310d8ab2a48e057f9047b16d116e30e0e1b082d78953fe9570cee3bee2d14f6f0
-  data.tar.gz: fefe49ca8cd8a8b8c80139a10cc874d24a08808349cae3a71237f47b263502c2fafc92a12d947bcf9b1c17a977bd4ffff8c3956f17bd0f1a18f68dfb566d8b2f
+  metadata.gz: 1d918daf7096d1889bf72ee0eca74ef473234ed1ed46e4275418028e9a32c9284b4412ff202a932a3cc43c777bbf55d1455ce8fd8805c965184e4d2bc740e527
+  data.tar.gz: 0657a6629d97623d40f68d0ffe7a3e0522c951d9b22dc0c7b4b918d78eb27b026ab68d347b1c2fa68661536eceef9cbf3de3ee82b4ea4381da2675f1d34b3f2d

data/README.md

@@ -5,14 +5,13 @@
 [![DCO](https://github.com/jaymzh/sugarjar/workflows/DCO%20Check/badge.svg)](https://github.com/jaymzh/sugarjar/actions?query=workflow%3A%22DCO+Check%22)
 
 > [!IMPORTANT]
-> If you are a _new_ user, I suggest looking at [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, new users
-> will likely want to start there.  Sapling is far more feature rich, faster,
-> and have more development resources behind them. SugarJar is a smaller
-> transition, and for the time being I'm maintaining it for all existing users,
-> and for those who may not yet be ready for the transition to Sapling.
+> As this was meant to replace arc/jf, which has now been open-sourced as
+> [Sapling](https://sapling-scm.com/), I highly recommend taking a look at that!
+>
+> Sapling is a great tool and solves a variety of problems SugarJar will never
+> be able to. However, it is a bigger workflow change, so existing SJ users
+> may choose to stick with this. Similarly some workflows may not be suitable
+> for Sapling. I still plan to maintain and develop SugarJar for the time being.
 
 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/).
@@ -33,18 +32,29 @@ If you don't, there's a ton of useful stuff for everyone!
 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)
+[![Packaging status](https://repology.org/badge/vertical-allrepos/sugarjar.svg?exclude_unsupported=1)](https://repology.org/project/sugarjar/versions)
 
-For MacOS users, you can use our Homebrew Tap:
+If you are using a Linux distribution version that is end-of-life'd, click the
+above image, it'll take you to a page that lists unsupported distro versions
+as well (they'll have older SugarJar, but they'll probably still have some
+version).
+
+Ubuntu users, Ubuntu versions prior to 24.x cannot be updated, so if you're on
+an older Ubuntu please use [this
+PPA](https://launchpad.net/~michel-slm/+archive/ubuntu/sugarjar) from our
+Ubuntu package maintainer.
+
+For MacOS users, we recommend using Homebrew - SugarJar is now in Homebrew Core.
+
+NOTE: If you previously used our custom Homebrew tap, you should remove and
+untap it:
 
 ```shell
-homebrew tap jaymzh/sugarjar
-homebrew install sugarjar
+homebrew uninstall sugarjar
+homebrew untap jaymzh/sugarjar
 ```
 
-You can also weigh in on [this
-PR](https://github.com/Homebrew/homebrew-core/pull/157910) and tell the
-Homebrew folks you'd like to see it in core.
+Then you can install the core version (`brew install sugarjar`).
 
 Finally, if none of those work for you, you can clone this repo and run it
 directly from there.
@@ -410,3 +420,9 @@ will allow me to make sure it shows up in the Repology badge above.
 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.
+
+**How do I get tab-completion?**
+
+If the package for your OS/distro didn't set it up manually, you should find
+that `sugarjar_completion.bash` is included in the package, and you can simply
+source that in your dotfiles, assuming you are using bash.

data/bin/sj

@@ -91,6 +91,24 @@ parser = OptionParser.new do |opts|
     options['log_level'] = level
   end
 
+  opts.on(
+    '--[no-]pr-autofill',
+    'When creating a PR, auto fill the title & description from the commit ' +
+    'if there is a single commit and if we are using "gh". [default: true]',
+  ) do |autofill|
+    options['pr_autofill'] = autofill
+  end
+
+  opts.on(
+    '--[no-]pr-autostack',
+    'When creating a PR, if this is a subfeature, should we make it a ' +
+    'PR on the PR for the parent feature. If not specified, we prompt ' +
+    'when this happens, when true always do this, when false never do ' +
+    'this. Only applicable when usiing "gh".',
+  ) do |autostack|
+    options['pr_autostack'] = autostack
+  end
+
   opts.on('--[no-]use-color', 'Enable color. [default: true]') do |color|
     options['color'] = color
   end
@@ -112,10 +130,10 @@ COMMANDS:
               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".
+  bclean [<branch>]
+              If safe, delete the current branch (or the specified 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
@@ -127,7 +145,7 @@ COMMANDS:
   br
               Verbose branch list. An alias for "git branch -v".
 
-  feature
+  feature, f <branch_name>
               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
@@ -177,11 +195,17 @@ COMMANDS:
               A smart wrapper to "git push" that runs whatever is defined in
               "on_push" in .sugarjar.yml, and only pushes if they succeed.
 
+  subfeature, sf <feature>
+              An alias for 'sj feature <feature> <current_branch>'
+
   unit
               Run any unitests configured in .sugarjar.yaml.
 
-  up
-              Rebase the current branch on upstream/master or origin/master.
+  up [<branch>]
+              Rebase the current branch (or specified branch) intelligently.
+              In most causes this will check for a main (or master) branch on
+              upstream, then origin. If a branch explicitly tracks something
+              else, then that will be used, instead.
 
   upall
               Same as "up", but for all branches.
@@ -190,9 +214,9 @@ COMMANDS:
               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
+Be sure to checkout Sapling (https://sapling-scm.com/)! SugarJar 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.
+Sapling may serve your needs even better.
 COMMANDS
 
   # rubocop:enable Layout/HeredocIndentation

data/extras/sugarjar_completion.bash

@@ -0,0 +1,42 @@
+# bash completion for sugarjar
+
+SJCONFIG="$HOME/.config/sugarjar/config.yaml"
+
+_sugarjar_completions()
+{
+    if [ "${#COMP_WORDS[@]}" -eq 2 ]; then
+        return
+    fi
+
+    local -a suggestions
+
+    # grap the feature_prefix if we have one so that we
+    # can let the user ignore that part. If we have `yq`
+    # we'll use it as that's going to be always 100%
+    # reliable, but if we don't, do our best with shell
+    # utils
+    local prefix=''
+    if [ -e "$SJCONFIG" ]; then
+        if type yq &>/dev/null; then
+            prefix=$(yq .feature_prefix $SJCONFIG)
+        else
+            # the xargs removes extra spaces
+            prefix=$(grep feature_prefix $SJCONFIG | cut -f2 -d: | xargs)
+        fi
+    fi
+
+    case "${COMP_WORDS[1]}" in
+        co|checkout|bclean)
+            local branches=$(git branch | sed -e 's/* //g' | xargs)
+            if [ -n "$prefix" ]; then
+                local branches=$(echo $branches | sed -e "s!$prefix!!g")
+            fi
+            suggestions=($(compgen -W "$branches" -- "${COMP_WORDS[2]}"))
+            COMPREPLY=("${suggestions[@]}")
+            ;;
+        *)
+            return
+    esac
+}
+
+complete -F _sugarjar_completions sj

data/lib/sugarjar/commands.rb

@@ -23,6 +23,8 @@ class SugarJar
       @repo_config = SugarJar::RepoConfig.config
       SugarJar::Log.debug("Repoconfig: #{@repo_config}")
       @color = options['color']
+      @pr_autofill = options['pr_autofill']
+      @pr_autostack = options['pr_autostack']
       @feature_prefix = options['feature_prefix']
       @checks = {}
       @main_branch = nil
@@ -43,19 +45,31 @@ class SugarJar
       name = fprefix(name)
       die("#{name} already exists!") if all_local_branches.include?(name)
       base ||= most_main
-      base_pieces = base.split('/')
-      git('fetch', base_pieces[0]) if base_pieces.length > 1
+      # If our base is a local branch, don't try to parse it for a remote name
+      unless all_local_branches.include?(base)
+        base_pieces = base.split('/')
+        git('fetch', base_pieces[0]) if base_pieces.length > 1
+      end
       git('checkout', '-b', name, base)
+      git('branch', '-u', base)
       SugarJar::Log.info(
         "Created feature branch #{color(name, :green)} based on " +
         color(base, :green),
       )
     end
+    alias f feature
+
+    def subfeature(name)
+      assert_in_repo
+      SugarJar::Log.debug("Subfature: #{name}")
+      feature(name, current_branch)
+    end
+    alias sf subfeature
 
     def bclean(name = nil)
       assert_in_repo
       name ||= current_branch
-      name = fprefix(name) unless all_local_branches.include?(name)
+      name = fprefix(name)
       if clean_branch(name)
         SugarJar::Log.info("#{name}: #{color('reaped', :green)}")
       else
@@ -100,7 +114,7 @@ class SugarJar
       # and then add any featureprefix, and if _that_ is a branch
       # name, replace the last arguement with that
       name = args.last
-      bname = fprefix(name) unless all_local_branches.include?(name)
+      bname = fprefix(name)
       if all_local_branches.include?(bname)
         SugarJar::Log.debug("Featurepefixing #{name} -> #{bname}")
         args[-1] = bname
@@ -133,17 +147,25 @@ class SugarJar
 
     alias sl smartlog
 
-    def up
+    def up(branch = nil)
       assert_in_repo
+      branch ||= current_branch
+      branch = fprefix(branch)
       # get a copy of our current branch, if rebase fails, we won't
       # be able to determine it without backing out
       curr = current_branch
+      git('checkout', branch)
       result = gitup
       if result['so'].error?
+        backout = ''
+        if rebase_in_progress?
+          backout = ' You can get out of this with a `git rebase --abort`.'
+        end
+
         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: ' +
+          "#{result['base']}. Leaving the repo as-is.#{backout} " +
+          '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}",
         )
@@ -151,6 +173,8 @@ class SugarJar
         SugarJar::Log.info(
           "#{color(current_branch, :green)} rebased on #{result['base']}",
         )
+        # go back to where we were if we rebased a different branch
+        git('checkout', curr) if branch != curr
       end
     end
 
@@ -179,7 +203,7 @@ class SugarJar
             "#{color(branch, :red)} failed rebase. Reverting attempt and " +
             'moving to next branch. Try `sj up` manually on that branch.',
           )
-          git('rebase', '--abort')
+          git('rebase', '--abort') if rebase_in_progress?
         else
           SugarJar::Log.info(
             "#{color(branch, :green)} rebased on " +
@@ -297,6 +321,7 @@ class SugarJar
     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. ' +
@@ -304,9 +329,38 @@ class SugarJar
         )
         exit(1)
       end
+
       if gh?
+        curr = current_branch
+        base = tracked_branch
+        if @pr_autofill
+          num_commits = git(
+            'rev-list', '--count', curr, "^#{base}"
+          ).stdout.strip.to_i
+          if num_commits > 1
+            SugarJar::Log.debug(
+              "Not using --fill because there are #{num_commits} commits",
+            )
+          else
+            SugarJar::Log.info('Autofilling in PR from commit message')
+            args.unshift('--fill')
+          end
+        end
+        if subfeature?(base)
+          # nil is prompt, true is always, false is never
+          if @pr_autostack.nil?
+            $stdout.print(
+              'It looks like this is a subfeature, would you like to base ' +
+              "this PR on #{base}? [y/n] ",
+            )
+            ans = $stdin.gets.strip
+            args += ['--base', base] if %w{Y y}.include?(ans)
+          elsif @pr_autostack
+            args += ['--base', base]
+          end
+        end
         SugarJar::Log.trace("Running: gh pr create #{args.join(' ')}")
-        system(which('gh'), 'pr', 'create', '--fill', *args)
+        system(which('gh'), 'pr', 'create', *args)
       else
         SugarJar::Log.trace("Running: hub pull-request #{args.join(' ')}")
         system(which('hub'), 'pull-request', *args)
@@ -336,7 +390,7 @@ class SugarJar
 
       src = "origin/#{current_branch}"
       fetch('origin')
-      diff = git('diff', src).stdout
+      diff = git('diff', "..#{src}").stdout
       return unless diff && !diff.empty?
 
       puts "Will merge the following suggestions:\n\n#{diff}"
@@ -364,6 +418,9 @@ class SugarJar
     def fprefix(name)
       return name unless @feature_prefix
 
+      return name if name.start_with?(@feature_prefix)
+      return name if all_local_branches.include?(name)
+
       newname = "#{@feature_prefix}#{name}"
       SugarJar::Log.debug(
         "Munging feature name: #{name} -> #{newname} due to feature prefix",
@@ -707,11 +764,15 @@ class SugarJar
     end
 
     def all_local_branches
-      branches = []
-      git('branch', '--format', '%(refname)').stdout.lines.each do |line|
-        branches << branch_from_ref(line.strip)
+      git(
+        'branch', '--format', '%(refname)'
+      ).stdout.lines.map do |line|
+        branch_from_ref(line.strip)
       end
-      branches
+    end
+
+    def all_remotes
+      git('remote').stdout.lines.map(&:strip)
     end
 
     def safe_to_clean(branch)
@@ -789,14 +850,28 @@ class SugarJar
       SugarJar::Log.debug('Fetching upstream')
       fetch_upstream
       curr = current_branch
-      base = tracked_branch
+      # this isn't a hash, it's a named param, silly rubocop
+      # rubocop:disable Style/HashSyntax
+      base = tracked_branch(fallback: false)
+      # rubocop:enable Style/HashSyntax
+      unless base
+        SugarJar::Log.info(
+          'The brach we were tracking is gone, resetting tracking to ' +
+          most_main,
+        )
+        git('branch', '-u', most_main)
+        base = most_main
+      end
+      # If this is a subfeature based on a local branch which has since
+      # been deleted, 'tracked branch' will automatically return <most_main>
+      # so we don't need any special handling for that
       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 ' +
           '(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".',
+          "to do a 'git branch -u #{most_main}'.",
         )
       end
       SugarJar::Log.debug('Rebasing')
@@ -807,12 +882,28 @@ class SugarJar
       }
     end
 
-    def tracked_branch
+    # determine if this branch is based on another local branch (i.e. is a
+    # subfeature). Used to figure out of we should stack the PR
+    def subfeature?(base)
+      all_local_branches.reject { |x| x == most_main }.include?(base)
+    end
+
+    def rebase_in_progress?
+      # for rebase without -i
+      rebase_file = git('rev-parse', '--git-path', 'rebase-apply').stdout.strip
+      # for rebase -i
+      rebase_merge_file = git('rev-parse', '--git-path', 'rebase-merge').
+                          stdout.strip
+      File.exist?(rebase_file) || File.exist?(rebase_merge_file)
+    end
+
+    def tracked_branch(fallback: true)
       s = git_nofail(
         'rev-parse', '--abbrev-ref', '--symbolic-full-name', '@{u}'
       )
       if s.error?
-        most_main
+        fallback ? most_main : nil
+
       else
         s.stdout.strip
       end
@@ -830,9 +921,7 @@ class SugarJar
     def upstream
       return @remote if @remote
 
-      s = git('remote')
-
-      remotes = s.stdout.lines.map(&:strip)
+      remotes = all_remotes
       SugarJar::Log.debug("remotes is #{remotes}")
       if remotes.empty?
         @remote = nil

data/lib/sugarjar/config.rb

@@ -9,6 +9,8 @@ class SugarJar
       'github_cli' => 'auto',
       'github_user' => ENV.fetch('USER'),
       'fallthru' => true,
+      'pr_autofill' => true,
+      'pr_autostack' => nil,
     }.freeze
 
     def self._find_ordered_files

data/lib/sugarjar/util.rb

@@ -1,5 +1,7 @@
 require_relative 'log'
 
+require 'mixlib/shellout'
+
 class SugarJar
   # Some common methods needed by other classes
   module Util

data/lib/sugarjar/version.rb

@@ -1,3 +1,3 @@
 class SugarJar
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.1.2'.freeze
 end

data/sugarjar.gemspec

@@ -8,14 +8,16 @@ Gem::Specification.new do |spec|
   spec.email = ['phil@ipom.com']
   spec.license = 'Apache-2.0'
   spec.homepage = 'https://github.com/jaymzh/sugarjar'
-  spec.required_ruby_version = '>= 3.1'
+  # We'll support 3.0 until 2024-03-31 when it goes EOL
+  # https://www.ruby-lang.org/en/downloads/branches/
+  spec.required_ruby_version = '>= 3.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
+    Dir.glob('extras/*')
 
   spec.add_dependency 'deep_merge'
   spec.add_dependency 'mixlib-log'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-31 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -82,6 +82,7 @@ files:
 - LICENSE
 - README.md
 - bin/sj
+- extras/sugarjar_completion.bash
 - lib/sugarjar/commands.rb
 - lib/sugarjar/config.rb
 - lib/sugarjar/log.rb
@@ -106,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="