edsinclair-git-pair 0.3.0 → 0.4.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+script: rake

data/Gemfile

@@ -1,4 +1,2 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in git-pair.gemspec
-gemspec
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -1,5 +1,7 @@
 # git-pair
 
+<img src="https://travis-ci.org/edsinclair/git-pair.png?branch=master" height="14" alt="Retina-ready Shields example" />
+
 A git porcelain for changing `user.name` and `user.email` so you can commit as
 more than one author.
 
@@ -9,7 +11,7 @@ Install the gem:
 
     gem install edsinclair-git-pair
 
-And here's how to use it!
+Usage:
 
     $ git pair
 
@@ -29,20 +31,37 @@ And here's how to use it!
                                          author's name. You can specify one or more authors.
 
     Current config:
-         Author list: Adam McCrea
-                      Jon Distad
+         Author list: Adam McCrea <amccrea@example.org>
+                      Jon Distad <jdistad@example.net>
+
+         Pair email: devs@edgecase.com
 
       Current author: Jon Distad + Adam McCrea
-       Current email: devs+jd+am@edgecase.com
+       Current email: devs+jd+am@example.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 will be generated using the first author's email
-domain and the initials separated by a '+' will precede the '@'.
-Alternatively you can specify an email address to be used for pair commits.
-For example: if you specify pair@example.net the pair email address will be pair+aa+bb@example.net
+domain part and the address local parts separated by a '+' will precede the '@'.
+
+You can specify a 'pair' email address to be used in which case the local part
+will be followed by each author's initials separated by a '+' will be used to
+form the local part of the pair email address. Alternatively if you leave off
+the local part and specify the pair email address as '@domain.tld' the
+local part for the pair email will be composed of the local part for each 
+author's email address.
+
+Examples with the git pair email set:
+
+If the git pair email is: devs@example.com Then pair email address will be devs+am+jd@example.com
+If the git pair email is: @example.com Then pair email address will be amccrea+jdistad@example.com
+
+Examples without the git pair email set:
+
+First author is Adam McCrea. Then pair email address will be amccrea+jdistad@example.org
+First author is Jon Disatd. Then pair email address will be jdistad@+amccrea@example.net
 
 ## About this version
 
@@ -54,4 +73,5 @@ and --install-hook options and converts the gem to use Bundler for dependency ma
 
 ## License
 
-Copyright (c) 2009 Chris Kampmeier. See `LICENSE` for details.
+Copyright (c) 2009 Chris Kampmeier.
+Copyright (c) 2013 Eirik Dentz Sinclair. See `LICENSE` for details.

data/Rakefile

@@ -1,19 +1,17 @@
 require "rubygems"
 require "bundler"
 Bundler.setup
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
-  task :features
-rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
-end
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task :spec
 
-task :default => :features
+require "cucumber/rake/task"
+Cucumber::Rake::Task.new(:features)
+task :features
+
+task :default => [:spec, :features]
 
 # Don't print commands when shelling  out (for example, running Cucumber)
-RakeFileUtils.verbose(false)
+RakeFileUtils.verbose(false)

data/config/cucumber.yml

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

data/edsinclair-git-pair.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |s|
   s.name        = "edsinclair-git-pair"
   s.version     = GitPair::VERSION
   s.authors     = ["Chris Kampmeier", "Adam McCrea", "Jon Distad", "Eirik Dentz Sinclair", "Tim Gildea"]
-  s.email       = ["eirik@efficiency20.com"]
+  s.email       = ["eirikdentz@gmail.com"]
   s.homepage    = ""
-  s.date        = %q{2011-08-24}
+  s.date        = %q{2013-02-22}
   s.summary     = %q{Configure git to commit as more than one author}
   s.description = %q{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.}
 
@@ -19,5 +19,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.add_development_dependency "cucumber"
-  s.add_development_dependency "ruby-debug"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
 end

data/features/authors.feature

@@ -17,17 +17,17 @@ Feature: seeing authors on console
     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 specify the initials "LT JCH"
-    Then the last command's output should include "Linus Torvalds & Junio C Hamano <lt+jch@example.net>"
+    Then the last command's output should include "Linus Torvalds & Junio C Hamano <linus+junio@example.net>"
 
   Scenario: A single author and the pair email has been set
     Given I have set the pair email to "devs@widgets.com"
     And I have added the author "Linus Torvalds <linus@example.net>"
     When I specify the initials "LT"
