sugarjar 2.0.2 → 3.0.1

data/lib/sugarjar/commands/checks.rb

@@ -22,12 +22,12 @@ class SugarJar
           exit(1)
         end
       end
-      exit(1) unless run_check('lint')
+      exit(1) unless run_check('lint', false)
     end
 
     def unit
       assert_in_repo!
-      exit(1) unless run_check('unit')
+      exit(1) unless run_check('unit', false)
     end
 
     def get_checks_from_command(type)
@@ -71,7 +71,13 @@ class SugarJar
       @checks[type]
     end
 
-    def run_check(type)
+    # autorun is true when we're running from push, and false when someone
+    # ran 'lint' or 'unit' directly
+    #
+    # In the case of a autorun, if a linter changes the code, we require
+    # either the user amend, or bail out. If it's a manual run, then we
+    # allow them to just go on.
+    def run_check(type, autorun)
       repo_root = SugarJar::Util.repo_root
       Dir.chdir repo_root do
         checks = get_checks(type)
@@ -81,6 +87,7 @@ class SugarJar
 
         checks.each do |check|
           SugarJar::Log.debug("Running #{type} #{check}")
+          skip_redo = false
 
           short = check.split.first
           if short.include?('/')
@@ -104,10 +111,15 @@ class SugarJar
             )
             puts git('diff').stdout
             loop do
-              $stdout.print(
-                "\nWould you like to\n\t[q]uit and inspect\n\t[a]mend the " +
-                "changes to the current commit and re-run\n  > ",
-              )
+              options = [
+                '[q]uit and inspect',
+                '[a]mend the changes to the current commit and re-run',
+              ]
+              options << '[i]gnore the changes and keep going' unless autorun
+
+              msg = "\nWould you like to\n\t" + options.join("\n\t") + "\n  > "
+
+              $stdout.print(msg)
               ans = $stdin.gets.strip
               case ans
               when /^q/
@@ -118,9 +130,14 @@ class SugarJar
                 # break here, if we get out of this loop we 'redo', assuming
                 # the user chose this option
                 break
+              when /^i/
+                unless autorun
+                  skip_redo = true
+                  break
+                end
               end
             end
-            redo
+            redo unless skip_redo
           end
 
           if s.error?

data/lib/sugarjar/commands/debuginfo.rb

@@ -4,7 +4,7 @@ class SugarJar
   class Commands
     def debuginfo(*args)
       puts "sugarjar version #{SugarJar::VERSION}"
-      puts ghcli('version').stdout
+      puts forge('version').stdout
       puts git('version').stdout
 
       puts "Config: #{JSON.pretty_generate(args[0])}"

data/lib/sugarjar/commands/feature.rb

@@ -5,10 +5,32 @@ class SugarJar
       SugarJar::Log.debug("Feature: #{name}, #{base}")
       name = fprefix(name)
       die("#{name} already exists!") if all_local_branches.include?(name)
+      rel_branches = release_branches
       if base
-        fbase = fprefix(base)
-        base = fbase if all_local_branches.include?(fbase)
+        # If the user specified a base branch (sf mything base)
+        # we check if <base> is a release branch and if so, we make
+        # this track <upstream>/<base>
+        if rel_branches.include?(base)
+          newbase = "#{upstream}/#{base}"
+          SugarJar::Log.info(
+            "Base branch #{base} is a release branch, setting it to track " +
+            newbase,
+          )
+          base = newbase
+        else
+          fbase = fprefix(base)
+          base = fbase if all_local_branches.include?(fbase)
+        end
+      elsif rel_branches.include?(name)
+        # If the user did NOT specify a base *and* this new feature is
+        # a release branch, check it out tracking the upstream release
+        # branch instead of main
+        base = "#{upstream}/#{name}"
+        SugarJar::Log.info(
+          "Feature #{name} is a release branch, setting it to track #{base}",
+        )
       else
+        # otherwise, fallback to most-main
         base ||= most_main
       end
       # If our base is a local branch, don't try to parse it for a remote name
@@ -25,6 +47,7 @@ class SugarJar
     end
     alias f feature
 
+    # alias for "feature <current_branch>'
     def subfeature(name)
       assert_in_repo!
       SugarJar::Log.debug("Subfature: #{name}")

data/lib/sugarjar/commands/push.rb

@@ -43,7 +43,7 @@ class SugarJar
     def run_prepush
       @repo_config['on_push']&.each do |item|
         SugarJar::Log.debug("Running on_push check type #{item}")
-        unless run_check(item)
+        unless run_check(item, true)
           SugarJar::Log.info("[prepush]: #{item} #{color('failed', :red)}.")
           return false
         end

data/lib/sugarjar/commands/smartclone.rb

@@ -1,9 +1,15 @@
 class SugarJar
   class Commands
-    def smartclone(repo, dir = nil, *)
-      reponame = File.basename(repo, '.git')
-      dir ||= reponame
+    def smartclone(repo, *args)
       org = extract_org(repo)
