sugarjar 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22bcfbf2376fe2665d068e42a3a2263c13602ac0a534fc958efbedd959e89862
-  data.tar.gz: c817adecadb1c3886cc8b8cfb105a1f844e5cfb90f32f351c17647d28ab21e68
+  metadata.gz: 2820df2090fc51cb383edb67d4f4f450d659bed13da44cdf34c6fc9242084a10
+  data.tar.gz: 6571f45c6609aa80441cea9102da98f85fef8056bfe1e7bce1d566a6ce6e1bb3
 SHA512:
-  metadata.gz: 1e2d3c3cc050f9da5432333559e8338fcb9312fd42be1b254f31a9e553440f0c2f4b86da8d93ccc6c58f6647bed931808ba714a893a8e868e6d439b2e29e74b0
-  data.tar.gz: d74d2118706f4c3386b27a6a23bd594301c3c5621e2da72fd08c6dcd3e6c59917f0cef11cb9fad2c93f99e942ff175c512766510c8c510d7158240bd4d6ea3bc
+  metadata.gz: 953d1400363c4ddddf92fb4c0f0cbbe239c60b0c19c9a47726e99c8f8bca48008079b903e9c921886a26dfe0b4c0d4495d89ae15cd32a298cfa7b5bf78317bc5
+  data.tar.gz: bea7b4b10e735797c288b3bece8ddad975f0ebc35f264e732bdda2d583d9380f719b7f471d1df1640f1bcd6e76a3d39e36456fa18d8ede04a10de0c40355784a

data/Gemfile

@@ -5,5 +5,6 @@ gem 'sugarjar', :path => '.'
 
 group :test do
   gem 'mdl'
+  gem 'rspec'
   gem 'rubocop'
 end

data/README.md

@@ -246,17 +246,19 @@ troubleshoot configuration parsing.
 ## Repository Configuration
 
 Sugarjar looks for a `.sugarjar.yaml` in the root of the repository to tell it
-how to handle repo-specific things. Currently there are only three
-configurations accepted:
+how to handle repo-specific things. Currently there options are:
 
-* lint - A list of scripts to run on `sj lint`. These should be linters like
+* `lint` - A list of scripts to run on `sj lint`. These should be linters like
   rubocop or pyflake.
-* unit - A list of scripts to run on `sj unit`. These should be unittest
+* `unit` - A list of scripts to run on `sj unit`. These should be unittest
   runners like rspec or pyunit.
-* on_push - A list of types (`lint`, `unit`) of checks to run before pushing.
+* `on_push` - A list of types (`lint`, `unit`) of checks to run before pushing.
   It is highly recommended this is only `lint`. The goal here is to allow for
   the user to get quick stylistic feedback before pushing their branch to avoid
   the push-fix-push-fix loop.
+* `commit_template` - A path to a commit template to set in the `commit.template`
+  git config for this repo. Should be either a fully-qualified path, or a path
+  relative to the repo root.
 
 Example configuration:
 
@@ -267,8 +269,17 @@ unit:
   - scripts/unit
 on_push:
   - lint