-    Then the last command's output should include "Linus Torvalds <linus@example.net>"
+    Then the last command's output should include "Linus Torvalds <linus@widgets.com>"
 
   Scenario: Pairing with two authors and the pair email has been set
     Given I have set the pair email to "devs@widgets.com"
     And I have added the author "Linus Torvalds <linus@example.net>"
     And I have added the author "Junio C Hamano <junio@example.org>"
     When I specify the initials "LT JCH"
-    Then the last command's output should include "Linus Torvalds & Junio C Hamano <devs+lt+jch@widgets.com>"
+    Then the last command's output should include "Linus Torvalds & Junio C Hamano <devs+lt+jch@widgets.com>"

data/features/step_definitions/config_steps.rb

@@ -1,5 +1,5 @@
 Given /^I have added the author "([^\"]*)"$/ do |name_and_email|
-  When %(I add the author "#{name_and_email}")
+  step %(I add the author "#{name_and_email}")
 end
 
 Given /^my global Git configuration is setup with user "([^\"]*)"$/ do |name|

data/features/support/env.rb

@@ -24,20 +24,35 @@ module RepositoryHelper
 
   def backup_gitconfigs
     FileUtils.mkdir_p CONFIG_BACKUP_PATH
-    FileUtils.cp File.expand_path("~/.gitconfig"), "#{CONFIG_BACKUP_PATH}/.gitconfig.backup"
+    backup_user_gitconfig
     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.cp "#{CONFIG_BACKUP_PATH}/config.backup", "#{PROJECT_PATH}/.git/config"
+    restore_user_gitconfig
     FileUtils.rm_rf CONFIG_BACKUP_PATH
   end
+
+  def backup_user_gitconfig
+    FileUtils.cp(gitconfig_path, gitconfig_backup_path) if File.exists?(gitconfig_path)
+  end
+
+  def restore_user_gitconfig
+    FileUtils.cp(gitconfig_backup_path, gitconfig_path) if File.exists?(gitconfig_backup_path)
+  end
+
+  def gitconfig_backup_path
+    @gitconfig_backup_path ||= File.join(CONFIG_BACKUP_PATH, ".gitconfig.backup")
+  end
+
+  def gitconfig_path
+    @gitconfig_path ||= File.expand_path(File.join("~", ".gitconfig"))
+  end
 end
 
 World(RepositoryHelper)
 
-
 Before do
   backup_gitconfigs
   FileUtils.mkdir_p RepositoryHelper::TEST_REPO_DOT_GIT_PATH

data/features/switching_authors.feature

@@ -19,22 +19,14 @@ Feature: Switching authors
     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 "Linus Torvalds & Junio C Hamano" for the current author
-    And `git pair` should display "lt+jch@example.net" for the current email
-
-  Scenario: Pairing with two authors the pair email domain is set to the first author
-    Given I have added the author "Linus Torvalds <linus@example.net>"
-    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 "JCH LT"
-    Then `git pair` should display "Junio C Hamano & Linus Torvalds" for the current author
-    And `git pair` should display "jch+lt@example.org" for the current email
+    And `git pair` should display "linus+junio@example.net" for the current email
 
   Scenario: Pairing with a single author and the pair email has been set
     Given I have set the pair email to "devs@widgets.com"
     And I have added the author "Linus Torvalds <linus@example.net>"
     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.net" for the current email
+    And `git pair` should display "linus@widgets.com" for the current email
 
   Scenario: Pairing with two authors and the pair email has been set
     Given I have set the pair email to "devs@widgets.com"
@@ -42,4 +34,4 @@ Feature: Switching authors
     And I have added the author "Junio C Hamano <junio@example.org>"
     When I switch to the pair "LT JCH"
     Then `git pair` should display "Linus Torvalds & Junio C Hamano" for the current author
-    And `git pair` should display "devs+lt+jch@widgets.com" for the current email
+    And `git pair` should display "devs+lt+jch@widgets.com" for the current email

data/lib/git-pair.rb

@@ -1,10 +1,11 @@
 require "git-pair/version"
 
 module GitPair
