sugarjar 2.0.1 → 3.0.0

data/lib/sugarjar/commands.rb

@@ -36,13 +36,27 @@ class SugarJar
       @checks = {}
       @main_branch = nil
       @main_remote_branches = {}
-      @ghuser = @repo_config['github_user'] || options['github_user']
-      @ghhost = @repo_config['github_host'] || options['github_host']
+      # This is CONFIGURED host, which may be null, as opposed
+      # to the method forge_host which will always return something
+      @_forge_host = @repo_config['forge_host'] || options['forge_host']
+      @repo_forge = @repo_config['forge_type'] || options['forge_type'] ||
+                    _determine_forge_type
+
+      unless @repo_forge.nil?
+        cmd = _forge_cmd
+        unless SugarJar::Util.which_nofail(cmd)
+          die("No '#{cmd}' found, please install it'")
+        end
+      end
 
-      die("No 'gh' found, please install 'gh'") unless gh_avail?
+      user_option = "#{@repo_forge}_user"
+      @forge_user = @repo_config[user_option] || options[user_option]
 
-      # Tell the 'gh' cli where to talk to, if not github.com
-      ENV['GH_HOST'] = @ghhost if @ghhost
+      # Tell the cli where to talk to, if not default
+      if @_forge_host
+        ENV['GH_HOST'] = @_forge_host
+        ENV['GL_HOST'] = @_forge_host
+      end
 
       return if options['no_change']
 
@@ -52,12 +66,8 @@ class SugarJar
     private
 
     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}"
+      repo = extract_repo(repo)
+      "git@#{forge_host}:#{username}/#{repo}.git"
     end
 
     # gh utils will default to https, but we should always default to SSH
@@ -66,12 +76,41 @@ class SugarJar
       # 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"
+      # otherwise, it's a shortname
+      cr = "git@#{forge_host}:#{repo}.git"
       SugarJar::Log.debug("canonicalized #{repo} to #{cr}")
       cr
     end
 
+    def forge_host
+      # if one is specifically configured, use that
+      return @_forge_host if @_forge_host
+
+      # otherwise, if we're in a repo, use the hostname of the remote
+      if SugarJar::Util.in_repo?
+        extract_host(remote_url_map['origin'])
+      else
+        @repo_forge == 'gitlab' ? 'gitlab.com' : 'github.com'
+      end
+    end
+
+    def repo_shortname(repo)
+      # if it's already a shortname, return
+      return repo unless repo.start_with?('http', 'git@')
+
+      # otherwise, parse it
+      if repo.start_with?('http')
+        bits = repo.split('/')
+      elsif repo.start_with?('git@')
+        relevant = repo.split(':').last
+        bits = relevant.split('/')
+      end
+      repo = bits[-1].gsub('.git', '')
+      org = bits[-2]
+
+      "#{org}/#{repo}"
+    end
+
     def set_commit_template
       unless SugarJar::Util.in_repo?
         SugarJar::Log.debug('Skipping set_commit_template: not in repo')
@@ -119,8 +158,29 @@ class SugarJar
       die('sugarjar must be run from inside a git repo')
     end
 
+    def dirty_check!
+      return unless dirty?
+
+      if @ignore_dirty
+        SugarJar::Log.warn(
+          'Your repo is dirty, but --ignore-dirty was specified, so ' +
+          'carrying on anyway.',
+        )
+      else
+        SugarJar::Log.error(
+          'Your repo is dirty, so I am refusing to continue. Please commit ' +
+          'or amend first (or use --ignore-dirty to override).',
+        )
+        exit(1)
+      end
+    end
+
     def determine_main_branch(branches)
-      branches.include?('main') ? 'main' : 'master'
+      if branches.include?('main')
+        'main'
+      elsif branches.include?('master')
+        'master'
+      end
     end
 
     def main_branch
@@ -150,8 +210,10 @@ class SugarJar
       git(
         'branch', '--format', '%(refname)'
       ).stdout.lines.map do |line|
-        next if line.start_with?('(HEAD detached')
-
+        if line.start_with?('(')
+          SugarJar::Log.debug("Skipping meta-branch: #{line.strip}")
+          next
+        end
         branch_from_ref(line.strip)
       end
     end
