kch-git_remote_branch 0.3.0

data/CHANGELOG

@@ -0,0 +1,32 @@
+* Release 0.3.0 *
+
+  Housekeeping
+  - Support for a bunch of platforms has been added (Windows, Ubuntu, Ruby 1.9)
+  - git_remote_branch now has actual online documentation: grb.rubyforge.org
+  - give useful error message if grb can't find the git executable
+  
+  Features
+  - track now works even if you already have a local branch of the same name
+    - it uses git config instead of branch --track in that case
+    - the difference can be seen by running
+      - grb explain track master
+      - grb explain track non_existent_branch
+  - Let you force the usage of a specific git executable by setting the environment variable GRB_GIT to point to it. It's pretty much undocumented for now, except for this mention :-) The tests for the useful error message use this feature. So it works.
+
+* Release 0.2.6 *
+  Three new actual features
+  - grb rename, contributed by Caio Chassot (caiochassot.com)
+  - grb publish, to make available and track a local branch
+  - the --silent option, if you want to use grb in a script
+  
+  And other stuff
+  - the grb bin file now works when symlinked (also thanks to Caio Chassot)
+  - Lots and lots of unit and functional tests
+  - bug fixes
+  - more flexibility for running grb outside of a git repository (e.g. for 'explain' or 'help')
+  - Now officially under the MIT license
+  - refactored a bunch of rake tasks
+
+
+Versions lost in time:
+0.2.1, 0.2.2, 0.2.3, 0.2.4

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Mathieu Martin
+
+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 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/README.rdoc

