sugarjar 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c4dd59aaf4843033f5c38df43b3fdfa556298708bc7f437f2923e00f9133c8
-  data.tar.gz: 5edeeb730db94059fd10b115b192ed239782b797473eb3b1fcf5aa749ca23e95
+  metadata.gz: c9a62438fa0d483eb64cd28cb5de3e603d6907a353194fac8df0bc8cd51a55f1
+  data.tar.gz: ff816417124253671a07ffe4ee2c6cb066a3b8f3f6dc0bac439a667297b595bf
 SHA512:
-  metadata.gz: 3869512549691df320f1dc344424b65944cd8cb501e25cd1a982f9b8d4d92cf608531147a8c5eb7a7437eee7644683ef9cf57e6035c44b61e4d247eec3331e03
-  data.tar.gz: 159e663e59a6c2aa939a5e9aecb90ce811bb9a168476d842ced28eab7a9968b760daec22661455a7bdaf3ac75ecc11a1c706e2ea07a6368ab653bcc3a222a597
+  metadata.gz: a97436c810c10af47d507eeb8c29070da38927884aef6f6ffaa39a9476777ba88e4c176fdb69ab67a979c832c3d32339f1c848c97ef1f6ecd5dcf17025f2b9e0
+  data.tar.gz: 478d20bcc6c8ed561f2ab6294d38a0e3267a96f0e239a565e498b483505dff950ad1712931a777012141e955438bb5f082db75698eb478a36981666bba38af19

data/README.md

