git-utils 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc7e18850e6bd2ccc17a911e1884c00df08f8318686ccfd90970a8d6b323f7c2
-  data.tar.gz: 1bc5d574a523470425b0fefc1dcb69e80c58ffb0597cf575c22dfb987332f7d5
+  metadata.gz: 3e1c46d3c400bbc8d913745063c92a103b45b11e59cdd2bb494a099100b12d05
+  data.tar.gz: b2d4253cc25ec916282f1bfd9198f3017d6369bc55deb41b3a0161fb52bbd34c
 SHA512:
-  metadata.gz: e63b742743af06a52425ff7d4942740d5abd9e272e502b0593a0864b101022d41e2352ebb435719a400a69d6305c6f8fbc04aac95eb9cfd9f4500914764fc3d2
-  data.tar.gz: 56c86af4c83ac1a1af52cdca22a3386de105d6c00eca53b5dd01b3d9789cdaa6cb725022891b24735a5adf1abae7cab04aaa9ff7756f03e3bddf746bdc599bc7
+  metadata.gz: bff26db7b631b266ba97210256544ca7031efb99e4af1f9289414598c343d8f9762421e386921c58d3c00ad93a5bc03d7eed2e3e60dcc5b26d9f5411d71aee3a
+  data.tar.gz: 5ba1d70da71ae6b35afa1fa1dd7e8ceb36b2db348587b9a7adb910fc084f5a4933aefba765f2d0b9db2e96975083dcea99f99b9de74efd6c1472eb6e75fdfa34

data/README.md

@@ -2,27 +2,27 @@
 
 This repo contains some Git utility scripts. The highlights are `git open`, `git pull-request`, `git push-branch`, and `git undo`, which you’ll never understand how you did without.
 
