sugarjar 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2820df2090fc51cb383edb67d4f4f450d659bed13da44cdf34c6fc9242084a10
-  data.tar.gz: 6571f45c6609aa80441cea9102da98f85fef8056bfe1e7bce1d566a6ce6e1bb3
+  metadata.gz: 9fefe2bc9c94d95d3c869f8636bbabf433ec6196ae8d68b7ac131b4a955a882b
+  data.tar.gz: 5237f94836f686a0e82a8a18543b54179e7190ce874d481e59ae5fe685aa26d9
 SHA512:
-  metadata.gz: 953d1400363c4ddddf92fb4c0f0cbbe239c60b0c19c9a47726e99c8f8bca48008079b903e9c921886a26dfe0b4c0d4495d89ae15cd32a298cfa7b5bf78317bc5
-  data.tar.gz: bea7b4b10e735797c288b3bece8ddad975f0ebc35f264e732bdda2d583d9380f719b7f471d1df1640f1bcd6e76a3d39e36456fa18d8ede04a10de0c40355784a
+  metadata.gz: d8ade9a12c3ba79a5ba591123179a80aeff6db7cbd4ab48c42cc27ecd5f5f4c3bcd713b99a04654b7c28e4fca715c3f6535f9938a97f3c55fc41169791f8d6a6
+  data.tar.gz: cbe9733235652a2ee5d777e53eed4a0f7deb9ffdcb69b0825b89c7831c52e5317e1e854b61e038d1a27fd92c85326e560c287e9e162d3068abcd246bc0e9ee48

data/README.md

@@ -1,6 +1,7 @@
 # SugarJar
 
