hitch 0.5.2

data/README.rdoc

@@ -0,0 +1,76 @@
+= hitch
+    by Rogelio J. Samour
+    http://therubymug.com
+
+== DESCRIPTION:
+
+Hitch allows developers to be properly credited when Pair Programming and using Git.
+
+== FEATURES:
+
+* Persists pair(s) between different terminal instances.
+* Creates a unique email address for the pair. (e.g. dev+leshill+therubymug@hashrocket.com) This provides the ability to create a Gravatar for the pair.
+
+== SYNOPSIS:
+
+- First, create your hitchrc by running:
+  - hitch -m
+- For therubymug and leshill to pair in the current project:
+  - hitch leshill therubymug
+- or globally:
+  - hitch -g leshill therubymug
+- To clear pair info (for the local project):
+  - hitch -u
+- To clear pair info in the global file:
+  - hitch -u -g
+- For a complete list of features:
+  - hitch -h
+- Creating a Gravatar for your pair:
+  - Once I've hitched with my pair. (e.g. hitch leshill) I have now created a unique email: dev+leshill+therubymug@hashrocket.com
+  - Then, I go to gravatar.com. Add an image to that particular email address and I'm done.
+- If you want to allow different committer vs author, then:
+  - unhitch    (unhitch the current project)
+  - unhitch -g (globally unhitch)
+  - add the following aliases to your .bashrc:
+     alias hitch='hitch -p -g'
+     alias unhitch='unhitch -p -g'
+     alias git='. ~/.hitch_export_authors && git'
+
+== REQUIREMENTS:
+
+* Git, HighLine
+
+== INSTALL:
+
+* sudo gem install therubymug-hitch
+
+== ACKNOWLEDGEMENTS:
+
+* Les Hill
+* Tim Pope
+* Bodaniel Jeanes
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Rogelio J. Samour
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,52 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'hitch'
+
+task :default => 'spec:run'
+
+PROJ.name = 'hitch'
+PROJ.authors = 'Rogelio J. Samour (therubymug)'
+PROJ.email = 'rogelio@therubymug.com'
+PROJ.url = 'http://github.com/therubymug/hitch'
+PROJ.version = Hitch::VERSION
+PROJ.rubyforge.name = 'hitch'
+PROJ.dependencies = ['highline']
+PROJ.readme_file = 'README.rdoc'
+
+PROJ.spec.opts << '--color'
+
+require 'fileutils'
+
+spec = Gem::Specification.new do |s|
+  s.name = %q{hitch}
+  s.version = Hitch::VERSION
+  s.summary = %q{Hitch allows developers to be properly credited when Pair Programming and using Git.}
+  s.email = %q{ro@hashrocket.com}
+  s.homepage = %q{http://github.com/therubymug/hitch}
+  s.has_rdoc = false
+  s.authors = ["Rogelio Samour", "Les Hill"]
+  s.files = %w( README.rdoc Rakefile ) + Dir["{bin,lib}/**/*"].sort
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.executables = ["hitch", "unhitch", "hitchrc"]
+  s.add_dependency('highline', '>= 1.5.0')
+end
+
+desc "Generate the static gemspec required for github"
+task :gemspec do
+  open("hitch.gemspec", "w").write(spec.to_ruby)
+end
+

data/bin/hitch

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib hitch]))
+include Hitch
+
+if personal_info
+  hitch
+end

data/bin/hitchrc

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib hitch]))
+include Hitch
+
+manage_hitchrc

data/bin/hitchstatus

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+require 'yaml'
+yaml = YAML.load(File.read(File.expand_path('~/.hitchrc')))
+pairs = yaml['current_pair']
+print pairs.join(':') if pairs

data/bin/unhitch

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib hitch]))
+include Hitch
+
+unhitch

data/lib/hitch.rb