@@ -1,4 +1,4 @@
-# SugjarJar
+# SugarJar
 
 ![CI](https://github.com/jaymzh/sugarjar/workflows/CI/badge.svg)
 
@@ -12,84 +12,219 @@ 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.
 
-## Commands
+If you miss Mondrian or Phabrictor - this is the tool for you!
 
-### amend
+If you don't, there's a ton of useful stuff for everyone!
 
-Amend the current commit. Alias for `git commit --amend`.  Accepts other
-arguments such as `-a` or files.
+## Auto cleanup squash-merged branches
 
-### amendq, qamend
+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>`
+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.
 
-Same as `amend` but without changing the message. Alias for `git commit --amend
---no-edit`.
+Enter `sj bclean` - it determines of the contents of your branch has been merge
+and safely deletes if so.
 
-### bclean
+``` shell
+sj bclean
+```
+
+Will delete a branch, if it has been merged, **even if it was squash-merged**.
 
-If safe, delete the current branch. Unlike `git branch -d`, bclean can handle
-squash-merged branches. Think of it as a smarter `git branch -d`.
+You can pass it a branch if you'd like (it defaults to the branch you're on):
+`sj bclean <branch>`.
 
-### bcleanall
+But it gets better! You can use `sj bcleanall` to remove all branches that have
+been merged:
+
+```shell
+$ git branch
+* argparse
+  master
+  feature
+  hubhost
+$ git bcleanall
+Skipping branch argparse - there are unmerged commits
+Reaped branch feature
+Reaped branch hubhost
+```
 
-Walk all branches, and try to delete them if it's safe. See `bclean` for
-details.
+## Smarter clones and remotes
+
+There's a pattern to every new repo we want to contribute to. First we fork,
+then we clone the fork, then we add a remote of the upstream repo. It's
+monotonous. SugarJar does this for you:
+
+```shell
+sj smartclone jaymzh/sugarjar
+```
 
-### binfo
+(also `sj sclone`)
 
-Verbose information about the current branch.
+This will:
 
-### br
+* Make a fork of the repo, if you don't already have one
+* Clone your fork
+* Add the original as an 'upstream' remote
 
-Verbose branch list. An alias for `git branch -v`.
+Note that it takes `hub`s short-names for repos. No need to specify a full URL,
+just a $org/$repo.
 
-### feature
+Like `git clone`, `sj sclone` will accept an additional arguement as the
+destination directory to clone to. It will also pass any other unknown options
+to `git clone` under the hood.
 
-Create a "feature branch." It's morally equivalent to `git checkout -b` except
-it defaults to creating it based on some form of 'master' instead of your
-current branch. In order of preference it will be `upstream/master`,
-`origin/master`, or `master`, depending upon what remotes are available.
+## Work with stacked branches more easily
 
-### forcepush, fpush
+It's important to break changes into reviewable chunks, but working with
+stacked branches can be confusing. Enter `binfo` - it gives you a view of your
+current branch all the way up to master. In this example imagine we have a
+branch structure like:
 
-The same as `smartpush`, but uses `--force-with-lease`. This is a "safer" way
-of doing force-pushes and is the recommended way to push after rebasing or
-amending. Never do this to shared branches. Very convenient for keeping the
-branch behind a pull-request clean.
+```text
+                      +- test2.1
+                     /
+master --- test --- test2 --- test3
+```
 
-### lint
+This is what `binfo` on test3 looks like:
 
-Run any linters configured in `.sugarjar.yaml`.
+```shell
+$ sj binfo
+* e451865 (HEAD -> test3) test3
+* e545b41 (test2) test2
+* c808eae (test1) test1
+o 44cf9e2 (origin/master, origin/HEAD, master) Lint/gemspec cleanups
+```
 
-### smartclone, sclone
+while `binfo` on test2.1 looks like:
 
-A smart wrapper to `git clone` that handles forking and managing remotes for
-you.  It will clone a git repository using hub-style short name (`$org/$repo`).
-If the org of the repository is not the same as your github-user then it will
-fork the repo for you to your account (if not already done) and then setup your
-remotes so that `origin` is your fork and `upstream` is the upstream.
+```shell
+$ sj binfo
+* 36d0136 (HEAD -> test2.1) test2.1
+* e545b41 (test2) test2
+* c808eae (test1) test1
+o 44cf9e2 (origin/master, origin/HEAD, master) Lint/gemspec cleanups
+```
 
-### smartpush, spush
+## Have a better lint/unittest experience!
 
-A smart wrapper to `git push` that runs whatever is defined in `on_push` in
-`.sugarjar.yml`, and only pushes if they succeed.
+Ever made a PR, only to find out later that it failed tests because of some
+small lint issue? Not anymore! SJ can be configured to run things before
+pushing. For example,in the SugarJar repo, we have it run Rubocop (ruby lint)
+and Markdownlint "on_push". If those fail, it lets you know and doesn't push.
 
-It will also allow you to not specify a remote or branch, and will default to
-`origin` and whatever your current local branch name is.
+You can configure SugarJar to tell how how to run both lints and unittests for
+a given repo and if one or both should be run prior to pushing.
 
-### unit
+The details on the config file format is below, but we provide three commands:
 
-Run any unitests configured in `.sugarjar.yaml`.
+```shell
+git lint
+```
 
-### up
+Run all linters.
 
-Rebase the current branch on the branch it's tracking, or if it's tracking one
-then, otherise `upstream/master` if it exists, or `origin/master`.
+```shell
+git unit
+```
 
-### upall
+Run all unittests.
 
-Same as `up`, but for all branches.
+```shell
+git smartpush # or spush
+```
 
-## User Configuration
+Run configured push-time actions (nothing, lint, unit, both), and do not
+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
+`origin` remote and the same branch name you're on as the remote branch.
+
+## Cleaning up your own history
+
+Perhaps you contribute to a project that prefers to use merge commits, so you
+like to clean up your own history. This is often difficult to get right - a
+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
+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
+--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
+command is a mouthful! Enter `sj fpush`. It has all the smarts of `sj
+smartpush` (runs configured pre-push actions), but adds `--force-with-lease` to
+the command!
+
+## Better feature branches
+
+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.
+
+```shell
+$ git branch
+  master
+  test1
+  test2
+* test2.1
+  test3
+$ sj feature test-branch
+Created feature branch test-branch based on origin/master
+$ sj feature dependent-feature test-branch
+Created feature branch dependent-feature based on test-branch
+```
+
+## And more!
+
+See `sj help` for more commands!
+
+## Using SugarJar as a git wrapper
+
+SugarJar, by default, will pass any command it doesn't know straight to `hub`
+(which passes commands **it** doesn't know to `git`). As such you can alias it
+to `git` and just have a super-git.
+
+```shell
+$ alias git=sj
+$ git config -l | grep color
+color.diff=auto
+color.status=auto
+color.branch=auto
+color.branch.current=yellow reverse
+color.branch.local=yellow
+color.branch.remote=green
+$ git br
+* dependent-feature 44cf9e2 Lint/gemspec cleanups
+  master            44cf9e2 Lint/gemspec cleanups
+  test-branch       44cf9e2 Lint/gemspec cleanups
+  test1             c808eae [ahead 1] test1
+  test2             e545b41 test2
+  test2.1           c1831b3 test2.1
+  test3             e451865 test3
+```
+
+It's for this reason that SugarJar doesn't have conflicting command names. You
+can turn off fallthru by setting `fallthru: false` in your config.
+
+The only command we "override" is `version`, in which case we not only print
+our version, but also call `hub version` which prints its version and calls
+`git version` too!
+
+## Configuration
 
 Sugarjar will read in both a system-level config file
 (`/etc/sugarjar/config.yaml`) and a user-level config file
@@ -133,17 +268,41 @@ on_push:
   - lint
 ```
 
+## Enterprise GitHub
+
+Like `hub`, SugarJar supports GitHub Enterprise. In fact, we provide extra
+features just for it.
+
+We recommend the global or user config specify the `github_host`. However, most
+users will also have a few repos from upstream so always specifying a
+`github_host` is sub-optimal.
+
+So, when you overwrite the `github_host` on the command line, we go ahead and
+set the `hub.host` git config in that single repo so that it'll "just work"
+from there on out.
+
+In other words, assuming your global SJ config has `github_host:
+github.sample.com`, and the you clone sugarjar with:
+
+```shell
+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..
+
 ## FAQ
 
 Why the name SugarJar?
 
-It's mostly a backranym. Like jellyfish, I wanted two letters that were on
-home row on different sides of the keyboard to make it easy to type. I looked
-at the possible options that where there and not taken and tried to find one
-I could make an appropriate name out of. Since this utility adds lots of sugar
-to git and github, it seemed appropriate.
+It's mostly a backranym. Like jellyfish, I wanted two letters that were on home
+row on different sides of the keyboard to make it easy to type. I looked at the
+possible options that where there and not taken and tried to find one I could
+make an appropriate name out of. Since this utility adds lots of sugar to git
+and github, it seemed appropriate.
 
 Why did you use `hub` instead of the newer `gh` CLI?
 
-`gh` is less feature-rich (currently). I'm also considering making this optionally
-act as a wrapper to `hub` the way `hub` can be a wrapper to `git`.
+`gh` is still new and not yet as feature rich as `hub`. Also I wanted SugarJar
+to be able to be a git wrapper, and so wrapping `hub` allows us to do that but
+wrapping `gh` does not.

data/lib/sugarjar/commands.rb

@@ -22,6 +22,8 @@ class SugarJar
       SugarJar::Log.debug("Feature: #{name}, #{base}")
       die("#{name} already exists!") if all_branches.include?(name)
       base ||= most_master
+      base_pieces = base.split('/')
+      hub('fetch', base_pieces[0]) if base_pieces.length > 1
       hub('checkout', '-b', name, base)
       SugarJar::Log.info("Created feature branch #{name} based on #{base}")
     end
@@ -44,16 +46,16 @@ 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",
           )
         end
         # rubocop:enable Style/Next
       end
     end
 
-    def co(name)
+    def co(*args)
       assert_in_repo
-      hub('checkout', name)
+      hub('checkout', *args)
     end
 
     def br
@@ -82,7 +84,7 @@ class SugarJar
     def amend(*args)
       assert_in_repo
       # This cannot use shellout since we need a full terminal for the editor
-      exit(system('/usr/bin/git', 'commit', '--amend', *args))
+      exit(system(which('git'), 'commit', '--amend', *args))
     end
 
     def qamend(*args)
@@ -104,7 +106,7 @@ class SugarJar
         else
           SugarJar::Log.error(
             "Failed to rebase #{branch}, aborting that and moving to next " +
-            'branch'
+            'branch',
           )
           hub('rebase', '--abort')
         end
@@ -202,10 +204,15 @@ class SugarJar
         if current == @ghost
           SugarJar::Log.debug('Repo hub.host already set correctly')
         else
-          SugarJar::Log.info(
-            "Overwriting repo hub.host from #{current} to #{@ghhost}"
+          # Even though we have an explicit config, in most cases, it
+          # comes from a global or user config, but the config in the
+          # local repo we likely set. So we'd just constantly revert that.
+          SugarJar::Log.debug(
+            "Not overwriting repo hub.host. Already set to #{current}. " +
+            "To change it, run `git config --local --add hub.host #{@ghhost}`",
           )
         end