-![CI](https://github.com/jaymzh/sugarjar/workflows/CI/badge.svg)
+[![Lint](https://github.com/jaymzh/sugarjar/workflows/Lint/badge.svg)](https://github.com/jaymzh/sugarjar/actions?query=workflow%3ALint)
+[![DCO](https://github.com/jaymzh/sugarjar/workflows/DCO%20Check/badge.svg)](https://github.com/jaymzh/sugarjar/actions?query=workflow%3A%22DCO+Check%22)
 [![Gem Version](https://badge.fury.io/rb/sugarjar.svg)](https://badge.fury.io/rb/sugarjar)
 
 Welcome to SugarJar - a git/github helper. It leverages the amazing GitHub cli,
@@ -13,7 +14,7 @@ the Phabricator workflow this aims to bring to the GitHub workflow.
 In particular there are a lot of helpers for using a squash-merge workflow that
 is poorly handled by the standard toolsets.
 
-If you miss Mondrian or Phabrictor - this is the tool for you!
+If you miss Mondrian or Phabricator - this is the tool for you!
 
 If you don't, there's a ton of useful stuff for everyone!
 
@@ -21,7 +22,7 @@ If you don't, there's a ton of useful stuff for everyone!
 
 It is common for a PR to go back and forth with a variety of nits, lint fixes,
 typos, etc. that can muddy history. So many projects will "squash and merge"
-when they accept a pull request. Howevet, that means `git branch -d <branch>`
+when they accept a pull request. However, that means `git branch -d <branch>`
 doesn't work. Git will tell you the branch isn't fully merged. You can, of
 course `git branch -D <branch>`, but that does no safety checks at all, it
 forces the deletion.
@@ -74,7 +75,7 @@ This will:
 Note that it takes `hub`s short-names for repos. No need to specify a full URL,
 just a $org/$repo.
 
-Like `git clone`, `sj sclone` will accept an additional arguement as the
+Like `git clone`, `sj sclone` will accept an additional argument as the
 destination directory to clone to. It will also pass any other unknown options
 to `git clone` under the hood.
 
@@ -145,7 +146,7 @@ push if any of them fail.
 ## Better push defaults
 
 In addition to running pre-push tests for you `smartpush` also picks smart
-defaults for push. So if you `sj spush` with no arguements, it uses the
+defaults for push. So if you `sj spush` with no arguments, it uses the
 `origin` remote and the same branch name you're on as the remote branch.
 
 ## Cleaning up your own history
@@ -156,11 +157,11 @@ combination of rebases, amends and force pushes. We provide two commands here
 to help.
 
 The first is pretty straight forward and is basically just an alias: `sj
-amend`. It will ammend whatever you want to the most recent commit (just an
+amend`. It will amend whatever you want to the most recent commit (just an
 alias for `git commit --amend`). It has a partner `qamend` (or `amendq` if you
 prefer) that will do so without prompting to update your commit message.
 
-So now you've rebased or amended, pushing becomes challening. You can `git push
+So now you've rebased or amended, pushing becomes challenging. You can `git push
 --force`, but everyone knows that's incredibly dangerous. Is there a better
 way? There is! Git provides `git push --force-with-lease` - it checks to make
 sure you're up-to-date with the remote before forcing the push. But man that
@@ -174,7 +175,7 @@ When you want to start a new feature, you want to start developing against
 latest. That's why `sj feature` defaults to creating a branch against what we
 call "most master". That is, `upstream/master` if it exists, otherwise
 `origin/master` if that exists, otherwise `master`. You can pass in an
-additional arguement to base it off of something else.
+additional argument to base it off of something else.
 
 ```shell
 $ git branch

data/bin/sj

@@ -61,6 +61,20 @@ parser = OptionParser.new do |opts|
     options['log_level'] = level
   end
 
+  opts.on(
+    '--ignore-dirty',
+    'Tell command that check for a dirty repo to carry on anyway.',
+  ) do
+    options['ignore_dirty'] = true
+  end
+
+  opts.on(
+    '--ignore-prerun-failure',
+    'Ignore preprun failure on *push commands.',
+  ) do
+    options['ignore_prerun_failure'] = true
+  end
+
   opts.on('--version') do
     puts SugarJar::VERSION
     exit
@@ -119,6 +133,10 @@ COMMANDS:
               your account (if not already done) and then setup your remotes
               so that "origin" is your fork and "upstream" is the upstream.
 
+  smartpullrequest, smartpr, spr
+              A smart wrapper to "hub pull-request" that checks if your repo
+              is dirty before creating the pull request.
+
   smartpush, spush
               A smart wrapper to "git push" that runs whatever is defined in
               "on_push" in .sugarjar.yml, and only pushes if they succeed.
@@ -132,7 +150,7 @@ COMMANDS:
   upall
               Same as "up", but for all branches.
 
-  verson
+  version
               Print the version of sugarjar, and then run 'hub version'
               to show the hub and git versions.
 COMMANDS

data/lib/sugarjar/commands.rb

@@ -1,3 +1,5 @@
+require 'mixlib/shellout'
+
 require_relative 'util'
 require_relative 'repoconfig'
 require_relative 'log'
@@ -14,6 +16,8 @@ class SugarJar
       SugarJar::Log.debug("Commands.initialize options: #{options}")
       @ghuser = options['github_user']
       @ghhost = options['github_host']
+      @ignore_dirty = options['ignore_dirty']
+      @ignore_prerun_failure = options['ignore_prerun_failure']
       @repo_config = SugarJar::RepoConfig.config
       return if options['no_change']
 
@@ -37,7 +41,10 @@ class SugarJar
       name ||= current_branch
       # rubocop:disable Style/GuardClause
       unless clean_branch(name)
-        die("Cannot clean #{name} - there are unmerged commits")
+        die(
+          "Cannot clean #{name} - there are unmerged commits; use " +
+          "'git branch -D #{name}' to forcefully delete it.",
+        )
       end
       # rubocop:enable Style/GuardClause
     end
@@ -51,7 +58,8 @@ class SugarJar
         # rubocop:disable Style/Next
         unless clean_branch(branch)
           SugarJar::Log.info(
-            "Skipping branch #{branch} - there are unmerged commits",
+            "Skipping branch #{branch} - there are unmerged commits; use " +
+            "'git branch -D #{branch}' to forcefully delete it.",
           )
         end
         # rubocop:enable Style/Next
@@ -139,7 +147,8 @@ class SugarJar
         # Now that we have a repo, if we have a hub host set it.
         set_hub_host if @ghhost
 
-        org = File.basename(File.dirname(repo))
+        org = extract_org(repo)
+        SugarJar::Log.debug("Comparing org #{org} to ghuser #{@ghuser}")
         if org == @ghuser
           puts 'Cloned forked or self-owned repo. Not creating "upstream".'
           return
@@ -149,9 +158,10 @@ class SugarJar
         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', repo.gsub("#{org}/", "#{@ghuser}/"))
+          hub('remote', 'add', 'origin', forked_path(repo, @ghuser))
         else
           SugarJar::Log.info("Forked #{reponame} to #{@ghuser}")
         end
@@ -162,38 +172,25 @@ class SugarJar
     alias sclone smartclone
 
     def lint
+      assert_in_repo
       exit(1) unless run_check('lint')
     end
 
     def unit
+      assert_in_repo
       exit(1) unless run_check('unit')
     end
 
     def smartpush(remote = nil, branch = nil)
-      unless remote && branch
-        remote ||= 'origin'
-        branch ||= current_branch
-      end
-
-      if run_prepush
-        puts hub('push', remote, branch).stderr
-      else
-        SugarJar::Log.error('Pre-push checks failed. Not pushing.')
-      end
+      assert_in_repo
+      _smartpush(remote, branch, false)
     end
 
     alias spush smartpush
 
     def forcepush(remote = nil, branch = nil)
-      unless remote && branch
-        remote ||= 'origin'
-        branch ||= current_branch
-      end
-      if run_prepush
-        puts hub('push', '--force-with-lease', remote, branch).stderr
-      else
-        SugarJar::Log.error('Pre-push checks failed. Not pushing.')
-      end
+      assert_in_repo
+      _smartpush(remote, branch, true)
     end
 
     alias fpush forcepush
@@ -203,8 +200,86 @@ class SugarJar
       puts hub('version').stdout
     end
 
+    def smartpullrequest
+      assert_in_repo
+      if dirty?
+        SugarJar::Log.warn(
+          'Your repo is dirty, so I am not going to create a pull request. ' +
+          'You should commit or amend and push it to your remote first.',
+        )
+        exit(1)
+      end
+      system(which('hub'), 'pull-request')
+    end
+
+    alias spr smartpullrequest
+    alias smartpr smartpullrequest
+
     private
 
+    def _smartpush(remote, branch, force)
+      unless remote && branch
+        remote ||= 'origin'
+        branch ||= current_branch
+      end
+
+      if 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 not going to push. Please commit ' +
+            'or amend first.',
+          )
+          exit(1)
+        end
+      end
+
+      unless run_prepush
+        if @ignore_prerun_failure
+          SugarJar::Log.warn(
+            'Pre-push checks failed, but --ignore-prerun-failure was ' +
+            'specified, so carrying on anyway',
+          )
+        else
+          SugarJar::Log.error('Pre-push checks failed. Not pushing.')
+          exit(1)
+        end
+      end
+
+      args = ['push', remote, branch]
+      args << '--force-with-lease' if force
+      puts hub(*args).stderr
+    end
+
+    def dirty?
+      s = hub_nofail('diff', '--quiet')
+      s.error?
+    end
+
+    def extract_org(path)
+      if path.start_with?('http')
+        File.basename(File.dirname(path))
+      elsif path.start_with?('git@')
+        path.split(':')[1].split('/')[0]
+      else
+        # assume they passed in a hub-friendly name
+        path.split('/').first
+      end
+    end
+
+    def forked_path(path, username)
+      repo = if path.start_with?('http', 'git@')
+               File.basename(path)
+             else
+               "#{File.basename(path)}.git"
+             end
+      "git@github.com:#{username}/#{repo}"
+    end
+
     def set_hub_host
       return unless in_repo
 
@@ -213,7 +288,7 @@ class SugarJar
         SugarJar::Log.info("Setting repo hub.host = #{@ghhost}")
       else
         current = s.stdout
-        if current == @ghost
+        if current == @ghhost
           SugarJar::Log.debug('Repo hub.host already set correctly')
         else
           # Even though we have an explicit config, in most cases, it

data/lib/sugarjar/config.rb

@@ -13,7 +13,7 @@ class SugarJar
     def self._find_ordered_files
       [
         '/etc/sugarjar/config.yaml',
-        "#{ENV['HOME']}/.config/sugarjar/config.yaml"
+        "#{ENV['HOME']}/.config/sugarjar/config.yaml",
       ].select { |f| File.exist?(f) }
     end
 

data/lib/sugarjar/util.rb

@@ -29,23 +29,46 @@ class SugarJar
     def hub_nofail(*args)
       SugarJar::Log.trace("Running: hub #{args.join(' ')}")
       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.',
+      if s.error?
+        # depending on hub version and possibly other things, STDERR
+        # is either "Requires authentication" or "Must authenticate"
+        case s.stderr
+        when /^(Must|Requires) authenticat/
+          SugarJar::Log.info(
+            'Hub was run but no github token exists. Will run "hub api user" ' +
+            "to force\nhub to authenticate...",
           )
-          exit(1)
+          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
+        when /^fatal: could not read Username/
+          # On http(s) URLs, git may prompt for username/passwd
+          SugarJar::Log.info(
+            'Hub was run but git prompted for authentication. This probably ' +
+            "means you have\nused an http repo URL instead of an ssh one. It " +
+            "is recommended you reclone\nusing 'sj sclone' to setup your " +
+            "remotes properly. However, in the meantime,\nwe'll go ahead " +
+            "and re-run the command in a shell so you can type in the\n" +
+            'credentials.',
+          )
+          unless system(which('hub'), *args)
+            SugarJar::Log.fatal(
+              'That failed, I will bail out. You can either manually change ' +
+              'your remotes, or simply create a fresh clone with ' +
+              '"sj smartclone".',
+            )
+            exit(1)
+          end
+          SugarJar::Log.info('Re-running original hub command...')
+          s = Mixlib::ShellOut.new([which('hub')] + args).run_command
         end
-        SugarJar::Log.info('Re-running original hub command...')
-        s = Mixlib::ShellOut.new([which('hub')] + args).run_command
       end
       s
     end

data/lib/sugarjar/version.rb

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

data/sugarjar.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.email = ['phil@ipom.com']
   spec.license = 'Apache-2.0'
   spec.homepage = 'https://github.com/jaymzh/sugarjar'
+  spec.required_ruby_version = '>= 2.6.0'
   docs = %w{README.md LICENSE Gemfile sugarjar.gemspec}
   spec.extra_rdoc_files = docs
   spec.executables << 'sj'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -73,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="