sugarjar 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4282936baebdd165acf740d342b5f2e75a74dcaac6b77049842e903fe675957
-  data.tar.gz: f200b2404a6b61444b8846f0b67af1c43585daaab22b89d6e916f3a5fe9b3b3e
+  metadata.gz: bc16295007c8698083a182a521c68481b3cb421644def0115aa04286867dd1eb
+  data.tar.gz: c901d92e5d7d5287472f52cf56a83d29a5b1b4b0248232278b36e1706bc7117d
 SHA512:
-  metadata.gz: aa37f43fbbfbd68bf3a43f58706add2a3ea981a257e41cea1b894077cad51f2f10a1d3e95d9968ea59518bbd5b6a739678bd123cd279ec67016856666521452b
-  data.tar.gz: 44a62d13863c21952264b4722a8fb6dd26fa3d1f548d7ab41f65d7dd0600c95f38fd333f49dfb0840734f9472ffa54050b6216a1140dc7edae2306d3b46b24b8
+  metadata.gz: 6d64d758a56feac59e5617544cdde17341c804a8831524c49222f6397e47e886ed16f42280d60584a5231d279410839bdacebda66827ae77bb115addb24f3b6d
+  data.tar.gz: e65b75d83d852906c713f00d6424a76897177f39eb1f2eaa0b5d17896b6d2fb288de3d1cf0946f5587f5674819a074782279ecdb26094c8038d221fcd7ceab0f

data/Gemfile

@@ -1,6 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'appbundler'
 gem 'sugarjar', :path => '.'
 
 group :test do

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,21 +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 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.
+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).
 
-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.
+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 uninstall sugarjar
+homebrew untap jaymzh/sugarjar
+```
+
+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.
@@ -406,11 +413,16 @@ 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.
+will allow me to make sure it shows up in the Repology badge above.
 
 **What platforms does it work on?**
 
 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

@@ -190,9 +190,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

@@ -140,10 +140,15 @@ class SugarJar
       curr = current_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}",
         )
@@ -179,7 +184,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 " +
@@ -807,6 +812,15 @@ class SugarJar
       }
     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
       s = git_nofail(
         'rev-parse', '--abbrev-ref', '--symbolic-full-name', '@{u}'

data/lib/sugarjar/config.rb

@@ -23,9 +23,9 @@ class SugarJar
       c = DEFAULTS.dup
       _find_ordered_files.each do |f|
         SugarJar::Log.debug("Loading config #{f}")
-        data = YAML.safe_load(File.read(f))
+        data = YAML.safe_load_file(f)
         # an empty file is a `nil` which you can't merge
-        c.merge!(YAML.safe_load(File.read(f))) if data
+        c.merge!(YAML.safe_load_file(f)) if data
         SugarJar::Log.debug("Modified config: #{c}")
       end
       c

data/lib/sugarjar/repoconfig.rb

@@ -17,7 +17,7 @@ class SugarJar
 
     def self.hash_from_file(config_file)
       SugarJar::Log.debug("Loading repo config: #{config_file}")
-      YAML.safe_load(File.read(config_file))
+      YAML.safe_load_file(config_file)
     end
 
     # wrapper for File.exist to make unittests easier

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.0.1'.freeze
+  VERSION = '1.1.1'.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 = '>= 2.6.0'
+  # 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'
@@ -23,5 +25,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'pastel'
   spec.metadata = {
     'rubygems_mfa_required' => 'true',
+    'bug_tracker_uri' => 'https://github.com/jaymzh/sugarjar/issues',
+    'changelog_uri' =>
+      'https://github.com/jaymzh/sugarjar/blob/main/CHANGELOG.md',
+    'homepage_uri' => 'https://github.com/jaymzh/sugajar',
+    'source_code_uri' => 'https://github.com/jaymzh/sugarjar',
   }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2024-02-13 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
@@ -94,6 +95,10 @@ licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://github.com/jaymzh/sugarjar/issues
+  changelog_uri: https://github.com/jaymzh/sugarjar/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/jaymzh/sugajar
+  source_code_uri: https://github.com/jaymzh/sugarjar
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -102,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="