sugarjar 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e4979017c0ed58f99c446d9215a6b64aec7d5ebc22694a95903710d5af9d7e
-  data.tar.gz: b4b7a648bc7e8002e46dfbaa73cc52749cd38258b5782a2b33a6d66db98facfc
+  metadata.gz: d4282936baebdd165acf740d342b5f2e75a74dcaac6b77049842e903fe675957
+  data.tar.gz: f200b2404a6b61444b8846f0b67af1c43585daaab22b89d6e916f3a5fe9b3b3e
 SHA512:
-  metadata.gz: 0e34735382f6646bf5fe1577eb6637ad7aaceaa9ccf2d2dad024d4a95f3e2a0e8ec080fe086fd5dae7354b3f15f83d26e6ae8b067a1fae9fb5b3da777f9e1f86
-  data.tar.gz: 155d1aa1c7148f2d7181678f64ef64b17fb5efc90386ce3bd27c2bcc7b256113680b4e69a16558790ab3c77080325fc36a56c9f3cc76cf4962f8f575cd00d5d7
+  metadata.gz: aa37f43fbbfbd68bf3a43f58706add2a3ea981a257e41cea1b894077cad51f2f10a1d3e95d9968ea59518bbd5b6a739678bd123cd279ec67016856666521452b
+  data.tar.gz: 44a62d13863c21952264b4722a8fb6dd26fa3d1f548d7ab41f65d7dd0600c95f38fd333f49dfb0840734f9472ffa54050b6216a1140dc7edae2306d3b46b24b8

data/README.md

@@ -5,12 +5,14 @@
 [![DCO](https://github.com/jaymzh/sugarjar/workflows/DCO%20Check/badge.svg)](https://github.com/jaymzh/sugarjar/actions?query=workflow%3A%22DCO+Check%22)
 
 > [!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
+> 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, this is
-> likely to be deprecated at some point. Sapling is far more feature rich,
-> faster, and have more development resources behind them.
+> 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:
 either [gh](https://cli.github.com/) or the older [hub](https://hub.github.com/).
@@ -222,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
 
@@ -317,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:
 

data/lib/sugarjar/commands.rb

@@ -21,6 +21,7 @@ class SugarJar
       @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 = {}
@@ -95,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
@@ -296,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)
@@ -553,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

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 = '1.0.0'.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: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-23 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