sugarjar 0.0.11 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f4c70f80f34b048ba0d6b526e5eb20fcc51164b8ef78412a38ad5c953296898
-  data.tar.gz: 53958fab72a6c93d35617b63ffdb178cddcf1f97837a321533836896b0336c8b
+  metadata.gz: d4282936baebdd165acf740d342b5f2e75a74dcaac6b77049842e903fe675957
+  data.tar.gz: f200b2404a6b61444b8846f0b67af1c43585daaab22b89d6e916f3a5fe9b3b3e
 SHA512:
-  metadata.gz: 5b3c546fe02babc8b186cf4f5de2d6a2716e371228af676dd5550d56b1f17db9d310d135f47a1905e77a98ed32ebd6716292bc19059a1e6e9e4733f725422900
-  data.tar.gz: 37df61e3b4161c2737dcf6392b5db3dcb8feef5d402868b48d6f28db9cb2254ddaf9b39d2719ea88071c4f37feb32efd9d327c105c3dcde428f495957e85913e
+  metadata.gz: aa37f43fbbfbd68bf3a43f58706add2a3ea981a257e41cea1b894077cad51f2f10a1d3e95d9968ea59518bbd5b6a739678bd123cd279ec67016856666521452b
+  data.tar.gz: 44a62d13863c21952264b4722a8fb6dd26fa3d1f548d7ab41f65d7dd0600c95f38fd333f49dfb0840734f9472ffa54050b6216a1140dc7edae2306d3b46b24b8

data/README.md

@@ -4,10 +4,18 @@
 [![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)
 
+> [!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.
+
 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.
+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
@@ -27,6 +35,12 @@ 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
@@ -210,12 +224,20 @@ $ sj feature dependent-feature test-branch
 Created feature branch dependent-feature based on test-branch
 ```
 
+Additionally you can specify a `feature_prefix` in your config which will cause
+`feature` to create branches prefixed with your `feature_prefix` and will also
+cause `co` to checkout branches with that prefix. This is useful when organizations
+use branch-based workflows and branches need to be prefixed with e.g. `$USER/`.
+
+For example, if your prefix was `user/`, then `sj feature foo` would create
+`user/foo`, and `sj co foo` would switch to `user/foo`.
+
 ## Smartlog
 
 Smartlog will show you a tree diagram of your branches! Simply run `sj
 smartlog` or `sj sl` for short.
 
-![smartlog screenshot](https://github.com/jaymzh/sugarjar/blob/master/smartlog.png)
+![smartlog screenshot](https://github.com/jaymzh/sugarjar/blob/main/smartlog.png)
 
 ## Pulling in suggestions from the web
 
@@ -279,8 +301,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
@@ -294,7 +316,7 @@ how to handle repo-specific things. Currently there options are:
   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. Test will be run fro mthe root of the repo.
+  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.
@@ -305,6 +327,12 @@ how to handle repo-specific things. Currently there options are:
 * `commit_template` - A path to a commit template to set in the `commit.template`
   git config for this repo. Should be either a fully-qualified path, or a path
   relative to the repo root.
+* `include_from` - This will read an additional repoconfig file and merge it
+  into the one being read. The value should be relative to the root of the
+  repo. This will not error if the file does not exist, it is intended for
+  organizations to allow users to optionally extend a default repo config.
+* `overwrite_from` - Same as `include_from`, but completely overwrites the
+  base configuration if the file is found.
 
 Example configuration:
 
@@ -349,41 +377,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..
 
-## Support for `gh`
+## Choosing a GitHub CLI
 
-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
-```
+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. Now that `gh` has matured, we have experimental support for
-`gh` and will switch it to the default at some point.
+many more features. In addition, I wrote SugarJar to be a wrapper for git/hub,
+and `hub` allows this but `gh` does not.
 
-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.
+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?
+**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?
+**What platforms does it work on?**
 
-It should! Though I will admit I don't regularly test on non-Linux OSes.
+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,15 +29,20 @@ 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('--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"). Note that support for "gh" is ' +
-    'currently experimental. default: "hub"',
+    '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
@@ -64,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
@@ -127,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
@@ -176,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
@@ -246,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
@@ -257,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}")

data/lib/sugarjar/commands.rb

@@ -18,16 +18,21 @@ class SugarJar
       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
+      SugarJar::Log.debug("Repoconfig: #{@repo_config}")
       @color = options['color']
+      @feature_prefix = options['feature_prefix']
       @checks = {}
       @main_branch = nil
       @main_remote_branches = {}
       return if options['no_change']
 
+      # 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
@@ -35,6 +40,7 @@ class SugarJar
     def feature(name, base = nil)
       assert_in_repo
       SugarJar::Log.debug("Feature: #{name}, #{base}")
+      name = fprefix(name)
       die("#{name} already exists!") if all_local_branches.include?(name)
       base ||= most_main
       base_pieces = base.split('/')
@@ -49,6 +55,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
@@ -89,6 +96,15 @@ class SugarJar
 
     def co(*args)
       assert_in_repo
+      # Pop the last arguement, which is _probably_ a branch name
+      # 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)
+      if all_local_branches.include?(bname)
+        SugarJar::Log.debug("Featurepefixing #{name} -> #{bname}")
+        args[-1] = bname
+      end
       s = git('checkout', *args)
       SugarJar::Log.info(s.stderr + s.stdout.chomp)
     end
@@ -180,28 +196,34 @@ class SugarJar
 
       reponame = File.basename(repo, '.git')
       dir ||= reponame
+      org = extract_org(repo)
 
       SugarJar::Log.info("Cloning #{reponame}...")
 
       # 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?
+      #
+      # 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.
+      # 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
 
-        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".'
@@ -284,7 +306,7 @@ class SugarJar
       end
       if gh?
         SugarJar::Log.trace("Running: gh pr create #{args.join(' ')}")
-        system(which('gh'), 'pr', 'create', *args)
+        system(which('gh'), 'pr', 'create', '--fill', *args)
       else
         SugarJar::Log.trace("Running: hub pull-request #{args.join(' ')}")
         system(which('hub'), 'pull-request', *args)
@@ -339,6 +361,16 @@ class SugarJar
 
     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'
@@ -531,7 +563,12 @@ class SugarJar
           SugarJar::Log.debug("Running #{type} #{check}")
 
           short = check.split.first
-          unless File.exist?(short)
+          if short.include?('/')
+            short = File.join(repo_root, short) unless short.start_with?('/')
+            unless File.exist?(short)
+              SugarJar::Log.error("Configured #{type} #{short} does not exist!")
+            end
+          elsif !which_nofail(short)
             SugarJar::Log.error("Configured #{type} #{short} does not exist!")
             return false
           end
@@ -686,7 +723,7 @@ class SugarJar
       ).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",
         )
