simple-git-pair 0.0.4 → 0.1.0

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://secure.travis-ci.org/fsproru/simple-git-pair.png)](http://travis-ci.org/fsproru/simple-git-pair)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/fsproru/simple-git-pair)
 
 ## TL;DR
 Simple way to add your pair to a git commit message.

data/bin/git-pair

@@ -3,10 +3,8 @@ require 'rubygems'
 require 'commander/import'
 require 'simple-git-pair'
 
-BINARY_NAME = "git pair"
-
 #TODO: figure out a better way to output usage first
-program :name,           "\n  Usage:\n    #{BINARY_NAME} <initials>"
+program :name,           "\n  Usage:\n    #{SimpleGitPair::BINARY_NAME} <initials>"
 program :version,        SimpleGitPair::VERSION
 program :description,    SimpleGitPair::SUMMARY
 program :int_message,    "Good bye"
@@ -15,9 +13,9 @@ program :help_formatter, :compact
 
 default_command :change
 command :change do |c|
-  c.description = "Changes your git user.name"
-  c.syntax = "git pair change <initials>"
-  c.example 'Nicola Tesla & Alfred Einstein', "#{BINARY_NAME} change nt ae"
+  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.action do |args, options|
     if args.empty?
       commands['help'].run
@@ -28,11 +26,19 @@ command :change do |c|
 end
 
 command :init do |c|
-  c.syntax = "#{BINARY_NAME} init"
-  c.description = "Creates a sample config file"
-  c.example "Creates .git_pairs in your home directory", "#{BINARY_NAME} init"
+  c.description = "Create a sample config file"
+  c.syntax = "#{SimpleGitPair::BINARY_NAME} init"
+  c.example "Creates .git_pairs in your home directory", "#{SimpleGitPair::BINARY_NAME} init"
   c.action do |args, options|
     SimpleGitPair::Command::Init.new.run!
   end
 end
 
+command :add do |c|
+  c.description = "Add new pair to a list"
+  c.syntax = SimpleGitPair::Command::Add::USAGE
+  c.example "Adds New Guy to pairs list", "#{SimpleGitPair::BINARY_NAME} add ng New Guy"
+  c.action do |args, options|
+    SimpleGitPair::Command::Add.new(args).run!
+  end
+end

data/features/step_definitions/pair_steps.rb

@@ -5,8 +5,14 @@ Given /^there is a local repo$/ do
   step 'I run `git init`'
 end
 
-Given /^there is no pairs file$/ do
-  step %Q{I remove the file "#{@pairs_file}"} if File.exists? @pairs_file
+Given /^there is (no|a) pairs file$/ do |yes_no|
+  file_should_exist = yes_no == "a" ? true : false
+
+  if file_should_exist
+    `git pair init`
+  else
+    step %Q{I remove the file "#{@pairs_file}"} if File.exists? @pairs_file
+  end
 end
 
 Then /^it creates a sample pairs file$/ do

data/lib/simple-git-pair.rb

@@ -2,3 +2,4 @@ require 'simple-git-pair/helper'
 require 'simple-git-pair/command/base'
 require 'simple-git-pair/command/init'
 require 'simple-git-pair/command/change'
+require 'simple-git-pair/command/add'

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

@@ -0,0 +1,56 @@
+require 'simple-git-pair/command/base'
+require 'rainbow'
+
+module SimpleGitPair
+  module Command
+    class Add < Base
+      USAGE = "#{BINARY_NAME} add <initials> <Full Name>"
+
+      def run!
+        exit 1 unless ensure_pairs_file_exists
+
+        initials, fullname, valid_opts, errors = validate_opts
+        unless valid_opts
+          puts errors.join "\n"
+          puts "Usage: #{USAGE}"
+          exit 1
+        end
+
+        pairs = Helper.read_pairs
+        existent_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
+
+          message = "Updated #{initials} to be #{fullname}"
+        else
+          message = "Added #{fullname}"
+        end
+
+        pairs[initials] = fullname
+        Helper.save_pairs pairs
+        puts message.color(:green)
+      end
+
+      private
+
+      ##
+      # Validate and return options
+      #
+      # Returns: array
+      #   [initials, fullname, status, errors]
+      def validate_opts
+        initials = opts.shift
+        fullname = opts.join " "
+        errors = []
+        errors << "Initials should contain no spaces" if /\s/.match initials
+        errors << "Please provide a Full Name" if fullname == ""
+        [ initials, fullname, errors.empty?, errors ]
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+require 'simple-git-pair/helper'
+
 module SimpleGitPair
   module Command
     class Base