-The commands are especially useful when combined with [pivotal-github](https://github.com/mhartl/pivotal-github) gem (which, despite its name, also works with Bitbucket).
-
-The `git-utils` used to be pure Bash scripts, but they are now available as a Ruby gem, both because Ruby is more powerful than bash and because now `git-utils` can be included more easily as a dependency for the [pivotal-github](https://github.com/mhartl/pivotal-github/) gem. As a result, installation is easy if you have RubyGems installed:
+`git-utils` used to be pure Bash scripts, but they are now available as a Ruby gem:
 
     gem install git-utils
 
+See below for more details on the commands defined by `git-utils`. To learn more about how to use Git itself, see the tutorial book and online course [*Learn Enough Git to Be Dangerous*](https://www.learnenough.com/git).
+
 ## Commands
 
 * `git amend`: alias for `git commit --amend`
 * `git bump`: makes a commit with the message `"Bump version number"`
-* `git cleanup`: deletes every branch already merged into current branch (apart from `master`, `staging`, `development`, and any branches listed in `~/.git-cleanup-preserved`). Pass the `-r` option to delete remote merged branches.
-* `git merge-into-branch [branch]`: merges current branch into given branch (defaults to `master`)
+* `git cleanup`: deletes every branch already merged into current branch (apart from `master`, `main`, `staging`, `development`, and any branches listed in `~/.git-cleanup-preserved`). Pass the `-r` option to delete remote merged branches.
+* `git merge-into-branch [branch]`: merges current branch into given branch (defaults to repo's default branch)
 * `git minor`: makes a commit with the message `"Make minor changes"`
-* `git open`: opens the remote page for the repo (OS X & Linux)
+* `git open`: opens the remote page for the repo (macOS & Linux)
 * `git polish`: makes a commit with the message `"Polish"`
-* `git pull-request`: pushes the branch and opens the remote page for issuing a new a pull request (OS X only)
+* `git pull-request`: pushes the branch and opens the remote page for issuing a new a pull request (macOS-only)
 * `git push-branch`: pushes the current branch up to origin
 * `git delete-remote-branch <branch>`: deletes the remote branch if it is safe to do so
 * `git switch <pattern>`: switches to the first branch matching the given pattern
-* `git sync [branch]`: syncs the given branch with the remote branch (defaults to master)
-* `git sync-fork`: syncs the `master` branch of a fork with the original upstream `master` (assumes upstream configuration as in “[Configuring a remote for a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork)”)
+* `git sync [branch]`: syncs the given branch with the remote branch (defaults to repo's default branch)
+* `git sync-fork`: syncs the default branch of a fork with the original upstream default (assumes upstream configuration as in “[Configuring a remote for a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork)”)
 * `git typo`: makes a commit with the message `"Fix typo"`
 * `git undo`: undoes the last commit
 * `git graph`: displays full repository history in graphical format; alias for `git log --graph --oneline --decorate --all --full-history --author-date-order --no-notes`
@@ -41,12 +41,12 @@ Some of these commands deserve further explanation.
 
 ### git merge-into-branch
 
-`git merge-into-branch [target]` merges the current branch into the target branch (defaults to `master`). On a branch called `add-markdown-support`, `git merge-into-branch` is equivalent to the following:
+`git merge-into-branch [target]` merges the current branch into the target branch (defaults to repo's default branch). On a branch called `add-markdown-support` in a repo with default branch `main`, `git merge-into-branch` is equivalent to the following:
 
-    $ git checkout master
+    $ git checkout main
     $ git merge --no-ff --log add-markdown-support
 
-Note that this effectively changes the default merge behavior from fast-forward to no-fast-forward, which makes it possible to use `git log` to see which of the commit objects together have implemented a feature on a particular branch. As noted in [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/),
+Note that this effectively changes the default merge behavior from fast-forward to no-fast-forward, which makes it possible to use `git log` to see which of the commit objects together have implemented a feature on a particular branch. As noted in [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/):
 
 > The `--no-ff` flag causes the merge to always create a new commit object, even if the merge could be performed with a fast-forward. This avoids losing information about the historical existence of a feature branch and groups together all commits that together added the feature… Yes, it will create a few more (empty) commit objects, but the gain is much bigger than that cost.
 
@@ -66,16 +66,16 @@ These options can be overriden (and thus restored to their defaults) by passing
 
 ### git sync
 
-`git sync [branch]` syncs the given local branch  with the remote branch (defaults to master). On a branch called `add-markdown-support`, `git sync` is equivalent to the following:
+`git sync [branch]` syncs the given local branch  with the remote branch (defaults to repo's default branch). On a branch called `add-markdown-support` in a repo with default branch `master`, `git sync` is equivalent to the following:
 
     $ git checkout master
     $ git pull
     $ git checkout add-markdown-support
 
-The main purpose of `git sync` is to prepare the current branch for merging with `master`:
+The main purpose of `git sync` is to prepare the current branch for merging with the default branch:
 
     $ git sync
-    $ git merge master
+    $ git merge master    # or `main`, etc.
 
 (This is essentially equivalent to
 

data/bin/git-cleanup

@@ -2,9 +2,9 @@
 require 'optparse'
 
 # Deletes (almost) every branch already merged into current branch.
-# Exceptions are `master`, `staging`, and `development`, and the current
-# branch, which are preserved. We also support custom configuration via the
-# `~/.git-cleanup-preserved` file.
+# Exceptions are `master`, `main`, `staging`, and `development`,
+# and the current branch, which are preserved.
+# We also support custom configuration via the `~/.git-cleanup-preserved` file.
 
 options = {}
 OptionParser.new do |opts|
@@ -15,7 +15,7 @@ OptionParser.new do |opts|
   end
 end.parse!
 
-preserved = "master|staging|development"
+preserved = "master|main|staging|development"
 preserved_file = File.join(Dir.home, '.git-cleanup-preserved')
 if File.exist?(preserved_file)
   additional_preserved = File.read(preserved_file).strip.split("\n")

data/lib/git-utils/command.rb

@@ -26,6 +26,27 @@ class Command
     @current_branch ||= `git rev-parse --abbrev-ref HEAD`.strip
   end
 
+  # Returns the default branch for the current repository.
+  # Command retrieved from
+  # https://stackoverflow.com/questions/28666357/git-how-to-get-default-branch
+  def default_branch
+    branch_name = `git symbolic-ref --short refs/remotes/origin/HEAD \
+                   | sed 's@^origin/@@'`.strip
+    if branch_name.empty?
+      $stderr.puts "Repository configuration error"
+      $stderr.puts "Missing reference to refs/remotes/origin/HEAD"
+      $stderr.puts "Run"
+      $stderr.puts
+      $stderr.puts "  git remote set-head origin <default branch>"
+      $stderr.puts
+      $stderr.puts "where <default branch> is the default branch name"
+      $stderr.puts "(typically `main`, `master`, or `trunk`)"
+      $stderr.puts "and then rerun the command"
+      exit(1)
+    end
+    @default_branch ||= branch_name
+  end
+
   # Returns the URL for the remote origin.
   def origin_url
     @origin_url ||= `git config --get remote.origin.url`.strip
@@ -95,4 +116,4 @@ class Command
     def deliver?
       options.deliver
     end
-end
+end

data/lib/git-utils/merge_branch.rb

@@ -28,8 +28,8 @@ class MergeBranch < Command
 
     # Returns the name of the branch to be merged into.
     # If there is anything left in the known options after parsing,
-    # that's the merge branch. Otherwise, it's master.
+    # that's the merge branch. Otherwise, it's the default branch.
     def target_branch
-      self.known_options.first || 'master'
+      self.known_options.first || default_branch
     end
 end

data/lib/git-utils/sync.rb

@@ -13,10 +13,10 @@ class Sync < Command
 
   # Returns a command appropriate for executing at the command line.
   def cmd
-    branch = self.known_options.first || 'master'
+    branch = self.known_options.first || default_branch
     c = ["git checkout #{branch}"]
     c << "git pull"
     c << "git checkout #{current_branch}"
     c.join("\n")
   end
-end
+end

data/lib/git-utils/sync_fork.rb

@@ -4,7 +4,7 @@ class SyncFork < Command
 
   def parser
     OptionParser.new do |opts|
-      opts.banner = "Usage: git sync-fork"
+      opts.banner = "Usage: git sync-fork [default]"
       opts.on_tail("-h", "--help", "this usage guide") do
         puts opts.to_s; exit 0
       end
@@ -13,9 +13,9 @@ class SyncFork < Command
 
   # Returns a command appropriate for executing at the command line.
   def cmd
-    c = ["git checkout master"]
+    c = ["git checkout #{default_branch}"]
     c << "git fetch upstream"
-    c << "git merge upstream/master"
+    c << "git merge upstream/#{default_branch}"
     c.join("\n")
   end
 end

data/lib/git-utils/version.rb

@@ -1,5 +1,5 @@
 module Git
   module Utils
-    VERSION = "2.1.0"
+    VERSION = "2.2.0"
   end
 end

data/spec/commands/merge_branch_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe MergeBranch do
 
   let(:command) { MergeBranch.new }
-  before { command.stub(:current_branch).and_return('tau-manifesto') }
+  before  { command.stub(:current_branch).and_return('tau-manifesto') }
   subject { command }
 
   its(:cmd) { should match /git merge/ }
@@ -19,6 +19,21 @@ describe MergeBranch do
     its(:cmd) { should match /git checkout master/ }
   end
 
+  describe "default branch" do
+    let(:command) { MergeBranch.new }
+
+    describe "for current real repo" do
+      subject { command.default_branch }
+      it { should match 'master' }
+    end
+
+    describe "for repo with different default" do
+      before  { command.stub(:default_branch).and_return('main') }
+      subject { command.default_branch }
+      it { should match 'main' }
+    end
+  end
+
   describe "with a custom development branch" do
     let(:command) { MergeBranch.new(['development']) }
     its(:cmd) { should match /git checkout development/ }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-utils
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Michael Hartl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-01 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies: []
 description: Add some Git utilities
 email:
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: See the README for full documentation