sugarjar 3.0.0 → 4.0.0

data/examples/sample_repoconfig.yaml

@@ -37,8 +37,11 @@ release_branches:
 # is assumed it is a relative path and `sj` will check that the file exists.
 
 lint:
+  # can be a string which is just a command to run...
   - scripts/run_rubocop.sh
-  - scripts/run_mdl.sh
+  # want it to have a pretty name? Entries can be a hash instead...
+  - name: mdl
+    command: scripts/run_mdl.sh
 
 # `unit` is a list of scripts to run when `sj unit` is executed (or, if
 # configured to run on `sj spush`/`sj fpush`- see `on_push` below).  Regardless
@@ -47,8 +50,11 @@ lint:
 # assumed it is a relative path and `sj` will check that the file exists.
 
 unit:
+  # like lint, supports bare strings...
   - bundle exec rspec
-  - scripts/run_tests.sh
+  # or hashes...
+  - name: unittests
+    command: scripts/run_tests.sh
 
 # `lint_list_cmd` is like `lint`, except it's a command to run which will
 # determine the proper lints to run and return them, one per line. This is
@@ -74,20 +80,3 @@ on_push: [lint] # or [lint, unit]
 # template configured.
 
 commit_template: .git_commit_template.txt
-
-# `github_user` is the user to use when talking to GitHub. Overrides any such
-# setting in the regular SugarJar config. Most useful when in the
-# `include_from` file.
-
-github_user: myuser
-
-# `gitlab_user` is the user to use when talking to GitLab. Overrides any such
-# setting in the regular SugarJar config. Most useful when in the
-# `include_from` file.
-
-gitlab_user: myuser
-
-# `forge_host` is the GitHub/GitLab host to use when talking to hosted versions
-# of these services.
-
-forge_host: github.sample.com

data/extras/sugarjar_completion.bash

@@ -10,26 +10,29 @@ _sugarjar_completions()
 
     local -a suggestions
 
-    # grap the feature_prefix if we have one so that we
-    # can let the user ignore that part. If we have `yq`
-    # we'll use it as that's going to be always 100%
-    # reliable, but if we don't, do our best with shell
-    # utils
-    local prefix=''
+    # grap any and all feature_prefixes so that we can let the user ignore that
+    # part. If we have `yq` we'll use it as that's going to be always 100%
+    # reliable, but if we don't, do our best with shell utils
+    local prefixes=''
     if [ -e "$SJCONFIG" ]; then
         if type yq &>/dev/null; then
-            prefix=$(yq .feature_prefix $SJCONFIG)
+            # We don't use the '// empty' syntax here as thats only in
+            # very new yq, so use the more standard '| select(. != null)'
+            yq_search='[.host_configs[].feature_prefix | select(. != null)] | unique[]'
+            prefixes=$(yq -r "$yq_search" $SJCONFIG | xargs)
         else
-            # the xargs removes extra spaces
-            prefix=$(grep feature_prefix $SJCONFIG | cut -f2 -d: | xargs)
+            prefixes=$(
+                grep feature_prefix $SJCONFIG | cut -f2 -d: | sort -u | xargs
+            )
         fi
     fi
 
     case "${COMP_WORDS[1]}" in
         co|checkout|bclean)
             local branches=$(git branch | sed -e 's/* //g' | xargs)
-            if [ -n "$prefix" ]; then
-                local branches=$(echo $branches | sed -e "s!$prefix!!g")
+            if [ -n "$prefixes" ]; then
+                regex=$(printf '%s\n' $prefixes | paste -sd'|')
+                local branches=$(echo $branches | sed -E "s!($regex)!!g")
             fi
             suggestions=($(compgen -W "$branches" -- "${COMP_WORDS[2]}"))
             COMPREPLY=("${suggestions[@]}")

data/lib/sugarjar/commands/checks.rb

@@ -1,4 +1,4 @@
-require_relative '../util'
+require_relative '../git'
 
 class SugarJar
   class Commands
@@ -7,7 +7,7 @@ class SugarJar
 
       # does not use dirty_check! as we want a custom message
       if dirty?
-        if @ignore_dirty
+        if @config['ignore_dirty']
           SugarJar::Log.warn(
             'Your repo is dirty, but --ignore-dirty was specified, so ' +
             'carrying on anyway. If the linter autocorrects, the displayed ' +
@@ -48,7 +48,21 @@ class SugarJar
         )
         return false
       end
