sugarjar 1.1.3 → 2.0.1

data/lib/sugarjar/config.rb

@@ -6,11 +6,11 @@ class SugarJar
   # This is stuff like log level, github-user, etc.
   class Config
     DEFAULTS = {
-      'github_cli' => 'auto',
       'github_user' => ENV.fetch('USER'),
-      'fallthru' => true,
       'pr_autofill' => true,
       'pr_autostack' => nil,
+      'color' => true,
+      'ignore_deprecated_options' => [],
     }.freeze
 
     def self._find_ordered_files
@@ -26,11 +26,31 @@ class SugarJar
       _find_ordered_files.each do |f|
         SugarJar::Log.debug("Loading config #{f}")
         data = YAML.safe_load_file(f)
+        warn_on_deprecated_configs(data, f)
         # an empty file is a `nil` which you can't merge
         c.merge!(YAML.safe_load_file(f)) if data
         SugarJar::Log.debug("Modified config: #{c}")
       end
       c
     end
+
+    def self.warn_on_deprecated_configs(data, fname)
+      ignore_deprecated_options = data['ignore_deprecated_options'] || []
+      %w{fallthru gh_cli}.each do |opt|
+        next unless data.key?(opt)
+
+        if ignore_deprecated_options.include?(opt)
+          SugarJar::Log.debug(
+            "Not warning about deprecated option '#{opt}' in #{fname} due to " +
+            '"ignore_deprecated_options" in that file.',
+          )
+          next
+        end
+        SugarJar::Log.warn(
+          "Config file #{fname} contains deprecated option #{opt}. You can " +
+          'suppress this warning with ignore_deprecated_options.',
+        )
+      end
+    end
   end
 end

data/lib/sugarjar/repoconfig.rb

@@ -7,12 +7,10 @@ class SugarJar
   # This parses SugarJar repoconfigs (not to be confused with configs).
   # This is lint/unit/on_push configs.
   class RepoConfig
-    extend SugarJar::Util
-
     CONFIG_NAME = '.sugarjar.yaml'.freeze
 
     def self.repo_config_path(config)
-      ::File.join(repo_root, config)
+      ::File.join(SugarJar::Util.repo_root, config)
     end
 
     def self.hash_from_file(config_file)
@@ -27,7 +25,7 @@ class SugarJar
 
     def self.config(config = CONFIG_NAME)
       data = {}
-      unless in_repo
+      unless SugarJar::Util.in_repo?
         SugarJar::Log.debug('Not in repo, skipping repoconfig load')
         return data
       end

data/lib/sugarjar/util.rb

@@ -1,114 +1,61 @@
-require_relative 'log'
-
 require 'mixlib/shellout'
 
+require_relative 'log'
+
 class SugarJar
-  # Some common methods needed by other classes
   module Util
+    # a mixin to hold stuff that Commands and RepoConfig both use
+    def self.which(cmd)
+      path = which_nofail(cmd)
+      return path if path
+
+      SugarJar::Log.fatal("Could not find #{cmd} in your path")
+      exit(1)
+    end
+
     # Finds the first entry in the path for a binary and checks
-    # to make sure it's not us (i.e. we may be linked to as 'git'
-    # or 'hub', but when we are calling that, we don't want ourselves.
-    def which_nofail(cmd)
+    # to make sure it's not us. Warn if it is us as that won't work in 2.x
+    def self.which_nofail(cmd)
       ENV['PATH'].split(File::PATH_SEPARATOR).each do |dir|
         p = File.join(dir, cmd)
-        # if it exists, and it is executable and is not us...
-        if File.exist?(p) && File.executable?(p) &&
-           File.basename(File.realpath(p)) != 'sj'
-          return p
+        next unless File.exist?(p) && File.executable?(p)
+
+        if File.basename(File.realpath(p)) == 'sj'
+          SugarJar::Log.error(
+            "'#{cmd}' is linked to 'sj' which is no longer supported.",
+          )
+          next
         end
+        return p
       end
       false
     end
 
-    def which(cmd)
-      path = which_nofail(cmd)
-      return path if path
-
-      SugarJar::Log.fatal("Could not find #{cmd} in your path")
-      exit(1)
-    end
-
-    def git_nofail(*args)
+    def self.git_nofail(*args, color: true)
       if %w{diff log grep branch}.include?(args[0]) &&
          args.none? { |x| x.include?('color') }