@@ -188,11 +250,13 @@ class SugarJar
       all_local_branches.reject { |x| x == most_main }.include?(base)
     end
 
-    def tracked_branch(fallback: true)
-      branch = nil
+    def tracked_branch(branch = nil, fallback: true)
+      curr = current_branch
+      git('checkout', branch) if branch && branch != curr
       s = git_nofail(
         'rev-parse', '--abbrev-ref', '--symbolic-full-name', '@{u}'
       )
+      git('checkout', curr) if branch && branch != curr
       if s.error?
         branch = fallback ? most_main : nil
         SugarJar::Log.debug("No specific tracked branch, using #{branch}")
@@ -242,7 +306,7 @@ class SugarJar
 
     # 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
+      url = remote_url_map['origin']
       extract_org(url)
     end
 
@@ -261,8 +325,8 @@ class SugarJar
       end
     end
 
-    def gh_avail?
-      !!SugarJar::Util.which_nofail('gh')
+    def forge_cli_avail?
+      !!SugarJar::Util.which_nofail(_forge_cmd)
     end
 
     def fprefix(name)
@@ -302,11 +366,47 @@ class SugarJar
       File.basename(repo, '.git')
     end
 
+    def extract_host(repo)
+      if repo.start_with?('git@')
+        repo.split(':').first.split('@').last
+      elsif repo.start_with?('http')
+        repo.split('/')[2]
+      end
+    end
+
     def die(msg)
       SugarJar::Log.fatal(msg)
       exit(1)
     end
 
+    def release_branches
+      @repo_config['release_branches'] || []
+    end
+
+    def worktree_branches
+      worktrees.values.map do |wt|
+        branch_from_ref(wt['branch'])
+      end
+    end
+
+    def worktrees
+      root = SugarJar::Util.repo_root
+      s = git('worktree', 'list', '--porcelain')
+      s.error!
+      worktrees = {}
+      # each entry is separated by a double newline
+      s.stdout.split("\n\n").each do |entry|
+        # then each key/val is split by a new line with the key and
+        # the value themselves split by a whitespace
+        tree = entry.split("\n").to_h(&:split)
+        # Skip the one
+        next if tree['worktree'] == root
+
+        worktrees[tree['worktree']] = tree
+      end
+      worktrees
+    end
+
     def branch_from_ref(ref, type = :local)
       # local branches are refs/head/XXXX
       # remote branches are refs/remotes/<remote>/XXXX
@@ -314,6 +414,12 @@ class SugarJar
       ref.split('/')[base..].join('/')
     end
 
+    def remote_from_ref(ref)
+      return nil unless ref.start_with?('refs/remotes/')
+
+      ref.split('/')[2]
+    end
+
     def git(*)
       SugarJar::Util.git(*, :color => @color)
     end
@@ -322,12 +428,36 @@ class SugarJar
       SugarJar::Util.git_nofail(*, :color => @color)
     end
 
-    def ghcli(*)
-      SugarJar::Util.ghcli(*)
+    def _determine_forge_type
+      return nil unless SugarJar::Util.in_repo?
+
+      if remote_url_map.values.any? do |x|
+        x.include?('gitlab')
+      end
+        'gitlab'
+      else
+        'github'
+      end
+    end
+
+    def _forge_cmd
+      @repo_forge == 'gitlab' ? 'glab' : 'gh'
     end
 
-    def ghcli_nofail(*)
-      SugarJar::Util.ghcli_nofail(*)
+    def forge(*)
+      if @repo_forge == 'gitlab'
+        SugarJar::Util.glcli(*)
+      else
+        SugarJar::Util.ghcli(*)
+      end
+    end
+
+    def forge_nofail(*)
+      if @repo_forge == 'gitlab'
+        SugarJar::Util.glcli_nofail(*)
+      else
+        SugarJar::Util.ghcli_nofail(*)
+      end
     end
   end
 end

data/lib/sugarjar/config.rb

