simple-git-pair 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## 0.0.1
+ - Initial release
+
+## 0.0.2
+ - Added rspec suite
+ - Fixed ugly output if unknown pair is specified
+
+## 0.0.3
+ - Added integration test suite
+ - git pair init command
+ - Improved documentation
+
+## 0.0.4
+ - Interactive creation of a sample config

data/bin/git-pair

@@ -1,4 +1,38 @@
 #!/usr/bin/env ruby
+require 'rubygems'
+require 'commander/import'
 require 'simple-git-pair'
 
-SimpleGitPair::Cli.new(ARGV).run!
+BINARY_NAME = "git pair"
+
+#TODO: figure out a better way to output usage first
+program :name,           "\n  Usage:\n    #{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_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.action do |args, options|
+    if args.empty?
+      commands['help'].run
+    else
+      SimpleGitPair::Command::Change.new(args).run!
+    end
+  end
+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.action do |args, options|
+    SimpleGitPair::Command::Init.new.run!
+  end
+end
+

data/features/step_definitions/pair_steps.rb

@@ -0,0 +1,34 @@
+Given /^there is a local repo$/ do
+  @git_repo   = 'my-repo'
+  step %Q{a directory named "#{@git_repo}"}
+  step %Q{I cd to "#{@git_repo}"}
+  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
+end
+
+Then /^it creates a sample pairs file$/ do
+  step %Q{a file named "#{@pairs_file}" should exist}
+end
+
+When /^the git username should be "(.*?)"$/ do |username|
+  step "I run `git config user.name`"
+  step %Q{the output should contain "#{username}"}
+end
+
+When /^I commit some changes$/ do
+  step 'I append to "some_file" with "some_changes"'
+  step 'I run `git add .`'
+  step 'I run `git commit -m "some changes"`'
+end
+
+Then /^I should see "(.*?)" on the commit$/ do |username|
+  step 'I run `git --no-pager log`'
+  step %Q{the output should contain "Author: #{username}"}
+end
+
+Then /^it should offer to create a sample config$/ do
+  step %Q{the output should contain "Create a sample one?"}
+end

data/features/support/env.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+require 'aruba/cucumber'
+PROJECT_ROOT = "#{File.dirname(__FILE__)}/../.."
+CUKE_TMP_DIR = File.join PROJECT_ROOT, 'features', 'tmp'
+
+Before do
+  @dirs = [CUKE_TMP_DIR]
+  @real_home = ENV['HOME']
+  ENV['HOME'] = CUKE_TMP_DIR
+  @pairs_file = File.join ENV['HOME'], ".git_pairs"
+  FileUtils.rm_rf CUKE_TMP_DIR if File.exists? CUKE_TMP_DIR
+end
+
+After do |scenario|
+  FileUtils.rm_rf CUKE_TMP_DIR if File.exists? CUKE_TMP_DIR
+  ENV['HOME'] = @real_home
+end

data/lib/simple-git-pair.rb

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

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

@@ -0,0 +1,15 @@
+module SimpleGitPair
+  module Command
+    class Base
+      attr_accessor :opts
+
+      def initialize(opts = {})
+        self.opts = opts
+      end
+
+      def run!
+        raise "Could you implement run! method on #{self.class}?"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'simple-git-pair/command/base'
+require 'simple-git-pair/helper'
+
+module SimpleGitPair
+  module Command
+    class Change < Base
+      def run!
+        exit 1 unless ensure_pairs_file_exists
+
+        begin
+          system "git config user.name '#{(Helper.names_for opts).join ' & '}'"
+        rescue Helper::NotFoundException => ex
+          puts ex.message
+          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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require 'simple-git-pair/command/base'
+require 'simple-git-pair/helper'
+
+module SimpleGitPair
+  module Command
+    class Init < Base
+      def run!
+        if Helper.pairs_file_exists?
+          Helper.say_pairs_file_exists
+        else
+          Helper.create_pairs_file
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-require 'yaml'
+require 'yaml' # need to explicitly require yaml for ruby 1.8.7
 require 'simple-git-pair/version'
 
 module SimpleGitPair
@@ -8,32 +8,17 @@ module SimpleGitPair
 
     class << self
       PAIRS_FILE_NAME = '.git_pairs'
-      PAIRS_FILE_PATH = File.expand_path("~/#{PAIRS_FILE_NAME}")
-
-      def show_help
-        puts <<-EOS
-
-          #{SUMMARY}
-          Usage: git-pair <initial1> <initial2>
-
-          Commands:
-            init - creates sample #{PAIRS_FILE_NAME} config
-        EOS
-      end
+      PAIRS_FILE_PATH = File.join ENV['HOME'], PAIRS_FILE_NAME
 
       def complain_about_pairs_file
         puts <<-EOS
-
-          Please create #{PAIRS_FILE_NAME} file in your home directory in yaml format:
-            ae: Alfred Einstein
-            nt: Nikola Tesla
+Couldn't find #{PAIRS_FILE_PATH}
+Please run: git pair init
         EOS
       end
 
       def say_pairs_file_exists
