simple-git-pair 0.0.1

data/README.md

@@ -0,0 +1,26 @@
+## TL;DR
+Simple way to add your pair to a git commit message.
+
+## Description
+Unlike many other gems it doesn NOT change your email address in git config, so Github can associate your commit to github account properly.
+This is especially useful for Github graphs and statistics.
+
+## Usage
+`git pair nt ae` # changes your git user.name to "Nicola Tesla & Alfred Einstein"
+
+## Configuration
+Create and keep your pairs in `.git_pairs` file in your home directory in yaml format, e.g.
+```yml
+nt: Nicola Tesla
+ae: Alfred Einstein
+...
+```
+
+## Future Development
+ - git pair init # creates simple .git_pairs file
+ - git pair add <initial> <full_name> # adds an author to .git_pairs
+ - git pair delete <initial> # deletes a pair from .git_pairs
+ - git pair list # lists all available pairs
+
+## Issues and Contributions
+Feel free to submit issues or pull requests.

data/bin/git-pair

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'simple-git-pair'
+
+SimpleGitPair::Cli.new(ARGV).run!

data/lib/simple-git-pair.rb

@@ -0,0 +1,2 @@
+require 'simple-git-pair/helper'
+require 'simple-git-pair/cli'

data/lib/simple-git-pair/cli.rb

@@ -0,0 +1,26 @@
+require 'simple-git-pair/helper'
+
+module SimpleGitPair
+  class Cli
+    attr_accessor :opts
+
+    def initialize(opts = {})
+      self.opts = opts
+    end
+
+    def run!
+      if opts.delete "--help" or opts.delete "-h" or opts.empty?
+        Helper.show_help
+        exit 0
+      end
+
+      unless Helper.pairs_file_exists?
+        Helper.complain_about_pairs_file
+        exit 1
+      end
+
+      system "git config user.name '#{(Helper.names_for ARGV).join ' & '}'"
+      system "git config user.name" # output current username
+    end
+  end
+end

data/lib/simple-git-pair/helper.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+
+module SimpleGitPair
+  module Helper
+    class << self
+      PAIRS_FILE = File.expand_path('~/.git_pairs')
+
+      def show_help
+        puts <<-EOS
+
+          Changes your git user.name to specified names from #{PAIRS_FILE}
+          Usage: git-pair <initial1> <initial2>
+        EOS
+      end
+
+      def complain_about_pairs_file
+        puts <<-EOS
+
+          Please create #{PAIRS_FILE.split("/").last} file in your home directory in yaml format:
+            ae: Alfred Einstein
+            nt: Nikola Tesla
+        EOS
+      end
+
+      def names_for args
+        pairs = YAML.load_file PAIRS_FILE
+
+        names = []
+        args.each do |opt|
+          raise "There is no entry for #{opt} in #{PAIRS_FILE}" unless pairs[opt]
+          names << pairs[opt]
+        end
+
+        names
+      end
+
+      def pairs_file_exists?
+        File.exist? PAIRS_FILE
+      end
+    end
+  end
+end

data/lib/simple-git-pair/version.rb

@@ -0,0 +1,3 @@
+module SimpleGitPair
+  VERSION = '0.0.1'
+end

data/spec/lib/simple-git-pair/cli_spec.rb

@@ -0,0 +1,64 @@
+require 'simple-git-pair/cli'
+
+describe SimpleGitPair::Cli do
+  before { Object.stub(:system) }
+  let(:opts) { [] }
+  let(:cli) { described_class.new opts }
+
+  describe "#run!" do
+    subject { cli.run! }
+
+    context "there is no option passed in" do
+      let(:opts) { [] }
+      it "shows help" do
+        SimpleGitPair::Helper.should_receive :show_help
+        expect { subject }.to raise_error SystemExit
+      end
+    end
+
+    context "with --help or -h option" do
+      let(:opts) { ['--help', '-h'] }
+      it "shows help" do
+        SimpleGitPair::Helper.should_receive :show_help
+        expect { subject }.to raise_error SystemExit
+      end
+    end
+
+    context "there is NO pairs file" do
+      before { SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return false }
+      let(:opts) { ["some_initials"] }
+      it "complains and exit" do
+        SimpleGitPair::Helper.should_receive :complain_about_pairs_file
+        expect { subject }.to raise_error SystemExit
+      end
+    end
+
+    context "there is a pairs file" do
+      context "and multiple initials are passed in" do
+        before {
+          SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return true
+          SimpleGitPair::Helper.stub(:names_for).and_return ["Super Mario", "Pac Man"]
+          cli.stub! :system
+        }
+        let(:opts) { ['sm', 'pm'] }
+        it "changes only username to pair name" do
+          cli.should_receive(:system).with("git config user.name 'Super Mario & Pac Man'")
+          subject
+        end
+      end
+
+      context "and single initial is passed in" do
+        before {
+          SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return true
+          SimpleGitPair::Helper.stub(:names_for).and_return ["Pac Man"]
+          cli.stub! :system
+        }
+        let(:opts) { ['pm'] }
+        it "changes only username to single name" do
+          cli.should_receive(:system).with("git config user.name 'Pac Man'")
+          subject
+        end
+      end
+    end
+  end
+end

data/spec/lib/simple-git-pair/helper_spec.rb

@@ -0,0 +1,39 @@
+require 'simple-git-pair/helper'
+
+describe SimpleGitPair::Helper do
+  describe :names_for do
+    before do
+      YAML.stub(:load_file).and_return(
+        { "pm" => "Pac Man", "sm" => "Super Mario" }
+      )
+    end
+
+    subject {described_class.names_for initials}
+
+    context "there is NO user in pairs file" do
+      let(:initials) { ["non_existent_pair"] }
+      it { expect { subject }.to raise_error }
+    end
+
+    context "there are users in pairs file" do
+      let(:initials) { ["pm", "sm"] }
+      it 'returns array with user names' do
+        subject.should == ["Pac Man", "Super Mario"]
+      end
+    end
+  end
+
+  describe :pairs_file_exists? do
+    subject { described_class.pairs_file_exists? }
+
+    context "pairs file exists" do
+      before { File.stub(:exist?).and_return true }
+      it { should be_true }
+    end
+
+    context "there is no pairs file" do
+      before { File.stub(:exist?).and_return false }
+      it { should be_false }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+Rspec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: simple-git-pair
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Tamoykin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70211604747240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211604747240
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: &70211604746720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211604746720
+description: Changes only user.name setting in git config,                    so github
+  can still understand under which account a code was committed
+email:
+- a.tamoykin@gmail.com
+executables:
+- git-pair
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/simple-git-pair/cli.rb
+- lib/simple-git-pair/helper.rb
+- lib/simple-git-pair/version.rb
+- lib/simple-git-pair.rb
+- bin/git-pair
+- README.md
+- spec/lib/simple-git-pair/cli_spec.rb
+- spec/lib/simple-git-pair/helper_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/fsproru/simple-git-pair
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Adds your pair to a commit message
+test_files:
+- spec/lib/simple-git-pair/cli_spec.rb
+- spec/lib/simple-git-pair/helper_spec.rb
+- spec/spec_helper.rb