sugarjar 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b12b221b467eca9aeba30396d059870a82608120ce1739ded50b4aef55ce7ba
-  data.tar.gz: c84bcab24de60fc61a0241f7c2940d6da6d78bc7416fa3fb92500528a447f9c8
+  metadata.gz: a1c65749738fac53cfb69c3ec42007433f7598e3e43dd36e33217c8c0efbbb2e
+  data.tar.gz: 50288abc1d21962e793731a937a8dd886bd2674db269ed62fbb0f89bb4121850
 SHA512:
-  metadata.gz: e041cd65eb939ea1d2153bf13a8a019e05f194fcf6ce4326c69d62a2de9e34e1d036cf759c5ea17b5b42d8e7e159fc99d65ee75470580a4ed15a854fffc7c87f
-  data.tar.gz: 2c47c2920b6a774ffb83ef16761183ac7dbfcc808a6885335bbeeee5470a29ceff343df4e3748897ab4e8e681e7c7d8b9a5fc3c7ed4d44fafaa40dda6c08b300
+  metadata.gz: 97ca2433bccc9e15d8c86ab141fa74e8f441f62cdb2be16e3131e2dcf71b37319ed0399990a96cb8c34ee4c55e75f1eca8a652cd5c7031f272493eec3fdb0f9a
+  data.tar.gz: 5395379c1ca16bc50c900cd75a4b72665c0079dfe48f8717d38640d4ba610cc571c5f407333e088c0c387f19dc620039e3a406f03d6d6ea4a72a7348b98e7a41

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2020-present Phil Dibowitz
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -244,8 +244,8 @@ yaml file is a straight key-value pair of options without their '--'. For
 example:
 
 ```yaml
-debug: true
-github-user: jaymzh
+log_level: debug
+github_user: jaymzh
 ```
 
 In addition, the environment variable `SUGARJAR_DEBUG` can be defined to set
@@ -312,6 +312,22 @@ sj clone jaymzh/sugarjar --github-host githuh.com
 We will add the `hub.host` to the `sugarjar` clone so that future `hub` or `sj`
 commands work without needing to specify..
 
+## Installing
+
+There are many ways to install SugarJar. The easiest is to use one of the
+packages we provide in the
+[releases](https://github.com/jaymzh/sugarjar/releases) section. Currently we
+provide packages for Fedora, CentOS, Debian, and Ubuntu, but if you want
+others, file an Issue. Since these packages are
+[omnibus](https://github.com/chef/omnibus) packages which means they are bundled
+with all of their dependencies. This means these packages will likely work as-is
+on later releases of these distros or any similar distros.
+
+We also distribute SugarJar via [RubyGems](https://rubygems.org/gems/sugarjar/),
+so you can install it as a gem either via system ruby or via rvm/rbenv.
+
+Finally you can clone the git repo and run it from within the repo if you'd like.
+
 ## FAQ
 
 Why the name SugarJar?

data/bin/sj

@@ -182,19 +182,23 @@ extra_opts = []
 config = SugarJar::Config.config
 
 valid_commands = sj.public_methods - Object.public_methods
-
-is_valid_command = ARGV.any? { |arg| valid_commands.include?(arg.to_s.to_sym) }
+possible_valid_command = ARGV.any? do |arg|
+  valid_commands.include?(arg.to_s.to_sym)
+end
 
 # if we're configured to fall thru and the subcommand isn't one
 # we recognize, don't parse the options as they may be different
 # than git's. For example `git config -l` - we error because we
 # require an arguement to `-l`.
-if config['fallthru'] && !is_valid_command
+if config['fallthru'] && !possible_valid_command
   SugarJar::Log.debug(
     'Skipping option parsing: fall-thru is set and we do not recognize ' +
     'any subcommands',
   )
 else
+  SugarJar::Log.debug(
+    'We MIGHT have a valid command... parse-command line options',
+  )
   # We want to allow people to pass in extra args to be passed to
   # git commands, but OptionParser doesn't easily allow this. So we
   # loop over it, catching exceptions.
@@ -240,6 +244,7 @@ SugarJar::Log.level = options['log_level'].to_sym if options['log_level']
 sj = SugarJar::Commands.new(options)
 
 subcommand = argv_copy.reject { |x| x.start_with?('-') }.first
+is_valid_command = valid_commands.include?(subcommand.to_sym)
 argv_copy.delete(subcommand)
 SugarJar::Log.debug("subcommand is #{subcommand}")
 

data/lib/sugarjar/commands.rb

@@ -12,6 +12,8 @@ class SugarJar
   class Commands
     include SugarJar::Util
 
+    MAIN_BRANCHES = %w{master main}.freeze
+
     def initialize(options)
       SugarJar::Log.debug("Commands.initialize options: #{options}")
       @ghuser = options['github_user']
@@ -30,7 +32,7 @@ class SugarJar
       assert_in_repo
       SugarJar::Log.debug("Feature: #{name}, #{base}")
       die("#{name} already exists!") if all_branches.include?(name)
-      base ||= most_master
+      base ||= most_main
       base_pieces = base.split('/')
       hub('fetch', base_pieces[0]) if base_pieces.length > 1
       hub('checkout', '-b', name, base)
@@ -57,8 +59,8 @@ class SugarJar
       assert_in_repo
       curr = current_branch
       all_branches.each do |branch|
-        if branch == 'master'
-          SugarJar::Log.debug('Skipping master')
+        if MAIN_BRANCHES.include?(branch)
+          SugarJar::Log.debug("Skipping #{branch}")
           next
         end
 
@@ -73,11 +75,11 @@ class SugarJar
         end
       end
 
-      # Return to the branch we were on, or master
+      # Return to the branch we were on, or main
       if all_branches.include?(curr)
         hub('checkout', curr)
       else
-        hub('checkout', 'master')
+        checkout_main_branch
       end
     end
 
@@ -105,7 +107,7 @@ class SugarJar
       assert_in_repo
       SugarJar::Log.info(hub(
         'log', '--graph', '--oneline', '--decorate', '--boundary',
-        '--branches', "#{most_master}.."
+        '--branches', "#{most_main}.."
       ).stdout.chomp)
     end
 
@@ -113,13 +115,22 @@ class SugarJar
 
     def up
       assert_in_repo
+      # get a copy of our current branch, if rebase fails, we won't
+      # be able to determine it without backing out
+      curr = current_branch
       result = gitup
-      if result
-        SugarJar::Log.info(
-          "#{color(current_branch, :green)} rebased on #{result}",
+      if result['so'].error?
+        die(
+          "#{color(curr, :red)}: Failed to rebase on " +
+          "#{result['base']}. Leaving the repo as-is. You can get out of " +
+          'this with a `git rebase --abort`. Output from failed rebase is: ' +
+          "\nSTDOUT:\n#{result['so'].stdout.lines.map { |x| "\t#{x}" }.join}" +
+          "\nSTDERR:\n#{result['so'].stderr.lines.map { |x| "\t#{x}" }.join}",
         )
       else
-        die("#{color(current_branch, :red)}: Failed to rebase")
+        SugarJar::Log.info(
+          "#{color(current_branch, :green)} rebased on #{result['base']}",
+        )
       end
     end
 
@@ -139,20 +150,21 @@ class SugarJar
     def upall
       assert_in_repo
       all_branches.each do |branch|
-        next if branch == 'master'
+        next if MAIN_BRANCHES.include?(branch)
 
         hub('checkout', branch)
         result = gitup
-        if result
-          SugarJar::Log.info(
-            "#{color(branch, :green)} rebased on #{color(result, :green)}",
-          )
-        else
+        if result['so'].error?
           SugarJar::Log.error(
             "#{color(branch, :red)} failed rebase. Reverting attempt and " +
-            'moving to next branch',
+            'moving to next branch. Try `sj up` manually on that branch.',
           )
           hub('rebase', '--abort')
+        else
+          SugarJar::Log.info(
+            "#{color(branch, :green)} rebased on " +
+            color(result['base'], :green).to_s,
+          )
         end
       end
     end
@@ -180,12 +192,26 @@ class SugarJar
 
         s = hub_nofail('fork', '--remote-name=origin')
         if s.error?
-          # if the fork command failed, we already have one, so we have
-          # to swap the remote names ourselves
-          # newer 'hub's don't fail and do the right thing...
-          SugarJar::Log.info("Fork (#{@ghuser}/#{reponame}) detected.")
-          hub('remote', 'rename', 'origin', 'upstream')
-          hub('remote', 'add', 'origin', forked_repo(repo, @ghuser))
+          if s.stdout.include?('SAML enforcement')
+            SugarJar::Log.info(
+              'Forking the repo failed because the repo requires SAML ' +
+              "authentication. Full output:\n\n\t#{s.stdout}",
+            )
+            exit(1)
+          else
+            # In old versions of hub, it would fail if the upstream fork
+            # already existed. If we got an error, but didn't recognize
+            # that, we'll assume that's what happened and try to add the
+            # remote ourselves.
+            SugarJar::Log.info("Fork (#{@ghuser}/#{reponame}) detected.")
+            SugarJar::Log.debug(
+              'The above is a bit of a lie. "hub" failed to fork and it was ' +
+              'not a SAML error, so our best guess is that a fork exists ' +
+              'and so we will try to configure it.',
+            )
+            hub('remote', 'rename', 'origin', 'upstream')
+            hub('remote', 'add', 'origin', forked_repo(repo, @ghuser))
+          end
         else
           SugarJar::Log.info("Forked #{reponame} to #{@ghuser}")
         end
@@ -461,14 +487,22 @@ class SugarJar
       die('sugarjar must be run from inside a git repo') unless in_repo
     end
 
+    def main_branch
+      @main_branch = all_branches.include?('main') ? 'main' : 'master'
+    end
+
+    def checkout_main_branch
+      hub('checkout', main_branch)
+    end
+
     def clean_branch(name)
-      die('Cannot remove master branch') if name == 'master'
+      die("Cannot remove #{name} branch") if MAIN_BRANCHES.include?(name)
       SugarJar::Log.debug('Fetch relevant remote...')
       fetch_upstream
       return false unless safe_to_clean(name)
 
       SugarJar::Log.debug('branch deemed safe to delete...')
-      hub('checkout', 'master')
+      checkout_main_branch
       hub('branch', '-D', name)
       gitup
       true
@@ -477,8 +511,6 @@ class SugarJar
     def all_branches
       branches = []
       hub('branch', '--format', '%(refname)').stdout.lines.each do |line|
-        next if line == 'master'
-
         branches << line.strip.split('/')[2]
       end
       branches
@@ -502,7 +534,7 @@ class SugarJar
 
       # if the "easy" check didn't work, it's probably because there
       # was a squash-merge. To check for that we make our own squash
-      # merge to upstream/master and see if that has any delta
+      # merge to upstream/main and see if that has any delta
 
       # First we need a temp branch to work on
       tmpbranch = "_sugar_jar.#{Process.pid}"
@@ -512,7 +544,7 @@ class SugarJar
       if s.error?
         cleanup_tmp_branch(tmpbranch, branch)
         SugarJar::Log.debug(
-          'Failed to merge changes into current master. This means we could ' +
+          'Failed to merge changes into current main. This means we could ' +
           'not figure out if this is merged or not. Check manually and use ' +
           "'git branch -D #{branch}' if it is safe to do so.",
         )
@@ -530,7 +562,7 @@ class SugarJar
         true
       else
         SugarJar::Log.debug(
-          'After squash-merging, this branch is NOT fully merged to master',
+          'After squash-merging, this branch is NOT fully merged to main',
         )
         false
       end
@@ -555,9 +587,8 @@ class SugarJar
       SugarJar::Log.debug('Fetching upstream')
       fetch_upstream
       curr = current_branch
-      SugarJar::Log.debug('Rebasing')
       base = tracked_branch
-      if curr != 'master' && base == "origin/#{curr}"
+      if !MAIN_BRANCHES.include?(curr) && base == "origin/#{curr}"
         SugarJar::Log.warn(
           "This branch is tracking origin/#{curr}, which is probably your " +
           'downstream (where you push _to_) as opposed to your upstream ' +
@@ -566,8 +597,12 @@ class SugarJar
           'to do a "git branch -u upstream".',
         )
       end
+      SugarJar::Log.debug('Rebasing')
       s = hub_nofail('rebase', base)
-      s.error? ? nil : base
+      {
+        'so' => s,
+        'base' => base,
+      }
     end
 
     def tracked_branch
@@ -575,18 +610,18 @@ class SugarJar
         'rev-parse', '--abbrev-ref', '--symbolic-full-name', '@{u}'
       )
       if s.error?
-        most_master
+        most_main
       else
         s.stdout.strip
       end
     end
 
-    def most_master
+    def most_main
       us = upstream
       if us
-        "#{us}/master"
+        "#{us}/#{main_branch}"
       else
-        master
+        main_branch
       end
     end
 

data/lib/sugarjar/version.rb

@@ -1,3 +1,3 @@
 class SugarJar
-  VERSION = '0.0.9'.freeze
+  VERSION = '0.0.10'.freeze
 end

data/sugarjar.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mixlib-log'
   spec.add_dependency 'mixlib-shellout'
   spec.add_dependency 'pastel'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Phil Dibowitz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-21 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - phil@ipom.com
 executables:
@@ -78,8 +78,9 @@ files:
 homepage: https://github.com/jaymzh/sugarjar
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: A git/github helper script
 test_files: []