@@ -833,6 +870,29 @@ class SugarJar
       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

data/lib/sugarjar/config.rb

@@ -6,7 +6,7 @@ class SugarJar
   # This is stuff like log level, github-user, etc.
   class Config
     DEFAULTS = {
-      'github_cli' => 'hub',
+      'github_cli' => 'auto',
       'github_user' => ENV.fetch('USER'),
       'fallthru' => true,
     }.freeze

data/lib/sugarjar/repoconfig.rb

@@ -1,6 +1,7 @@
 require_relative 'util'
 require_relative 'log'
 require 'yaml'
+require 'deep_merge'
 
 class SugarJar
   # This parses SugarJar repoconfigs (not to be confused with configs).
@@ -10,23 +11,40 @@ class SugarJar
 
     CONFIG_NAME = '.sugarjar.yaml'.freeze
 
-    def self.repo_config
-      ::File.join(repo_root, CONFIG_NAME)
+    def self.repo_config_path(config)
+      ::File.join(repo_root, config)
     end
 
-    def self.config
+    def self.hash_from_file(config_file)
+      SugarJar::Log.debug("Loading repo config: #{config_file}")
+      YAML.safe_load(File.read(config_file))
+    end
+
+    # wrapper for File.exist to make unittests easier
+    def self.config_file?(config_file)
+      File.exist?(config_file)
+    end
+
+    def self.config(config = CONFIG_NAME)
+      data = {}
       unless in_repo
         SugarJar::Log.debug('Not in repo, skipping repoconfig load')
-        return {}
+        return data
       end
-      config = repo_config
-      if File.exist?(config)
-        SugarJar::Log.debug("Loading repo config: #{config}")
-        YAML.safe_load(File.read(repo_config))
-      else
-        SugarJar::Log.debug("No repo config (#{config}), returning empty hash")
-        {}
+      config_file = repo_config_path(config)
+      data = hash_from_file(config_file) if config_file?(config_file)
+      if data['overwrite_from'] && config_file?(data['overwrite_from'])
+        SugarJar::Log.debug(
+          "Attempting overwrite_from #{data['overwrite_from']}",
+        )
+        data = config(data['overwrite_from'])
+        data.delete('overwrite_from')
+      elsif data['include_from'] && config_file?(data['include_from'])
+        SugarJar::Log.debug("Attempting include_from #{data['include_from']}")
+        data.deep_merge!(config(data['include_from']))
+        data.delete('include_from')
       end
+      data
     end
   end
 end

data/lib/sugarjar/version.rb

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

data/sugarjar.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
     Dir.glob('bin/*') +
     docs
 
+  spec.add_dependency 'deep_merge'
   spec.add_dependency 'mixlib-log'
   spec.add_dependency 'mixlib-shellout'
   spec.add_dependency 'pastel'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 1.0.1
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mixlib-log
   requirement: !ruby/object:Gem::Requirement