git_remote_branch 0.2.2

data/README

@@ -0,0 +1,77 @@
+==== Why git_remote_branch? ====
+
+The basic idea for git_remote_branch is to trivialize the interaction with 
+remote branches in simple situations. 
+
+For now git_remote_branch assumes that the local and remote branches have the 
+same name. Multiple origins are supported.
+
+Another goal of git_remote_branch is to help teach the real underlying git 
+commands. Each operation done on your behalf is displayed at the console.
+
+
+
+==== Installation ====
+
+sudo gem install webmat-git_remote_branch --source=http://gems.github.com
+
+Note: don't add gems.github.com as a permanent source for your gems. Check out
+http://gems.github.com for more information on the matter. If you've included 
+it already and find yourself in trouble, check out 
+http://chalain.livejournal.com/71260.html.
+
+
+
+==== 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]    #=> Displays help
+
+== create (alias: new) ==
+Create a new local branch as well as a corresponding remote branch from the
+branch you are currently on.
+Automatically track the new remote branch (useful for pulling and merging).
+Switch to the new branch.
+
+$ grb create branch_name [origin_server]
+
+
+== delete (aliases: destroy, kill) ==
+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) ==
+Track an existing remote branch locally.
+
+
+$ grb track branch_name [origin_server]
+
+
+
+==== History ====
+
+This script was originally created by Carl Mercier and made public on his blog 
+here:
+
+No nonsense GIT, part 1: git-remote-branch
+http://blog.carlmercier.com/2008/01/25/no-nonsense-git-part-1-git-remote-branch/
+
+
+I'm using it as a starting point to make it even easier to interact with remote
+repositories.
+
+
+=== Contributors ===
+
+- Mathieu Martin  webmat@gmail.com
+- Carl Mercier    (Carl: want your email here?)

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+
+HERE = File.dirname(__FILE__)
+
+require "#{HERE}/lib/git_remote_branch"
+
+
+#Stuff gleaned from merb-core's Rakefile
+NAME = 'git_remote_branch'
+windows = (RUBY_PLATFORM =~ /win32|cygwin/) rescue nil
+install_home = ENV['GEM_HOME'] ? "-i #{ENV['GEM_HOME']}" : ""
+SUDO = windows ? "" : "sudo"
+
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test
+
+gem_spec = eval(File.read("#{HERE}/git_remote_branch.gemspec"))
+
+namespace :gem do
+  #Creates clobber_package, gem,  package, repackage tasks
+  #Note on clobber_package: fortunately, this will clobber the CODE package
+  Rake::GemPackageTask.new(gem_spec) do |pkg| 
+    pkg.need_tar = true 
+  end
+
+  #Tasks gleaned from merb-core's Rakefile
+
+  desc "Run :gem and install the resulting .gem"
+  task :install => :gem do
+    cmd = "#{SUDO} gem install #{install_home} --local pkg/#{NAME}-#{GitRemoteBranch::VERSION}.gem --no-rdoc --no-ri"
+    puts cmd
+    `#{cmd}`
+  end
+
+  desc "Uninstall the .gem"
+  task :uninstall do
+    cmd = "#{SUDO} gem uninstall #{NAME}"
+    #TODO fix this crap
+    puts cmd, '  (Note: execute manually if more than one version is installed)'
+    `#{cmd}`
+  end
+end

data/TODO