@@ -0,0 +1,283 @@
+require 'highline'
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib hitch options]))
+
+module Hitch
+
+  # :stopdoc:
+  VERSION = '0.5.2'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+  HighLine.track_eof = false
+
+  def write_hitchrc
+    personal_info['current_pair'] = current_pair
+    File.open(hitchrc, File::CREAT|File::TRUNC|File::RDWR, 0644) do |out|
+      YAML.dump(personal_info, out)
+    end
+  end
+
+  def hitchrc
+    @hitchrc ||= File.expand_path("~/.hitchrc")
+  end
+
+  def personal_info
+    if File.exists?(hitchrc)
+      @personal_info ||= YAML::load_file(hitchrc)
+    else
+      @personal_info ||= {}
+    end
+  end
+
+  def hitch_pairs
+    @hitch_pairs ||= File.expand_path("~/.hitch_pairs")
+  end
+
+  def pairs
+    if File.exists?(hitch_pairs)
+      @pairs ||= YAML::load_file(hitch_pairs)
+    else
+      @pairs ||= {}
+    end
+  end
+
+  def write_hitch_pairs
+    File.open(hitch_pairs, File::CREAT|File::TRUNC|File::RDWR, 0644) do |out|
+      YAML.dump(pairs, out)
+    end
+  end
+
+  def ui
+    @ui ||= HighLine.new
+  end
+
+  def exporting_hitch_authors
+    !!hitch_options.export_hitch_authors
+  end
+
+  def write_hitch_authors
+    File.open(File.expand_path('~/.hitch_export_authors'), "w") do |f|
+      f.puts "# "
+      f.puts "export GIT_AUTHOR_NAME='#{hitch_name}'"
+      f.puts "export GIT_AUTHOR_EMAIL='#{hitch_email}'"
+    end
+  end
+
+  def write_gitconfig
+    clean_gitconfig
+    File.open(hitch_options.current_gitconfig, "a+") do |f|
+      f.puts "# start - lines added by hitch #"
+      f.puts "[user]"
+      f.puts "\tname = '#{hitch_name}'"
+      f.puts "\temail = #{hitch_email}"
+      f.puts "# end - lines added by hitch #"
+    end
+  end
+
+  def add_pair(git_name)
+    current_pair << git_name
+    current_pair.sort!
+    current_pair.uniq!
+  end
+
+  def current_pair
+    @current_pair ||= (personal_info['current_pair'] or [])
+  end
+
+  def hitch_name
+    my_pairs_and_i.map {|github, name| name}.join(' and ')
+  end
+
+  def hitch_email
+    "#{group_prefix}+#{my_pairs_and_i.map{|github, name| github}.join('+')}@#{group_domain}"
+  end
+
+  def my_pairs_and_i
+    and_i = current_pair.map {|github| [github, pairs[github]]}
+    and_i.sort_by {|github, name| github }
+  end
+
+  def group_prefix
+    personal_info['group_email'].split('@').first
+  end
+
+  def group_domain
+    personal_info['group_email'].split('@').last
+  end
+
+  def clean_hitch_authors
+    authors_file = File.expand_path '~/.hitch_export_authors'
+    File.open(authors_file, 'w') do |f|
+      f.puts "unset GIT_AUTHOR_NAME"
+      f.puts "unset GIT_AUTHOR_EMAIL"
+    end
+  end
+
+  def clean_gitconfig(opts={:print => false})
+    config_file = hitch_options.current_gitconfig
+    ui.say " Clearing hitch info in: #{config_file}" if opts[:print]
+    body = File.read(config_file)
+    body.gsub!(/# start - lines added by hitch #\n.*?\n# end - lines added by hitch #\n/m, '')
+    File.open(config_file + ".tmp", 'w') {|f| f.write(body)}
+    File.rename(config_file + ".tmp", config_file)
+  end
+
+  def prep_hitch_authors
+    if pairing?
+      write_hitch_authors
+    else
+      clean_hitch_authors
+    end
+  end
+
+  def prep_gitconfig
+    if pairing?
+      write_gitconfig
+    else
+      clean_gitconfig
+    end
+  end
+
+  def unhitch
+    if personal_info
+      clear_pair_info
+      write_hitchrc
+      if exporting_hitch_authors
+        clean_hitch_authors
+      else
+        clean_gitconfig(:print => true)
+      end
+      print_current_status
+    end
+  end
+
+  def print_current_status
+    if pairing?
+      ui.say " Currently pairing with #{current_pair.join(' ')}."
+    else
+      ui.say " Currently coding solo."
+    end
+  end
+
+  def print_version
+    ui.say "hitch v#{Hitch.version}"
+  end
+
+  def clear_pair_info
+    personal_info['current_pair'] = []
+  end
+
+  def pairing?
+    return false if personal_info.empty?
+    return false if personal_info['current_pair'].nil? || personal_info['current_pair'].length.zero?
+    return false if personal_info['current_pair'].length < 2
+    true
+  end
+
+  def existing_pair?(pair)
+    pairs.any? {|github, name| github == pair}
+  end
+
+  def hitch_options
+    @hitch_options ||= Options.parse(ARGV)
+  end
+
+  def hitch
+    case hitch_options.action
+    when "manage_hitchrc"
+      manage_hitchrc
+    when "unhitch"
+      unhitch
+    when "hitch"
+      if ARGV.any? && ARGV.size >= 2
+        potential_pairs = ARGV
+        save_pairs = false
+        clear_pair_info
+
+        potential_pairs.each do |pair|
+          unless existing_pair?(pair)
+            ui.say("I don't know who #{pair} is.")
+            if ui.agree("Do you want to add #{pair} to ~/.hitch_pairs?  ", true)
+              pairs[pair] = ui.ask("What is #{pair}'s full name?") do |q|
+                q.validate = /\A[-(\w|.,)+\s?]+\Z/
+              end
+              add_pair(pair)
+              save_pairs ||= true
+            else
+              ui.say("Ignoring #{pair}.")
+            end
+          else
+            add_pair(pair)
+          end
+        end
+        write_hitchrc
+        write_hitch_pairs if save_pairs
+        if exporting_hitch_authors
+          prep_hitch_authors
+        else
+          prep_gitconfig
+        end
+      else
+        ui.say " Silly Rabbit! A pair is comprised of two." unless ARGV.size.zero?
+      end
+      print_current_status
+    end
+  end
+
+  def manage_hitchrc
+    begin
+      unless File.exists?(hitchrc) and !ui.agree("Do you want to overwrite your #{ENV['HOME']}/.hitchrc file?", true)
+        ui.say("Let's setup your #{ENV['HOME']}/.hitchrc file")
+
+        personal_info['group_email'] = ui.ask("What is the group email? e.g. dev@hashrocket.com will become dev+therubymug+leshill@hashrocket.com") do |q|
+          q.case     = :down
+          q.validate = /\A[a-zA-Z0-9_\.\-]+@[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-\.]+\z/ # Simple email validation.
+        end
+
+        write_hitchrc
+      end
+    rescue EOFError  # HighLine throws this if @input.eof?
+      break
+    end
+
+    print_current_status
+  end
+end  # module Hitch
+
+Hitch.require_all_libs_relative_to(__FILE__)

data/lib/hitch/options.rb

@@ -0,0 +1,71 @@
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+
+module Hitch
+
+  class Options
+
+    def self.parse(args)
+      options = OpenStruct.new
+      options.action = "hitch"
+
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: hitch [options] first_pair_username second_pair_username"
+        opts.separator ""
+        opts.separator "Hitch defaults to the current project's .git/config"
+        opts.separator ""
+        opts.separator "General options:"
+
+        opts.on('-p', '--preserve_gitconfig', 'Preserves your ~/.gitconfig and .git/config files.  Uses ~/.hitch_export_authors instead') do
+          options.export_hitch_authors = true
+        end
+
+        opts.on("-g", "--global", "Modifies your global ~/.gitconfig") do
+          options.current_gitconfig = File.expand_path("~/.gitconfig")
+        end
+
+        opts.on("-m", "--manage-hitchrc", "Creates or manages your personal information into ~/.hitchrc") do
+          if options.action.empty? || options.action == "hitch"
+            options.action = "manage_hitchrc"
+          else
+            abort "You can only perform one action at a time. hitch -h for more info."
+          end
+        end
+
+        opts.on("-u", "--unhitch", "Clear pair information") do
+          if options.action.empty? || options.action == "hitch"
+            options.action = "unhitch"
+          else
+            abort "You can only perform one action at a time. hitch -h for more info."
+          end
+        end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+
+        opts.on_tail("-v", "--version", "Show version") do
+          abort "hitch v#{Hitch.version}"
+        end
+      end
+
+      opts.parse!(args)
+
+      if options.current_gitconfig.nil?
+        options.current_gitconfig = File.expand_path(File.join(Dir.pwd, ".git", "config"))
+      end
+
+      unless File.exists?(options.current_gitconfig)
+        abort "Config File: #{options.current_gitconfig} does not exist. hitch -h for more info."
+      end
+
+      options
+    end
+
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: hitch
+version: !ruby/object:Gem::Version 
+  version: 0.5.2
+platform: ruby
+authors: 
+- Rogelio Samour
+- Les Hill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+description: 
+email: ro@hashrocket.com
+executables: 
+- hitch
+- unhitch
+- hitchrc
+- hitchstatus
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- bin/hitch
+- bin/hitchrc
+- bin/unhitch
+- lib/hitch.rb
+- lib/hitch/options.rb
+has_rdoc: true
+homepage: http://github.com/therubymug/hitch
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Hitch allows developers to be properly credited when Pair Programming and using Git.
+test_files: []
+