-  autoload :Command, 'git-pair/command'
-  autoload :Author,  'git-pair/author'
-  autoload :Config,  'git-pair/config'
-  autoload :Display, 'git-pair/display'
+  autoload :Command,      'git-pair/command'
+  autoload :EmailAddress, 'git-pair/email_address'
+  autoload :Author,       'git-pair/author'
+  autoload :Config,       'git-pair/config'
+  autoload :Display,      'git-pair/display'
 
   class NoMatchingAuthorsError < ArgumentError; end
   class MissingConfigurationError < RuntimeError; end

data/lib/git-pair/author.rb

@@ -19,26 +19,23 @@ module GitPair
         raise(NoMatchingAuthorsError, "no authors matched #{abbr}")
     end
 
-    def self.email(authors)
-      if authors.length == 1
-        authors.first.email
-      else
-        author_names = authors.map { |a| a.initials }
-        if self.authors_prefix
-          author_names.unshift(authors_prefix)
-        end
-        initials_string = author_names.join('+')
-        "#{initials_string}@#{authors_email(authors)}"
-      end
+    def self.email_address_for(authors)
+      "#{local_part_for(authors)}@#{domain_for(authors.first.email)}"
     end
 
-    def self.authors_prefix
-      return Config.pair_email.split("@").first unless Config.pair_email.empty?
+    def self.local_part_for(authors)
+      return authors.first.email.local_part if authors.size == 1
+
+      if pair_email.local_part && pair_email.local_part != ""
+        authors.map(&:initials).unshift(pair_email.local_part).join("+")
+      else
+        authors.map { |author| author.email.local_part }.join("+")
+      end
     end
 
-    def self.authors_email(authors)
-      return Config.pair_email.split("@").last unless Config.pair_email.empty?
-      return authors.first.email.split("@").last
+    def self.domain_for(email_address)
+      return pair_email.domain if pair_email.domain
+      return email_address.domain
     end
 
     def self.exists?(author)
@@ -49,6 +46,10 @@ module GitPair
       author_string =~ ValidAuthorStringRegex
     end
 
+    def self.pair_email
+      EmailAddress.new(Config.pair_email)
+    end
+
     attr_reader :name, :email
 
     def initialize(string)
@@ -57,8 +58,8 @@ module GitPair
       end
 
       string =~ ValidAuthorStringRegex
-      @name = $1.to_s.strip
-      @email = $2.to_s.strip
+      self.name = $1.to_s.strip
+      self.email = EmailAddress.new($2.to_s.strip)
     end
 
     def <=>(other)
@@ -73,5 +74,9 @@ module GitPair
       abbr.downcase == initials
     end
 
+  private
+
+    attr_writer :name, :email
+
   end
 end

data/lib/git-pair/config.rb

@@ -23,7 +23,7 @@ module GitPair
 
     def switch(authors)
       `git config user.name "#{authors.map { |a| a.name }.join(' & ')}"`
-      `git config user.email "#{Author.email(authors)}"`
+      `git config user.email "#{Author.email_address_for(authors)}"`
     end
 
     def reset

data/lib/git-pair/display.rb

@@ -3,7 +3,7 @@ module GitPair
     extend self
 
     def git_author(authors)
-      "#{authors.map { |a| a.name }.join(' & ')} <#{Author.email(authors)}>"
+      "#{authors.map { |a| a.name }.join(' & ')} <#{Author.email_address_for(authors)}>"
     end
   end
 end

data/lib/git-pair/email_address.rb

@@ -0,0 +1,22 @@
+module GitPair
+  class EmailAddress
+    def initialize(address)
+      self.address = address
+    end
+
+    def local_part
+      address.split("@").first
+    end
+
+    def domain
+      address.split("@").last
+    end
+
+    def to_s
+      address
+    end
+
+  private
+    attr_accessor :address
+  end
+end

data/lib/git-pair/version.rb