@@ -7,6 +7,7 @@ class SugarJar
   class Config
     DEFAULTS = {
       'github_user' => ENV.fetch('USER'),
+      'gitlab_user' => ENV.fetch('USER'),
       'pr_autofill' => true,
       'pr_autostack' => nil,
       'color' => true,
@@ -27,6 +28,10 @@ class SugarJar
         SugarJar::Log.debug("Loading config #{f}")
         data = YAML.safe_load_file(f)
         warn_on_deprecated_configs(data, f)
+        if data['github_host']
+          data['forge_host'] = data['github_host'] if data['forge_host'].nil?
+          data.delete('github_host')
+        end
         # 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}")
@@ -41,14 +46,37 @@ class SugarJar
 
         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.',
+            "#{fname}: Not warning about deprecated option `#{opt}` 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.',
+          "#{fname}: contains deprecated option `#{opt}`. You can " +
+          'suppress this warning with `ignore_deprecated_options`.',
+        )
+      end
+
+      # github_host has special handling
+      return unless data['github_host']
+
+      if ignore_deprecated_options.include?('github_host')
+        SugarJar::Log.debug(
+          "#{fname}: Deprecated option `github_host` found, but not " +
+          'warning due to `ignore_deprecated_options` in that file.',
+        )
+      elsif data.key?('forge_host')
+        SugarJar::Log.warn(
+          "#{fname}: Deprecated option `github_host` found. " +
+          'Ignoring in favor of newer `force_host` option. You can ' +
+          'suppress this warning with `ignore_deprecated_options`.',
+        )
+      else
+        SugarJar::Log.warn(
+          "#{fname}: Deprecated option `github_host` found. " +
+          'Treating it as if it was `forge_host` for now. Please update ' +
+          'your config file to use this new option. You can suppress ' +
+          'this warning with `ignore_deprecated_options`.',
         )
       end
     end

data/lib/sugarjar/log.rb

@@ -1,5 +1,6 @@
 require 'mixlib/log'
 
+# rubocop:disable Style/OneClassPerFile
 module Mixlib
   module Log
     # A simple formatter so that 'info' is just like 'puts'
@@ -22,3 +23,4 @@ class SugarJar
     extend Mixlib::Log
   end
 end
+# rubocop:enable Style/OneClassPerFile

data/lib/sugarjar/util.rb

@@ -46,16 +46,36 @@ class SugarJar
       s
     end
 
-    def self.ghcli_nofail(*args)
-      SugarJar::Log.trace("Running: gh #{args.join(' ')}")
-      gh = which('gh')
-      s = Mixlib::ShellOut.new([gh] + args).run_command
-      if s.error? && s.stderr.include?('gh auth')
+    def self.ghcli_nofail(*)
+      forge_nofail('gh', *)
+    end
+
+    def self.ghcli(*)
+      s = ghcli_nofail(*)
+      s.error!
+      s
+    end
+
+    def self.glcli_nofail(*)
+      forge_nofail('glab', *)
+    end
+
+    def self.glcli(*)
+      s = glcli_nofail(*)
+      s.error!
+      s
+    end
+
+    def self.forge_nofail(cli, *args)
+      SugarJar::Log.trace("Running: #{cli} #{args.join(' ')}")
+      bin = which(cli)
+      s = Mixlib::ShellOut.new([bin] + args).run_command
+      if s.error? && s.stderr.include?("#{cli} auth")
         SugarJar::Log.info(
-          'gh was run but no github token exists. Will run "gh auth login" ' +
-          "to force\ngh to authenticate...",
+          'glab was run but no gitlab token exists. Will run ' +
+          '"glab auth login" to force\ngh to authenticate...',
         )
-        unless system(gh, 'auth', 'login', '-p', 'ssh')
+        unless system(bin, '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 ' +
@@ -67,12 +87,6 @@ class SugarJar
       s
     end
 
-    def self.ghcli(*)
-      s = ghcli_nofail(*)
-      s.error!
-      s
-    end
-
     def self.in_repo?
       s = git_nofail('rev-parse', '--is-inside-work-tree')
       !s.error? && s.stdout.strip == 'true'

data/lib/sugarjar/version.rb

@@ -1,3 +1,3 @@
 class SugarJar
-  VERSION = '2.0.1'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-12 00:00:00.000000000 Z
+date: 2026-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge