git-duet 0.1.1

data/lib/git/duet/solo_command.rb

@@ -0,0 +1,45 @@
+require 'git/duet'
+require 'git/duet/author_mapper'
+require 'git/duet/command_methods'
+
+class Git::Duet::SoloCommand
+  include Git::Duet::CommandMethods
+
+  def initialize(soloist, quiet = false, global = false)
+    @soloist = soloist
+    @quiet = !!quiet
+    @global = !!global
+    @author_mapper = Git::Duet::AuthorMapper.new
+  end
+
+  def execute!
+    set_soloist_as_git_config_user
+    unset_committer_vars
+    report_env_vars
+    write_env_vars
+  end
+
+  private
+  attr_accessor :soloist, :author_mapper
+
+  def set_soloist_as_git_config_user
+    exec_check("git config #{@global ? '--global ' : ''}user.name '#{soloist_info[:name]}'")
+    exec_check("git config #{@global ? '--global ' : ''}user.email '#{soloist_info[:email]}'")
+  end
+
+  def unset_committer_vars
+    exec_check("git config #{@global ? '--global ' : ''}--unset-all duet.env.git-committer-name", [0, 5])
+    exec_check("git config #{@global ? '--global ' : ''}--unset-all duet.env.git-committer-email", [0, 5])
+  end
+
+  def var_map
+    {
+      'GIT_AUTHOR_NAME' => soloist_info[:name],
+      'GIT_AUTHOR_EMAIL' => soloist_info[:email]
+    }
+  end
+
+  def soloist_info
+    @soloist_info ||= author_mapper.map(@soloist).fetch(@soloist)
+  end
+end

data/lib/git/duet/version.rb

@@ -0,0 +1,7 @@
+unless defined?(Git::Duet::VERSION)
+  module Git
+    module Duet
+      VERSION = '0.1.1'
+    end
+  end
+end

data/spec/integration/end_to_end_spec.rb

@@ -0,0 +1,304 @@
+require 'tmpdir'
+
+describe 'git-duet end to end', :integration => true do
+  EMAIL_LOOKUP_SCRIPT = <<-EOF.gsub(/^  /, '')
+  #!/usr/bin/env ruby
+  addr = {
+    'jd' => 'jane_doe@lookie.me.local',
+    'fb' => 'fb9000@dalek.info.local'
+  }[ARGV.first]
+  puts addr
+  EOF
+
+  def install_hook
+    Dir.chdir(@repo_dir)
+    `git duet-install-hook -q`
+  end
+
+  def uninstall_hook
+    FileUtils.rm_f('.git/hooks/pre-commit')
+  end
+
+  def make_an_edit
+    Dir.chdir(@repo_dir)
+    File.open('file.txt', 'w') { |f| f.puts "foo-#{rand(100000)}" }
+    `git add file.txt`
+  end
+
+  before :all do
+    @startdir = Dir.pwd
+    @tmpdir = Dir.mktmpdir('git-duet-specs')
+    @git_authors = File.join(@tmpdir, '.git-authors')
+    @email_lookup_path = File.join(@tmpdir, 'email-lookup')
+    File.open(@git_authors, 'w') do |f|
+      f.puts YAML.dump(
+        'pairs' => {
+          'jd' => 'Jane Doe',
+          'fb' => 'Frances Bar',
+          'zp' => 'Zubaz Pants'
+        },
+        'email' => {
+          'domain' => 'hamster.info.local'
+        },
+        'email_addresses' => {
+          'jd' => 'jane@hamsters.biz.local'
+        }
+      )
+    end
+    ENV['GIT_DUET_AUTHORS_FILE'] = @git_authors
+    ENV['PATH'] = "#{File.expand_path('../../../bin', __FILE__)}:#{ENV['PATH']}"
+    File.open(@email_lookup_path, 'w') { |f| f.puts EMAIL_LOOKUP_SCRIPT }
+    FileUtils.chmod(0755, @email_lookup_path)
+    @repo_dir = File.join(@tmpdir, 'foo')
+    Dir.chdir(@tmpdir)
+    `git init #{@repo_dir}`
+  end
+
+  after :all do
+    Dir.chdir(@startdir)
+    if ENV['RSPEC_NO_CLEANUP']
+      File.open('integration-end-to-end-test-dir.txt', 'w') { |f| f.puts @tmpdir }
+    else
+      FileUtils.rm_rf(@tmpdir)
+    end
+  end
+
+  context 'when installing the pre-commit hook' do
+    before(:each) { install_hook }
+    after(:each) { uninstall_hook }
+
+    it 'should write the hook to the `pre-commit` hook file' do
+      File.exist?('.git/hooks/pre-commit').should be_true
+    end
+
+    it 'should make the `pre-commit` hook file executable' do
+      File.executable?('.git/hooks/pre-commit').should be_true
+    end
+  end
+
+  context 'when setting the author via solo' do
+    before :each do
+      Dir.chdir(@repo_dir)
+      `git solo jd -q`
+    end
+
+    it 'should set the git user name' do
+      `git config user.name`.chomp.should == 'Jane Doe'
+    end
+
+    it 'should set the git user email' do
+      `git config user.email`.chomp.should == 'jane@hamsters.biz.local'
+    end
+
+    it 'should cache the git user name as author name' do
+      `git config duet.env.git-author-name`.chomp.should == 'Jane Doe'
+    end
+
+    it 'should cache the git user email as author email' do
+      `git config duet.env.git-author-email`.chomp.should == 'jane@hamsters.biz.local'
+    end
+  end
+
+
+  context 'when an external email lookup is provided' do
+    before :each do
+      @old_email_lookup = ENV.delete('GIT_DUET_EMAIL_LOOKUP_COMMAND')
+      ENV['GIT_DUET_EMAIL_LOOKUP_COMMAND'] = @email_lookup_path
+    end
+
+    after :each do
+      ENV['GIT_DUET_EMAIL_LOOKUP_COMMAND'] = @old_email_lookup
+    end
+
+    context 'when setting the author via solo' do
+      before :each do
+        Dir.chdir(@repo_dir)
+        `git solo jd -q`
+      end
+
+      it 'should set the author email address given by the external email lookup' do
+        `git config duet.env.git-author-email`.chomp.should == 'jane_doe@lookie.me.local'
+      end
+    end
+
+    context 'when setting author and committer via duet' do
+      before :each do
+        Dir.chdir(@repo_dir)
+        `git duet jd fb -q`
+      end
+
+      it 'should set the author email address given by the external email lookup' do
+        `git config duet.env.git-author-email`.chomp.should == 'jane_doe@lookie.me.local'
+      end
+
+      it 'should set the committer email address given by the external email lookup' do
+        `git config duet.env.git-committer-email`.chomp.should == 'fb9000@dalek.info.local'
+      end
+    end
+  end
+
+  context 'when a custom email template is provided' do
+    before :each do
+      authors_cfg = YAML.load_file(@git_authors)
+      @name_suffix = rand(9999)
+      authors_cfg['email_template'] =
+        %Q^<%= '' << author.split.first.downcase << ^ <<
+          %Q^author.split.last[0].chr.downcase << '#{@name_suffix}@mompopshop.local' %>^
+      File.open(@git_authors, 'w') do |f|
+        f.puts YAML.dump(authors_cfg)
+      end
+    end
+
+    after :each do
+      authors_cfg = YAML.load_file(@git_authors)
+      authors_cfg.delete('email_template')
+      File.open(@git_authors, 'w') do |f|
+        f.puts YAML.dump(authors_cfg)
+      end
+    end
+
+    context 'after running git-solo' do
+      before :each do
+        Dir.chdir(@repo_dir)
+        `git solo zp -q`
+        make_an_edit
+      end
+
+      it 'should use the email template to construct the author email' do
+        `git duet-commit -q -m 'Testing custom email template for author'`
+        `git log -1 --format='%an <%ae>'`.chomp.should == "Zubaz Pants <zubazp#{@name_suffix}@mompopshop.local>"
+      end
+
+      it 'should use the email template to construct the committer email' do
+        `git duet-commit -q -m 'Testing custom email template for committer'`
+        `git log -1 --format='%cn <%ce>'`.chomp.should == "Zubaz Pants <zubazp#{@name_suffix}@mompopshop.local>"
+      end
+    end
+
+    context 'after running git-duet' do
+      before :each do
+        Dir.chdir(@repo_dir)
+        `git duet zp fb -q`
+        make_an_edit
+      end
+
+      it 'should use the email template to construct the author email' do
+        `git duet-commit -q -m 'Testing custom email template for author'`
+        `git log -1 --format='%an <%ae>'`.chomp.should == "Zubaz Pants <zubazp#{@name_suffix}@mompopshop.local>"
+      end
+
+      it 'should use the email template to construct the committer email' do
+        `git duet-commit -q -m 'Testing custom email template for committer'`
+        `git log -1 --format='%cn <%ce>'`.chomp.should == "Frances Bar <francesb#{@name_suffix}@mompopshop.local>"
+      end
+    end
+  end
+
+  context 'when setting author and committer via duet' do
+    before :each do
+      Dir.chdir(@repo_dir)
+      `git duet jd fb -q`
+    end
+
+    it 'should set the git user name' do
+      `git config user.name`.chomp.should == 'Jane Doe'
+    end
+
+    it 'should set the git user email' do
+      `git config user.email`.chomp.should == 'jane@hamsters.biz.local'
+    end
+
+    it 'should cache the git committer name' do
+      `git config duet.env.git-committer-name`.chomp.should == 'Frances Bar'
+    end
+
+    it 'should cache the git committer email' do
+      `git config duet.env.git-committer-email`.chomp.should == 'f.bar@hamster.info.local'
+    end
+  end
+
+  context 'when committing via git-duet-commit' do
+    context 'after running git-duet' do
+      before :each do
+        Dir.chdir(@repo_dir)
+        `git duet jd fb -q`
+        make_an_edit
+      end
+
+      it 'should list the alpha of the duet as author in the log' do
+        `git duet-commit -q -m 'Testing set of alpha as author'`
+        `git log -1 --format='%an <%ae>'`.chomp.should == 'Jane Doe <jane@hamsters.biz.local>'
+      end
+
+      it 'should list the omega of the duet as committer in the log' do
+        `git duet-commit -q -m 'Testing set of omega as committer'`
+        `git log -1 --format='%cn <%ce>'`.chomp.should == 'Frances Bar <f.bar@hamster.info.local>'
+      end
+
+      context 'with the pre-commit hook in place' do
+        before :each do
+          `git commit -m 'Committing before installing the hook'`
+          @latest_sha1 = `git log -1 --format=%H`.chomp
+          make_an_edit
+          install_hook
+          `git config --unset-all duet.env.mtime`
+          ENV['GIT_DUET_QUIET'] = '1'
+        end
+
+        after :each do
+          uninstall_hook
+          ENV.delete('GIT_DUET_QUIET')
+        end
+
+        it 'should fire the hook and reject the commit' do
+          `git duet-commit -q -m 'Testing hook firing'`
+          `git log -1 --format=%H`.chomp.should == @latest_sha1
+        end
+      end
+    end
+
+    context 'after running git-solo' do
+      before :each do
+        Dir.chdir(@repo_dir)
+        `git solo jd -q`
+        make_an_edit
+      end
+
+      it 'should list the soloist as author in the log' do
+        `git duet-commit -m 'Testing set of soloist as author' 2>/dev/null`
+        `git log -1 --format='%an <%ae>'`.chomp.should == 'Jane Doe <jane@hamsters.biz.local>'
+      end
+
+      it 'should list the soloist as committer in the log' do
+        `git duet-commit -m 'Testing set of soloist as committer' 2>/dev/null`
+        `git log -1 --format='%cn <%ce>'`.chomp.should == 'Jane Doe <jane@hamsters.biz.local>'
+      end
+
+      it 'should not include "Signed-off-by" in the commit message' do
+        `git duet-commit -m 'Testing ommitting signoff when only one author' 2>/dev/null`
+        `grep 'Signed-off-by' .git/COMMIT_EDITMSG`.chomp.should == ''
+      end
+
+      context 'with the pre-commit hook in place' do
+        before :each do
+          `git commit -m 'Committing before installing the hook'`
+          @latest_sha1 = `git log -1 --format=%H`.chomp
+          make_an_edit
+          install_hook
+          `git config --unset-all duet.env.mtime`
+          ENV['GIT_DUET_QUIET'] = '1'
+        end
+
+        after :each do
+          uninstall_hook
+          ENV.delete('GIT_DUET_QUIET')
+        end
+
+        it 'should fire the hook and reject the commit' do
+          `git duet-commit -q -m 'Testing hook firing'`
+          `git log -1 --format=%H`.chomp.should == @latest_sha1
+        end
+      end
+    end
+  end
+end