+commit_template: .commit-template.txt
 ```
 
+### Commit Templates
+
+While GitHub provides a way to specify a pull-request template by putting the
+right file into a repo, there is no way to tell git to automatically pick up a
+commit template by dropping a file in the repo. Users must do something like:
+`git config commit.template <file>`. Making each developer do this is error
+prone, so this setting will automatically set this up for each developer.
+
 ## Enterprise GitHub
 
 Like `hub`, SugarJar supports GitHub Enterprise. In fact, we provide extra

data/bin/sj

@@ -147,7 +147,7 @@ argv_copy = ARGV.dup
 
 # We don't have options yet, but we need an instance of SJ in order
 # to list public methods. We will recreate it
-sj = SugarJar::Commands.new(options)
+sj = SugarJar::Commands.new(options.merge({ 'no_change' => true }))
 extra_opts = []
 
 # as with above, this can't go into 'options', until after we parse
@@ -209,8 +209,8 @@ end
 options = config.merge(options)
 
 # Recreate SJ with all of our options
-sj = SugarJar::Commands.new(options)
 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
 argv_copy.delete(subcommand)
@@ -227,7 +227,9 @@ if subcommand == 'help'
 end
 
 if is_valid_command
-  SugarJar::Log.debug("running #{subcommand}, #{extra_opts.join(', ')}")
+  SugarJar::Log.debug(
+    "running #{subcommand}; extra opts: #{extra_opts.join(', ')}",
+  )
   sj.send(subcommand.to_sym, *extra_opts)
 elsif options['fallthru']
   SugarJar::Log.debug("Falling thru to: hub #{ARGV.join(' ')}")

data/lib/sugarjar/commands.rb

@@ -15,7 +15,10 @@ class SugarJar
       @ghuser = options['github_user']
       @ghhost = options['github_host']
       @repo_config = SugarJar::RepoConfig.config
+      return if options['no_change']
+
       set_hub_host if @ghhost
+      set_commit_template if @repo_config['commit_template']
     end
 
     def feature(name, base = nil)
@@ -41,6 +44,7 @@ class SugarJar
 
     def bcleanall
       assert_in_repo
+      curr = current_branch
       all_branches.each do |branch|
         next if branch == 'master'
 
@@ -52,6 +56,13 @@ class SugarJar
         end
         # rubocop:enable Style/Next
       end
+
+      # Return to the branch we were on, or master
+      if all_branches.include?(curr)
+        hub('checkout', curr)
+      else
+        hub('checkout', 'master')
+      end
     end
 
     def co(*args)
@@ -130,7 +141,7 @@ class SugarJar
 
         org = File.basename(File.dirname(repo))
         if org == @ghuser
-          put 'Cloned forked or self-owned repo. Not creating "upstream".'
+          puts 'Cloned forked or self-owned repo. Not creating "upstream".'
           return
         end
 
@@ -155,7 +166,7 @@ class SugarJar
     end
 
     def unit
-      exit(1) unless run_check('lint')
+      exit(1) unless run_check('unit')
     end
 
     def smartpush(remote = nil, branch = nil)
@@ -218,6 +229,47 @@ class SugarJar
       hub('config', '--local', '--add', 'hub.host', @ghhost)
     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 = hub_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.",
+      )
+      hub(
+        'config', '--local', 'commit.template', @repo_config['commit_template']
+      )
+    end
+
     def run_check(type)
       unless @repo_config[type]
         SugarJar::Log.debug("No #{type} configured. Returning success")

data/lib/sugarjar/util.rb

@@ -28,7 +28,26 @@ class SugarJar
 
     def hub_nofail(*args)
       SugarJar::Log.trace("Running: hub #{args.join(' ')}")
-      Mixlib::ShellOut.new([which('hub')] + args).run_command
+      s = Mixlib::ShellOut.new([which('hub')] + args).run_command
+      # depending on hub version and possibly other things, STDERR
+      # is either "Requires authentication" or "Must authenticate"
+      if s.error? && s.stderr =~ /^(Must|Requires) authenticat/
+        SugarJar::Log.info(
+          'Hub was run but no github token exists. Will run "hub api user" ' +
+          "to force\nhub to authenticate...",
+        )
+        unless system(which('hub'), 'api', 'user')
+          SugarJar::Log.fatal(
+            'That failed, I will bail out. Hub needs to get a github ' +
+            'token. Try running "hub api user" (will list info about ' +
+            'your account) and try this again when that works.',
+          )
+          exit(1)
+        end
+        SugarJar::Log.info('Re-running original hub command...')
+        s = Mixlib::ShellOut.new([which('hub')] + args).run_command
+      end
+      s
     end
 
     def hub(*args)

data/lib/sugarjar/version.rb

@@ -1,3 +1,3 @@
 class SugarJar
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A git/github helper script