@@ -10,6 +12,24 @@ module SimpleGitPair
       def run!
         raise "Could you implement run! method on #{self.class}?"
       end
+
+      private
+
+      # Interactively creates a sample pairs file if pairs file doesn't exist
+      def ensure_pairs_file_exists
+        file_exists = Helper.pairs_file_exists?
+
+        unless file_exists
+          if agree("Can't find a config file. Create a sample one? (yes/no)")
+            file_exists = Helper.create_pairs_file
+          else
+            Helper.complain_about_pairs_file
+            file_exists = false
+          end
+        end
+
+        file_exists
+      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 require 'simple-git-pair/command/base'
-require 'simple-git-pair/helper'
+require 'rainbow'
 
 module SimpleGitPair
   module Command
@@ -14,25 +14,7 @@ module SimpleGitPair
           exit 1
         end
 
-        system "git config user.name" # output current username
-      end
-
-      private
-
-      # Interactively creates a sample pairs file if pairs file doesn't exist
-      def ensure_pairs_file_exists
-        file_exists = Helper.pairs_file_exists?
-
-        unless file_exists
-          if agree("Can't find a config file. Create a sample one? (yes/no)")
-            file_exists = Helper.create_pairs_file
-          else
-            Helper.complain_about_pairs_file
-            file_exists = false
-          end
-        end
-
-        file_exists
+        puts `git config user.name`.chomp.color(:green)
       end
     end
   end

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

@@ -1,5 +1,4 @@
 require 'simple-git-pair/command/base'
-require 'simple-git-pair/helper'
 
 module SimpleGitPair
   module Command

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

@@ -18,11 +18,11 @@ Please run: git pair init
       end
 
       def say_pairs_file_exists
-        puts "#{PAIRS_FILE_PATH} already exists. You're good to go."
+        puts "#{PAIRS_FILE_PATH} already exists. You're good to go.".color(:green)
       end
 
       def names_for args
-        pairs = YAML.load_file PAIRS_FILE_PATH
+        pairs = read_pairs
 
         names = []
         args.each do |opt|
@@ -40,6 +40,16 @@ Please run: git pair init
       def create_pairs_file
         File.open(PAIRS_FILE_PATH, "w") { |f| f.write "nt: Nikola Tesla\nae: Alfred Einstein" }
       end
+
+      def save_pairs hash
+        File.open(PAIRS_FILE_PATH, 'w' ) do |file|
+          YAML.dump( hash, file )
+        end
+      end
+
+      def read_pairs
+        YAML.load_file PAIRS_FILE_PATH
+      end
     end
   end
 end

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

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

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

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'simple-git-pair/command/add'
+
+describe SimpleGitPair::Command::Add 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
+      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 }
+          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 }
+          it "doesn't override and exits" do
+            SimpleGitPair::Helper.should_not_receive :save_pairs
+            expect {subject}.to raise_error SystemExit
+          end
+        end
+      end
+
+      context "and there is NO pair with same initials" do
+        let(:opts) { ["ng", "New", "Guy"] }
+        before { SimpleGitPair::Helper.stub(:read_pairs).and_return({"og" => "Old Guy"}) }
+
+        it "adds a pair" do
+          SimpleGitPair::Helper.should_receive(:save_pairs).with({"og" => "Old Guy", "ng" => "New Guy"})
+          subject
+        end
+      end
+    end
+  end
+
+  describe "#validate_opts" do
+    subject { command.send :validate_opts }
+
+    context "initials have spaces" do
+      let(:opts) { ["n g", "New_Guy"] }
+      it "returns error status and msg" do
+        initials, fullname, valid_opts, errors = subject
+        valid_opts.should be_false
+        errors.should_not be_empty
+      end
+    end
+
+    context "full name is not passed in" do
+      let(:opts) { ["ng"] }
+      it "returns error status and msg" do
+        initials, fullname, valid_opts, errors = subject
+        valid_opts.should be_false
+        errors.should_not be_empty
+      end
+    end
+
+    context "initals and fullname are fine" do
+      let(:opts) { ["ng", "New", "Awesome", "Guy"] }
+
+      it { expect {subject}.to_not raise_error RuntimeError }
+
+      it "treats all options after intials as a fullname" do
+        intials, fullname = subject
+        fullname.should == "New Awesome Guy"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'simple-git-pair/command/base'
+
+describe SimpleGitPair::Command::Base do
+  let(:command) { described_class.new [] }
+
+  describe "#run!" do
+    subject { command.run! }
+    it { expect { subject }.to raise_error RuntimeError }
+  end
+
+  describe "#ensure_pairs_file_exists" do
+    subject { command.send :ensure_pairs_file_exists }
+
+    context "there is NO pairs file" do
+      before { SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return false }
+
+      context "and user agrees to create it" do
+        before { command.stub(:agree).and_return true }
+        it "creates a pairs file and returns true" do
+          SimpleGitPair::Helper.should_receive(:create_pairs_file).and_return true
+          subject.should be_true
+        end
+      end
+
+      context "and user disagrees to create it" do
+        before { command.stub(:agree).and_return false }
+        it "complains and return false" do
+          SimpleGitPair::Helper.should_receive :complain_about_pairs_file
+          subject.should be_false
+        end
+      end
+    end
+  end
+end

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