+        return
       end
       hub('config', '--local', '--add', 'hub.host', @ghhost)
     end
@@ -287,7 +294,7 @@ class SugarJar
       end
       if out.length.zero?
         SugarJar::Log.debug(
-          "cherry-pick shows branch #{branch} obviously safe to delete"
+          "cherry-pick shows branch #{branch} obviously safe to delete",
         )
         return true
       end
@@ -303,10 +310,10 @@ class SugarJar
       s = hub_nofail('merge', '--squash', branch)
       if s.error?
         cleanup_tmp_branch(tmpbranch, branch)
-        error(
+        SugarJar::Log.error(
           'Failed to merge changes into current master. 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."
+          "'git branch -D #{branch}' if it is safe to do so.",
         )
         return false
       end
@@ -317,12 +324,12 @@ class SugarJar
       cleanup_tmp_branch(tmpbranch, branch)
       if out.empty?
         SugarJar::Log.debug(
-          'After squash-merging, this branch appears safe to delete'
+          'After squash-merging, this branch appears safe to delete',
         )
         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 master',
         )
         false
       end

data/lib/sugarjar/config.rb

@@ -22,7 +22,9 @@ class SugarJar
       c = DEFAULTS.dup
       _find_ordered_files.each do |f|
         SugarJar::Log.debug("Loading config #{f}")
-        c.merge!(YAML.safe_load(File.read(f)))
+        data = YAML.safe_load(File.read(f))
+        # an empty file is a `nil` which you can't merge
+        c.merge!(YAML.safe_load(File.read(f))) if data
         SugarJar::Log.debug("Modified config: #{c}")
       end
       c

data/lib/sugarjar/util.rb

@@ -3,9 +3,32 @@ require_relative 'log'
 class SugarJar
   # Some common methods needed by other classes
   module Util
+    # Finds the first entry in the path for a binary and checks
+    # to make sure it's not us (i.e. we may be linked to as 'git'
+    # or 'hub', but when we are calling that, we don't want ourselves.
+    def which_nofail(cmd)
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |dir|
+        p = File.join(dir, cmd)
+        # if it exists, and it is executable and is not us...
+        if File.exist?(p) && File.executable?(p) &&
+           File.basename(File.realpath(p)) != 'sj'
+          return p
+        end
+      end
+      false
+    end
+
+    def which(cmd)
+      path = which_nofail(cmd)
+      return path if path
+
+      SugarJar::Log.fatal("Could not find #{cmd} in your path")
+      exit(1)
+    end
+
     def hub_nofail(*args)
       SugarJar::Log.trace("Running: hub #{args.join(' ')}")
-      Mixlib::ShellOut.new(['/usr/bin/hub'] + args).run_command
+      Mixlib::ShellOut.new([which('hub')] + args).run_command
     end
 
     def hub(*args)

data/lib/sugarjar/version.rb

@@ -1,3 +1,3 @@
 class SugarJar
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: yaml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: A git/github helper script