pivotal_git_scripts 1.1.2 → 1.1.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pivotal_git_scripts (1.1.2)
+    pivotal_git_scripts (1.1.3)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -16,16 +16,18 @@ These scripts are helpers for managing developer workflow when using git repos h
 
 ## git-pair
 
-    $ git pair js sp
+Configures git authors when pair programming.
+
+    git pair sp js
     user.name=Josh Susser & Sam Pierson
     user.email=pair+jsusser+sam@pivotallabs.com
 
 
-Use `git pair` to set the git config user info that sets the commit user metadata.  You'll need to create a `.pairs` config file to map initials to names and email ids.  The example file:
+Create a `.pairs` config file in project root or your home folder.
 
     # .pairs - configuration for 'git pair'
-    # place in project or home directory
     pairs:
+      # <initials>: <Firstname> <Lastname>[; <email-id>]
       eh: Edward Hieatt
       js: Josh Susser; jsusser
       sf: Serguei Filimonov; serguei
@@ -34,9 +36,14 @@ Use `git pair` to set the git config user info that sets the commit user metadat
       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 or add 'global: true' to your pairs file to set the global git configuration for all projects (~/.gitconfig).
+By default this affects the current project (.git/config).<br/>
+Use the `--global` option or add `global: true` to your `.pairs` file to set the global git configuration for all projects (~/.gitconfig).
+
+Options are:
+    -g, --global                     Modify global git options instead of local
+    -v, --version                    Show Version
+    -h, --help                       Show this.
 
 ## git-project
 