@@ -1,3 +1,3 @@
 module GitPair
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/git-pair/author_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+require "git-pair/author"
+require "git-pair/email_address"
+
+module GitPair
+  describe Author do
+    let(:author1) { Author.new("User One <user1@example.com>") }
+    let(:author2) { Author.new("User Two <user2@example.com>") }
+
+    describe ".email_address_for" do
+      before do
+        Config.stub(:pair_email => "")
+      end
+
+      it "returns the email of the current author" do
+        Author.email_address_for([author1]).should eq("user1@example.com")
+      end
+
+      it "returns the email prefixes of the current authors in order separated by '+'" do
+        Author.email_address_for([author1, author2]).should eq("user1+user2@example.com")
+      end
+
+      context "a pair email address is provided with a local part" do
+        before do
+          Config.stub(:pair_email => "pair@example-corp.com")
+        end
+
+        it "returns the local part of the current author with the pair domain" do
+          Author.email_address_for([author1]).should eq("user1@example-corp.com")
+        end
+
+        it "returns the pair address local part and the initials of the current authors in order separated by '+'" do
+          Author.email_address_for([author1, author2]).should eq("pair+uo+ut@example-corp.com")
+        end
+      end
+
+      context "a pair email address without a local part" do
+        before do
+          Config.stub(:pair_email => "@example-corp.com")
+        end
+
+        it "returns the local part of the current author with the pair domain" do
+          Author.email_address_for([author1]).should eq("user1@example-corp.com")
+        end
+
+        it "returns the pair address local part and the initials of the current authors in order separated by '+'" do
+          Author.email_address_for([author1, author2]).should eq("user1+user2@example-corp.com")
+        end
+      end
+    end
+
+    describe ".local_part_for" do
+      before do
+        Config.stub(:pair_email => "")
+      end
+
+      it "returns the email address local parts for the authors joined by '+'" do
+        Author.local_part_for([author1, author2]).should eq("user1+user2")
+      end
+
+      it "returns the email address local parts for the authors in order" do
+        Author.local_part_for([author2, author1]).should eq("user2+user1")
+        Author.local_part_for([author1, author2]).should eq("user1+user2")
+      end
+    end
+
+    describe ".domain_for" do
+      let(:email_address) { EmailAddress.new("user1@example.com") }
+
+      it "returns the domain part of the email address" do
+        Config.stub(:pair_email => "")
+        Author.domain_for(email_address).should eq("example.com")
+      end
+
+      it "returns the domain part of the pair email address when set" do
+        Config.stub(:pair_email => "pair@example-corp.com")
+        Author.domain_for(email_address).should eq("example-corp.com")
+      end
+    end
+  end
+end

data/spec/git-pair/email_address_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+require "git-pair/email_address"
+
+module GitPair
+  describe EmailAddress do
+    let(:email_address) { EmailAddress.new("user1@example.com") }
+
+    describe "#local_part" do
+      it "returns the local part" do
+        email_address.local_part.should eq("user1")
+      end
+    end
+
+    describe "#domain" do
+      it "returns the domain part" do
+        email_address.domain.should eq("example.com")
+      end
+
+      it "returns nil if initialized with an empty string" do
+        EmailAddress.new("").domain.should eq(nil)
+      end
+    end
+
+    describe "#to_s" do
+      it "returns the address as a string" do
+        email_address.to_s.should eq("user1@example.com")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "git-pair"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,15 +1,10 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: edsinclair-git-pair
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Chris Kampmeier
 - Adam McCrea
 - Jon Distad
@@ -18,49 +13,68 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-24 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-  name: cucumber
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-  name: ruby-debug
-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: 
-- eirik@efficiency20.com
-executables: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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:
+- eirikdentz@gmail.com
+executables:
 - git-pair
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .autotest
+files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -82,41 +96,42 @@ files:
 - lib/git-pair/command.rb
 - lib/git-pair/config.rb
 - lib/git-pair/display.rb
+- lib/git-pair/email_address.rb
 - lib/git-pair/version.rb
-homepage: ""
+- spec/git-pair/author_spec.rb
+- spec/git-pair/email_address_spec.rb
+- spec/spec_helper.rb
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -2868322485057099188
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -2868322485057099188
 requirements: []
-
 rubyforge_project: git-pair
-rubygems_version: 1.8.8
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Configure git to commit as more than one author
-test_files: 
+test_files:
 - features/adding_an_author.feature
 - features/authors.feature
 - features/removing_an_author.feature
@@ -125,3 +140,6 @@ test_files:
 - features/step_definitions/config_steps.rb
 - features/support/env.rb
 - features/switching_authors.feature
+- spec/git-pair/author_spec.rb
+- spec/git-pair/email_address_spec.rb
+- spec/spec_helper.rb

data/.autotest

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