git-pair 0.1.0

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,48 @@
+# 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 git-pair
+
+And here's how to use it!
+
+    $ git pair
+
+    Configuration:
+      git pair [options]
+        -a, --add NAME                   Add an author. Use the full name.
+        -r, --remove NAME                Remove an author. Use the full name.
+        -e, --set-email TEMPLATE         Set the email template. A value like devs@example.com
+                                         will be interpolated with the current authors' initials
+                                         into something like devs+aa+bb@example.com.
+
+    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.
+
+Once you've added authors, running `git pair` with no options will also print
+out their names, the current pair, and some other information.
+
+## Known issues
+
+* I just shoved everything into a gem. Refactor into separate files.
+* Needs `git pair --reset` to restore the original `user.name` and `user.email`.
+  For now, just `git config --edit` and remove the `[user]` section to go back
+  to your global config.
+* It'd be better if you could specify an email address for each author instead
+  of just automatically using the authors' initials. Especially if you have two
+  authors with the same initials. And also because when there's just one author,
+  it should use that person's email instead of an interpolation like
+  `devs+ck@example.com`.
+* Don't add duplicate authors to the git-config (doesn't affect the proper
+  functioning of git-pair, but makes `git pair --add` not idempotent and
+  clutters up your config file).
+
+## License
+
+Copyright (c) 2009 Chris Kampmeier. See `LICENSE` for details.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "git-pair"
+    gem.version = File.read("lib/git-pair/VERSION").strip
+    gem.summary = %Q{Configure git to commit as more than one author}
+    gem.description = %Q{Configure git to commit as more than one author}
+    gem.email = "chris@kampers.net"
+    gem.homepage = "http://github.com/chrisk/git-pair"
+    gem.authors = ["Chris Kampmeier"]
+    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

data/bin/git-pair

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'optparse'
+require 'git-pair'
+
+begin
+  banner = "\n#{$reverse} Configuration: #{$reset}"
+  parser = OptionParser.new do |opts|
+    opts.banner = banner
+    opts.separator "  git pair [options]"
+    opts.on("-a", "--add NAME",    "Add an author. Use the full name.")    { |name| GitPair::Commands.add name }
+    opts.on("-r", "--remove NAME", "Remove an author. Use the full name.") { |name| GitPair::Commands.remove name }
+    opts.on("-e", "--set-email TEMPLATE", "Set the email template. A value like devs@example.com",
+                                          "will be interpolated with the current authors' initials",
+                                          "into something like devs+aa+bb@example.com.") { |email| GitPair::Commands.set_email_template email }
+
+    opts.separator " "
+    opts.separator ["#{$reverse} Switching authors: #{$reset}",
+                    "  git pair AA [BB]                   Where AA and BB are any abbreviation of an",
+                    " "*37 + "author's name. You can specify one or more authors."]
+
+    opts.separator " "
+    opts.separator ["#{$reverse} Current config: #{$reset}",
+                    *(GitPair::Helpers.display_string_for_config.split("\n") + [" "] +
+                      GitPair::Helpers.display_string_for_current_info.split("\n"))]
+  end
+
+  unused_options = parser.parse!
+
+  if GitPair::Commands.config_change_made?
+    puts GitPair::Helpers.display_string_for_config
+  elsif unused_options.any?
+    GitPair::Commands.switch(unused_options)
+    puts GitPair::Helpers.display_string_for_current_info
+  elsif ARGV.empty?
+    puts parser.help
+  end
+
+rescue OptionParser::MissingArgument
+  GitPair::Helpers.abort "missing required argument", parser.help
+rescue OptionParser::InvalidOption, OptionParser::InvalidArgument => e
+  GitPair::Helpers.abort e.message.sub(':', ''), parser.help
+rescue GitPair::NoMatchingAuthorsError => e
+  GitPair::Helpers.abort e.message, "\n" + GitPair::Helpers.display_string_for_config
+rescue GitPair::MissingConfigurationError => e
+  GitPair::Helpers.abort e.message, parser.help
+end

data/features/git-pair.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'git-pair'
+
+require 'test/unit/assertions'
+
+World(Test::Unit::Assertions)