@@ -53,6 +60,7 @@ 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)
+ - git-pair original author [Bryan Helmkamp](http://brynary.com)
  - lots of pivots :)
  - [James Sanders](https://github.com/jsanders)
  - [Todd Persen](https://github.com/toddboom)

data/bin/git-pair

@@ -1,25 +1,52 @@
 #!/usr/bin/env ruby
-
-# 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')
-#        git pair --global (Unsets the global author)
-#
-# Orginal Author: Bryan Helmkamp (http://brynary.com)
-
-#######################################################################
-
 require 'yaml'
+require 'optparse'
+
+def parse_cli_options(argv)
+  options = {}
+  OptionParser.new do |opts|
+    # copy-paste from readme
+    opts.banner = <<BANNER.sub('<br/>','')
+Configures git authors when pair programming.
+
+    git pair sp js
+    user.name=Josh Susser & Sam Pierson
+    user.email=pair+jsusser+sam@pivotallabs.com
+
+
+Create a `.pairs` config file in project root or your home folder.
+
+    # .pairs - configuration for 'git pair'
+    pairs:
+      # <initials>: <Firstname> <Lastname>[; <email-id>]
+      eh: Edward Hieatt
+      js: Josh Susser; jsusser
+      sf: Serguei Filimonov; serguei
+    email:
+      prefix: pair
+      domain: pivotallabs.com
+    #global: true
+
+
+By default this affects the current project (.git/config).<br/>
+Use the `--global` option or add `global: true` to your `.pairs` file to set the global git configuration for all projects (~/.gitconfig).
+
+Options are:
+BANNER
+    opts.on("-g", "--global", "Modify global git options instead of local") { options[:global] = true }
+    opts.on("-v", "--version", "Show Version") do
+      $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+      require "pivotal_git_scripts/version"
+      puts PivotalGitScripts::VERSION
+      exit
+    end
+    opts.on("-h", "--help", "Show this.") { puts opts; exit }
+  end.parse!(argv)
 
-git_dir = `git rev-parse --git-dir`.chomp
-exit 1 unless File.exists?(git_dir)
-
-## Configuration
+  options
+end
 
-def get_pairs_config
+def read_pairs_config
   pairs_file_path = nil
   candidate_file_path = '.pairs'
   until pairs_file_path || File.expand_path(candidate_file_path) == '/.pairs' do
@@ -29,7 +56,6 @@ 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
@@ -51,74 +77,72 @@ INSTRUCTIONS
   pairs_file_path ? YAML.load_file(pairs_file_path) : {}
 end
 
-def get_global_config(config)
-  if ARGV.delete("--global") || config["global"]
-    "--global"
+def read_author_info_from_config(config, initials)
+  initials.map do |initials|
+    if full_name = config['pairs'][initials.downcase]
+      full_name
+    else
+      puts "Couldn't find author name for initials: #{initials}. Add this person to the .pairs file in your project or home directory."
+      exit 1
+    end
   end
 end
 
-## End of configuration
-#######################################################################
-
-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
+def build_email(emails, config)
+  if config.is_a?(Hash)
+    "#{([config['prefix']] + emails).compact.join('+')}@#{config['domain']}"
   else
-    puts "Couldn't find author name for initials: #{initials}. Add this person to the .pairs file in your project or home directory."
-    exit 1
+    config
+  end
+end
+
+def set_git_config(global_config_string, options)
+  options.each do |key,value|
+    key = "user.#{key}"
+    value = value ? %Q{#{key} "#{value}"} : "--unset #{key}"
+    system(%Q{git config#{global_config_string} #{value}})
   end
 end
 
-if authors.any?
+def report_git_settings(git_dir, key)
+  global = `git config --global --get-regexp '^user\.#{key}'`
+  local = `git config -f #{git_dir}/config --get-regexp '^user\.#{key}'`
+  if global.length > 0 && local.length > 0
+    puts "NOTE: Overriding global user.#{key} setting with local."
+  end
+  puts "global: #{global}" if global.length > 0
+  puts "local:  #{local}" if local.length > 0
+end
+
+def extract_author_names_and_email_ids_from_config(config, initials)
+  authors = read_author_info_from_config(config, initials)
   authors.sort!.uniq!
-  names, emails = authors.collect do |a|
-    both = a.split(";").collect {|s| s.strip}
-    both << both[0].split(' ').first.downcase if both.length == 1  # default email to first name
-    both
+  authors.map do |a|
+    full_name, email_id = a.split(";").map(&:strip)
+    email_id ||= full_name.split(' ').first.downcase
+    [full_name, email_id]
   end.transpose
+end
 
-  case authors.size
-  when 1
-    authors = names.first
-  when 2
-    authors = names.join(" & ")
-  else
-    authors = names[0..-2].join(", ") + " & " + names.last
-  end
+git_dir = `git rev-parse --git-dir`.chomp
+exit 1 if git_dir.empty?
 
-  email = if config['email'].is_a?(Hash)
-    "#{([config['email']['prefix']] + emails).compact.join('+')}@#{config['email']['domain']}"
-  else
-    config['email']
-  end
+options = parse_cli_options(ARGV)
+initials = ARGV
+config = read_pairs_config
+global = " --global" if options[:global] or config["global"]
 
-  initials = ARGV.join(' ')
+if initials.any?
+  author_names, email_ids = extract_author_names_and_email_ids_from_config(config, initials)
+  authors = [author_names[0..-2].join(", "), author_names.last].reject(&:empty?).join(" & ")
+  email = build_email(email_ids, config["email"])
 
-  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}"})
+  set_git_config global, :name => authors, :email => email, :initials => initials.join(" ")
 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"
+  set_git_config global, :name => nil, :email => nil, :initials => nil
+  puts "Unset#{global} user.name, user.email, user.initials"
 end
 
-global_name_setting = `git config --global --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
-puts "global: #{global_name_setting}" if global_name_setting.length > 0
-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_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."
+[:name, :email, :initials].each do |key|
+  report_git_settings(git_dir, key)
 end
-puts "global: #{global_email_setting}" if global_email_setting.length > 0
-puts "local:  #{local_email_setting}"  if local_email_setting.length > 0

data/lib/pivotal_git_scripts/version.rb

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

data/spec/cli_spec.rb

@@ -78,10 +78,20 @@ describe "CLI" do
 
       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.initials #{initials}"
       result.should include "#{prefix}user.email #{email}"
     end
 
+    it "prints help" do
+      result = run "git-pair --help"
+      result.should include("Configures git authors when pair programming")
+    end
+
+    it "prints version" do
+      result = run "git pair --version"
+      result.should =~ /\d+\.\d+\.\d+/
+    end
+
     context "with .pairs file" do
       before do
         write ".pairs", <<-YAML.unindent
@@ -156,7 +166,7 @@ describe "CLI" 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
+        result.should include "Unset user.name, user.email, user.initials"
         expect_config result, "Aa Bb", "ab", "the-pair+aa@the-host.com", :global => true
         result.should_not include("local:")
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pivotal_git_scripts
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors: