git-duet 0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+/.env
+Gemfile.lock
+/coverage/
+/tags

data/.jrubyrc

@@ -0,0 +1 @@
+compat.version=1.9

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p327

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.simplecov

@@ -0,0 +1,5 @@
+if ENV['COVERAGE']
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-head
+  - ree

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ModCloth, Inc.
+
+MIT License
+
+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,268 @@
+# Git Duet
+
+<a href="https://travis-ci.org/modcloth/git-duet">
+  <img src="https://api.travis-ci.org/modcloth/git-duet.png"
+    title="Build Status"
+/></a>
+
+Pair harmoniously!  Working in a pair doesn't mean you've both lost your
+identity.  Git Duet helps with blaming/praising by using stuff that's
+already in `git` without littering your repo history with fictitous user
+identities.
+
+## Installation
+
+Install it with `gem`:
+
+~~~~~ bash
+gem install git-duet
+~~~~~
+
+## Usage
+
+### Setup
+
+Make an authors file with email domain, or if you're already using
+[git pair](https://github.com/pivotal/git_scripts), just symlink your
+`~/.pairs` file over to `~/.git-authors`.
+
+~~~~~ yaml
+authors:
+  jd: Jane Doe; jane
+  fb: Frances Bar
+email:
+  domain: awesometown.local
+~~~~~
+
+`git duet` will use the `git pair` YAML structure if it has to (the
+difference is the top-level key being `pairs` instead of `authors`,) e.g.:
+
+~~~~~ yaml
+pairs:
+  jd: Jane Doe; jane
+  fb: Frances Bar
+email:
+  domain: awesometown.local
+~~~~~
+
+If you want your authors file to live somwhere else, just tell
+Git Duet about it via the `GIT_DUET_AUTHORS_FILE` environmental
+variable, e.g.:
+
+~~~~~ bash
+export GIT_DUET_AUTHORS_FILE=$HOME/.secret-squirrel/git-authors
+# ...
+git duet jd am
+~~~~~
+
+### Workflow stuff
+
+Set the author and committer via `git duet`:
+
+~~~~~ bash
+git duet jd fb
+~~~~~
+
+When you're ready to commit, use `git duet-commit` (or add an alias like
+a normal person.  Something like `dci = duet-commit` should work.)
+
+~~~~~ bash
+git duet-commit -v [any other git options]
+~~~~~
+
+When you're done pairing, set the author back to yourself with `git solo`:
+
+~~~~~ bash
+git solo jd
+~~~~~
+
+### Global Config Support
+
+If you're jumping between projects and don't want to think about
+managing them all individually, you can operate on the global git
+config:
+
+~~~~~ bash
+git solo -g jd
+~~~~~
+
+~~~~~ bash
+git duet --global jd fb
+~~~~~
+
+### Email Configuration
+
+By default, email addresses are constructed from the first initial and
+last name ( *or* optional username after a `;`) plus email domain, e.g.
+with the following authors file:
+
+~~~~~ yaml
+pairs:
+  jd: Jane Doe; jane
+  fb: Frances Bar
+email:
+  domain: eternalstench.bog.local
+~~~~~
+
+After invoking:
+
+~~~~~ bash
+git duet jd fb
+~~~~~
+
+Then the configured email addresses will show up like this:
+
+~~~~~ bash
+git config user.email
+# -> jane@eternalstench.bog.local
+git config duet.env.git-author-email
+# -> jane@eternalstench.bog.local
+git config duet.env.git-committer-email
+# -> f.bar@eternalstench.bog.local
+~~~~~
+
+A custom email template may be provided via the `email_template` config
+variable.  The template should be a valid ERB string and the variables
+available are `author` which is the full first and last name value
+associated with each set of initials, `initials` which are the initials
+key, and `username` which is the part following `;` in the author value.
+
+~~~~~ yaml
+pairs:
+  jd: Jane Doe
+  fb: Frances Bar
+email_template: '<%= "#{author.gsub(/ /, "-").downcase}@hamster.local" =%>'
+~~~~~
+
+After invoking:
+
+~~~~~ bash
+git duet jd fb
+~~~~~
+
+Then the configured email addresses will show up like this:
+
+~~~~~ bash
+git config user.email
+# -> jane-doe@hamster.local
+git config duet.env.git-author-email
+# -> jane-doe@hamster.local
+git config duet.env.git-committer-email
+# -> frances-bar@hamster.local
+~~~~~
+
+If there are any exceptions to either the default format or a provided
+`email_template` config var, explicitly setting email addresses by
+initials is supported.
+
+~~~~~ yaml
+pairs:
+  jd: Jane Doe; jane
+  fb: Frances Bar
+email:
+  domain: awesometown.local
+email_addresses:
+  jd: jane@awesome.local
+~~~~~
+
+Then Jane Doe's email will show up like this:
+
+~~~~~ bash
+git solo jd
+# ...
+git config user.email
+# -> jane@awesome.local
+~~~~~
+
+Alternatively, if you have some other preferred way to look up email
+addresses by initials, name or username, just use that instead:
+
+~~~~~ bash
+export GIT_DUET_EMAIL_LOOKUP_COMMAND="$HOME/bin/custom-ldap-thingy"
+# ... do work
+git duet jd fb
+# ... observe emails being set via the specified executable
+~~~~~
+
+The initials, name, and username will be passed as arguments to the
+lookup executable.  Anything written to standard output will be used as
+the email address:
+
+~~~~~ bash
+$HOME/bin/custom-ldap-thingy 'jd' 'Jane Doe' 'jane'
+# -> doej@behemoth.company.local
+~~~~~
+
+If nothing is returned on standard output, email construction falls back
+to the decisions described above.
+
+#### Order of Precedence
+
+Since there are multiple ways to determine an author or committer's
+email, it is important to note the order of precedence used by Git Duet:
+
+1. Email lookup executable configured via the
+   `GIT_DUET_EMAIL_LOOKUP_COMMAND` environmental variable
+2. Email lookup from `email_addresses` in your configuration file
+3. Custom email address from ERB template defined in `email_template` in
+   your configuration file
+4. The username after the `;`, followed by `@` and the configured email
+   domain
+5. The lower-cased first letter of the author or committer's first name,
+   followed by `.` followed by the lower-cased last name of the author
+or committer, followed by `@` and the configured email domain (e.g.
+`f.bar@baz.local`)
+
+### Git hook integration
+
+If you'd like to regularly remind yourself to set the solo or duet
+initials, use `git duet-pre-commit` in your pre-commit hook:
+
+*(in $REPO_ROOT/.git/hooks/pre-commit)*
+~~~~~ bash
+#!/bin/bash
+exec git duet-pre-commit
+~~~~~
+
+The `duet-pre-commit` command will exit with a non-zero status if the
+cached author and committer settings are missing or stale.  The default
+staleness cutoff is [20 minutes](http://en.wikipedia.org/wiki/Pomodoro_Technique),
+but may be configured via the `GIT_DUET_SECONDS_AGO_STALE` environmental variable,
+which should be an integer of seconds, e.g.:
+
+~~~~~ bash
+export GIT_DUET_SECONDS_AGO_STALE=60
+# ... do work for more than a minute
+git commit -v
+# ... pre-commit hook fires
+~~~~~
+
+If you want to use the default hook (as shown above), install it while
+in your repo like so:
+
+~~~~~ bash
+git duet-install-hook
+~~~~~
+
+Don't worry if you forgot you already had a `pre-commit` hook installed.
+The `git duet-install-hook` command will refuse to overwrite it.
+
+## Compatibility
+
+Git Duet has been tested on a bunch of platform/interpreter combinations
+provided by Travis CI *not including* Rubinius.
+
+While JRuby works it is not recommended as the VM startup time is
+usually longer than it takes most Git Duet commands to execute.
+
+If you experience badness, please [let us know via
+email](mailto:github@modcloth.com) or pretty please [create an issue on
+github](https://github.com/modcloth/git-duet/issues/new).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--format documentation'
+end
+
+task :default => :spec

data/bin/git-duet

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'git-duet'
+exit Git::Duet::Cli.run($0, ARGV)

data/bin/git-duet-commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'git-duet'
+exit Git::Duet::Cli.run($0, ARGV)

data/bin/git-duet-install-hook

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'git-duet'
+exit Git::Duet::Cli.run($0, ARGV)

data/bin/git-duet-pre-commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'git-duet'
+exit Git::Duet::Cli.run($0, ARGV)

data/bin/git-duet-pre-commit-tk

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'git-duet'
+exit Git::Duet::Cli.run($0, ARGV)

data/bin/git-solo

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'git-duet'
+exit Git::Duet::Cli.run($0, ARGV)

data/git-duet.gemspec

@@ -0,0 +1,36 @@
+# vim:fileencoding=utf-8
+require File.expand_path('../lib/git/duet/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = [
+    'Dan Buch',
+    'Jesse Szwedko',
+    'Rafe Colton',
+    'Sheena McCoy',
+  ]
+  gem.email = %w(
+    d.buch@modcloth.com
+    j.szwedko@modcloth.com
+    r.colton@modcloth.com
+    sp.mccoy@modcloth.com
+  )
+  gem.description = %q{Pair programming git identity thingy}
+  gem.summary = "Pair harmoniously!  Decide who's driving.  " <<
+                "Commit along the way.  Don't make a mess of " <<
+                "the repository history."
+  gem.homepage = ''
+  gem.license = 'MIT'
+
+  gem.files = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^spec/})
+  gem.name = 'git-duet'
+  gem.require_paths = %w(lib)
+  gem.version = Git::Duet::VERSION
+  gem.required_ruby_version = '>= 1.8.7'
+
+  gem.add_development_dependency 'nyan-cat-formatter', '>= 0.2.0'
+  gem.add_development_dependency 'rake', '>= 0.9.2.2'
+  gem.add_development_dependency 'rspec', '>= 2.0.0'
+  gem.add_development_dependency 'simplecov', '>= 0.7.0'
+end