-        puts <<-EOS
-          #{PAIRS_FILE_PATH} already exists. You're good to go.
-        EOS
+        puts "#{PAIRS_FILE_PATH} already exists. You're good to go."
       end
 
       def names_for args

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

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

data/spec/lib/simple-git-pair/{cli_spec.rb → command/change_spec.rb}

@@ -1,42 +1,18 @@
-require 'simple-git-pair/cli'
+require 'simple-git-pair/command/change'
 
-describe SimpleGitPair::Cli do
+describe SimpleGitPair::Command::Change do
   before { Object.stub(:system) }
   let(:opts) { [] }
-  let(:cli) { described_class.new opts }
+  let(:command) { 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 "'init' command" do
-      let(:opts) { ['init'] }
-      it "runs init cmd" do
-        cli.should_receive :init_cmd
-        expect { subject }.to raise_error SystemExit
-      end
-    end
+    subject { command.run! }
 
     context "there is NO pairs file" do
-      before { SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return false }
       let(:opts) { ["some_initials"] }
+
+      before { command.stub(:ensure_pairs_file_exists).and_return false }
       it "complains and exit" do
-        SimpleGitPair::Helper.should_receive :complain_about_pairs_file
         expect { subject }.to raise_error SystemExit
       end
     end
@@ -46,11 +22,11 @@ describe SimpleGitPair::Cli 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
+          command.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'")
+          command.should_receive(:system).with("git config user.name 'Super Mario & Pac Man'")
           subject
         end
       end
@@ -59,11 +35,11 @@ describe SimpleGitPair::Cli do
         before {
           SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return true
           SimpleGitPair::Helper.stub(:names_for).and_return ["Pac Man"]
-          cli.stub! :system
+          command.stub! :system
         }
         let(:opts) { ['pm'] }
         it "changes only username to single name" do
-          cli.should_receive(:system).with("git config user.name 'Pac Man'")
+          command.should_receive(:system).with("git config user.name 'Pac Man'")
           subject
         end
       end
@@ -74,31 +50,35 @@ describe SimpleGitPair::Cli do
         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)
+          command.stub! :system
+          command.should_receive(:puts).with(ex.message)
         }
         it { expect { subject }.to raise_error SystemExit }
       end
     end
+  end
 
-    describe "#init_cmd" do
-      subject { cli.send :init_cmd }
+  describe "#ensure_pairs_file_exists" do
+    subject { command.send :ensure_pairs_file_exists }
 
-      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 }
 
-      context "there is no pairs file" do
-        before { SimpleGitPair::Helper.stub(:pairs_file_exists?).and_return false }
-        it "creates a pairs file" do
+      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/init_spec.rb

@@ -0,0 +1,23 @@
+require 'simple-git-pair/command/init'
+
+describe SimpleGitPair::Command::Init do
+  describe "#run!" do
+    subject { described_class.new.run! }
+
+    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
+      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
+      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.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,44 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-02 00:00:00.000000000 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: &70286427233280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70286427233280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70241657198260 !ruby/object:Gem::Requirement
+  requirement: &70286427232800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70286427232800
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70286427232220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70286427232220
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70286427231460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70241657198260
+  version_requirements: *70286427231460
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70241657197660 !ruby/object:Gem::Requirement
+  requirement: &70286427231020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70241657197660
+  version_requirements: *70286427231020
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70241657197160 !ruby/object:Gem::Requirement
+  requirement: &70286427230240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,9 +76,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70241657197160
-description: Changes only user.name setting in git config,                    so github
-  can still understand under which account a code was committed
+  version_requirements: *70286427230240
+description: Simple way to add your pair to a git commit message
 email:
 - a.tamoykin@gmail.com
 executables:
@@ -53,15 +85,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/simple-git-pair/cli.rb
+- lib/simple-git-pair/command/base.rb
+- lib/simple-git-pair/command/change.rb
+- lib/simple-git-pair/command/init.rb
 - lib/simple-git-pair/helper.rb
 - lib/simple-git-pair/version.rb
 - lib/simple-git-pair.rb
 - bin/git-pair
+- CHANGELOG.md
 - README.md
-- spec/lib/simple-git-pair/cli_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
+- features/step_definitions/pair_steps.rb
+- features/support/env.rb
 homepage: http://github.com/fsproru/simple-git-pair
 licenses: []
 post_install_message: 
@@ -87,6 +125,9 @@ signing_key:
 specification_version: 3
 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/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
+- features/step_definitions/pair_steps.rb
+- features/support/env.rb

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

@@ -1,46 +0,0 @@
-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
-
-      if opts.delete "init"
-        exit(init_cmd ? 0 : 1)
-      end
-
-      unless Helper.pairs_file_exists?
-        Helper.complain_about_pairs_file
-        exit 1
-      end
-
-      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