-      s.stdout.split("\n")
+      output = s.stdout
+      if output.start_with?("---\n")
+        begin
+          checks = YAML.safe_load(s.stdout)
+          return checks
+        rescue Psych::SyntaxError => e
+          SugarJar::Log.error(
+            "#{type}_list_cmd (#{cmd}) produced invalid YAML: #{e.message}",
+          )
+          return false
+        end
+      end
+
+      # otherwise it's one line per command
+      output.split("\n")
     end
 
     # determine if we're using the _list_cmd and if so run it to get the
@@ -78,18 +92,26 @@ class SugarJar
     # 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
+      repo_root = SugarJar::Git.repo_root
       Dir.chdir repo_root do
         checks = get_checks(type)
-        # if we failed to determine the checks, the the checks have effectively
+        # if we failed to determine the checks, then the checks have effectively
         # failed
         return false unless checks
 
         checks.each do |check|
-          SugarJar::Log.debug("Running #{type} #{check}")
+          if check.is_a?(Hash)
+            command = check['command']
+            name = check['name'] || command.split.first
+          else
+            command = check
+            name = check.split.first
+          end
+
+          SugarJar::Log.debug("Running #{type} #{name}: #{command}")
           skip_redo = false
 
-          short = check.split.first
+          short = command.split.first
           if short.include?('/')
             short = File.join(repo_root, short) unless short.start_with?('/')
             unless File.exist?(short)
@@ -99,12 +121,12 @@ class SugarJar
             SugarJar::Log.error("Configured #{type} #{short} does not exist!")
             return false
           end
