pivotal_git_scripts_3 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 354565aac90f300622fb17b2076096c9248bab6cdf17bad09968b2ea04e4dfd6
+  data.tar.gz: e3742432925e0d7bc1735072aec99c91cba867690ed30adbd105e6553161fbcf
+SHA512:
+  metadata.gz: 983c0495e8a566dde1b566f21c5d2f7df43289bb378fd00cc6e8f607e63aa1dd1e1ab82967ca41d1cc617585da3162dd2709871945fa42fd5ea8f126ef30ffb5
+  data.tar.gz: 650f6c6c69e2f696fa0355681f582554d2f4418b79b7e7457535b760b1e0a0e613f16f6cfdd5d187ef323b6b73c7d85218a52c605ea52d4bc66f764f702ffbc0

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# CHANGELOG
+
+## 1.4.0 - released 2015-01-15
+
+### `git pair-commit` explicitly sets the author name
+
+Before this change, git's user.name setting would override. In
+repositories where the user had previously run `git duet`, this meant
+that after a `git pair --global ...` the email was set correctly by `git
+pair-commit`, but the author name was not.
+
+[#62606550]
+
+### `git pair-commit` sets committer name and email
+
+[Finishes #62606550]
+
+### Add ability to use a custom email address per user
+
+    # include the following section to set custom email addresses for users
+    email_addresses:
+      zr: zach.robinson@example.com
+
+### Include the $HOME directory if it's not in the list of pwd ancestors
+
+This fixes the actual behavior to match the documentation, which states that the `.pairs` file may be in the user's home directory.

data/MIT.LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Pivotal Labs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+[![Build Status](https://travis-ci.org/pivotal/git_scripts.png)](https://travis-ci.org/pivotal/git_scripts)
+
+# Git Scripts
+
+These scripts are helpers for managing developer workflow when using git repos hosted on GitHub.  Install as a rubygem and they can be run as standard git commands like `git about`.
+
+## Gem Installation
+
+    gem install pivotal_git_scripts
+
+## System Wide Installation
+
+    cd /usr/local/bin && curl -L http://github.com/pivotal/git_scripts/tarball/master | gunzip | tar xvf - --strip=2
+
+## git-about
+
+`git about` shows settings set by `git pair` and `git project`
+
+## git-pair
+
+Configures git authors when pair programming.
+
+    git pair sp js
+    user.name=Josh Susser & Sam Pierson
+    user.email=pair+jsusser+sam@pivotallabs.com
+
+
+Create a `.pairs` config file in project root or your home folder.
+
+    # .pairs - configuration for 'git pair'
+    pairs:
+      # <initials>: <Firstname> <Lastname>[; <email-id>]
+      eh: Edward Hieatt
+      js: Josh Susser; jsusser
+      sf: Serguei Filimonov; serguei
+    email:
+      prefix: pair
+      domain: pivotallabs.com
+      no_solo_prefix: true
+    global: false  # Set to true for git-pair to change git configuration for all your projects
+
+
+By default this affects the current project (`.git/config`).
+Use the `--global` option or add `global: true` to your `.pairs` file to set the global git configuration for all projects (`~/.gitconfig`).
+
+Options are:
+
+    -g, --global                     Modify global git options instead of local
+    -v, --version                    Show Version
+    -h, --help                       Show this.
+    
+When you're done pairing, change git's configuration to use your personal details.
+
+    git pair <your-initials>
+
+## git-pair-commit
+
+Makes a git commit as normal, but chooses one of the pair members randomly to get credit for the commit on github (by setting the author email to that member's email address). The author name on the commit will list all members of the pair, as usual.
+
+If pair members have email addresses on different domains, you can specify them separately in your `.pairs` file.
+
+    pairs:
+      jd: Jane Doe
+      fb: Frances Bar
+    email_addresses:
+      jd: jane@awesome.local
+      fb: frances@foo.bar
+
+### Using git-pair-commit in RubyMine
+RubyMine already supports pointing at a custom location for your git executable in the Preferences -> Version Control -> Git
+![screen shot 2014-03-11 at 12 49 02 pm](https://f.cloud.github.com/assets/163532/2390097/49c3023e-a956-11e3-8aeb-dcba1a814309.png)
+The trick then is that `pair-commit` doesn't encompass all git functionality, so you can't just point RubyMine directly at it, you need something in the middle that will use `pair-commit` if the first arg is `commit`, otherwise just pass through. Here's a ruby script to do just that:
+```ruby
+#!/usr/bin/env ruby
+
+exit_code = if ARGV[1] == "commit"
+  system "git pair-commit #{ARGV[1..-1].join(" ")}"
+else
+  system "git #{ARGV.join(" ")}"
+end
+
+exit exit_code
+```
+Make sure it's executable.
+
+## git-project
+
+    $ git project pivots
+
+This script sets the user account you will use to access repos hosted on github.com.  It creates a symlink from `id_github_current` to `id_github_pivotal<project>`, which switches the SSH key you are currently using to access GitHub repos.  Make sure you have the following lines in your .ssh/config file:
+
+    Host github.com
+      User git
+      IdentityFile /Users/pivotal/.ssh/id_github_current
+
+Authors
+====
+Copyright (c) 2010 [Pivotal Labs](http://pivotallabs.com). This software is licensed under the MIT License.
+
+### [Contributors](https://github.com/pivotal/git_scripts/contributors)
+ - git-pair original author [Bryan Helmkamp](http://brynary.com)
+ - lots of pivots :)
+ - [James Sanders](https://github.com/jsanders)
+ - [Todd Persen](https://github.com/toddboom)

data/bin/git-about

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+user_name = `git config --get user.name`
+user_name = 'NONE' if user_name.strip.empty?
+
+user_email = `git config --get user.email`
+user_email = 'NONE' if user_email.strip.empty?
+
+begin
+  key_file = File.readlink(File.expand_path('~/.ssh/id_github_current'))
+  project = (key_file =~ /id_github_(\w+)/ ? Regexp.last_match(1) : 'NONE')
+rescue Errno::ENOENT
+  project = 'NONE'
+end
+
+puts "git user:       #{user_name}"
+puts "git email:      #{user_email}"
+puts "GitHub project: #{project}"

data/bin/git-pair

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__)) # this is required when running from /usr/local/bin
+require 'pivotal_git_scripts/git_pair'
+
+PivotalGitScripts::GitPair.main(ARGV)

data/bin/git-pair-commit

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__)) # this is required when running from /usr/local/bin
+require 'pivotal_git_scripts/git_pair'
+
+PivotalGitScripts::GitPair.commit(ARGV)

data/bin/git-project

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'socket'
+
+def check_ssh_config
+  return unless `grep -c id_github_current config`.to_i.zero?
+
+  puts <<-WARNING
+    You must edit your .ssh/config file to include:
+      Host github.com
+        User git
+        IdentityFile /Users/pivotal/.ssh/id_github_current
+  WARNING
+end
+
+project = ARGV[0] || Dir.pwd.split('/').last
+hostname = Socket.gethostname.split('.').first
+possible_id_files = [
+  "id_#{hostname}_github_pivotal#{project}",
+  "id_github_pivotal#{project}",
+  "id_github_#{project}"
+]
+
+Dir.chdir(File.expand_path('~/.ssh')) do
+  possible_id_files.each do |id_file|
+    next unless File.exist?(id_file)
+
+    `ln -sf #{id_file} id_github_current`
+    puts "Now using key #{id_file}"
+    check_ssh_config
+    exit 0
+  end
+  puts "Key not found. You must create a ssh key in ~/.ssh/ called #{possible_id_files[0..-2].join(', ')} or #{possible_id_files[-1]}"
+end

data/bin/git-superpull

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+git pull && git submodule init && git submodule update

data/lib/pivotal_git_scripts/git_pair.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+require 'pivotal_git_scripts/version'
+require 'yaml'
+require 'optparse'
+require 'pathname'
+
+module PivotalGitScripts
+  module GitPair
+    def self.main(argv)
+      runner = Runner.new
+      runner.main(argv)
+    end
+
+    def self.commit(argv)
+      runner = Runner.new
+      runner.commit(argv)
+    end
+
+    class GitPairException < Exception; end
+
+    class Runner
+      def main(argv)
+        git_dir = `git rev-parse --git-dir`.chomp
+        exit 1 if git_dir.empty?
+
+        options = parse_cli_options(argv)
+        initials = argv
+        config = read_pairs_config
+        global = !!(options[:global] || config['global'])
+
+        if initials.any?
+          author_names, email_ids = extract_author_names_and_email_ids_from_config(config, initials)
+          authors = pair_names(author_names)
+          git_config = { name: authors, initials: initials.sort.join(' ') }
+          git_config[:email] = build_email(email_ids, config['email']) unless no_email(config)
+          set_git_config global, git_config
+        else
+          git_config = { name: nil, initials: nil }
+          git_config[:email] = nil unless no_email(config)
+          set_git_config global, git_config
+          puts "Unset#{' global' if global} user.name, #{'user.email, ' unless no_email(config)}user.initials"
+        end
+
+        %i[name email initials].each do |key|
+          report_git_settings(git_dir, key)
+        end
+      rescue GitPairException => e
+        puts e.message
+        exit 1
+      end
+
+      def commit(argv)
+        if argv[0] == '-h'
+          puts 'Usage: git pair-commit [options_for_git_commit]'
+          puts ''
+          puts 'Commits changes to the repository using `git commit`, but randomly chooses the author email from the'
+          puts 'members of the pair. In order for GitHub to assign credit for the commit activity, the user\'s email'
+          puts 'must be linked in their GitHub account.'
+          exit 0
+        end
+
+        config = read_pairs_config
+        author_details = extract_author_details_from_config(config, current_pair_initials)
+        author_names = author_details.keys.map { |i| author_details[i][:name] }
+        authors = pair_names(author_names)
+        author_email = random_author_email(author_details)
+        puts "Committing under #{author_email}"
+        passthrough_args = argv.map { |arg| "'#{arg}'" }.join(' ')
+        env_variables = "GIT_AUTHOR_NAME='#{authors}' GIT_AUTHOR_EMAIL='#{author_email}' GIT_COMMITTER_NAME='#{authors}' GIT_COMMITTER_EMAIL='#{author_email}'"
+        system "#{env_variables} git commit #{passthrough_args}"
+      rescue GitPairException => e
+        puts e.message
+        exit 1
+      end
+
+      def current_pair_initials
+        initials = `git config user.initials`.strip.split(' ')
+        raise GitPairException, 'Error: No pair set. Please set your pair with `git pair ...`' if initials.empty?
+
+        initials
+      end
+
+      def parse_cli_options(argv)
+        options = {}
+        OptionParser.new do |opts|
+          # copy-paste from readme
+          opts.banner = <<BANNER.sub('<br/>', '')
+      Configures git authors when pair programming.
+
+          git pair sp js
+          user.name=Josh Susser and Sam Pierson
+          user.email=pair+jsusser+sam@pivotallabs.com
+
+
+      Create a `.pairs` config file in project root or your home folder.
+
+          # .pairs - configuration for 'git pair'
+          pairs:
+            # <initials>: <Firstname> <Lastname>[; <email-id>]
+            eh: Edward Hieatt
+            js: Josh Susser; jsusser
+            sf: Serguei Filimonov; serguei
+          # if email section is present, email will be set
+          # if you leave out the email config section, email will not be set
+          email:
+            prefix: pair
+            domain: pivotallabs.com
+            # no_solo_prefix: true
+          #global: true
+          # include the following section to set custom email addresses for users
+          #email_addresses:
+          #  zr: zach.robinson@example.com
+
+
+      By default this affects the current project (.git/config).<br/>
+      Use the `--global` option or add `global: true` to your `.pairs` file to set the global git configuration for all projects (~/.gitconfig).
+
+      Options are:
+BANNER
+          opts.on('-g', '--global', 'Modify global git options instead of local') { options[:global] = true }
+          opts.on('-v', '--version', 'Show Version') do
+            puts PivotalGitScripts::VERSION
+            exit
+          end
+          opts.on('-h', '--help', 'Show this.') do
+            puts opts
+            exit
+          end
+        end.parse!(argv)
+
+        options
+      end
+
+      def read_pairs_config
+        pairs_file_name = '.pairs'
+
+        directory = File.absolute_path(Dir.pwd)
+        candidate_directories = [directory]
+        until Pathname.new(directory).root?
+          directory = File.absolute_path(File.join(directory, '..'))
+          candidate_directories << directory
+        end
+        home = File.absolute_path(ENV['HOME'])
+        candidate_directories << home unless candidate_directories.include? home
+
+        pairs_file_path = candidate_directories
+                          .map { |d| File.join(d, '.pairs') }
+                          .find { |f| File.exist? f }
+
+        unless pairs_file_path
+          raise GitPairException, <<-INSTRUCTIONS
+      Could not find a .pairs file. Create a YAML file in your project or home directory.
+      Format: <initials>: <name>[; <email>]
+      Example:
+      # .pairs - configuration for 'git pair'
+      # place in project or home directory
+      pairs:
+        eh: Edward Hieatt
+        js: Josh Susser; jsusser
+        sf: Serguei Filimonov; serguei
+      email:
+        prefix: pair
+        domain: pivotallabs.com
+          INSTRUCTIONS
+        end
+
+        YAML.load_file(pairs_file_path)
+      end
+
+      def read_author_info_from_config(config, initials_ary)
+        initials_ary.map do |initials|
+          config['pairs'][initials.downcase] or
+            raise GitPairException,
+                  "Couldn't find author name for initials: #{initials}. Add this person to the .pairs file in your project or home directory."
+        end
+      end
+
+      def build_email(emails, config)
+        if config.is_a?(Hash)
+          prefix = config['prefix'] if !config['no_solo_prefix'] or emails.size > 1
+          "#{([prefix] + emails).compact.join('+')}@#{config['domain']}"
+        else
+          config
+        end
+      end
+
+      def random_author_email(author_details)
+        author_id = author_details.keys.sample
+        author_details[author_id][:email]
+      end
+
+      def set_git_config(global, options)
+        options.each do |key, value|
+          config_key = "user.#{key}"
+          arg = value ? %(#{config_key} "#{value}") : "--unset #{config_key}"
+          system(%(git config#{' --global' if global} #{arg}))
+        end
+      end
+
+      def report_git_settings(git_dir, key)
+        global = `git config --global --get-regexp '^user\.#{key}'`
+        local = `git config -f #{git_dir}/config --get-regexp '^user\.#{key}'`
+        puts "NOTE: Overriding global user.#{key} setting with local." if global.length > 0 && local.length > 0
+        puts "global: #{global}" if global.length > 0
+        puts "local:  #{local}" if local.length > 0
+      end
+
+      def extract_author_names_and_email_ids_from_config(config, initials)
+        authors = read_author_info_from_config(config, initials)
+        authors.sort!.uniq! # FIXME
+        authors.map do |a|
+          full_name, email_id = a.split(';').map(&:strip)
+          email_id ||= full_name.split(' ').first.downcase
+          [full_name, email_id]
+        end.transpose
+      end
+
+      def no_email(config)
+        !config.key? 'email'
+      end
+
+      def extract_author_details_from_config(config, initials)
+        details = {}
+
+        initials.each do |i|
+          info = read_author_info_from_config(config, [i]).first
+
+          full_name, email_id = info.split(';').map(&:strip)
+          email_id ||= full_name.split(' ').first.downcase
+
+          email = read_custom_email_address_from_config(config, i)
+          email ||= "#{email_id}@#{config['email']['domain']}"
+
+          details[i] = {
+            name: full_name,
+            email: email
+          }
+        end
+
+        details
+      end
+
+      def read_custom_email_address_from_config(config, initial)
+        return nil unless config['email_addresses']
+
+        config['email_addresses'][initial.downcase]
+      end
+
+      private
+
+      def pair_names(author_names)
+        [author_names[0..-2].join(', '), author_names.last].reject(&:empty?).join(' and ')
+      end
+    end
+  end
+end

data/lib/pivotal_git_scripts/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PivotalGitScripts
+  VERSION = '3.0.0'
+end

data/spec/cli_spec.rb

@@ -0,0 +1,449 @@
+# frozen_string_literal: true
+
+require 'unindent'
+
+describe 'CLI' do
+  before :all do
+    # use local scripts
+    ENV['PATH'] = "#{File.join(File.dirname(__FILE__), '..', 'bin')}:#{ENV['PATH']}"
+  end
+
+  def run(command, options = {})
+    output = `#{command}`
+    return output if $?.success?
+    return output if options[:fail]
+
+    message = "Unable to run #{command.inspect} in #{Dir.pwd}.\n#{output}"
+    warn "ERROR: #{message}"
+    raise message
+  end
+
+  def write(file, content)
+    File.open(file, 'w') { |f| f.write content }
+  end
+
+  around do |example|
+    dir = 'spec/tmp'
+    run "rm -rf #{dir}"
+    run "mkdir #{dir}"
+
+    # use fake home for .ssh hacks
+    run "mkdir #{dir}/home"
+    ENV['HOME'] = File.absolute_path("#{dir}/home")
+
+    Dir.chdir dir do
+      run 'touch a'
+      run 'git init'
+      run 'git add .'
+      run "git config user.email 'rspec-tests@example.com'"
+      run "git config user.name 'rspec test suite'"
+      run "git commit -am 'initial'"
+      run 'git config --unset user.email'
+      run 'git config --unset user.name'
+      example.run
+    end
+  end
+
+  describe 'about' do
+    it 'lists the user' do
+      run 'git config user.name NAME'
+      run('git about').should =~ /git user:\s+NAME/
+    end
+
+    it 'lists the user as NONE if there is none' do
+      run "git config user.name ''"
+      run('git about').should =~ /git user:\s+NONE/
+    end
+
+    it 'lists the email' do
+      run 'git config user.email EMAIL'
+      run('git about').should =~ /git email:\s+EMAIL/
+    end
+
+    it 'lists the email as NONE if there is none' do
+      run "git config user.email ''"
+      run('git about').should =~ /git email:\s+NONE/
+    end
+
+    it 'does not find a project' do
+      run('git about').should =~ /GitHub project:\s+NONE/
+    end
+
+    context 'with github project' do
+      before do
+        run 'mkdir home/.ssh'
+        run 'touch home/.ssh/id_github_foo'
+        run 'ln -s home/.ssh/id_github_foo home/.ssh/id_github_current'
+      end
+
+      it 'finds a project' do
+        run('git about').should =~ /GitHub project:\s+foo/
+      end
+    end
+  end
+
+  describe 'pair' do
+    def expect_config(result, name, initials, email, options = {})
+      global = 'cd /tmp && ' if options[:global]
+      run("#{global}git config user.name").should == "#{name}\n"
+      run("#{global}git config user.initials").should == "#{initials}\n"
+      run("#{global}git config user.email").should == "#{email}\n"
+
+      prefix = (options[:global] ? 'global: ' : 'local:  ')
+      result.should include "#{prefix}user.name #{name}"
+      result.should include "#{prefix}user.initials #{initials}"
+      result.should include "#{prefix}user.email #{email}"
+    end
+
+    def git_config_value(name, global = false)
+      global_prefix = 'cd /tmp && ' if global
+      `#{global_prefix}git config user.#{name}`
+    end
+
+    it 'prints help' do
+      result = run 'git-pair --help'
+      result.should include('Configures git authors when pair programming')
+    end
+
+    it 'prints version' do
+      result = run 'git pair --version'
+      result.should =~ /\d+\.\d+\.\d+/
+    end
+
+    context 'with .pairs file' do
+      before do
+        write '.pairs', <<-YAML.unindent
+          pairs:
+            ab: Aa Bb
+            bc: Bb Cc
+            cd: Cc Dd
+
+          email:
+            prefix: the-pair
+            domain: the-host.com
+        YAML
+      end
+
+      describe 'global' do
+        it 'sets pairs globally when global: true is set' do
+          write '.pairs', File.read('.pairs') + "\nglobal: true"
+          result = run 'git pair ab'
+          expect_config result, 'Aa Bb', 'ab', 'the-pair+aa@the-host.com', global: true
+        end
+
+        it 'sets pairs globally when --global is given' do
+          result = run 'git pair ab --global'
+          result.should include 'global: user.name Aa Bb'
+          expect_config result, 'Aa Bb', 'ab', 'the-pair+aa@the-host.com', global: true
+        end
+
+        it 'unsets global config when no argument is passed' do
+          run 'git pair ab --global'
+          run 'git pair ab'
+          result = run 'git pair --global'
+          # result.should include "Unset --global user.name, user.email and user.initials"
+          expect_config result, 'Aa Bb', 'ab', 'the-pair+aa@the-host.com'
+          result.should_not include('global:')
+        end
+      end
+
+      it 'can set a single user as pair' do
+        result = run 'git pair ab'
+        expect_config result, 'Aa Bb', 'ab', 'the-pair+aa@the-host.com'
+      end
+
+      it 'can set a 2 users as pair' do
+        result = run 'git pair ab bc'
+        expect_config result, 'Aa Bb and Bb Cc', 'ab bc', 'the-pair+aa+bb@the-host.com'
+      end
+
+      it 'can set n users as pair' do
+        result = run 'git pair ab bc cd'
+        expect_config result, 'Aa Bb, Bb Cc and Cc Dd', 'ab bc cd', 'the-pair+aa+bb+cc@the-host.com'
+      end
+
+      it 'prints names, email addresses, and initials in alphabetical order' do
+        result = run 'git pair ab cd bc'
+        expect_config result, 'Aa Bb, Bb Cc and Cc Dd', 'ab bc cd', 'the-pair+aa+bb+cc@the-host.com'
+      end
+
+      it 'can set a user with apostrophes as pair' do
+        write '.pairs', File.read('.pairs').sub('Aa Bb', "Pete O'Connor")
+        result = run 'git pair ab'
+        expect_config result, "Pete O'Connor", 'ab', 'the-pair+pete@the-host.com'
+      end
+
+      it 'fails when there is no .git in the tree' do
+        run 'rm -f /tmp/pairs'
+        run 'cp .pairs /tmp'
+        Dir.chdir '/tmp' do
+          result = run 'git pair ab 2>&1', fail: true
+          result.should include('Not a git repository (or any of the parent directories)')
+        end
+        run 'rm -f /tmp/pairs'
+      end
+
+      it 'finds .pairs file in lower parent folder' do
+        run 'mkdir foo'
+        Dir.chdir 'foo' do
+          result = run 'git pair ab'
+          expect_config result, 'Aa Bb', 'ab', 'the-pair+aa@the-host.com'
+        end
+      end
+
+      it 'unsets local config when no argument is passed' do
+        run 'git pair ab --global'
+        run 'git pair bc'
+        result = run 'git pair'
+        result.should include 'Unset user.name, user.email, user.initials'
+        expect_config result, 'Aa Bb', 'ab', 'the-pair+aa@the-host.com', global: true
+        result.should_not include('local:')
+      end
+
+      it 'uses hard email when given' do
+        write '.pairs', File.read('.pairs').sub(/email:.*/m, 'email: foo@bar.com')
+        result = run 'git pair ab'
+        expect_config result, 'Aa Bb', 'ab', 'foo@bar.com'
+      end
+
+      context 'when no email config is present' do
+        before do
+          write '.pairs', File.read('.pairs').sub(/email:.*/m, '')
+        end
+
+        it "doesn't set email" do
+          run 'git pair ab'
+          git_config_value('email').should be_empty
+        end
+
+        it "doesn't report about email" do
+          result = run 'git pair ab'
+          result.should_not include 'email'
+        end
+      end
+
+      it 'uses no email prefix when only host is given' do
+        write '.pairs', File.read('.pairs').sub(/email:.*/m, "email:\n  domain: foo.com")
+        result = run 'git pair ab'
+        expect_config result, 'Aa Bb', 'ab', 'aa@foo.com'
+      end
+
+      context 'when no no_solo_prefix is given' do
+        before do
+          write '.pairs',
+                File.read('.pairs').sub(/email:.*/m,
+                                        "email:\n  prefix: pairs\n  no_solo_prefix: true\n  domain: foo.com")
+        end
+
+        it 'uses no email prefix for single developers' do
+          result = run 'git pair ab'
+          expect_config result, 'Aa Bb', 'ab', 'aa@foo.com'
+        end
+
+        it 'uses email prefix for multiple developers' do
+          result = run 'git pair ab bc'
+          expect_config result, 'Aa Bb and Bb Cc', 'ab bc', 'pairs+aa+bb@foo.com'
+        end
+      end
+
+      it 'fails with unknown initials' do
+        result = run 'git pair xx', fail: true
+        result.should include("Couldn't find author name for initials: xx")
+      end
+
+      it 'uses alternate email prefix' do
+        write '.pairs', File.read('.pairs').sub(/ab:.*/, 'ab: Aa Bb; blob')
+        result = run 'git pair ab'
+        expect_config result, 'Aa Bb', 'ab', 'the-pair+blob@the-host.com'
+      end
+    end
+
+    context 'without a .pairs file in the tree' do
+      around do |example|
+        Dir.chdir '/tmp' do
+          run 'rm -f .pairs'
+          dir = 'git_stats_test'
+          run "rm -rf #{dir}"
+          run "mkdir #{dir}"
+          Dir.chdir dir do
+            run 'git init'
+            example.run
+          end
+          run "rm -rf #{dir}"
+        end
+      end
+
+      context 'and without a .pairs file in the home directory' do
+        it 'fails if it cannot find a pairs file' do
+          run 'git pair ab', fail: true
+        end
+
+        it 'prints instructions' do
+          result = run 'git pair ab', fail: true
+          result.should include('Could not find a .pairs file. Create a YAML file in your project or home directory.')
+        end
+      end
+
+      context 'but a .pairs file in the home directory' do
+        around do |example|
+          file = File.join(ENV['HOME'], '.pairs')
+          write file, <<-YAML.unindent
+            pairs:
+              ab: Aa Bb
+              bc: Bb Cc
+              cd: Cc Dd
+
+            email:
+              prefix: the-pair
+              domain: the-host.com
+          YAML
+
+          example.run
+
+          FileUtils.rm file
+        end
+
+        it 'loads the file' do
+          result = run 'git pair ab'
+          expect_config result, 'Aa Bb', 'ab', 'the-pair+aa@the-host.com'
+        end
+      end
+    end
+  end
+
+  describe 'pair-commit' do
+    before do
+      write '.pairs', <<-YAML.unindent
+          pairs:
+            ab: Aa Bb; abb
+            bc: Bb Cc; bcc
+            cd: Cc Dd; cdd
+
+          email:
+            prefix: the-pair
+            domain: the-host.com
+
+          email_addresses:
+            bc: test@other-host.com
+      YAML
+    end
+
+    context 'when a pair has been set' do
+      before do
+        run 'git pair ab cd'
+      end
+
+      def author_name_of_last_commit
+        (run 'git log -1 --pretty=%an').strip
+      end
+
+      def author_email_of_last_commit
+        (run 'git log -1 --pretty=%ae').strip
+      end
+
+      def committer_name_of_last_commit
+        (run 'git log -1 --pretty=%cn').strip
+      end
+
+      def committer_email_of_last_commit
+        (run 'git log -1 --pretty=%ce').strip
+      end
+
+      it 'makes a commit' do
+        git_pair_commit
+        output = run 'git log -1'
+        output.should include('Pair pare pear')
+      end
+
+      it "sets the author name to the pair's names" do
+        git_pair_commit
+        output = run 'git log -1 --pretty=%an'
+        output.strip.should eq('Aa Bb and Cc Dd')
+      end
+
+      it 'randomly chooses from pair and sets user.email' do
+        emails = 6.times.map do
+          git_pair_commit
+          author_email_of_last_commit
+        end.uniq
+        emails.should =~ ['abb@the-host.com', 'cdd@the-host.com']
+      end
+
+      context 'when git options are passed' do
+        it 'forwards those options to git' do
+          git_pair_commit
+          run 'git pair ab bc'
+          run 'git pair-commit --amend -C HEAD --reset-author'
+
+          output = run 'git log -1 --pretty=%an'
+          output.strip.should eq('Aa Bb and Bb Cc')
+        end
+      end
+
+      context 'when the pair is set globally and the local repo has custom user name and email' do
+        before do
+          run 'git pair --global ab cd'
+          run "git config user.name 'Betty White'"
+          run "git config user.email 'betty@example.com'"
+        end
+
+        it 'still makes the commit with the correct user name' do
+          git_pair_commit
+
+          author_name_of_last_commit.should eq('Aa Bb and Cc Dd')
+        end
+
+        it 'still makes the commit with the correct user email' do
+          git_pair_commit
+
+          %w[abb@the-host.com cdd@the-host.com].should include(author_email_of_last_commit)
+        end
+
+        it 'still makes the commit with the correct committer name' do
+          git_pair_commit
+
+          committer_name_of_last_commit.should eq('Aa Bb and Cc Dd')
+        end
+
+        it 'still makes the commit with the correct committer email' do
+          git_pair_commit
+
+          %w[abb@the-host.com cdd@the-host.com].should include(committer_email_of_last_commit)
+        end
+      end
+
+      context 'when one of the pair has a custom email address' do
+        before do
+          run 'git pair ab bc'
+        end
+
+        it 'uses that email address' do
+          emails = 6.times.map do
+            git_pair_commit
+            author_email_of_last_commit
+          end.uniq
+          emails.should =~ ['abb@the-host.com', 'test@other-host.com']
+        end
+      end
+    end
+
+    context 'when no pair has been set' do
+      it 'raises an exception' do
+        git_pair_commit.should include('Error: No pair set')
+      end
+    end
+
+    context 'when -h flag is passed' do
+      it 'shows the help message' do
+        results = run 'git pair-commit -h'
+        results.gsub(/\s+/, ' ').should include('randomly chooses the author email from the members of the pair')
+      end
+    end
+
+    def git_pair_commit
+      run "echo #{rand(100)} > b"
+      run 'git add b'
+      run 'git pair-commit -m "Pair pare pear"', fail: true
+    end
+  end
+end

data/spec/git_pair_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'pivotal_git_scripts/git_pair'
+
+describe PivotalGitScripts::GitPair::Runner do
+  let(:runner) { described_class.new }
+
+  describe 'set_git_config' do
+    it 'calls git config with pairs in the options' do
+      runner.should_receive(:system).with('git config user.foo "bar baz"')
+
+      runner.set_git_config(false, 'foo' => 'bar baz')
+    end
+
+    it 'can unset git config options' do
+      runner.should_receive(:system).with('git config --unset user.foo')
+
+      runner.set_git_config(false, 'foo' => nil)
+    end
+
+    it 'can handle multiple pairs in a hash' do
+      runner.should_receive(:system).with('git config --unset user.remove')
+      runner.should_receive(:system).with('git config user.ten "10"')
+
+      runner.set_git_config(false, 'remove' => nil, 'ten' => '10')
+    end
+
+    it 'supports a global option' do
+      runner.should_receive(:system).with('git config --global user.foo "bar baz"')
+
+      runner.set_git_config(true, 'foo' => 'bar baz')
+    end
+  end
+
+  describe 'read_author_info_from_config' do
+    it 'maps from the initials to the full name' do
+      config = {
+        'pairs' => {
+          'aa' => 'An Aardvark',
+          'tt' => 'The Turtle'
+        }
+      }
+
+      names = runner.read_author_info_from_config(config, %w[aa tt])
+      names.should =~ ['An Aardvark', 'The Turtle']
+    end
+
+    it 'exits when initials cannot be found' do
+      expect do
+        runner.read_author_info_from_config({ 'pairs' => {} }, ['aa'])
+      end.to raise_error(PivotalGitScripts::GitPair::GitPairException)
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: pivotal_git_scripts_3
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Pivotal Labs
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: These scripts are helpers for managing developer workflow when using
+  git repos hosted on GitHub.
+email:
+- gems@pivotallabs.com
+executables:
+- git-about
+- git-pair
+- git-pair-commit
+- git-project
+- git-superpull
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT.LICENSE
+- README.md
+- bin/git-about
+- bin/git-pair
+- bin/git-pair-commit
+- bin/git-project
+- bin/git-superpull
+- lib/pivotal_git_scripts/git_pair.rb
+- lib/pivotal_git_scripts/version.rb
+- spec/cli_spec.rb
+- spec/git_pair_spec.rb
+homepage: https://github.com/akkadaya/pivotal_git_scripts_3
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Developer git workflow convenience scripts
+test_files:
+- spec/cli_spec.rb
+- spec/git_pair_spec.rb