@@ -0,0 +1,184 @@
+= Why git_remote_branch?
+
+git_remote_branch is a simple command-line tool that makes it very easy to manipulate
+branches published in shared repositories.
+
+It achieves this goal by sticking to a few principles:
+- keep grb's commands extremely regular (they all look alike)
+- support aliases for commands
+- print all commands it runs on your behalf in red, so you eventually learn them
+
+Another nice thing about git_remote_branch is that it can simply explain a command 
+(print out all the corresponding git commands) instead of running them on your behalf.
+
+Note: git_remote_branch assumes that the local and remote branches have the
+same name. Multiple remote repositories (or origins) are supported.
+
+
+= Installation
+
+  sudo gem install git_remote_branch --include-dependencies
+
+If you have an old version of Rubygems, you may have to manually install the "colored" gem.
+  sudo gem install colored
+
+If you're on Windows, you must also install "win32console" manually (before or after installing git_remote_branch doesn't matter).
+  gem install win32console colored
+
+
+See the "Bleeding edge and development" section the end of this document for more details about fiddling with the source of git_remote_branch or running it with Ruby 1.9 (yes, it works).
+
+= Usage
+
+Notes: 
+- parts between brackets are optional
+- When 'origin_server' is not specified, the name 'origin' is assumed.
+
+Available commands (with aliases):
+
+
+=== Help
+
+  $ grb [-h|help]    #=> Displays help
+
+=== create (alias: new)
+
+Create a new local branch as well as a corresponding remote branch based on the
+branch you currently have checked out. 
+Track the new remote branch. Checkout the new branch.
+
+  $ grb create branch_name [origin_server]
+
+
+=== publish (aliases: remotize, share)
+
+Publish an existing local branch to the remote server.
+Set up the local branch to track the new remote branch.
+
+  $ grb publish branch_name [origin_server]
+
+
+=== delete (aliases: destroy, kill, remove, rm)
+
+Delete the remote branch then delete the local branch.
+The local branch is not deleted if there are pending changes.
+
+  $ grb delete branch_name [origin_server]
+
+
+=== track (aliases: follow grab fetch)
+
+Track an existing remote branch locally and checkout the branch.
+
+  $ grb track branch_name [origin_server]
+
+
+=== rename (aliases: rn mv move)
+
+Rename a remote branch and its local tracking branch.
+The branch you want to rename must be checked out.
+
+  # On branch to be renamed
+  $ grb rename new_branch_name [origin_server]
+
+
+=== explain
+
+All commands can be prepended by the word 'explain'.  Instead of executing the
+command, git_remote_branch will simply output the list of commands you need to
+run to accomplish that goal.
+Examples: 
+
+  $ grb explain create
+  git_remote_branch version 0.3.0
+  
+  List of operations to do to create a new remote branch and track it locally:
+  
+  git push origin master:refs/heads/branch_to_create
+  git fetch origin
+  git branch --track branch_to_create origin/branch_to_create
+  git checkout branch_to_create
+
+Explain your specific case:
+
+  $ grb explain create my_branch github
+  git_remote_branch version 0.3.0
+  
+  List of operations to do to create a new remote branch and track it locally:
+  
+  git push github master:refs/heads/my_branch
+  git fetch github
+  git branch --track my_branch github/my_branch
+  git checkout my_branch
+
+This, of course, works for each of the grb commands.
+
+= More on git_remote_branch
+
+- Documentation: http://grb.rubyforge.org
+- News:          http://programblings.com/category/git/git_remote_branch/
+- Bug tracker:   http://git-remote-branch.lighthouseapp.com/projects/19198-git_remote_branch/overview
+- Code:          http://github.com/webmat/git_remote_branch
+- Mailing list:  http://groups.google.com/group/git_remote_branch
+
+
+== History
+
+git_remote_branch in its current form was inspired by a script created by Carl Mercier and made public on his blog: {No nonsense GIT, part 1: git-remote-branch}[http://blog.carlmercier.com/2008/01/25/no-nonsense-git-part-1-git-remote-branch/]
+
+
+== Contributors
+
+- Mathieu Martin  webmat@gmail.com
+- Caio Chassot    dev@caiochassot.com
+- Axelson         github.com/axelson
+- Carl Mercier    github.com/cmer
+
+
+== Legalese
+
+git_remote_branch is licensed under the MIT License. See the file LICENSE for details.
+
+== Bleeding edge and development
+
+(Notice the keyword "bleeding")
+
+=== Getting the bleeding edge
+
+Installing from GitHub
+  sudo gem install webmat-git_remote_branch --source=http://gems.github.com
+
+Note that the only stable version of the gem you should trust is the one from Rubyforge. The GitHub gem is a development gem. The GitHub gem WILL be rebuilt with the same version number, and other horrible things like that. If you use the GitHub version of git_remote_branch, children will die! You've been warned.
+
+Cloning the repo and installing from your copy
+  git clone git://github.com/webmat/git_remote_branch.git
+  rake install
+
+=== Testing dependencies
+
+Note that git_remote_branch uses a few more gems for tests. Running any rake task will try to load them due to the way Rake::TestTask works.
+
+  sudo gem install thoughtbot-shoulda --source http://gems.github.com
+  sudo gem install mocha
+
+An attempt is made to require 2 more optional gems: redgreen and ruby-debug. If they're not present, only a whiny message will be displayed.
+
+=== Supported platforms
+
+git_remote_branch has been tested with the following configurations:
+
+- OS X Leopard / Ruby 1.8.6 / Git 1.5.4.3 and 1.6.0.2
+- OS X Leopard / Ruby 1.9.1 / Git 1.5.4.3 and 1.6.0.2
+- Ubuntu Intrepid Ibex / Ruby 1.8.7 / Git 1.5.6.3
+- Windows XP / Ruby 1.8.6 / Git 1.6.0.2 (the msys version)
+
+Let me know if you have problems running git_remote_branch with your platform.
+
+To run the test suite using Ruby 1.9, simply set the RUBY environment variable to point to your 1.9 interpreter and then run the 1.9 version of Rake. In my case, everything 1.9 is suffixed with 1.9:
+
+  $ RUBY=ruby1.9 rake1.9 test
+
+Or on Windows (Ruby 1.9 not tested on Windows)
+
+  > set RUBY=ruby1.9
+  > rake1.9 test

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+
+require 'rake'
+
+GRB_ROOT = File.dirname(__FILE__)
+
+#So we can use GitRemoteBranch::NAME, VERSION and so on.
+require "#{GRB_ROOT}/lib/git_remote_branch"
+
+SUDO = WINDOWS ? "" : "sudo"
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+desc 'Default: run all tests.'
+task :default => :test
+
+task :clean => [:clobber_package, :clobber_rdoc]

data/bin/grb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+# Check out the README (or try 'grb help') before you screw up your repos ;-)
+
+THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+require "#{File.dirname(THIS_FILE)}/../lib/git_remote_branch"
+
+include GitRemoteBranch
+
+def crap_out(message)
+  puts message
+  exit 1
+end
+
+unless git_found?
+  crap_out <<-MSG
+The git executable (#{GIT}) could not be found by git_remote_branch.
+Make sure your PATH variable contains the path for git's binary.
+Your PATH:
+#{ENV['PATH'].split(/[:;]/) * "\n"}
+MSG
+end
+
+begin
+  p = read_params(ARGV)
+rescue InvalidBranchError => ex
+  crap_out ex.message
+end
+
+$WHISPER = p[:silent]
+
+whisper get_welcome
+
+if p[:action] == :help
+  whisper get_usage
+  exit 0
+end
+
+if p[:explain]
+  explain_action(p[:action], p[:branch], p[:origin], p[:current_branch])
+else
+  execute_action(p[:action], p[:branch], p[:origin], p[:current_branch])
+end
+

data/lib/constants.rb

@@ -0,0 +1,5 @@
+module GitRemoteBranch
+  GIT = (ENV['GRB_GIT'] || 'git').freeze
+  
+  LOCAL_BRANCH_LISTING_COMMAND = "#{GIT} branch -l".freeze
+end

data/lib/git_remote_branch.rb

@@ -0,0 +1,164 @@
+require 'rubygems'
+
+if RUBY_VERSION =~ /1\.8/
+  gem 'colored', '>= 1.1'
+  require 'colored'
+else
+  class String
+    def red; self; end
+  end
+end
+
+begin
+  WINDOWS = !!(RUBY_PLATFORM =~ /win32|cygwin/)
+rescue Exception
+end
+
+grb_app_root = File.expand_path( File.dirname(__FILE__) + '/..' )
+
+$LOAD_PATH.unshift( grb_app_root + '/vendor' )
+require 'capture_fu'
+
+$LOAD_PATH.unshift( grb_app_root + '/lib' )
+%w(monkey_patches constants  state param_reader version).each do |f|
+  require f
+end
+
+module GitRemoteBranch
+  class InvalidBranchError < RuntimeError; end
+  class NotOnGitRepositoryError < RuntimeError; end
+
+  COMMANDS = {
+    :create     => {
+      :description => 'create a new remote branch and track it locally',
+      :aliases  => %w{create new},
+      :commands => [
+        '"#{GIT} push #{origin} #{current_branch}:refs/heads/#{branch_name}"',
+        '"#{GIT} fetch #{origin}"',
+        '"#{GIT} branch --track #{branch_name} #{origin}/#{branch_name}"',
+        '"#{GIT} checkout #{branch_name}"'
+      ]
+    },
+
+    :publish     => {
+      :description => 'publish an exiting local branch',
+      :aliases  => %w{publish remotize share},
+      :commands => [
+        '"#{GIT} push #{origin} #{branch_name}:refs/heads/#{branch_name}"',
+        '"#{GIT} fetch #{origin}"',
+        '"#{GIT} config branch.#{branch_name}.remote #{origin}"',
+        '"#{GIT} config branch.#{branch_name}.merge refs/heads/#{branch_name}"',
+        '"#{GIT} checkout #{branch_name}"'
+      ]
+    },
+
+    :rename     => {
+      :description => 'rename a remote branch and its local tracking branch',
+      :aliases  => %w{rename rn mv move},
+      :commands => [
+        '"#{GIT} push #{origin} #{current_branch}:refs/heads/#{branch_name}"',
+        '"#{GIT} fetch #{origin}"',
+        '"#{GIT} branch --track #{branch_name} #{origin}/#{branch_name}"',
+        '"#{GIT} checkout #{branch_name}"',
+        '"#{GIT} push #{origin} :refs/heads/#{current_branch}"',
+        '"#{GIT} branch -d #{current_branch}"',
+      ]
+    },
+
+    :delete     => {
+      :description => 'delete a local and a remote branch',
+      :aliases  => %w{delete destroy kill remove rm},
+      :commands => [
+        '"#{GIT} push #{origin} :refs/heads/#{branch_name}"',
+        '"#{GIT} checkout master" if current_branch == branch_name',
+        '"#{GIT} branch -d #{branch_name}"'
+      ]
+    },
+
+    :track      => {
+      :description => 'track an existing remote branch',
+      :aliases  => %w{track follow grab fetch},
+      :commands => [
+        # This string programming thing is getting old. Not flexible enough anymore.
+        '"#{GIT} fetch #{origin}"',
+        'if local_branches.include?(branch_name) 
+          "#{GIT} config branch.#{branch_name}.remote #{origin}\n" +
+          "#{GIT} config branch.#{branch_name}.merge refs/heads/#{branch_name}"
+        else
+          "#{GIT} branch --track #{branch_name} #{origin}/#{branch_name}"
+        end'
+      ]
+    }
+  } unless defined?(COMMANDS)
+  
+  def self.get_reverse_map(commands)
+    h={}
+    commands.each_pair do |cmd, params|
+      params[:aliases].each do |alias_|
+        unless h[alias_]
+          h[alias_] = cmd
+        else
+          raise "Duplicate aliases: #{alias_.inspect} already defined for command #{h[alias_].inspect}"
+        end
+      end
+    end
+    h
+  end
+  ALIAS_REVERSE_MAP = get_reverse_map(COMMANDS) unless defined?(ALIAS_REVERSE_MAP)
+  
+  def get_welcome
+    "git_remote_branch version #{VERSION::STRING}\n\n"
+  end
+
+  def get_usage
+    return <<-HELP
+  Usage:
+
+#{[:create, :publish, :rename, :delete, :track].map{|action|
+      "  grb #{action} branch_name [origin_server] \n\n"
+    }  
+  }
+  
+  Notes:
+  - If origin_server is not specified, the name 'origin' is assumed (git's default)
+  - The rename functionality renames the current branch
+  
+  The explain meta-command: you can also prepend any command with the keyword 'explain'. Instead of executing the command, git_remote_branch will simply output the list of commands you need to run to accomplish that goal.
+  Example: 
+    grb explain create
+    grb explain create my_branch github
+  
+  All commands also have aliases:
+  #{ COMMANDS.keys.map{|k| k.to_s}.sort.map {|cmd| 
+    "#{cmd}: #{COMMANDS[cmd.to_sym][:aliases].join(', ')}" }.join("\n  ") }
+  HELP
+  end
+
+  def execute_action(action, branch_name, origin, current_branch)
+    cmds = COMMANDS[action][:commands].map{ |c| eval(c) }.compact
+    execute_cmds(cmds)
+  end
+
+  def explain_action(action, branch_name, origin, current_branch)
+    cmds = COMMANDS[action][:commands].map{ |c| eval(c) }.compact
+
+    whisper "List of operations to do to #{COMMANDS[action][:description]}:", ''
+    puts_cmd cmds
+    whisper ''
+  end
+
+  def execute_cmds(*cmds)
+    silencer = $WHISPER ? ' 2>&1' : ''
+    cmds.flatten.each do |c|
+      puts_cmd c
+      `#{c}#{silencer}`
+      whisper ''
+    end
+  end
+
+  def puts_cmd(*cmds)
+    cmds.flatten.each do |c|
+      whisper "#{c}".red
+    end
+  end
+end