+      reponame = extract_repo(repo)
+      dir = if args.length.positive? && !args.first.start_with?('-')
+              args.shift
+            else
+              reponame
+            end
+
+      forkname = @fork_name || reponame
 
       SugarJar::Log.info("Cloning #{reponame}...")
 
@@ -13,18 +19,69 @@ class SugarJar
       #
       # Unless the repo is in our own org and cannot be forked, then it
       # will fail.
-      if org == @ghuser
-        git('clone', canonicalize_repo(repo), dir, *)
-      else
-        ghcli('repo', 'fork', '--clone', canonicalize_repo(repo), dir, *)
+      if @use_forks && @forge_user != org
+        if @repo_forge == 'gitlab'
+          _gitlab_clone(org, repo, dir, forkname, *args)
+        else
+          forge(
+            'repo', 'fork', '--clone', canonicalize_repo(repo), dir,
+            '--fork-name', forkname, *args
+          )
+        end
+
         # make the main branch track upstream
         Dir.chdir dir do
           git('branch', '-u', "upstream/#{main_branch}")
         end
+      else
+        git('clone', canonicalize_repo(repo), dir, *args)
       end
 
       SugarJar::Log.info('Remotes "origin" and "upstream" configured.')
     end
     alias sclone smartclone
+
+    def _gitlab_clone(_org, repo, dir, forkname, *)
+      # The gitlab CLI is much less forgiving about already-forked
+      # repos, and it has no option to clone to a differently-named
+      # directory. So we have to special case it.
+
+      extract_repo(repo)
+
+      # glab requires a short-name for the fork command...
+      shortname = repo_shortname(repo)
+
+      # We call fork without --clone since --clone can't clone
+      # to another directory. Also, we must specify =false, or it
+      # will prompt
+      s = forge_nofail(
+        'repo', 'fork', shortname, '--clone=false', '--name', forkname
+      )
+
+      # It fails with:
+      #    409 {message: [Project namespace name has already been taken,
+      #         Name has already been taken, Path has already been taken]}
+      #
+      # when there's already a fork... or if you happen to have a name
+      # collision. There's no way to tell, so we assume it means we've
+      # already forked.
+      if s.error?
+        if s.stderr.include?(' 409 ')
+          SugarJar::Log.debug('Forking failed, probably already forked')
+        else
+          s.error!
+        end
+      end
+
+      # Now we clone ourselves...
+      git('clone', canonicalize_repo(repo), dir, *)
+      Dir.chdir dir do
+        # and then configure remotes properly
+        git('remote', 'rename', 'origin', 'upstream')
+
+        fork_url = forked_repo(repo, @forge_user)
+        git('remote', 'add', 'origin', fork_url)
+      end
+    end
   end
 end

data/lib/sugarjar/commands/smartpullrequest.rb

@@ -60,10 +60,25 @@ class SugarJar
 
       # <org>:<branch> is the GH API syntax for:
       #   look for a branch of name <branch>, from a fork in owner <org>
-      args.unshift('--head', "#{push_org}:#{curr}")
-      SugarJar::Log.trace("Running: gh pr create #{args.join(' ')}")
-      gh = SugarJar::Util.which('gh')
-      system(gh, 'pr', 'create', *args)
+      if @repo_forge == 'github'
+        # On GitHub, the head is the org and the *BRANCH* name to use as
+        # the head branch...
+        args.unshift('--head', "#{push_org}:#{curr}")
+      else
+        # On GitLab, the head is the repo (org/repo) to use as the head
+        # _repo_, and then branch is configured seperately (with -s), but
+        # we don't need that since it defaults to the local branch name.
+        #
+        # Then we need --yes for it to not prompt us
+        args.unshift('--head', "#{push_org}/#{repo_name}", '--yes')
+      end
+
+      bin = SugarJar::Util.which(_forge_cmd)
+      subcmd = _pr_cmd
+      SugarJar::Log.trace(
+        "Running: #{bin} #{subcmd} create #{args.join(' ')}",
+      )
+      system(bin, subcmd, 'create', *args)
     end
 
     alias spr smartpullrequest
@@ -71,6 +86,10 @@ class SugarJar
 
     private
 
+    def _pr_cmd
+      @repo_forge == 'gitlab' ? 'mr' : 'pr'
+    end
+
     def assert_common_main_branch!
       upstream_branch = main_remote_branch(upstream)
       unless main_branch == upstream_branch
@@ -84,10 +103,14 @@ class SugarJar
           "\tgit remote set-head #{upstream} -a",
         )
       end
-      return if upstream_branch == 'origin'
+
+      # If we don't have an upstream and an origin, we're done
+      return if upstream == 'origin'
 
       origin_branch = main_remote_branch('origin')
