edgecase-git-pair 0.2.0

data/.autotest

@@ -0,0 +1,5 @@
+Autotest.add_hook :initialize do |autotest|
+  [/\.git/, /pkg\//, /\.gemspec$/, /\.log$/].each do |regexp|
+    autotest.add_exception regexp
+  end
+end

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Kampmeier
+
+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.markdown

@@ -0,0 +1,51 @@
+# git-pair
+
+A git porcelain for changing `user.name` and `user.email` so you can commit as
+more than one author.
+
+## Usage
+
+Install the gem:
+
+    gem install edgecase-git-pair
+
+And here's how to use it! 
+
+    $ git pair
+
+    General Syntax:
+      git pair [reset | authors | options]
+
+    Options:
+        -a, --add AUTHOR                 Add an author. Format: "Author Name <author@example.com>"
+        -r, --remove NAME                Remove an author. Use the full name.
+        -d, --reset                      Reset current author to default (global) config
+
+    Switching authors:
+      git pair aa [bb]                   Where AA and BB are any abbreviation of an
+                                         author's name. You can specify one or more authors.
+
+    Current config:
+         Author list: Adam McCrea
+                      Jon Distad
+
+      Current author: Jon Distad + Adam McCrea
+       Current email: devs+jd+am@edgecase.com
+
+## How does it work?
+
+The list of authors is maintained in the global git configuration file.  
+The current author is set in the git configuration local to the project.
+The email address for a pair is generated using the default email address
+from the global configuration along with the developer abbreviations.
+
+## About this version
+
+This was forked from http://github.com/chrisk/git-pair.  Many thanks to
+Chris Kampmeier for the original version.  Our version added the --reset
+option, modified how email addresses are handled, and refactored much of 
+the code.
+
+## License
+
+Copyright (c) 2009 Chris Kampmeier. See `LICENSE` for details.

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "edgecase-git-pair"
+    gem.summary = "Configure git to commit as more than one author"
+    gem.description = "A git porcelain for pair programming. Changes " +
+                      "git-config's user.name and user.email settings so you " +
+                      "can commit as more than one author."
+    gem.email = "adam@edgecase.com"
+    gem.homepage = "http://github.com/edgecase/git-pair"
+    gem.authors = ["Chris Kampmeier", "Adam McCrea", "Jon Distad"]
+    gem.add_development_dependency "cucumber", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :features
+
+# Don't print commands when shelling out (for example, running Cucumber)
+RakeFileUtils.verbose(false)
+

data/bin/git-pair

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'git-pair'
+
+GitPair::Command.run!(ARGV)
+

data/config/cucumber.yml

@@ -0,0 +1,3 @@
+default: --format progress --color features
+autotest: --format pretty
+autotest-all: --profile default

data/features/adding_an_author.feature

@@ -0,0 +1,21 @@
+Feature: Adding an author
+  In order to commit as a pair
+  A user should be able to
+  add a name and email to the list of authors
+
+  Scenario: adding a name and email
+    When I add the author "Linus Torvalds <linus@example.org>"
+    Then `git pair` should display "Linus Torvalds" in its author list
+
+  Scenario: adding the same name and email twice
+    When I add the author "Linus Torvalds <linus@example.org>"
+    And I add the author "Linus Torvalds <linus@example.org>"
+    Then `git pair` should display "Linus Torvalds" in its author list only once
+    And the gitconfig should include "Linus Torvalds" in its author list only once
+
+  Scenario: adding the same name twice with different emails
+    When I add the author "Linus Torvalds <linus@example.org>"
+    And I add the author "Linus Torvalds <linus@example.com>"
+    Then `git pair` should display "Linus Torvalds" in its author list only once
+    And the gitconfig should include "Linus Torvalds" in its author list only once
+    And the gitconfig should include "linus@example.org" as the email of "Linus Torvalds"

data/features/removing_an_author.feature

@@ -0,0 +1,19 @@
+Feature: Adding an author
+  In order remove old pairing partners
+  A user should be able to
+  remove a name from the list of authors
+
+  Scenario: removing a name
+    When I add the author "Linus Torvalds <linus@example.org>"
+    And I add the author "Junio C Hamano <junio@example.org>"
+    And I remove the name "Junio C Hamano"
+    Then `git pair` should display the following author list:
+      | name           |
+      | Linus Torvalds |
+
+  Scenario: removing all names
+    When I add the author "Linus Torvalds <linus@example.org>"
+    And I add the author "Junio C Hamano <junio@example.org>"
+    And I remove the name "Linus Torvalds"
+    And I remove the name "Junio C Hamano"
+    Then `git pair` should display an empty author list

data/features/resetting_the_pair.feature

@@ -0,0 +1,7 @@
+
+  Scenario: resetting the current authors
+    Given I have added the author "Linus Torvalds <linus@example.org>"
+    And my global Git configuration is setup with user "Global User"
+    And I switch to the pair "LT"
+    When I reset the current authors
+    Then `git pair` should display "Global User" for the current author

data/features/step_definitions/config_steps.rb

@@ -0,0 +1,91 @@
+Given /^I have added the author "([^\"]*)"$/ do |name_and_email|
+  When %(I add the author "#{name_and_email}")
+end
+
+Given /^my global Git configuration is setup with user "([^\"]*)"$/ do |name|
+  git_config "--global user.name \"#{name}\""
+end
+
+Given /^my global Git configuration is setup with email "([^\"]*)"$/ do |email|
+  git_config "--global user.email \"#{email}\""
+end
+
+When /^I add the author "([^\"]*)"$/ do |name_and_email|
+  git_pair %(--add "#{name_and_email}")
+end
+
+When /^I remove the name "([^\"]*)"$/ do |name|
+  git_pair %(--remove "#{name}")
+end
+
+When /^I (?:try to )?switch to the pair "([^\"]*)"$/ do |abbreviations|
+  @output = git_pair abbreviations
+end
+
+When /^I reset the current authors$/ do 
+  git_pair '--reset'
+end
+
+Then /^`git pair` should display "([^\"]*)" in its author list$/ do |name|
+  output = git_pair
+  authors = authors_list_from_output(output)
+  assert authors.include?(name)
+end
+
+Then /^`git pair` should display "([^\"]*)" in its author list only once$/ do |name|
+  output = git_pair
+  authors = authors_list_from_output(output)
+  assert_equal 1, authors.select { |author| author == name}.size
+end
+
+Then /^`git pair` should display "([^\"]*)" for the current author$/ do |names|
+  output = git_pair
+  assert_equal names, current_author_from_output(output)
+end
+
+Then /^`git pair` should display "([^\"]*)" for the current email$/ do |email|
+  output = git_pair
+  assert_equal email, current_email_from_output(output)
+end
+
+Then /^the gitconfig should include "([^\"]*)" in its author list only once$/ do |name|
+  output = git_config
+  authors = output.split("\n").map { |line| line =~ /^git-pair\.authors=(.*) <[^>]+>$/; $1 }.compact
+  assert_equal 1, authors.select { |author| author == name}.size
+end
+
+Then /^the gitconfig should include "([^\"]*)" as the email of "([^\"]*)"$/ do |email, name|
+  output = git_config
+  authors = output.split("\n").map { |line| line =~ /^git-pair\.authors=.* <([^>]+)>$/; $1 }.compact
+  assert_equal 1, authors.select { |author| author == email}.size
+end
+
+Then /^`git pair` should display the following author list:$/ do |table|
+  output = git_pair
+  names = authors_list_from_output(output).map { |name| {"name" => name} }
+  table.diff! names
+end
+
+Then /^`git pair` should display an empty author list$/ do
+  output = git_pair
+  assert authors_list_from_output(output).empty?
+end
+
+Then /^the last command's output should include "([^\"]*)"$/ do |output|
+  assert @output.include?(output)
+end
+
+def authors_list_from_output(output)
+  output =~ /Author list: (.*?)\n\s?\n/im
+  $1.strip.split("\n").map { |name| name.strip }
+end
+
+def current_author_from_output(output)
+  output =~ /Current author: (.*?)\n/im
+  $1.strip
+end
+
+def current_email_from_output(output)
+  output =~ /Current email: (.*?)\n/im
+  $1.strip
+end

data/features/support/env.rb

@@ -0,0 +1,50 @@
+require 'tmpdir'
+require 'test/unit/assertions'
+World(Test::Unit::Assertions)
+
+
+module RepositoryHelper
+  # TODO: use 1.8.7's Dir.mktmpdir?
+  TEST_REPO_PATH         = File.join(Dir::tmpdir, "git-pair-test-repo")
+  TEST_REPO_DOT_GIT_PATH = "#{TEST_REPO_PATH}/.git"
+
+  PROJECT_PATH       = File.join(File.dirname(__FILE__), "../..")
+  GIT_PAIR           = "#{PROJECT_PATH}/bin/git-pair"
+  CONFIG_BACKUP_PATH = "#{PROJECT_PATH}/tmp"
+
+  def git_pair(options = "")
+    output = `HOME=#{TEST_REPO_PATH} GIT_DIR=#{TEST_REPO_DOT_GIT_PATH} && #{GIT_PAIR} #{options} 2>&1`
+    output.gsub(/\e\[\d\d?m/, '')  # strip any ANSI colors
+  end
+
+  def git_config(options = nil)
+    options ||= "--list"
+    `HOME=#{TEST_REPO_PATH} GIT_DIR=#{TEST_REPO_DOT_GIT_PATH} && git config #{options} 2>&1`
+  end
+
+  def backup_gitconfigs
+    FileUtils.mkdir_p CONFIG_BACKUP_PATH
+    FileUtils.cp File.expand_path("~/.gitconfig"), "#{CONFIG_BACKUP_PATH}/.gitconfig.backup"
+    FileUtils.cp "#{PROJECT_PATH}/.git/config", "#{CONFIG_BACKUP_PATH}/config.backup"
+  end
+
+  def restore_gitconfigs
+    FileUtils.cp "#{CONFIG_BACKUP_PATH}/config.backup",     "#{PROJECT_PATH}/.git/config"
+    FileUtils.cp "#{CONFIG_BACKUP_PATH}/.gitconfig.backup", File.expand_path("~/.gitconfig")
+    FileUtils.rm_rf CONFIG_BACKUP_PATH
+  end
+end
+
+World(RepositoryHelper)
+
+
+Before do
+  backup_gitconfigs
+  FileUtils.mkdir_p RepositoryHelper::TEST_REPO_PATH
+  `GIT_DIR=#{RepositoryHelper::TEST_REPO_DOT_GIT_PATH} && git init`
+end
+
+After do
+  FileUtils.rm_rf RepositoryHelper::TEST_REPO_PATH
+  restore_gitconfigs
+end

data/features/switching_authors.feature

@@ -0,0 +1,22 @@
+Feature: Switching authors
+  In order to indicate which authors are committing
+  A user should be able to
+  change the currently active pair
+
+  Scenario: No authors have been added
+    When I try to switch to the pair "AA BB"
+    Then the last command's output should include "Please add some authors first"
+
+  Scenario: Pairing with a single author
+    Given I have added the author "Linus Torvalds <linus@example.org>"
+    When I switch to the pair "LT"
+    Then `git pair` should display "Linus Torvalds" for the current author
+    And `git pair` should display "linus@example.org" for the current email
+
+  Scenario: Pairing with two authors
+    Given I have added the author "Linus Torvalds <linus@example.org>"
+    And I have added the author "Junio C Hamano <junio@example.org>"
+    And my global Git configuration is setup with email "devs@example.com"
+    When I switch to the pair "LT JCH"
+    Then `git pair` should display "Junio C Hamano + Linus Torvalds" for the current author
+    And `git pair` should display "devs+jch+lt@example.com" for the current email

data/lib/git-pair.rb

@@ -0,0 +1,12 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'git-pair/command'
+require 'git-pair/author'
+require 'git-pair/config'
+
+module GitPair
+
+  class NoMatchingAuthorsError < ArgumentError; end
+  class MissingConfigurationError < RuntimeError; end
+
+end

data/lib/git-pair/author.rb

@@ -0,0 +1,52 @@
+module GitPair
+  class Author
+    
+    def self.all
+      Config.all_author_strings.map { |string| new(string) }
+    end
+
+    def self.find_all(abbrs)
+      raise MissingConfigurationError, "Please add some authors first" if all.empty?
+      abbrs.map { |abbr| self.find(abbr) }
+    end
+
+    def self.find(abbr)
+      all.find { |author| author.match?(abbr) } || 
+        raise(NoMatchingAuthorsError, "no authors matched #{abbr}")
+    end
+
+    def self.email(authors)
+      if authors.length == 1
+        authors.first.email
+      else
+        initials_string = '+' + authors.map { |a| a.initials }.join('+')
+        Config.default_email.sub("@", "#{initials_string}@")
+      end
+    end
+
+    def self.exists?(author)
+      self.all.find { |a| a.name == author.name }
+    end
+
+    attr_reader :name, :email
+
+    def initialize(string)
+      string =~ /^(.+)\s+<([^>]+)>$/
+      @name = $1.to_s 
+      @email = $2.to_s
+    end
+
+    def <=>(other)
+      name.split.last <=> other.name.split.last
+    end
+
+    def initials
+      name.split.map { |word| word[0].chr }.join.downcase
+    end
+
+    def match?(abbr)
+      abbr.downcase == initials
+    end
+
+  end
+end

data/lib/git-pair/command.rb

@@ -0,0 +1,88 @@
+require 'optparse'
+
+module GitPair
+  module Command
+    extend self
+
+    C_BOLD, C_REVERSE, C_RED, C_RESET = "\e[1m", "\e[7m", "\e[91m", "\e[0m"
+
+    def run!(args)
+      parser = OptionParser.new do |opts|
+        opts.banner = highlight('General Syntax:')
+        opts.separator '  git pair [reset | authors | options]'
+
+        opts.separator ' '
+        opts.separator highlight('Options:')
+        opts.on '-a', '--add AUTHOR',    'Add an author. Format: "Author Name <author@example.com>"' do |author| 
+          Config.add_author Author.new(author)
+        end
+        opts.on '-r', '--remove NAME', 'Remove an author. Use the full name.' do |name| 
+          Config.remove_author name
+        end
+        opts.on '-d', '--reset', 'Reset current author to default (global) config' do
+          Config.reset
+        end
+
+        opts.separator ' '
+        opts.separator highlight('Switching authors:')
+        opts.separator '  git pair aa [bb]                   Where AA and BB are any abbreviation of an'
+        opts.separator ' '*37 + 'author\'s name. You can specify one or more authors.'
+
+        opts.separator ' '
+        opts.separator highlight('Current config:')
+        opts.separator author_list.split("\n")
+        opts.separator ' '
+        opts.separator current_author_info.split("\n")
+      end
+
+      authors = parser.parse!(args.dup)
+
+      if args.empty?
+        puts parser.help
+      elsif authors.empty?
+        puts author_list
+        puts
+        puts current_author_info
+      else
+        Config.switch Author.find_all(authors)
+        puts current_author_info
+      end
+
+    rescue OptionParser::MissingArgument
+      abort "missing required argument", parser.help
+    rescue OptionParser::InvalidOption, OptionParser::InvalidArgument => e
+      abort e.message.sub(':', ''), parser.help
+    rescue NoMatchingAuthorsError => e
+      abort e.message, "\n" + author_list
+    rescue MissingConfigurationError => e
+      abort e.message, parser.help
+    end
+
+    def author_list
+      "     #{bold 'Author list:'} #{Author.all.sort.map { |a| a.name }.join "\n                  "}"
+    end
+
+    def current_author_info
+      "  #{bold 'Current author:'} #{Config.current_author}\n" +
+      "   #{bold 'Current email:'} #{Config.current_email}\n "
+    end
+
+    def abort(error_message, extra = "")
+      super red(" Error: #{error_message}\n") + extra
+    end
+
+    def highlight(string)
+      "#{C_REVERSE}#{string}#{C_RESET}"
+    end
+
+    def bold(string)
+      "#{C_BOLD}#{string}#{C_RESET}"
+    end
+
+    def red(string)
+      "#{C_RED}#{C_REVERSE}#{string}#{C_RESET}"
+    end
+
+  end
+end
+

data/lib/git-pair/config.rb

@@ -0,0 +1,44 @@
+module GitPair
+  module Config
+    extend self
+
+    def all_author_strings
+      `git config --global --get-all git-pair.authors`.split("\n")
+    end
+
+    def add_author(author)
+      unless Author.exists?(author)
+        `git config --global --add git-pair.authors "#{author.name} <#{author.email}>"`
+      end
+    end
+
+    def remove_author(name)
+      `git config --global --unset-all git-pair.authors "^#{name} <"`
+      `git config --global --remove-section git-pair` if all_author_strings.empty?
+    end
+
+    def switch(authors)
+      authors.sort!
+
+      `git config user.name "#{authors.map { |a| a.name }.join(' + ')}"`
+      `git config user.email "#{Author.email(authors)}"`
+    end
+
+    def reset
+      `git config --remove-section user`
+    end
+
+    def default_email
+      `git config --global --get user.email`.strip
+    end
+
+    def current_author
+      `git config --get user.name`.strip
+    end
+
+    def current_email
+      `git config --get user.email`.strip
+    end
+
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: edgecase-git-pair
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Chris Kampmeier
+- Adam McCrea
+- Jon Distad
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-18 00:00:00 -05:00
+default_executable: git-pair
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A git porcelain for pair programming. Changes git-config's user.name and user.email settings so you can commit as more than one author.
+email: adam@edgecase.com
+executables: 
+- git-pair
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .autotest
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- bin/git-pair
+- config/cucumber.yml
+- features/adding_an_author.feature
+- features/removing_an_author.feature
+- features/resetting_the_pair.feature
+- features/step_definitions/config_steps.rb
+- features/support/env.rb
+- features/switching_authors.feature
+- lib/git-pair.rb
+- lib/git-pair/author.rb
+- lib/git-pair/command.rb
+- lib/git-pair/config.rb
+has_rdoc: true
+homepage: http://github.com/edgecase/git-pair
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Configure git to commit as more than one author
+test_files: []
+