data/git-pair.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{git-pair}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Kampmeier"]
+  s.date = %q{2009-12-06}
+  s.default_executable = %q{git-pair}
+  s.description = %q{Configure git to commit as more than one author}
+  s.email = %q{chris@kampers.net}
+  s.executables = ["git-pair"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "bin/git-pair",
+     "features/git-pair.feature",
+     "features/step_definitions/git-pair_steps.rb",
+     "features/support/env.rb",
+     "git-pair.gemspec",
+     "lib/git-pair.rb",
+     "lib/git-pair/VERSION"
+  ]
+  s.homepage = %q{http://github.com/chrisk/git-pair}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Configure git to commit as more than one author}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0"])
+  end
+end
+

data/lib/git-pair.rb

@@ -0,0 +1,107 @@
+$bold, $reverse, $red, $reset = "\e[1m", "\e[7m", "\e[91m", "\e[0m"
+
+module GitPair
+
+  VERSION = File.read(File.join(File.dirname(__FILE__), "git-pair", "VERSION")).strip
+
+  class NoMatchingAuthorsError < ArgumentError; end
+  class MissingConfigurationError < RuntimeError; end
+
+
+  module Commands
+    def add(name)
+      @config_changed = true
+      `git config --add git-pair.authors "#{name}"`
+    end
+
+    def remove(name)
+      @config_changed = true
+      `git config --unset-all git-pair.authors "^#{name}$"`
+    end
+
+    def set_email_template(email)
+      @config_changed = true
+      `git config git-pair.email "#{email}"`
+    end
+
+    def config_change_made?
+      @config_changed
+    end
+
+    def switch(abbreviations)
+      raise MissingConfigurationError, "Please add some authors first" if Helpers.author_names.empty?
+      raise MissingConfigurationError, "Please set the email template first" if Helpers.email_template.empty?
+
+      names = abbreviations.map { |abbrev|
+        name = Helpers.author_name_from_abbreviation(abbrev)
+        raise NoMatchingAuthorsError, "no authors matched #{abbrev}" if name.nil?
+        name
+      }
+
+      sorted_names = names.uniq.sort_by { |name| name.split.last }
+      `git config user.name "#{sorted_names.join(' + ')}"`
+      initials = sorted_names.map { |name| name.split.map { |word| word[0].chr }.join.downcase }
+      `git config user.email "#{Helpers.email(*initials)}"`
+    end
+
+    extend self
+  end
+
+
+  module Helpers
+    def display_string_for_config
+      "#{$bold}  Email template: #{$reset}" + email("[aa]", "[bb]") + "\n" +
+      "#{$bold}     Author list: #{$reset}" + author_names.join("\n                  ")
+    end
+
+    def display_string_for_current_info
+      "#{$bold}  Current author: #{$reset}" + current_author + "\n" +
+      "#{$bold}   Current email: #{$reset}" + current_email + "\n "
+    end
+
+    def author_names
+      names = `git config --get-all git-pair.authors`.split("\n")
+      names.uniq.sort_by { |name| name.split.last }
+    end
+
+    def email(*initials_list)
+      initials_string = initials_list.map { |initials| "+#{initials}" }.join
+      email_template.sub("@", "#{initials_string}@")
+    end
+
+    def email_template
+      `git config --get git-pair.email`.strip
+    end
+
+    def current_author
+      `git config --get user.name`.strip
+    end
+
+    def current_email
+      `git config --get user.email`.strip
+    end
+
+    def author_name_from_abbreviation(abbrev)
+      # initials
+      author_names.each do |name|
+        return name if abbrev.downcase == name.split.map { |word| word[0].chr }.join.downcase
+      end
+
+      # start of a name
+      author_names.each do |name|
+        return name if name.gsub(" ", "") =~ /^#{abbrev}/i
+      end
+
+      # includes the letters in order
+      author_names.detect do |name|
+        name =~ /#{abbrev.split("").join(".*")}/i
+      end
+    end
+
+    def abort(error_message, extra = "")
+      super "#{$red}#{$reverse} Error: #{error_message} #{$reset}\n" + extra
+    end
+
+    extend self
+  end
+end

data/lib/git-pair/VERSION

@@ -0,0 +1 @@
+0.1.0

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: git-pair
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Kampmeier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-06 00:00:00 -08: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: Configure git to commit as more than one author
+email: chris@kampers.net
+executables: 
+- git-pair
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- bin/git-pair
+- features/git-pair.feature
+- features/step_definitions/git-pair_steps.rb
+- features/support/env.rb
+- git-pair.gemspec
+- lib/git-pair.rb
+- lib/git-pair/VERSION
+has_rdoc: true
+homepage: http://github.com/chrisk/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: []
+