pivotal_git_scripts 1.1.0 → 1.1.2

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+spec/tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in pivotal_git_scripts.gemspec
+gemspec
+
+gem "rake"
+gem "bundler"
+gem "rspec"
+gem "unindent"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    pivotal_git_scripts (1.1.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    unindent (1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  pivotal_git_scripts!
+  rake
+  rspec
+  unindent

data/README.md

@@ -2,10 +2,14 @@
 
 These scripts are helpers for managing developer workflow when using git repos hosted on GitHub.  Install as a rubygem and they can be run as standard git commands like `git about`.
 
-## Installation
+## Gem Installation
 
     $ gem install pivotal_git_scripts
 
+## System Wide Installation
+
+    $ cd /usr/local/bin && curl -L http://github.com/pivotal/git_scripts/tarball/master | gunzip | tar xvf - --strip=2
+
 ## git-about
 
 `git about` shows settings set by `git pair` and `git project`
@@ -28,10 +32,11 @@ Use `git pair` to set the git config user info that sets the commit user metadat
     email:
       prefix: pair
       domain: pivotallabs.com
+    #global: true
 
 You can put the .pairs file in your project repo root directory and check it into git, or you can put it in your ~ directory so it's available to all projects on the workstation.
 
-By default this command affects the configuration in the current project (.git/config). Use the `--global` option to set the global git configuration for all projects (~/.gitconfig).
+By default this command affects the configuration in the current project (.git/config). Use the `--global` option or add 'global: true' to your pairs file to set the global git configuration for all projects (~/.gitconfig).
 
 ## git-project
 
@@ -43,4 +48,11 @@ This script sets the user account you will use to access repos hosted on github.
       User git
       IdentityFile /Users/pivotal/.ssh/id_github_current
 
-Copyright (c) 2010 Pivotal Labs. This software is licensed under the MIT License.
+Authors
+====
+Copyright (c) 2010 [Pivotal Labs](http://pivotallabs.com). This software is licensed under the MIT License.
+
+### [Contributors](https://github.com/pivotal/git_scripts/contributors)
+ - lots of pivots :)
+ - [James Sanders](https://github.com/jsanders)
+ - [Todd Persen](https://github.com/toddboom)

data/Rakefile

@@ -1,2 +1,22 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
+
+task :default do
+  sh "bundle exec rspec spec"
+end
+
+# extracted from https://github.com/grosser/project_template
+rule /^version:bump:.*/ do |t|
+  sh "git status | grep 'nothing to commit'" # ensure we are not dirty
+  index = ['major', 'minor','patch'].index(t.name.split(':').last)
+  file = 'lib/pivotal_git_scripts/version.rb'
+
+  version_file = File.read(file)
+  old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
+  version_parts[index] = version_parts[index].to_i + 1
+  version_parts[2] = 0 if index < 2 # remove patch for minor
+  version_parts[1] = 0 if index < 1 # remove minor for major
+  new_version = version_parts * '.'
+  File.open(file,'w'){|f| f.write(version_file.sub(old_version, new_version)) }
+
+  sh "bundle && git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
+end

data/bin/git-about

@@ -1,14 +1,13 @@
 #!/usr/bin/env ruby
-
-config = `git config -l`
 user_name = `git config --get user.name`
-user_name = "NONE" if user_name.length == 0
+user_name = "NONE" if user_name.strip.empty?
+
 user_email = `git config --get user.email`
-user_email = "NONE" if user_email.length == 0
+user_email = "NONE" if user_email.strip.empty?
 
 begin
-  keyfile = File.readlink(File.expand_path("~/.ssh/id_github_current"))
-  project = keyfile =~ %r{id_github_(\w+)} ? $1 : "NONE"
+  key_file = File.readlink(File.expand_path("~/.ssh/id_github_current"))
+  project = (key_file =~ %r{id_github_(\w+)} ? $1 : "NONE")
 rescue Errno::ENOENT
   project = "NONE"
 end

data/bin/git-pair

@@ -2,7 +2,7 @@
 
 # Configures the git author to a list of developers when pair programming,
 # alphabetized on first name
-# 
+#
 # Usage: git pair ls gw (Sets the repo specific author to 'Greg Woodward & Loren Siebert')
 #        git pair       (Unsets the repo specific author so the git global config takes effect)
 #        git pair --global ls gw (Sets the global author to 'Greg Woodward & Loren Siebert')
@@ -14,10 +14,8 @@
 
 require 'yaml'
 
-unless File.exists?(".git")
-  puts "This doesn't look like a git repository."
-  exit 1
-end
+git_dir = `git rev-parse --git-dir`.chomp
+exit 1 unless File.exists?(git_dir)
 
 ## Configuration
 
@@ -31,6 +29,8 @@ def get_pairs_config
       candidate_file_path = File.join("..", candidate_file_path)
     end
   end
+  puts pairs_file_path.inspect
+
   unless pairs_file_path
     puts <<-INSTRUCTIONS
 Could not find a .pairs file. Create a YAML file in your project or home directory.
@@ -51,11 +51,17 @@ INSTRUCTIONS
   pairs_file_path ? YAML.load_file(pairs_file_path) : {}
 end
 
+def get_global_config(config)
+  if ARGV.delete("--global") || config["global"]
+    "--global"
+  end
+end
+
 ## End of configuration
 #######################################################################
 
-global_config_string = ARGV.delete("--global").to_s
 config               = get_pairs_config
+global_config_string = get_global_config(config)
 authors              = ARGV.map do |initials|
   if full_name = config['pairs'][initials.downcase]
     full_name
@@ -81,22 +87,27 @@ if authors.any?
   else
     authors = names[0..-2].join(", ") + " & " + names.last
   end
-  email = 
-    if email_prefix = config['email']['prefix']
-      "#{([email_prefix] + emails).join('+')}@#{config['email']['domain']}"
-    else
-      config['email']
-    end
+
+  email = if config['email'].is_a?(Hash)
+    "#{([config['email']['prefix']] + emails).compact.join('+')}@#{config['email']['domain']}"
+  else
+    config['email']
+  end
+
+  initials = ARGV.join(' ')
+
   system(%Q{git config #{global_config_string} user.name "#{authors}"})
   system(%Q{git config #{global_config_string} user.email "#{email}"})
+  system(%Q{git config #{global_config_string} user.initials "#{initials}"})
 else
   system("git config #{global_config_string} --unset user.name")
   system("git config #{global_config_string} --unset user.email")
+  system("git config #{global_config_string} --unset user.initials")
   puts "Unset #{global_config_string} user.name and user.email"
 end
 
 global_name_setting = `git config --global --get-regexp '^user\.name'`
-local_name_setting = `git config -f .git/config --get-regexp '^user\.name'`
+local_name_setting = `git config -f #{git_dir}/config --get-regexp '^user\.name'`
 if global_name_setting.length > 0 && local_name_setting.length > 0
   puts "NOTE: Overriding global user.name setting with local."
 end
@@ -105,7 +116,7 @@ puts "local:  #{local_name_setting}"  if local_name_setting.length > 0
 
 
 global_email_setting = `git config --global --get-regexp '^user\.email'`
-local_email_setting = `git config -f .git/config --get-regexp '^user\.email'`
+local_email_setting = `git config -f #{git_dir}/config --get-regexp '^user\.email'`
 if global_email_setting.length > 0 && local_email_setting.length > 0
   puts "NOTE: Overriding global user.email setting with local."
 end

data/lib/pivotal_git_scripts/version.rb

@@ -0,0 +1,3 @@
+module PivotalGitScripts
+  VERSION = "1.1.2"
+end

data/pivotal_git_scripts.gemspec

@@ -1,17 +1,25 @@
 # -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "pivotal_git_scripts/version"
 
 Gem::Specification.new do |s|
   s.name        = "pivotal_git_scripts"
-  s.version     = "1.1.0"
-  s.date        = Time.now.strftime('%Y-%m-%d')
-  s.platform    = Gem::Platform::RUBY
+  s.version     = PivotalGitScripts::VERSION
   s.authors     = ["Pivotal Labs"]
   s.email       = ["gems@pivotallabs.com"]
   s.homepage    = "http://github.com/pivotal/git_scripts"
   s.summary     = %q{Developer git workflow convenience scripts}
   s.description = %q{These scripts are helpers for managing developer workflow when using git repos hosted on GitHub.}
-  s.has_rdoc      = false
+
+  s.rubyforge_project = "pivotal_git_scripts"
 
   s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.license       = "MIT"
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
 end

data/spec/cli_spec.rb

@@ -0,0 +1,213 @@
+require "unindent"
+
+describe "CLI" do
+  before :all do
+    # use local scripts
+    ENV["PATH"] = "#{File.join(File.dirname(__FILE__),"..","bin")}:#{ENV["PATH"]}"
+  end
+
+  def run(command, options={})
+    result = `#{command}`
+    raise "FAILED #{command} : #{result}" if $?.success? == !!options[:fail]
+    result
+  end
+
+  def write(file, content)
+    File.open(file, 'w'){|f| f.write content }
+  end
+
+  around do |example|
+    dir = "spec/tmp"
+    run "rm -rf #{dir}"
+    run "mkdir #{dir}"
+
+    # use fake home for .ssh hacks
+    run "mkdir #{dir}/home"
+    ENV["HOME"] = File.expand_path("#{dir}/home")
+
+    Dir.chdir dir do
+      run "touch a && git init && git add . && git commit -am 'initial'"
+      example.run
+    end
+  end
+
+  describe "about" do
+    it "lists the user" do
+      run "git config user.name NAME"
+      run("git about").should =~ /git user:\s+NAME/
+    end
+
+    it "lists the user as NONE if there is none" do
+      run "git config user.name ''"
+      run("git about").should =~ /git user:\s+NONE/
+    end
+
+    it "lists the email" do
+      run "git config user.email EMAIL"
+      run("git about").should =~ /git email:\s+EMAIL/
+    end
+
+    it "lists the email as NONE if there is none" do
+      run "git config user.email ''"
+      run("git about").should =~ /git email:\s+NONE/
+    end
+
+    it "does not find a project" do
+      run("git about").should =~ /GitHub project:\s+NONE/
+    end
+
+    context "with github project" do
+      before do
+        run "mkdir home/.ssh"
+        run "touch home/.ssh/id_github_foo"
+        run "ln -s home/.ssh/id_github_foo home/.ssh/id_github_current"
+      end
+
+      it "finds a project" do
+        run("git about").should =~ /GitHub project:\s+foo/
+      end
+    end
+  end
+
+  describe "pair" do
+    def expect_config(result, name, initials, email, options={})
+      global = "cd /tmp && " if options[:global]
+      run("#{global}git config user.name").should == "#{name}\n"
+      run("#{global}git config user.initials").should == "#{initials}\n"
+      run("#{global}git config user.email").should == "#{email}\n"
+
+      prefix = (options[:global] ? "global: " : "local:  ")
+      result.should include "#{prefix}user.name #{name}"
+      #result.should include "#{prefix}user.initials #{initials}" # TODO
+      result.should include "#{prefix}user.email #{email}"
+    end
+
+    context "with .pairs file" do
+      before do
+        write ".pairs", <<-YAML.unindent
+          pairs:
+            ab: Aa Bb
+            bc: Bb Cc
+            cd: Cc Dd
+
+          email:
+            prefix: the-pair
+            domain: the-host.com
+          YAML
+      end
+
+      describe "global" do
+        it "sets pairs globally when global: true is set" do
+          write ".pairs", File.read(".pairs") + "\nglobal: true"
+          result = run "git pair ab"
+          expect_config result, "Aa Bb", "ab", "the-pair+aa@the-host.com", :global => true
+        end
+
+        it "sets pairs globally when --global is given" do
+          result = run "git pair ab --global"
+          result.should include "global: user.name Aa Bb"
+          expect_config result, "Aa Bb", "ab", "the-pair+aa@the-host.com", :global => true
+        end
+
+        it "unsets global config when no argument is passed" do
+          run "git pair ab --global"
+          run "git pair ab"
+          result = run "git pair --global"
+          #result.should include "Unset --global user.name, user.email and user.initials"
+          expect_config result, "Aa Bb", "ab", "the-pair+aa@the-host.com"
+          result.should_not include("global:")
+        end
+      end
+
+      it "can set a single user as pair" do
+        result = run "git pair ab"
+        expect_config result, "Aa Bb", "ab", "the-pair+aa@the-host.com"
+      end
+
+      it "can set a 2 users as pair" do
+        result = run "git pair ab bc"
+        expect_config result, "Aa Bb & Bb Cc", "ab bc", "the-pair+aa+bb@the-host.com"
+      end
+
+      it "can set a n users as pair" do
+        result = run "git pair ab bc cd"
+        expect_config result, "Aa Bb, Bb Cc & Cc Dd", "ab bc cd", "the-pair+aa+bb+cc@the-host.com"
+      end
+
+      it "fails when there is no .git in the tree" do
+        run "rm -f /tmp/pairs"
+        run "cp .pairs /tmp"
+        Dir.chdir "/tmp" do
+          result = run "git pair ab 2>&1", :fail => true
+          result.should include("Not a git repository (or any of the parent directories)")
+        end
+        run "rm -f /tmp/pairs"
+      end
+
+      it "finds .pairs file in lower parent folder" do
+        run "mkdir foo"
+        Dir.chdir "foo" do
+          result = run "git pair ab"
+          expect_config result, "Aa Bb", "ab", "the-pair+aa@the-host.com"
+        end
+      end
+
+      it "unsets local config when no argument is passed" do
+        run "git pair ab --global"
+        run "git pair bc"
+        result = run "git pair"
+        #result.should include "Unset user.name, user.email and user.initials" #TODO
+        expect_config result, "Aa Bb", "ab", "the-pair+aa@the-host.com", :global => true
+        result.should_not include("local:")
+      end
+
+      it "uses hard email when given" do
+        write ".pairs", File.read(".pairs").sub(/email:.*/m, "email: foo@bar.com")
+        result = run "git pair ab"
+        expect_config result, "Aa Bb", "ab", "foo@bar.com"
+      end
+
+      it "uses no email prefix when only host is given" do
+        write ".pairs", File.read(".pairs").sub(/email:.*/m, "email:\n  domain: foo.com")
+        result = run "git pair ab"
+        expect_config result, "Aa Bb", "ab", "aa@foo.com"
+      end
+
+      it "fails with unknown initials" do
+        result = run "git pair xx", :fail => true
+        result.should include("Couldn't find author name for initials: xx")
+      end
+
+      it "uses alternate email prefix" do
+        write ".pairs", File.read(".pairs").sub(/ab:.*/, "ab: Aa Bb; blob")
+        result = run "git pair ab"
+        expect_config result, "Aa Bb", "ab", "the-pair+blob@the-host.com"
+      end
+    end
+
+    context "without a .pairs file in the tree" do
+      around do |example|
+        Dir.chdir "/tmp" do
+          run "rm -f .pairs"
+          dir = "git_stats_test"
+          run "rm -rf #{dir}"
+          run "mkdir #{dir}"
+          Dir.chdir dir do
+            run "git init"
+            example.run
+          end
+          run "rm -rf #{dir}"
+        end
+      end
+
+      it "fails if it cannot find a pairs file" do
+        run "git pair ab", :fail => true
+      end
+
+      it "prints instructions" do
+        result = run "git pair ab", :fail => true
+        result.should include("Could not find a .pairs file. Create a YAML file in your project or home directory.")
+      end
+    end
+  end
+end

metadata

@@ -1,38 +1,32 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pivotal_git_scripts
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
+version: !ruby/object:Gem::Version
+  version: 1.1.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Pivotal Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-11-15 00:00:00 -08:00
-default_executable: 
+date: 2012-03-14 00:00:00.000000000Z
 dependencies: []
-
-description: These scripts are helpers for managing developer workflow when using git repos hosted on GitHub.
-email: 
+description: These scripts are helpers for managing developer workflow when using
+  git repos hosted on GitHub.
+email:
 - gems@pivotallabs.com
-executables: 
+executables:
 - git-about
 - git-pair
 - git-project
 - git-superpull
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
 - MIT.LICENSE
 - README.md
 - Rakefile
@@ -40,40 +34,33 @@ files:
 - bin/git-pair
 - bin/git-project
 - bin/git-superpull
+- lib/pivotal_git_scripts/version.rb
 - pivotal_git_scripts.gemspec
-has_rdoc: true
+- spec/cli_spec.rb
 homepage: http://github.com/pivotal/git_scripts
-licenses: []
-
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: pivotal_git_scripts
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Developer git workflow convenience scripts
-test_files: []
-
+test_files:
+- spec/cli_spec.rb