simple-git-pair 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,14 +1,26 @@
-## 0.0.1
- - Initial release
+## 0.2.0
+ - New command: git pair delete
+ - New command: git pair list
+ - Added support ruby-1.9.2 spport
+ - Bugfix: `git pair add` doesn't add a same pair
 
-## 0.0.2
- - Added rspec suite
- - Fixed ugly output if unknown pair is specified
+## 0.1.0
+ - New command: git pair add
+ - Added post install message
+ - Fixed noisy error message on failed validation
+ - Added some color to output
+
+## 0.0.4
+ - Interactive creation of a sample config
 
 ## 0.0.3
  - Added integration test suite
  - git pair init command
  - Improved documentation
 
-## 0.0.4
- - Interactive creation of a sample config
+## 0.0.2
+ - Added rspec suite
+ - Fixed ugly output if unknown pair is specified
+
+## 0.0.1
+ - Initial release

data/README.md

@@ -13,25 +13,22 @@ This is especially useful for Github graphs and statistics.
 ```sh
 gem install simple-git-pair
 git pair init
-git pair nt ae # changes your git user.name to "Nicola Tesla & Alfred Einstein"
+git pair nt ae # changes your git user.name to "Nikola Tesla & Alfred Einstein"
 ```
 
-## Configuration
-Keep your pairs in `.git_pairs` file in your home directory in yaml format, e.g.
-```yml
-nt: Nicola Tesla
-ae: Alfred Einstein
-...
+## Available commands
+```sh
+git pair init                        # create a sample .git_pairs file in your home directory
+git pair add <initials> <Full Name>  # add a new pair
+git pair delete <initial>            # delete a pair from .git_pairs
+git pair list                        # list all available pairs
+git pair help                        # display a help page
 ```
 
 ## Supported Rubies
  - 1.9.3
+ - 1.9.2
  - 1.8.7
 
-## Future Development
- - 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](https://github.com/fsproru/simple-git-pair/issues), pull requests or [feedback](mailto: a.tamoykin@gmail.com)

data/bin/git-pair

@@ -3,19 +3,18 @@ require 'rubygems'
 require 'commander/import'
 require 'simple-git-pair'
 
-#TODO: figure out a better way to output usage first
 program :name,           "\n  Usage:\n    #{SimpleGitPair::BINARY_NAME} <initials>"
 program :version,        SimpleGitPair::VERSION
 program :description,    SimpleGitPair::SUMMARY
 program :int_message,    "Good bye"
-program :help,           'Example', 'git pair nt ae       Changes your git user.name to "Nicola Tesla & Alfred Einstein"'
+program :help,           'Example', 'git pair nt ae       Changes your git user.name to "Nikola Tesla & Alfred Einstein"'
 program :help_formatter, :compact
 
 default_command :change
 command :change do |c|
   c.description = "Change your git user.name"
   c.syntax = "#{SimpleGitPair::BINARY_NAME} change <initials>"
-  c.example 'Nicola Tesla & Alfred Einstein', "#{SimpleGitPair::BINARY_NAME} change nt ae"
+  c.example 'Nikola Tesla & Alfred Einstein', "#{SimpleGitPair::BINARY_NAME} change nt ae"
   c.action do |args, options|
     if args.empty?
       commands['help'].run
@@ -34,6 +33,15 @@ command :init do |c|
   end
 end
 
+command :list do |c|
+  c.description = "List available pairs"
+  c.syntax = SimpleGitPair::Command::List::USAGE
+  c.example "Lists all available pairs", "#{SimpleGitPair::BINARY_NAME} list"
+  c.action do |args, options|
+    SimpleGitPair::Command::List.new.run!
+  end
+end
+
 command :add do |c|
   c.description = "Add new pair to a list"
   c.syntax = SimpleGitPair::Command::Add::USAGE
@@ -42,3 +50,12 @@ command :add do |c|
     SimpleGitPair::Command::Add.new(args).run!
   end
 end
+
+command :delete do |c|
+  c.description = "Delete existing pair"
+  c.syntax = SimpleGitPair::Command::Delete::USAGE
+  c.example "Deletes og from pairs list", "#{SimpleGitPair::BINARY_NAME} delete og"
+  c.action do |args, options|
+    SimpleGitPair::Command::Delete.new(args).run!
+  end
+end

data/lib/simple-git-pair.rb

@@ -3,3 +3,5 @@ require 'simple-git-pair/command/base'
 require 'simple-git-pair/command/init'
 require 'simple-git-pair/command/change'
 require 'simple-git-pair/command/add'
+require 'simple-git-pair/command/delete'
+require 'simple-git-pair/command/list'

data/lib/simple-git-pair/command/add.rb

@@ -17,15 +17,11 @@ module SimpleGitPair
         end
 
         pairs = Helper.read_pairs
-        existent_user = pairs[initials]
+        existing_user = pairs[initials]
         message = ""
 
-        if existent_user
-          unless agree("#{initials} has alredy taken by #{existent_user}. Override it with #{fullname}? (yes/no)")
-            puts "#{fullname} was not added"
-            exit 1
-          end
-
+        if existing_user
+          exit 1 unless user_needs_update? existing_user, initials, fullname
           message = "Updated #{initials} to be #{fullname}"
         else
           message = "Added #{fullname}"
@@ -51,6 +47,18 @@ module SimpleGitPair
         errors << "Please provide a Full Name" if fullname == ""
         [ initials, fullname, errors.empty?, errors ]
       end
+
+      def user_needs_update? existing_user, initials, fullname
+        if existing_user == fullname
+          puts "#{fullname} already exists"
+          false
+        elsif not agree("#{initials} has already taken by #{existing_user}. Override it with #{fullname}? (yes/no)")
+          puts "#{fullname} was not added"
+          false
+        else
+          true
+        end
+      end
     end
   end
 end

data/lib/simple-git-pair/command/delete.rb

@@ -0,0 +1,46 @@
+require 'simple-git-pair/command/base'
+require 'rainbow'
+
+module SimpleGitPair
+  module Command
+    class Delete < Base
+      USAGE = "#{BINARY_NAME} delete <initials>"
+
+      def run!
+        exit 1 unless ensure_pairs_file_exists
+
+        initials, valid_opts, errors = validate_opts
+        unless valid_opts
+          puts errors.join "\n"
+          puts "Usage: #{USAGE}"
+          exit 1
+        end
+
+        pairs = Helper.read_pairs
+        existing_user = pairs[initials]
+
+        if existing_user
+          pairs.delete initials
+          Helper.save_pairs pairs
+          puts "Deleted #{initials}: #{existing_user}".color(:green)
+        else
+          puts "There is no #{initials}"
+        end
+      end
+
+      private
+
+      ##
+      # Validate and return options
+      #
+      # Returns: array
+      #   [initials, status, errors]
+      def validate_opts
+        initials = opts.shift
+        errors = []
+        errors << "Initials should contain no spaces" if /\s/.match initials
+        [ initials, errors.empty?, errors ]
+      end
+    end
+  end
+end

data/lib/simple-git-pair/command/list.rb

@@ -0,0 +1,20 @@
+require 'simple-git-pair/command/base'
+
+module SimpleGitPair
+  module Command
+    class List < Base
+      USAGE = "#{BINARY_NAME} list"
+
+      def run!
+        exit 1 unless ensure_pairs_file_exists
+
+        pairs = Helper.read_pairs
+        if pairs.empty?
+          puts "No pairs available. Use 'git pair add' to add more pairs."
+        else
+          pairs.each {|initials, fullname| puts "#{initials}: #{fullname}"}
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module SimpleGitPair
   SUMMARY     = "Simple way to add your pair to a git commit message"
   BINARY_NAME = "git pair"
-  VERSION     = '0.1.0'
+  VERSION     = '0.2.0'
 end

data/spec/lib/simple-git-pair/command/add_spec.rb

@@ -4,28 +4,30 @@ require 'simple-git-pair/command/add'
 describe SimpleGitPair::Command::Add do
   let(:opts) { [] }
   let(:command) { described_class.new opts }
+  before { command.stub :puts }
 
   describe "#run!" do
     subject { command.run! }
-    before { command.stub :puts }
 
     it_should_behave_like "command that ensures that pairs file exists"
 
     context "there is a pairs file" do
+      before { command.stub(:ensure_pairs_file_exists).and_return true }
+
       context "and there is already a pair with the same initials" do
         let(:opts) { ["ng", "New", "Guy"] }
         before { SimpleGitPair::Helper.stub(:read_pairs).and_return({"ng" => "Already Exists"}) }
 
-        context "and user agrees to override" do
-          before { command.stub(:agree).and_return true }
+        context "and user needs an update" do
+          before { command.stub(:user_needs_update?).and_return true }
           it "overrides the pair" do
             SimpleGitPair::Helper.should_receive(:save_pairs).with({"ng" => "New Guy"})
             subject
           end
         end
 
-        context "and user dissagrees to override" do
-          before { command.stub(:agree).and_return false }
+        context "and user does NOT need an update" do
+          before { command.stub(:user_needs_update?).and_return false }
           it "doesn't override and exits" do
             SimpleGitPair::Helper.should_not_receive :save_pairs
             expect {subject}.to raise_error SystemExit
@@ -77,4 +79,29 @@ describe SimpleGitPair::Command::Add do
       end
     end
   end
+
+  describe "#user_needs_update?" do
+    let(:existing_user) { "Old Guy" }
+    let(:initials) { "og" }
+    subject { command.send :user_needs_update?, existing_user, initials, fullname }
+
+    context "user already exists with same initials and fullname" do
+      let(:fullname) { "Old Guy" }
+      it {should be_false}
+    end
+
+    context "user already exists with same initials only" do
+      let(:fullname) { "New Guy" }
+
+      context "user disagrees to override it" do
+        before { command.stub(:agree).and_return false }
+        it {should be_false}
+      end
+
+      context "user agrees to override it" do
+        before { command.stub(:agree).and_return true }
+        it {should be_true}
+      end
+    end
+  end
 end

data/spec/lib/simple-git-pair/command/delete_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'simple-git-pair/command/delete'
+
+describe SimpleGitPair::Command::Delete do
+  let(:opts) { [] }
+  let(:command) { described_class.new opts }
+
+  describe "#run!" do
+    subject { command.run! }
+    before { command.stub :puts }
+
+    it_should_behave_like "command that ensures that pairs file exists"
+
+    context "there is a pairs file" do
+      before { command.stub(:ensure_pairs_file_exists).and_return true }
+
+      context "and specified pair exists" do
+        let(:opts) { ["dm"] }
+        before { SimpleGitPair::Helper.stub(:read_pairs).and_return({"dm" => "Delete me", "km" => "Keep Me"}) }
+
+        it "deletes it" do
+          SimpleGitPair::Helper.should_receive(:save_pairs).with({"km" => "Keep Me"})
+          subject
+        end
+      end
+
+      context "and specified pair does NOT exist" do
+        let(:opts) { ["dm"] }
+        before { SimpleGitPair::Helper.stub(:read_pairs).and_return({"km" => "Keep Me"}) }
+
+        it "does NOT delete it" do
+          SimpleGitPair::Helper.should_not_receive :save_pairs
+        end
+      end
+    end
+  end
+
+  describe "#validate_opts" do
+    subject { command.send :validate_opts }
+
+    context "initials have spaces" do
+      let(:opts) { ["n g"] }
+      it "returns error status and msg" do
+        initials, valid_opts, errors = subject
+        valid_opts.should be_false
+        errors.should_not be_empty
+      end
+    end
+
+    context "initals are fine" do
+      let(:opts) { ["og"] }
+
+      it "returns intials and no error" do
+        initials, valid_opts, errors = subject
+        initials.should == "og"
+      end
+    end
+  end
+end

data/spec/lib/simple-git-pair/command/list_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'simple-git-pair/command/list'
+
+describe SimpleGitPair::Command::List do
+  let(:command) { described_class.new }
+
+  describe "#run!" do
+    subject { command.run! }
+
+    it_should_behave_like "command that ensures that pairs file exists"
+
+    context "there is a pairs file" do
+      before { command.stub(:ensure_pairs_file_exists).and_return true }
+
+      context "there are available pairs" do
+        before { SimpleGitPair::Helper.stub(:read_pairs).and_return({"od" => "One Dude", "ad" => "Another Dude"}) }
+        it "displays them" do
+          command.should_receive(:puts).with("od: One Dude")
+          command.should_receive(:puts).with("ad: Another Dude")
+          subject
+        end
+      end
+
+      context "there is NO available pairs" do
+        before { SimpleGitPair::Helper.stub(:read_pairs).and_return({}) }
+        it "complains" do
+          command.should_receive(:puts).with("No pairs available. Use 'git pair add' to add more pairs.")
+          subject
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ describe SimpleGitPair::Helper do
     subject {described_class.names_for initials}
 
     context "there is NO user in pairs file" do
-      let(:initials) { ["non_existent_pair"] }
+      let(:initials) { ["non_existing_pair"] }
       it { expect { subject }.to raise_error }
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-git-pair
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-24 00:00:00.000000000 Z
+date: 2012-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &70239044165920 !ruby/object:Gem::Requirement
+  requirement: &70223973955700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70239044165920
+  version_requirements: *70223973955700
 - !ruby/object:Gem::Dependency
   name: rainbow
-  requirement: &70239044181500 !ruby/object:Gem::Requirement
+  requirement: &70223973955060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70239044181500
+  version_requirements: *70223973955060
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70239044180880 !ruby/object:Gem::Requirement
+  requirement: &70223973954620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70239044180880
+  version_requirements: *70223973954620
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70239044180280 !ruby/object:Gem::Requirement
+  requirement: &70223973954040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70239044180280
+  version_requirements: *70223973954040
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70239044179400 !ruby/object:Gem::Requirement
+  requirement: &70223973953420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70239044179400
+  version_requirements: *70223973953420
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70239044178820 !ruby/object:Gem::Requirement
+  requirement: &70223973952520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70239044178820
+  version_requirements: *70223973952520
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70239044178320 !ruby/object:Gem::Requirement
+  requirement: &70223973950980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70239044178320
+  version_requirements: *70223973950980
 description: Simple way to add your pair to a git commit message
 email:
 - a.tamoykin@gmail.com
@@ -99,7 +99,9 @@ files:
 - lib/simple-git-pair/command/add.rb
 - lib/simple-git-pair/command/base.rb
 - lib/simple-git-pair/command/change.rb
+- lib/simple-git-pair/command/delete.rb
 - lib/simple-git-pair/command/init.rb
+- lib/simple-git-pair/command/list.rb
 - lib/simple-git-pair/helper.rb
 - lib/simple-git-pair/version.rb
 - lib/simple-git-pair.rb
@@ -109,7 +111,9 @@ files:
 - spec/lib/simple-git-pair/command/add_spec.rb
 - spec/lib/simple-git-pair/command/base_spec.rb
 - spec/lib/simple-git-pair/command/change_spec.rb
+- spec/lib/simple-git-pair/command/delete_spec.rb
 - spec/lib/simple-git-pair/command/init_spec.rb
+- spec/lib/simple-git-pair/command/list_spec.rb
 - spec/lib/simple-git-pair/helper_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples/command_examples.rb
@@ -143,7 +147,9 @@ test_files:
 - spec/lib/simple-git-pair/command/add_spec.rb
 - spec/lib/simple-git-pair/command/base_spec.rb
 - spec/lib/simple-git-pair/command/change_spec.rb
+- spec/lib/simple-git-pair/command/delete_spec.rb
 - spec/lib/simple-git-pair/command/init_spec.rb
+- spec/lib/simple-git-pair/command/list_spec.rb
 - spec/lib/simple-git-pair/helper_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples/command_examples.rb