@@ -1,21 +1,15 @@
+require 'spec_helper'
 require 'simple-git-pair/command/change'
 
 describe SimpleGitPair::Command::Change do
-  before { Object.stub(:system) }
   let(:opts) { [] }
   let(:command) { described_class.new opts }
 
   describe "#run!" do
+    before { command.stub :puts }
     subject { command.run! }
 
-    context "there is NO pairs file" do
-      let(:opts) { ["some_initials"] }
-
-      before { command.stub(:ensure_pairs_file_exists).and_return false }
-      it "complains and exit" do
-        expect { subject }.to raise_error SystemExit
-      end
-    end
+    it_should_behave_like "command that ensures that pairs file exists"
 
     context "there is a pairs file" do
       context "and multiple initials are passed in" do
@@ -57,28 +51,4 @@ describe SimpleGitPair::Command::Change do
       end
     end
   end
-
-  describe "#ensure_pairs_file_exists" do
-    subject { command.send :ensure_pairs_file_exists }
-
-    context "there is NO pairs file" do
-      before { SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return false }
-
-      context "and user agrees to create it" do
-        before { command.stub(:agree).and_return true }
-        it "creates a pairs file and returns true" do
-          SimpleGitPair::Helper.should_receive(:create_pairs_file).and_return true
-          subject.should be_true
-        end
-      end
-
-      context "and user disagrees to create it" do
-        before { command.stub(:agree).and_return false }
-        it "complains and return false" do
-          SimpleGitPair::Helper.should_receive :complain_about_pairs_file
-          subject.should be_false
-        end
-      end
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 
-Rspec.configure do |config|
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
   config.color_enabled = true
 end

data/spec/support/shared_examples/command_examples.rb

@@ -0,0 +1,8 @@
+shared_examples_for "command that ensures that pairs file exists" do
+  context "there is NO pairs file" do
+    before { command.stub(:ensure_pairs_file_exists).and_return false }
+    it "complains and exit" do
+      expect { subject }.to raise_error SystemExit
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-git-pair
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-10 00:00:00.000000000 Z
+date: 2012-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &70286427233280 !ruby/object:Gem::Requirement
+  requirement: &70239044165920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70286427233280
+  version_requirements: *70239044165920
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: &70239044181500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70239044181500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70286427232800 !ruby/object:Gem::Requirement
+  requirement: &70239044180880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286427232800
+  version_requirements: *70239044180880
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70286427232220 !ruby/object:Gem::Requirement
+  requirement: &70239044180280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286427232220
+  version_requirements: *70239044180280
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70286427231460 !ruby/object:Gem::Requirement
+  requirement: &70239044179400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286427231460
+  version_requirements: *70239044179400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70286427231020 !ruby/object:Gem::Requirement
+  requirement: &70239044178820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286427231020
+  version_requirements: *70239044178820
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70286427230240 !ruby/object:Gem::Requirement
+  requirement: &70239044178320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286427230240
+  version_requirements: *70239044178320
 description: Simple way to add your pair to a git commit message
 email:
 - a.tamoykin@gmail.com
@@ -85,6 +96,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 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/init.rb
@@ -94,15 +106,18 @@ files:
 - bin/git-pair
 - CHANGELOG.md
 - README.md
+- 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/init_spec.rb
 - spec/lib/simple-git-pair/helper_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/command_examples.rb
 - features/step_definitions/pair_steps.rb
 - features/support/env.rb
 homepage: http://github.com/fsproru/simple-git-pair
 licenses: []
-post_install_message: 
+post_install_message: ! 'Pair up! Run: git pair'
 rdoc_options: []
 require_paths:
 - lib
@@ -125,9 +140,12 @@ signing_key:
 specification_version: 3
 summary: Simple way to add your pair to a git commit message
 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/init_spec.rb
 - spec/lib/simple-git-pair/helper_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/command_examples.rb
 - features/step_definitions/pair_steps.rb
 - features/support/env.rb