simple-git-pair 0.0.1 → 0.0.3

data/README.md

@@ -1,26 +1,36 @@
+[![Build Status](https://secure.travis-ci.org/fsproru/simple-git-pair.png)](http://travis-ci.org/fsproru/simple-git-pair)
+
 ## 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.
+Unlike many other gems it changes only user.name and does 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"
+## Installation and Usage
+```sh
+gem install simple-git-pair
+git pair init
+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.
+Keep your pairs in `.git_pairs` file in your home directory in yaml format, e.g.
 ```yml
 nt: Nicola Tesla
 ae: Alfred Einstein
 ...
 ```
 
+## Supported Rubies
+ - 1.9.3
+ - 1.8.7
+
 ## 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.
+Feel free to submit [issues](https://github.com/fsproru/simple-git-pair/issues), pull requests or [feedback](mailto: a.tamoykin@gmail.com)

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

@@ -14,13 +14,33 @@ module SimpleGitPair
         exit 0
       end
 
+      if opts.delete "init"
+        exit(init_cmd ? 0 : 1)
+      end
+
       unless Helper.pairs_file_exists?
         Helper.complain_about_pairs_file
         exit 1
       end
 
-      system "git config user.name '#{(Helper.names_for ARGV).join ' & '}'"
+      begin
+        system "git config user.name '#{(Helper.names_for ARGV).join ' & '}'"
+      rescue Helper::NotFoundException => ex
+        puts ex.message
+        exit 1
+      end
+
       system "git config user.name" # output current username
     end
+
+    private
+
+    def init_cmd
+      if Helper.pairs_file_exists?
+        Helper.say_pairs_file_exists
+      else
+        Helper.create_pairs_file
+      end
+    end
   end
 end

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

@@ -1,33 +1,47 @@
 require 'yaml'
+require 'simple-git-pair/version'
 
 module SimpleGitPair
   module Helper
+
+    class NotFoundException < Exception; end
+
     class << self
-      PAIRS_FILE = File.expand_path('~/.git_pairs')
+      PAIRS_FILE_NAME = '.git_pairs'
+      PAIRS_FILE_PATH = File.expand_path("~/#{PAIRS_FILE_NAME}")
 
       def show_help
         puts <<-EOS
 
-          Changes your git user.name to specified names from #{PAIRS_FILE}
+          #{SUMMARY}
           Usage: git-pair <initial1> <initial2>
+
+          Commands:
+            init - creates sample #{PAIRS_FILE_NAME} config
         EOS
       end
 
       def complain_about_pairs_file
         puts <<-EOS
 
-          Please create #{PAIRS_FILE.split("/").last} file in your home directory in yaml format:
+          Please create #{PAIRS_FILE_NAME} file in your home directory in yaml format:
             ae: Alfred Einstein
             nt: Nikola Tesla
         EOS
       end
 
+      def say_pairs_file_exists
+        puts <<-EOS
+          #{PAIRS_FILE_PATH} already exists. You're good to go.
+        EOS
+      end
+
       def names_for args
-        pairs = YAML.load_file PAIRS_FILE
+        pairs = YAML.load_file PAIRS_FILE_PATH
 
         names = []
         args.each do |opt|
-          raise "There is no entry for #{opt} in #{PAIRS_FILE}" unless pairs[opt]
+          raise NotFoundException.new "There is no entry for #{opt} in #{PAIRS_FILE_PATH}" unless pairs[opt]
           names << pairs[opt]
         end
 
@@ -35,7 +49,11 @@ module SimpleGitPair
       end
 
       def pairs_file_exists?
-        File.exist? PAIRS_FILE
+        File.exist? PAIRS_FILE_PATH
+      end
+
+      def create_pairs_file
+        File.open(PAIRS_FILE_PATH, "w") { |f| f.write "nt: Nikola Tesla\nae: Alfred Einstein" }
       end
     end
   end

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

@@ -1,3 +1,4 @@
 module SimpleGitPair
-  VERSION = '0.0.1'
+  SUMMARY = "Simple way to add your pair to a git commit message"
+  VERSION = '0.0.3'
 end

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

@@ -24,6 +24,14 @@ describe SimpleGitPair::Cli do
       end
     end
 
+    context "'init' command" do
+      let(:opts) { ['init'] }
+      it "runs init cmd" do
+        cli.should_receive :init_cmd
+        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"] }
@@ -59,6 +67,38 @@ describe SimpleGitPair::Cli do
           subject
         end
       end
+
+      context "and passed initial is unknown" do
+        let(:opts) { ['unknown_dude'] }
+        let(:ex)   { SimpleGitPair::Helper::NotFoundException.new "I don't know about #{opts.first}" }
+        before {
+          SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return true
+          SimpleGitPair::Helper.stub(:names_for).and_raise ex
+          cli.stub! :system
+          cli.should_receive(:puts).with(ex.message)
+        }
+        it { expect { subject }.to raise_error SystemExit }
+      end
+    end
+
+    describe "#init_cmd" do
+      subject { cli.send :init_cmd }
+
+      context "pairs file already exists" do
+        before { SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return true }
+        it "complains and exit" do
+          SimpleGitPair::Helper.should_receive :say_pairs_file_exists
+          subject.should be_false
+        end
+      end
+
+      context "there is no pairs file" do
+        before { SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return false }
+        it "creates a pairs file" do
+          SimpleGitPair::Helper.should_receive(:create_pairs_file).and_return true
+          subject.should be_true
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-git-pair
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-01 00:00:00.000000000 Z
+date: 2012-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70211604747240 !ruby/object:Gem::Requirement
+  requirement: &70241657198260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70211604747240
+  version_requirements: *70241657198260
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70241657197660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70241657197660
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70211604746720 !ruby/object:Gem::Requirement
+  requirement: &70241657197160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70211604746720
+  version_requirements: *70241657197160
 description: Changes only user.name setting in git config,                    so github
   can still understand under which account a code was committed
 email:
@@ -74,7 +85,7 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Adds your pair to a commit message
+summary: Simple way to add your pair to a git commit message
 test_files:
 - spec/lib/simple-git-pair/cli_spec.rb
 - spec/lib/simple-git-pair/helper_spec.rb