data/spec/lib/git/duet/author_mapper_spec.rb

@@ -0,0 +1,170 @@
+require 'git/duet/author_mapper'
+
+describe Git::Duet::AuthorMapper do
+  before :each do
+    subject.instance_variable_set(:@cfg, {
+      'authors' => {
+        'jd' => 'Jane Doe; jdoe',
+        'fb' => 'Frances Bar; frances',
+        'qx' => 'Quincy Xavier; qx',
+        'hb' => 'Hampton Bones'
+      },
+      'email' => {
+        'domain' => 'awesometown.me'
+      },
+      'email_addresses' => {
+        'jd' => 'jane@awesome.biz'
+      }
+    })
+  end
+
+  after :each do
+    ENV.delete('GIT_DUET_AUTHORS_FILE')
+  end
+
+  it 'should use an authors file given at initialization' do
+    instance = described_class.new('/blarggie/blarggie/new/friend/.git-authors')
+    instance.authors_file.should == '/blarggie/blarggie/new/friend/.git-authors'
+  end
+
+  it 'should use the `GIT_DUET_AUTHORS_FILE` if provided' do
+    ENV['GIT_DUET_AUTHORS_FILE'] = '/fizzle/bizzle/.git-authors'
+    instance = described_class.new
+    instance.authors_file.should == '/fizzle/bizzle/.git-authors'
+  end
+
+  it 'should fall back to using `~/.git-authors` for the author map' do
+    subject.authors_file.should == File.join(ENV['HOME'], '.git-authors')
+  end
+
+  it 'should map initials to name -> email pairs' do
+    subject.map('jd').fetch('jd').should == {
+      :name => 'Jane Doe',
+      :email => 'jane@awesome.biz'
+    }
+  end
+
+  it 'should construct default email addresses from first initial and last name plus domain' do
+    subject.map('hb').should == {
+      'hb' => {
+        :name => 'Hampton Bones',
+        :email => 'h.bones@awesometown.me'
+      }
+    }
+  end
+
+  it 'should construct email addresses from optional username (if given) plus domain' do
+    subject.map('fb').should == {
+      'fb' => {
+        :name => 'Frances Bar',
+        :email => 'frances@awesometown.me'
+      }
+    }
+  end
+
+  it 'should use an explicitly-configured email address if given' do
+    subject.map('jd').should == {
+      'jd' => {
+        :name => 'Jane Doe',
+        :email => 'jane@awesome.biz'
+      }
+    }
+  end
+
+  it 'should map any number of initials to name -> email pairs' do
+    subject.map('jd', 'fb', 'qx', 'hb').should == {
+      'jd' => {
+        :name => 'Jane Doe',
+        :email => 'jane@awesome.biz'
+      },
+      'fb' => {
+        :name => 'Frances Bar',
+        :email => 'frances@awesometown.me'
+      },
+      'qx' => {
+        :name => 'Quincy Xavier',
+        :email => 'qx@awesometown.me'
+      },
+      'hb' => {
+        :name => 'Hampton Bones',
+        :email => 'h.bones@awesometown.me'
+      }
+    }
+  end
+
+  context 'when using a `~/.pairs` config' do
+    before :each do
+      subject.stub(:cfg => {
+        'pairs' => {
+          'jd' => 'Jane Doe; jdoe',
+          'fb' => 'Frances Bar; frances',
+          'qx' => 'Quincy Xavier; qx',
+          'hb' => 'Hampton Bones'
+        },
+        'email' => {
+          'domain' => 'awesometown.me'
+        },
+        'email_addresses' => {
+          'jd' => 'jane@awesome.biz'
+        }
+      })
+    end
+
+    it 'should map initials to name -> email pairs' do
+      subject.map('jd').fetch('jd').should == {
+        :name => 'Jane Doe',
+        :email => 'jane@awesome.biz'
+      }
+    end
+
+    it 'should map any number of initials to name -> email pairs' do
+      subject.map('jd', 'fb', 'qx', 'hb').should == {
+        'jd' => {
+          :name => 'Jane Doe',
+          :email => 'jane@awesome.biz'
+        },
+        'fb' => {
+          :name => 'Frances Bar',
+          :email => 'frances@awesometown.me'
+        },
+        'qx' => {
+          :name => 'Quincy Xavier',
+          :email => 'qx@awesometown.me'
+        },
+        'hb' => {
+          :name => 'Hampton Bones',
+          :email => 'h.bones@awesometown.me'
+        }
+      }
+    end
+  end
+
+  context 'when the authors file does not exist' do
+    let :bad_path do
+      "/its/#{rand(999)}/hosed/#{rand(999)}/captain/#{rand(999)}/.git-authors"
+    end
+
+    subject do
+      described_class.new(bad_path)
+    end
+
+    before :each do
+      subject.instance_variable_set(:@cfg, nil)
+      IO.stub(:read).with(bad_path).and_raise(
+        Errno::ENOENT.new("No such file or directory - #{bad_path}")
+      )
+    end
+
+    it 'should warn about missing authors file' do
+      STDERR.should_receive(:puts).with(
+        /Missing or corrupt authors file.*#{bad_path}/i
+      )
+      expect { subject.map('zzz') }.to raise_error
+    end
+
+    it 'should raise a ScriptDieError' do
+      STDERR.stub(:puts)
+      expect { subject.map('zzz') }.to raise_error(Git::Duet::ScriptDieError)
+    end
+  end
+end