-          s = Mixlib::ShellOut.new(check).run_command
+          s = Mixlib::ShellOut.new(command).run_command
 
           # Linters auto-correct, lets handle that gracefully
           if type == 'lint' && dirty?
             SugarJar::Log.info(
-              "[#{type}] #{short}: #{color('Corrected', :yellow)}",
+              "[#{type}] #{name}: #{color('Corrected', :yellow)}",
             )
             SugarJar::Log.warn(
               "The linter modified the repo. Here's the diff:\n",
@@ -142,14 +164,14 @@ class SugarJar
 
           if s.error?
             SugarJar::Log.info(
-              "[#{type}] #{short} #{color('failed', :red)}, output follows " +
+              "[#{type}] #{name} #{color('failed', :red)}, output follows " +
               "(see debug for more)\n#{s.stdout}",
             )
             SugarJar::Log.debug(s.format_for_exception)
             return false
           end
           SugarJar::Log.info(
-            "[#{type}] #{short}: #{color('OK', :green)}",
+            "[#{type}] #{name}: #{color('OK', :green)}",
           )
         end
       end

data/lib/sugarjar/commands/debuginfo.rb

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

data/lib/sugarjar/commands/modernize_config.rb

@@ -0,0 +1,119 @@
+class SugarJar
+  class Commands
+    def modernizeconfig(config)
+      require 'tempfile'
+      require 'diffy'
+
+      data = YAML.safe_load_file(config)
+      data = _modernize(data).to_yaml
+      tfile = Tempfile.new('sugarjar')
+      tfile.write(data)
+      tfile.close
+      diff = Diffy::Diff.new(
+        config,
+        tfile.path,
+        :source => 'files',
+        :context => 2,
+        :include_diff_info => true,
+        :format => @config['color'] ? 'color' : 'text',
+      ).to_s
+      puts "Here is the diff from your existing config to the new one:\n"
+      puts diff
+      options = [
+        '[u]pdate my config, saving my old one to .bak',
+        '[w]rite new config to a temporary file for me to inspect',
+      ]
+      msg = "\nWould you like to\n\t" + options.join("\n\t") + "\n  > "
+      loop do
+        $stdout.print(msg)
+        ans = $stdin.gets.strip
+        case ans
+        when /^u/
+          old = "#{config}.bak"
+          File.rename(config, old)
+          File.write(config, data)
+          puts "#{config} updated. Old config in #{old}"
+          break
+        when /^w/
+          new = "#{config}.new"
+          File.write(new, data)
+          puts "New config written to #{new}"
+          break
+        end
+      end
+      tfile.unlink
+    end
+    alias fixconfig modernizeconfig
+
+    def _modernize(data)
+      data['host_configs'] ||= {}
+      data['host_configs']['default'] ||= {}
+
+      # First, take anything that used to be a top-level config
+      # that's now a host config and move it to host_configs->default
+      %w{use_forks feature_prefix}.each do |tlc|
+        # this needs to return true even if the value is false-y
+        next unless data.key?(tlc)
+
+        if data['host_configs']['default'][tlc]
+          if data['host_configs']['default'][tlc] != data[tlc]
+            SugarJar::Log.warn(
+              "host_configs->default->#{tlc} already set to something" +
+              " different than deprecated top-level #{tlc}, so just deleting" +
+              ' old top-level config.',
+            )
+          end
+        else
+          data['host_configs']['default'][tlc] = data[tlc]
+        end
+
+        # we delete it either way, just only warn if it's different
+        data.delete(tlc)
+      end
+
+      # Users move into the default config, plus other userless hosts
+      # of that type
+      %w{github gitlab}.each do |forge|
+        tlc = "#{forge}_user"
+        site = "#{forge}.com"
+        next unless data[tlc]
+
+        # start with the "default site" for this user (github.com/gitlab.com)
+        if data.dig('host_configs', site, 'user')
+          if data['host_configs'][site]['user'] != data[tlc]
+            SugarJar::Log.warn(
+              "host_configs->#{site}->user already set to something" +
+              " different than deprecated top-level #{tlc}, so just" +
+              ' deleting old top-level config.',
+            )
+          end
+        else
+          data['host_configs'][site] ||= {}
+          data['host_configs'][site]['user'] = data[tlc]
+        end
+
+        # now loop through any existing hosts that have been configured that
+        # are NOT those default hosts... IFthey don't have a user, populate
+        # with the relevant top-level user as in the old world, we would have
+        # fallen back to ${type}_user
+        data['host_configs'].each do |host, cfg|
+          next if host == site
+          next unless host.include?(forge)
+          next if cfg && cfg['user']
+
+          data['host_configs'][host] ||= {}
+          data['host_configs'][host]['user'] = data[tlc]
+        end
+
+        # and finally, delete the top-level config
+        data.delete(tlc)
+      end
+
+      # Remove any unused/deprecated configs.
+      #
+      # we don't use TOP_LEVEL_CONFIGS here as that includes things
+      # that are cli-only
+      data.slice(*SugarJar::Config::DEFAULTS.keys)
+    end
+  end
+end

data/lib/sugarjar/commands/push.rb

@@ -23,7 +23,7 @@ class SugarJar
       dirty_check!
 
       unless run_prepush
-        if @ignore_prerun_failure
+        if @config['ignore_prerun_failure']
           SugarJar::Log.warn(
             'Pre-push checks failed, but --ignore-prerun-failure was ' +
             'specified, so carrying on anyway',

data/lib/sugarjar/commands/smartclone.rb

@@ -1,9 +1,34 @@
 class SugarJar
   class Commands
-    def smartclone(repo, dir = nil, *)
-      reponame = extract_repo(repo)
-      dir ||= reponame
+    def smartclone(repo, *args)
       org = extract_org(repo)
+      reponame = extract_repo(repo)
+      host = extract_host(repo) || @config['default_forge_host']
+      unless host
+        raise 'Failed to determine host. Please specify --default-forge-host,' +
+              ' and file a bug.'
+      end
+      @host_config = gen_host_config(host)
+      raise 'Failed to determine forge_type' unless @host_config['forge_type']
+
+      # force object recreation - the initial creation would not
+      # have had the right data. Plus, we want it to check for the
+      # right cli
+      @forge = nil
+      forge
+
+      # set env vars of the host, just for completeness
+      # since it's short-lived we just set both vars
+      ENV['GH_HOST'] = host
+      ENV['GL_HOST'] = host
+
+      dir = if args.length.positive? && !args.first.start_with?('-')
+              args.shift
+            else
+              reponame
+            end
+
+      forkname = @config['fork_name'] || reponame
 
       SugarJar::Log.info("Cloning #{reponame}...")
 
@@ -13,37 +38,49 @@ class SugarJar
       #
       # Unless the repo is in our own org and cannot be forked, then it
       # will fail.
-      if org == @forge_user
-        git('clone', canonicalize_repo(repo), dir, *)
-      else
-        if @repo_forge == 'gitlab'
-          _gitlab_clone(org, repo, dir, *)
+      if @host_config['use_forks'] && @host_config['user'] != org
+        case forge.type
+        when 'gitlab', 'forgejo'
+          _separate_fork_clone(org, repo, dir, forkname, *args)
         else
-          forge('repo', 'fork', '--clone', canonicalize_repo(repo), dir, *)
+          forge.run(
+            '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, *)
+    def _separate_fork_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')
+      # For both gitlab and forgejo we fork without clone:
+      #   * gitlab - it cannot clone to a chosen directory
+      #   * forgjo - it doesn't have an option to fork and clone in one
+      #
+      # Also note that for gitlab we must be explicit, if we don't
+      # set --clone=false it will prompt.
+      repo_ref = forge.type == 'gitlab' ? shortname : repo
+      args = ['repo', 'fork', repo_ref, '--name', forkname]
+      args << '--clone=false' if forge.type == 'gitlab'
+      s = forge.run_nofail(*args)
 
       # It fails with:
       #    409 {message: [Project namespace name has already been taken,
@@ -53,7 +90,8 @@ class SugarJar
       # collision. There's no way to tell, so we assume it means we've
       # already forked.
       if s.error?
-        if s.stderr.include?(' 409 ')
+        if %w{gitlab forgejo}.include?(forge.type) &&
+           s.stderr.include?(' 409 ')
           SugarJar::Log.debug('Forking failed, probably already forked')
         else
           s.error!
@@ -66,7 +104,7 @@ class SugarJar
         # and then configure remotes properly
         git('remote', 'rename', 'origin', 'upstream')
 
-        fork_url = forked_repo(repo, @forge_user)
+        fork_url = forked_repo(repo, @host_config['user'])
         git('remote', 'add', 'origin', fork_url)
       end
     end

data/lib/sugarjar/commands/smartpullrequest.rb

@@ -19,17 +19,24 @@ class SugarJar
 
       curr = current_branch
       base = tracked_branch
-      if @pr_autofill
+      if @config['pr_autofill']
         SugarJar::Log.info('Autofilling in PR from commit message')
         num_commits = git(
           'rev-list', '--count', curr, "^#{base}"
         ).stdout.strip.to_i
-        if num_commits > 1
+        if num_commits > 1 && forge.type == 'github'
           args.unshift('--fill-first')
+        elsif forge.type == 'forgejo'
+          args += _forgejo_pr_opts
         else
           args.unshift('--fill')
         end
       end
+      base_opt = if forge.type == 'gitlab'
+                   '--target-branch'
+                 else
+                   '--base'
+                 end
       unless user_specified_base
         if subfeature?(base)
           if upstream_org != push_org
@@ -41,44 +48,39 @@ class SugarJar
               ' PR is rebased.',
             )
           # nil is prompt, true is always, false is never
-          elsif @pr_autostack.nil?
+          elsif @config['pr_autostack'].nil?
             $stdout.print(
               'It looks like this is a subfeature, would you like to base ' +
               "this PR on #{base}? [y/n] ",
             )
             ans = $stdin.gets.strip
-            args.unshift('--base', base) if %w{Y y}.include?(ans)
-          elsif @pr_autostack
-            args.unshift('--base', base)
+            args.unshift(base_opt, base) if %w{Y y}.include?(ans)
+          elsif @config['pr_autostack']
+            args.unshift(base_opt, base)
           end
         elsif base.include?('/') && base != most_main
           # If our base is a remote branch, then use that as the
           # base branch of the PR
-          args.unshift('--base', base.split('/').last)
+          args.unshift(base_opt, base.split('/').last)
         end
       end
 
       # <org>:<branch> is the GH API syntax for:
       #   look for a branch of name <branch>, from a fork in owner <org>
-      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
+      if forge.type == 'gitlab'
         # 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}/#{reponame}", '--yes')
+        args.unshift('--head', "#{push_org}/#{repo_name}", '--yes')
+      else
+        # On GitHub/Forgeji, the head is the org and the *BRANCH* name to use as
+        # the head branch...
+        args.unshift('--head', "#{push_org}:#{curr}")
       end
 
-      bin = SugarJar::Util.which(_forge_cmd)
-      subcmd = _pr_cmd
-      SugarJar::Log.trace(
-        "Running: #{bin} #{subcmd} create #{args.join(' ')}",
-      )
-      system(bin, subcmd, 'create', *args)
+      forge.run_with_system(_pr_cmd, 'create', *args)
     end
 
     alias spr smartpullrequest
@@ -87,7 +89,7 @@ class SugarJar
     private
 
     def _pr_cmd
-      @repo_forge == 'gitlab' ? 'mr' : 'pr'
+      forge.type == 'gitlab' ? 'mr' : 'pr'
     end
 
     def assert_common_main_branch!
@@ -103,7 +105,9 @@ 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')
       # NOTE: that on GL, forks don't fork any branches by default, even
@@ -119,5 +123,11 @@ class SugarJar
         'run to update this clone.',
       )
     end
+
+    def _forgejo_pr_opts
+      title = git('log', '-1', '--pretty=format:%s').stdout
+      body = git('show', '-s', '--format=%b').stdout
+      [title, "--body=#{body}"]
+    end
   end
 end