sugarjar 2.0.0.beta.1 → 2.0.1

data/lib/sugarjar/util.rb

@@ -1,289 +1,21 @@
-require_relative 'log'
-
 require 'mixlib/shellout'
 
+require_relative 'log'
+
 class SugarJar
-  # Some common methods needed by other classes
   module Util
-    def extract_org(repo)
-      if repo.start_with?('http')
-        File.basename(File.dirname(repo))
-      elsif repo.start_with?('git@')
-        repo.split(':')[1].split('/')[0]
-      else
-        # assume they passed in a ghcli-friendly name
-        repo.split('/').first
-      end
-    end
-
-    def extract_repo(repo)
-      File.basename(repo, '.git')
-    end
-
-    def forked_repo(repo, username)
-      repo = if repo.start_with?('http', 'git@')
-               File.basename(repo)
-             else
-               "#{File.basename(repo)}.git"
-             end
-      "git@#{@ghhost || 'github.com'}:#{username}/#{repo}"
-    end
-
-    # gh utils will default to https, but we should always default to SSH
-    # unless otherwise specified since https will cause prompting.
-    def canonicalize_repo(repo)
-      # if they fully-qualified it, we're good
-      return repo if repo.start_with?('http', 'git@')
-
-      # otherwise, ti's a shortname
-      cr = "git@#{@ghhost || 'github.com'}:#{repo}.git"
-      SugarJar::Log.debug("canonicalized #{repo} to #{cr}")
-      cr
-    end
-
-    def set_commit_template
-      unless in_repo
-        SugarJar::Log.debug('Skipping set_commit_template: not in repo')
-        return
-      end
-
-      realpath = if @repo_config['commit_template'].start_with?('/')
-                   @repo_config['commit_template']
-                 else
-                   "#{repo_root}/#{@repo_config['commit_template']}"
-                 end
-      unless File.exist?(realpath)
-        die(
-          "Repo config specifies #{@repo_config['commit_template']} as the " +
-          'commit template, but that file does not exist.',
-        )
-      end
-
-      s = git_nofail('config', '--local', 'commit.template')
-      unless s.error?
-        current = s.stdout.strip
-        if current == @repo_config['commit_template']
-          SugarJar::Log.debug('Commit template already set correctly')
-          return
-        else
-          SugarJar::Log.warn(
-            "Updating repo-specific commit template from #{current} " +
-            "to #{@repo_config['commit_template']}",
-          )
-        end
-      end
-
-      SugarJar::Log.debug(
-        'Setting repo-specific commit template to ' +
-        "#{@repo_config['commit_template']} per sugarjar repo config.",
-      )
-      git(
-        'config', '--local', 'commit.template', @repo_config['commit_template']
-      )
-    end
-
-    def run_prepush
-      @repo_config['on_push']&.each do |item|
-        SugarJar::Log.debug("Running on_push check type #{item}")
-        unless send(:run_check, item)
-          SugarJar::Log.info("[prepush]: #{item} #{color('failed', :red)}.")
-          return false
-        end
-      end
-      true
-    end
+    # a mixin to hold stuff that Commands and RepoConfig both use
+    def self.which(cmd)
+      path = which_nofail(cmd)
+      return path if path
 
-    def die(msg)
-      SugarJar::Log.fatal(msg)
+      SugarJar::Log.fatal("Could not find #{cmd} in your path")
       exit(1)
     end
 
-    def assert_common_main_branch
-      upstream_branch = main_remote_branch(upstream)
-      unless main_branch == upstream_branch
-        die(
-          "The local main branch is '#{main_branch}', but the main branch " +
-          "of the #{upstream} remote is '#{upstream_branch}'. You probably " +
-          "want to rename your local branch by doing:\n\t" +
-          "git branch -m #{main_branch} #{upstream_branch}\n\t" +
-          "git fetch #{upstream}\n\t" +
-          "git branch -u #{upstream}/#{upstream_branch} #{upstream_branch}\n" +
-          "\tgit remote set-head #{upstream} -a",
-        )
-      end
-      return if upstream_branch == 'origin'
-
-      origin_branch = main_remote_branch('origin')
-      return if origin_branch == upstream_branch
-
-      die(
-        "The main branch of your upstream (#{upstream_branch}) and your " +
-        "fork/origin (#{origin_branch}) are not the same. You should go " +
-        "to https://#{@ghhost || 'github.com'}/#{@ghuser}/#{repo_name}/" +
-        'branches/ and rename the \'default\' branch to ' +
-        "'#{upstream_branch}'. It will then give you some commands to " +
-        'run to update this clone.',
-      )
-    end
-
-    def assert_in_repo
-      die('sugarjar must be run from inside a git repo') unless in_repo
-    end
-
-    def determine_main_branch(branches)
-      branches.include?('main') ? 'main' : 'master'
-    end
-
-    def main_branch
-      @main_branch = determine_main_branch(all_local_branches)
-    end
-
-    def main_remote_branch(remote)
-      @main_remote_branches[remote] ||=
-        determine_main_branch(all_remote_branches(remote))
-    end
-
-    def checkout_main_branch
-      git('checkout', main_branch)
-    end
-
-    def all_remote_branches(remote = 'origin')
-      branches = []
-      git('branch', '-r', '--format', '%(refname)').stdout.lines.each do |line|
-        next unless line.start_with?("refs/remotes/#{remote}/")
-
-        branches << branch_from_ref(line.strip, :remote)
-      end
-      branches
-    end
-
-    def all_local_branches
-      git(
-        'branch', '--format', '%(refname)'
-      ).stdout.lines.map do |line|
-        next if line.start_with?('(HEAD detached')
-
-        branch_from_ref(line.strip)
-      end
-    end
-
-    def all_remotes
-      git('remote').stdout.lines.map(&:strip)
-    end
-
-    def current_branch
-      branch_from_ref(git('symbolic-ref', 'HEAD').stdout.strip)
-    end
-
-    def fetch_upstream
-      us = upstream
-      fetch(us) if us
-    end
-
-    def fetch(remote)
-      git('fetch', remote)
-    end
-
-    # 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 tracked_branch(fallback: true)
-      branch = nil
-      s = git_nofail(
-        'rev-parse', '--abbrev-ref', '--symbolic-full-name', '@{u}'
-      )
-      if s.error?
-        branch = fallback ? most_main : nil
-        SugarJar::Log.debug("No specific tracked branch, using #{branch}")
-      else
-        branch = s.stdout.strip
-        SugarJar::Log.debug(
-          "Using explicit tracked branch: #{branch}, use " +
-          '`git branch -u` to change',
-        )
-      end
-      branch
-    end
-
-    def most_main
-      us = upstream
-      if us
-        "#{us}/#{main_branch}"
-      else
-        main_branch
-      end
-    end
-
-    def upstream
-      return @remote if @remote
-
-      remotes = all_remotes
-      SugarJar::Log.debug("remotes is #{remotes}")
-      if remotes.empty?
-        @remote = nil
-      elsif remotes.length == 1
-        @remote = remotes[0]
-      elsif remotes.include?('upstream')
-        @remote = 'upstream'
-      elsif remotes.include?('origin')
-        @remote = 'origin'
-      else
-        raise 'Could not determine "upstream" remote to use...'
-      end
-      @remote
-    end
-
-    # Whatever org we push to, regardless of if this is a fork or not
-    def push_org
-      url = git('remote', 'get-url', 'origin').stdout.strip
-      extract_org(url)
-    end
-
-    def branch_from_ref(ref, type = :local)
-      # local branches are refs/head/XXXX
-      # remote branches are refs/remotes/<remote>/XXXX
-      base = type == :local ? 2 : 3
-      ref.split('/')[base..].join('/')
-    end
-
-    def color(string, *colors)
-      if @color
-        pastel.decorate(string, *colors)
-      else
-        string
-      end
-    end
-
-    def pastel
-      @pastel ||= begin
-        require 'pastel'
-        Pastel.new
-      end
-    end
-
-    def gh_avail?
-      !!which_nofail('gh')
-    end
-
-    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",
-      )
-      newname
-    end
-
     # Finds the first entry in the path for a binary and checks
     # to make sure it's not us. Warn if it is us as that won't work in 2.x
-    def which_nofail(cmd)
+    def self.which_nofail(cmd)
       ENV['PATH'].split(File::PATH_SEPARATOR).each do |dir|
         p = File.join(dir, cmd)
         next unless File.exist?(p) && File.executable?(p)
@@ -299,43 +31,31 @@ class SugarJar
       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 ghcli_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...",
         )
-        ENV['GITHUB_HOST'] = @ghhost if @ghhost
-        args = [
-          which('gh'), 'auth', 'login', '-p', 'ssh'
-        ]
-        args + ['--hostname', @ghhost] if @ghhost
-        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 ' +
@@ -347,28 +67,19 @@ class SugarJar
       s
     end
 
-    def ghcli(*args)
-      s = ghcli_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 dirty?
-      s = git_nofail('diff', '--quiet')
-      s.error?
-    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 = '2.0.0.beta.1'.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: 2.0.0.beta.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-13 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: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A git/github helper script