data/lib/git-duet.rb

@@ -0,0 +1 @@
+require 'git/duet'

data/lib/git/duet.rb

@@ -0,0 +1,8 @@
+module Git
+  module Duet
+  end
+end
+
+require 'git/duet/version'
+require 'git/duet/cli'
+require 'git/duet/key_error'

data/lib/git/duet/author_mapper.rb

@@ -0,0 +1,77 @@
+require 'yaml'
+require 'erb'
+require 'git/duet'
+
+class Git::Duet::AuthorMapper
+  attr_accessor :authors_file
+
+  def initialize(authors_file = nil, email_lookup = nil)
+    @authors_file = authors_file ||
+                    ENV['GIT_DUET_AUTHORS_FILE'] ||
+                    File.join(ENV['HOME'], '.git-authors')
+    @email_lookup = email_lookup ||
+                    ENV['GIT_DUET_EMAIL_LOOKUP_COMMAND']
+  end
+
+  def map(*initials_list)
+    author_map = {}
+    initials_list.each do |initials|
+      author_map[initials] = author_info(initials)
+    end
+    author_map
+  end
+
+  private
+  def author_info(initials)
+    author, username = author_map.fetch(initials).split(/;/).map(&:strip)
+    {
+      :name => author,
+      :email => lookup_author_email(initials, author, username)
+    }
+  end
+
+  def lookup_author_email(initials, author, username)
+    if @email_lookup
+      author_email = `#{@email_lookup} '#{initials}' '#{author}' '#{username}'`.strip
+      return author_email if !author_email.empty?
+    end
+
+    return email_addresses[initials] if email_addresses[initials]
+    return email_from_template(initials, author, username) if email_template
+    return "#{username}@#{email_domain}" if username
+
+    author_name_parts = author.split
+    return "#{author_name_parts.first[0,1].downcase}." <<
+           "#{author_name_parts.last.downcase}@#{email_domain}"
+  end
+
+  def email_from_template(initials, author, username)
+    return ERB.new(email_template).result(binding)
+  rescue StandardError => e
+    STDERR.puts("git-duet: email template rendering error: #{e.message}")
+    raise Git::Duet::ScriptDieError.new(8)
+  end
+
+  def author_map
+    @author_map ||= (cfg['authors'] || cfg['pairs'])
+  end
+
+  def email_addresses
+    @email_addresses ||= (cfg['email_addresses'] || {})
+  end
+
+  def email_domain
+    @email_domain ||= cfg.fetch('email').fetch('domain')
+  end
+
+  def email_template
+    @email_template || cfg['email_template']
+  end
+
+  def cfg
+    @cfg ||= YAML.load(IO.read(@authors_file))
+  rescue StandardError => e
+    STDERR.puts("git-duet: Missing or corrupt authors file: #{e.message}")
+    raise Git::Duet::ScriptDieError.new(3)
+  end
+end