-      return if origin_branch == upstream_branch
+      # NOTE: that on GL, forks don't fork any branches by default, even
+      # a main one, so if it's 'nil', then ignore.
+      return if origin_branch.nil? || origin_branch == upstream_branch
 
       die(
         "The main branch of your upstream (#{upstream_branch}) and your " +

data/lib/sugarjar/commands/up.rb

@@ -53,21 +53,53 @@ class SugarJar
       end
     end
 
-    def sync
+    def fsync
+      sync(:force => true)
+    end
+    alias forcesync fsync
+
+    def sync(force: false)
       assert_in_repo!
       dirty_check!
 
       src = "origin/#{current_branch}"
       fetch('origin')
-      s = git_nofail('merge-base', '--is-ancestor', 'HEAD', src)
-      if s.error?
-        SugarJar::Log.debug(
-          "Choosing rebase sync since this isn't a direct ancestor",
-        )
-        rebase(src)
-      else
-        SugarJar::Log.debug('Choosing reset sync since this is an ancestor')
+      want_reset = false
+      if force
+        SugarJar::Log.debug('Forcing reset instead of rebase at user request')
+        want_reset = true
+      end
+
+      unless force
+        s = git_nofail('merge-base', '--is-ancestor', 'HEAD', src)
+        # if this IS an ancestor, we can just force reset.
+        #
+        # otherwise, we attempt a rebase to not lose anything (unless
+        # force is set)
+        if s.error?
+          SugarJar::Log.debug(
+            "Choosing rebase sync since this isn't a direct ancestor",
+          )
+        else
+          SugarJar::Log.debug('Choosing reset sync since this is an ancestor')
+          want_reset = true
+        end
+      end
+
+      if want_reset
         git('reset', '--hard', src)
+      else
+        rebase(src)
+        s = git_nofail('rev-parse', '--verify', 'REBASE_HEAD')
+        unless s.error?
+          SugarJar::Log.info(
+            'Rebase required input. You may continue the rebase from' +
+            ' here normally, or you may abort (`git rebase --abort`)' +
+            ' and instead to `sj fsync` to skip a rebase and force' +
+            ' reset to the remote branch.',
+          )
+          return
+        end
       end
       SugarJar::Log.info("Synced to #{src}.")
     end
@@ -85,7 +117,7 @@ class SugarJar
       # rubocop:enable Style/HashSyntax
       unless base
         SugarJar::Log.info(
-          'The brach we were tracking is gone, resetting tracking to ' +
+          'The branch we were tracking is gone, resetting tracking to ' +
           most_main,
         )
         git('branch', '-u', most_main)

data/lib/sugarjar/commands.rb

@@ -33,16 +33,32 @@ class SugarJar
       @pr_autofill = options['pr_autofill']
       @pr_autostack = options['pr_autostack']
       @feature_prefix = options['feature_prefix']
+      @use_forks = options['use_forks']
+      @fork_name = options['fork_name']
       @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 +68,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 +78,34 @@ 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?
+        url = remote_url_map.values.first
+        return extract_host(url)
+      end
+
+      @repo_forge == 'gitlab' ? 'gitlab.com' : 'github.com'
+    end
+
+    def repo_shortname(repo)
+      # if it's already a shortname, return
+      return repo unless repo.start_with?('http', 'git@')
+
+      repo_name = extract_repo(repo)
+      org_name = extract_org(repo)
+      [org_name, repo_name].join('/')
+    end
+
     def set_commit_template
       unless SugarJar::Util.in_repo?
         SugarJar::Log.debug('Skipping set_commit_template: not in repo')
@@ -137,7 +171,7 @@ class SugarJar
     end
 
     def determine_main_branch(branches)
-      branches.include?('main') ? 'main' : 'master'
+      branches.include?('master') ? 'master' : 'main'
     end
 
     def main_branch
@@ -263,7 +297,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
 
@@ -282,8 +316,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)
@@ -310,12 +344,12 @@ class SugarJar
 
     def extract_org(repo)
       if repo.start_with?('http')
-        File.basename(File.dirname(repo))
+        repo.split('://').last.split('/')[1..-2].join('/')
       elsif repo.start_with?('git@')
-        repo.split(':')[1].split('/')[0]
+        repo.split(':').last.split('/')[0..-2].join('/')
       else
-        # assume they passed in a ghcli-friendly name
-        repo.split('/').first
+        # assume they passed in a cli-friendly shortname
+        repo.split('/')[0..-2].join('/')
       end
     end
 
@@ -323,11 +357,23 @@ 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'])
@@ -373,12 +419,34 @@ class SugarJar
       SugarJar::Util.git_nofail(*, :color => @color)
     end
 
-    def ghcli(*)
-      SugarJar::Util.ghcli(*)
+    def _determine_forge_type
+      if SugarJar::Util.in_repo?
+        gl = remote_url_map.values.any? { |x| x.include?('gitlab') }
+        return gl ? 'gitlab' : 'github'
+      end
+
+      # if all else fails, guess GH
+      'github'
+    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,9 +7,11 @@ class SugarJar
   class Config
     DEFAULTS = {
       'github_user' => ENV.fetch('USER'),
+      'gitlab_user' => ENV.fetch('USER'),
       'pr_autofill' => true,
       'pr_autostack' => nil,
       'color' => true,
+      'use_forks' => true,
       'ignore_deprecated_options' => [],
     }.freeze
 
@@ -27,6 +29,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 +47,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