@@ -0,0 +1,20 @@
+- tests :-)
+- displaying help shouldn't need grb to execute in a git working dir...
+- better exit status behavior
+- Add verification if remote delete didn't work
+- New functionality:
+  - Remotize an existing local branch (aliases: publish share make_remote makeremote)
+    git push origin branch_name:refs/heads/branch_name
+    git fetch origin
+    (find a local branch other than the branch to remotize)
+    git checkout master
+    git branch --track -f branch_name origin/branch_name
+    (yay! we don't have to delete the local one...)
+- add support for different remote name (--remote-name)
+- avoid deleting local branches when tracking with the help of git-config ?
+
+- drop assumption that master can be treated differently than other branches (e.g. considered as a safe checkout)
+- reliance on current_branch
+  - is it even necessary to be on a branch per se? I think not...
+  - survive checkouts with wrong case 
+    e.g.: branch "Bob" checked out branch 'bob'. git branch -l won't correctly flag branch Bob as current.

data/bin/grb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+# Check out the README (or try 'grb help') before you screw up your repos ;-)
+
+require "#{File.dirname(__FILE__)}/../lib/git_remote_branch"
+
+include GitRemoteBranch
+
+print_welcome
+
+p = read_params(ARGV)
+
+if p[:action] == :help
+  print_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/git_remote_branch.rb

@@ -0,0 +1,93 @@
+grb_app_root = File.expand_path( File.dirname(__FILE__) + '/..' )
+
+require 'rubygems'
+require 'colored'
+
+$LOAD_PATH.unshift( grb_app_root + '/lib' )
+require 'param_reader'
+
+module GitRemoteBranch
+  VERSION = '0.2.2'
+
+  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}"'
+      ]
+    },
+
+    :delete     => {
+      :description => 'delete a local and a remote branch',
+      :aliases  => %w{delete destroy kill remove},
+      :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 => [
+        '"git fetch #{origin}"',
+        '"git checkout master" if current_branch == branch_name',
+        '"git branch --track #{branch_name} #{origin}/#{branch_name}"'
+      ]
+    }
+  }
+
+  def print_welcome
+    puts "git_remote_branch version #{VERSION}", ''
+  end
+
+  def print_usage
+    puts <<-HELP
+  Usage:
+
+  grb create branch_name [origin_server]
+
+  grb delete branch_name [origin_server]
+
+  grb track branch_name [origin_server]
+
+  If origin_server is not specified, the name 'origin' is assumed (git's default)
+  
+  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
+
+    puts "List of operations to do to #{COMMANDS[action][:description]}:", ''
+    puts_cmd cmds
+    puts ''
+  end
+
+  def execute_cmds(*cmds)
+    cmds.flatten.each do |c|
+      puts_cmd c
+      `#{c}`
+      puts ''
+    end
+  end
+
+  def puts_cmd(*cmds)
+    cmds.flatten.each do |c|
+      puts "#{c}".red
+    end
+  end
+end

data/lib/param_reader.rb

@@ -0,0 +1,51 @@
+module GitRemoteBranch
+  def read_params(argv)
+    p={}
+    p[:explain]        = explain_mode!(argv)
+    p[:action]         = get_action(argv[0]) || :help
+    p[:branch]         = get_branch(argv[1])
+    p[:origin]         = get_origin(argv[2])
+    p[:current_branch] = get_current_branch
+
+    #If in explain mode, the user doesn't have to specify a branch to get the explanation
+    p[:branch] ||= "branch_to_#{p[:action]}" if p[:explain]
+
+    #TODO Some validation on the params
+
+    p
+  end
+
+  def explain_mode!(argv)
+    if argv[0].to_s.downcase == 'explain'
+      argv.shift
+      true
+    else
+      false
+    end
+  end
+
+  def get_action(action)
+    a = action.to_s.downcase
+    return :create if COMMANDS[:create][:aliases].include?(a)
+    return :delete if COMMANDS[:delete][:aliases].include?(a)
+    return :track  if COMMANDS[:track][:aliases].include?(a)
+    return nil
+  end
+
+  def get_branch(branch)
+    branch
+  end
+  
+  def get_origin(origin)
+    return origin || 'origin'
+  end
+
+  def get_current_branch
+    #This is sensitive to checkouts of branches specified with wrong case
+    x = `git branch -l`
+    x.each_line do |l|
+      return l.sub("*","").strip if l =~ /\A\*/ and not l =~ /\(no branch\)/
+    end
+    raise "Couldn't identify the current local branch."
+  end
+end

data/test/git_helper.rb

@@ -0,0 +1,57 @@
+require 'fileutils'
+require 'tmpdir'
+
+# Instantiating a GitHelper object creates a temp directory containing 3 repos.
+# 1 that's considered the remote repo and 2 peer local repos (local1 and local2).
+# All 3 are synchronized with the same data (they contain a few dummy files).
+# Once instantiated you can access the 3 full repo locations through attribute readers
+# remote, local1 and local2.
+class GitHelper
+  include FileUtils
+
+  @@WORK_DIR = 'repo_test'
+  
+  attr_reader :remote, :local1, :local2
+  
+  def initialize
+    @wd = get_temp_dir
+    
+    @remote = init_repo(@wd, 'remote')
+    @local1 = clone_repo(@remote, @wd, 'local1')
+    @local2 = clone_repo(@remote, @wd, 'local2')
+  end
+  
+  def cleanup
+    rm_rf @wd
+  end
+  
+  protected
+  def get_temp_dir
+    #Note: it's NOT a good idea to do this stuff un a subdirectory of the 
+    #git_remote_branch repo. Trust me :-)
+    wd = File.expand_path( File.join( Dir::tmpdir, @@WORK_DIR) )
+    Dir.mkdir wd unless File.exists? wd
+    
+    #Create new subdir with a random name
+    new_dir=''
+    begin
+      new_dir = File.join( wd, "#{rand(10000)}" )
+      Dir.mkdir new_dir
+    rescue
+      retry
+    end
+    
+    new_dir
+  end
+  
+  def init_repo(path, name)
+    repo_dir = File.join(path, name)
+    `mkdir #{repo_dir}; cd $_; git init; touch file.txt; git add .; git commit -a -m "dummy file"`
+    repo_dir
+  end
+  
+  def clone_repo(origin_path, clone_path, name)
+    `cd #{clone_path}; git clone #{File.join(origin_path, '.git')} #{name}`
+    return File.join(clone_path, name)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'test/unit'
+
+test_dir = File.dirname(__FILE__)
+
+begin
+  require 'try_require'
+rescue LoadError
+  require File.join( [test_dir] + %w{ .. vendor try_require try_require } )
+end
+
+try_require 'redgreen'
+try_require 'ruby-debug'
+
+require File.join(test_dir, 'git_helper')
+require File.join( [test_dir] + %w{ .. lib git_remote_branch} )
+
+class Test::Unit::TestCase
+  include GitRemoteBranch
+
+  # Passes assertion if condition is false  
+  def assert_false(condition, message = nil)
+    message = "assert_false failed" unless message
+    assert condition == false, message
+  end
+
+end

data/test/unit/git_helper_test.rb

@@ -0,0 +1,30 @@
+require File.join( File.dirname(__FILE__), '..', 'test_helper')
+
+class GitHelperTest < Test::Unit::TestCase
+  
+  def setup
+    super
+    @g = GitHelper.new
+    @directories = [@g.remote, @g.local1, @g.local2]
+  end
+  
+  def teardown
+    @g.cleanup
+  end
+  
+  def test_init
+    @directories.each do |d|
+      assert File.exists?(@g.remote), 'Directory for repo must be created'
+      assert File.exists?( File.join(@g.remote, '.git') ), 'Repo must be created'
+    end
+  end
+  
+  def test_cleanup
+    @g.cleanup
+    
+    @directories.each do |d|
+      assert_false File.exists?(@g.remote), 'Each repo directory must be destroyed after cleanup'
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: git_remote_branch
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Mathieu Martin
+- Carl Mercier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: colored
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    version: 
+description: git_remote_branch is a learning tool to ease the interaction with remote branches in simple situations.
+email: webmat@gmail.com
+executables: 
+- grb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README
+- TODO
+- bin/grb
+- lib/git_remote_branch.rb
+- lib/param_reader.rb
+- test/git_helper.rb
+- test/test_helper.rb
+- test/unit/git_helper_test.rb
+has_rdoc: false
+homepage: http://github.com/webmat/git_remote_branch
+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.2.0
+signing_key: 
+specification_version: 2
+summary: git_remote_branch eases the interaction with remote branches
+test_files: 
+- test/git_helper.rb
+- test/test_helper.rb
+- test/unit/git_helper_test.rb