-        args << (@color ? '--color' : '--no-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)
+    def self.git(*, color: true)
+      s = git_nofail(*, :color => color)
       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?
-        # depending on hub version and possibly other things, STDERR
-        # is either "Requires authentication" or "Must authenticate"
-        case s.stderr
-        when /^(Must|Requires) authenticat/
-          SugarJar::Log.info(
-            'Hub was run but no github token exists. Will run "hub api user" ' +
-            "to force\nhub to authenticate...",
-          )
-          unless system(which('hub'), 'api', 'user')
-            SugarJar::Log.fatal(
-              'That failed, I will bail out. Hub needs to get a github ' +
-              'token. Try running "hub api user" (will list info about ' +
-              'your account) and try this again when that works.',
-            )
-            exit(1)
-          end
-          SugarJar::Log.info('Re-running original hub command...')
-          s = Mixlib::ShellOut.new([which('hub')] + args).run_command
-        when /^fatal: could not read Username/, /Anonymous access denied/
-
-          # On http(s) URLs, git may prompt for username/passwd
-          SugarJar::Log.info(
-            'Hub was run but git prompted for authentication. This probably ' +
-            "means you have\nused an http repo URL instead of an ssh one. It " +
-            "is recommended you reclone\nusing 'sj sclone' to setup your " +
-            "remotes properly. However, in the meantime,\nwe'll go ahead " +
-            "and re-run the command in a shell so you can type in the\n" +
-            'credentials.',
-          )
-          unless system(which('hub'), *args)
-            SugarJar::Log.fatal(
-              'That failed, I will bail out. You can either manually change ' +
-              'your remotes, or simply create a fresh clone with ' +
-              '"sj smartclone".',
-            )
-            exit(1)
-          end
-          SugarJar::Log.info('Re-running original hub command...')
-          s = Mixlib::ShellOut.new([which('hub')] + args).run_command
-        end
-      end
-      s
-    end
-
-    def hub(*args)
-      s = hub_nofail(*args)
-      s.error!
-      s
-    end
-
-    def gh_nofail(*args)
+    def self.ghcli_nofail(*args)
       SugarJar::Log.trace("Running: gh #{args.join(' ')}")
-      s = Mixlib::ShellOut.new([which('gh')] + args).run_command
+      gh = which('gh')
+      s = Mixlib::ShellOut.new([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')
+        unless system(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 ' +
@@ -120,23 +67,19 @@ class SugarJar
       s
     end
 
-    def gh(*args)
-      s = gh_nofail(*args)
+    def self.ghcli(*)
+      s = ghcli_nofail(*)
       s.error!
       s
     end
 
-    def in_repo
+    def self.in_repo?
       s = git_nofail('rev-parse', '--is-inside-work-tree')
       !s.error? && s.stdout.strip == 'true'
     end
 
-    def repo_root
+    def self.repo_root
       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 = '1.1.3'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/sugarjar.gemspec

@@ -8,14 +8,20 @@ Gem::Specification.new do |spec|
   spec.email = ['phil@ipom.com']
   spec.license = 'Apache-2.0'
   spec.homepage = 'https://github.com/jaymzh/sugarjar'
-  # 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.required_ruby_version = '>= 3.2'
+  docs = %w{
+    README.md
+    LICENSE
+    Gemfile
+    sugarjar.gemspec
+    CONTRIBUTING.md
+    CHANGELOG.md
+  } + Dir.glob('examples/*')
   spec.extra_rdoc_files = docs
   spec.executables << 'sj'
   spec.files =
     Dir.glob('lib/sugarjar/*.rb') +
+    Dir.glob('lib/sugarjar/commands/*.rb') +
     Dir.glob('bin/*') +
     Dir.glob('extras/*')
 
@@ -28,7 +34,7 @@ Gem::Specification.new do |spec|
     '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',
+    'homepage_uri' => 'https://github.com/jaymzh/sugarjar',
     '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.1.3
+  version: 2.0.1
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-20 00:00:00.000000000 Z
+date: 2025-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -77,13 +77,32 @@ extra_rdoc_files:
 - LICENSE
 - Gemfile
 - sugarjar.gemspec
+- CONTRIBUTING.md
+- CHANGELOG.md
+- examples/sample_config.yaml
+- examples/sample_repoconfig.yaml
 files:
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - bin/sj
+- examples/sample_config.yaml
+- examples/sample_repoconfig.yaml
 - extras/sugarjar_completion.bash
 - lib/sugarjar/commands.rb
+- lib/sugarjar/commands/amend.rb
+- lib/sugarjar/commands/bclean.rb
+- lib/sugarjar/commands/branch.rb
+- lib/sugarjar/commands/checks.rb
+- lib/sugarjar/commands/debuginfo.rb
+- lib/sugarjar/commands/feature.rb
+- lib/sugarjar/commands/pullsuggestions.rb
+- lib/sugarjar/commands/push.rb
+- lib/sugarjar/commands/smartclone.rb
+- lib/sugarjar/commands/smartpullrequest.rb
+- lib/sugarjar/commands/up.rb
 - lib/sugarjar/config.rb
 - lib/sugarjar/log.rb
 - lib/sugarjar/repoconfig.rb
@@ -97,7 +116,7 @@ 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
+  homepage_uri: https://github.com/jaymzh/sugarjar
   source_code_uri: https://github.com/jaymzh/sugarjar
 post_install_message:
 rdoc_options: []
@@ -107,14 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A git/github helper script