git_remote_branch 0.2.4 → 0.2.6

data/CHANGELOG

@@ -0,0 +1,17 @@
+* 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/COPYING

@@ -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

@@ -13,12 +13,16 @@ 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
+  sudo gem install grb
 
-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.
+
+Or if you want the bleeding edge from GitHub
+You may try
+  sudo gem install webmat-git_remote_branch --source=http://gems.github.com
+
+But you're probably better off with
+  git clone git://github.com/webmat/git_remote_branch.git
+  rake install
 
 
 
@@ -30,9 +34,10 @@ Notes:
 
 Available commands (with aliases):
 
+
 == Help ==
 
-$ grb [-h]    #=> Displays help
+$ grb [-h|help]    #=> Displays help
 
 == create (alias: new) ==
 Create a new local branch as well as a corresponding remote branch from the
@@ -43,6 +48,14 @@ Switch to the new branch.
 $ grb create branch_name [origin_server]
 
 
+== publish (aliases: remotize) ==
+Publish an existing local branch to the remote server.
+Set up the local branch to track the new remote branch.
+Switch to the new branch.
+
+$ grb publish branch_name [origin_server]
+
+
 == delete (aliases: destroy, kill, remove) ==
 Delete the remote branch then delete the local branch.
 The local branch is not deleted if there are pending changes.
@@ -57,10 +70,10 @@ $ grb track branch_name [origin_server]
 
 
 == rename (aliases: rn, mv, move) ==
-Rename the remote branch by copying and deleting the old name.
-Checkout a new local tracking branch with the new name and delete the branch
-with the old name.
-branch_name is the new name, the old name is always the current branch's
+To rename the branch you're currently on.
+Rename the remote branch by copying then deleting the old name.
+Checkout a new local tracking branch with the new name and delete the local
+branch with the old name.
 
 $ grb rename branch_name [origin_server]
 
@@ -73,7 +86,7 @@ run to accomplish that goal.
 Examples: 
 
 $ grb explain create
-git_remote_branch version 0.2.2
+git_remote_branch version 0.2.6
 
 List of operations to do to create a new remote branch and track it locally:
 
@@ -84,7 +97,7 @@ git checkout branch_to_create
 
 
 $ grb explain create my_branch github
-git_remote_branch version 0.2.2
+git_remote_branch version 0.2.6
 
 List of operations to do to create a new remote branch and track it locally:
 
@@ -94,6 +107,14 @@ git branch --track my_branch github/my_branch
 git checkout my_branch
 
 
+
+==== More on git_remote_branch ====
+
+Site:         http://github.com/webmat/git_remote_branch
+Mailing list: http://groups.google.com/group/git_remote_branch
+
+
+
 ==== History ====
 
 This script was originally created by Carl Mercier and made public on his blog
@@ -107,8 +128,13 @@ I'm using it as a starting point to make it even easier to interact with remote
 repositories.
 
 
-=== Contributors ===
+== Contributors ==
 
 - Mathieu Martin  webmat@gmail.com
 - Carl Mercier    (Carl: want your email here?)
 - Caio Chassot    dev@caiochassot.com
+
+
+== Legalese ==
+
+git_remote_branch is licensed under the MIT License. See the file COPYING for details.

data/Rakefile

@@ -1,51 +1,12 @@
 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
+require "#{HERE}/lib/git_remote_branch"
+Dir['tasks/**/*.rake'].each { |rake| load rake }
 
 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} -x"
-    #TODO fix this crap
-    puts cmd, '  (Note: execute manually if more than one version is installed)'
-    `#{cmd}`
-  end
-end

data/TODO

@@ -1,16 +1,7 @@
 - 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)
+- offer help when branch -d fails
+- connect (new remote repo)
+- Make remotize work when not specifying the local branch (and use this one by default)
 - 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)
@@ -18,3 +9,8 @@
   - 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.
+
+- better exit status behavior
+- Add verification if remote delete didn't work
+- add support for different remote name (--remote-name)
+

data/bin/grb

@@ -7,12 +7,19 @@ require "#{File.dirname(THIS_FILE)}/../lib/git_remote_branch"
 
 include GitRemoteBranch
 
-print_welcome
+begin
+  p = read_params(ARGV)
+rescue InvalidBranchError => ex
+  puts ex.message
+  exit 1
+end
+
+$SILENT = p[:silent]
 
-p = read_params(ARGV)
+whisper get_welcome
 
 if p[:action] == :help
-  print_usage
+  whisper get_usage
   exit 0
 end
 

data/lib/git_remote_branch.rb

@@ -1,13 +1,18 @@
-grb_app_root = File.expand_path( File.dirname(__FILE__) + '/..' )
-
 require 'rubygems'
 require 'colored'
 
+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' )
 require 'param_reader'
+require 'version'
 
 module GitRemoteBranch
-  VERSION = '0.2.4'
+  class InvalidBranchError < RuntimeError; end
+  class NotOnGitRepositoryError < RuntimeError; end
 
   COMMANDS = {
     :create     => {
@@ -21,9 +26,21 @@ module GitRemoteBranch
       ]
     },
 
+    :publish     => {
+      :description => 'publish an exiting local branch',
+      :aliases  => %w{publish remotize},
+      :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{ rn mv move },
+      :aliases  => %w{rename rn mv move},
       :commands => [
         '"git push #{origin} #{current_branch}:refs/heads/#{branch_name}"',
         '"git fetch #{origin}"',
@@ -53,25 +70,39 @@ module GitRemoteBranch
         '"git branch --track #{branch_name} #{origin}/#{branch_name}"'
       ]
     }
-  }
-
-  def print_welcome
-    puts "git_remote_branch version #{VERSION}", ''
+  } 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 print_usage
-    puts <<-HELP
+  def get_usage
+    return <<-HELP
   Usage:
 
-  grb create branch_name [origin_server]
-
-  grb delete branch_name [origin_server]
-
-  grb rename branch_name [origin_server]
-
-  grb track branch_name [origin_server]
-
-  If origin_server is not specified, the name 'origin' is assumed (git's default)
+#{[: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: 
@@ -92,22 +123,29 @@ module GitRemoteBranch
   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]}:", ''
+    whisper "List of operations to do to #{COMMANDS[action][:description]}:", ''
     puts_cmd cmds
-    puts ''
+    whisper ''
   end
 
   def execute_cmds(*cmds)
+    silencer = $SILENT ? ' 2>&1' : ''
     cmds.flatten.each do |c|
       puts_cmd c
-      `#{c}`
-      puts ''
+      `#{c}#{silencer}`
+      whisper ''
     end
   end
 
   def puts_cmd(*cmds)
     cmds.flatten.each do |c|
-      puts "#{c}".red
+      whisper "#{c}".red
+    end
+  end
+  
+  def whisper(*msgs)
+    unless $SILENT
+      msgs.flatten ?  msgs.flatten.each{|m| puts m} : puts
     end
   end
 end

data/lib/param_reader.rb

@@ -1,18 +1,40 @@
 module GitRemoteBranch
+  include ::CaptureFu
+  
+  private 
+  HELP_PARAMS = {:action => :help}
+
+  public
   def read_params(argv)
+    #TODO Some validation on the params
+    
     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
+    p[:silent]  = silent!(argv)
+    p[:explain] = explain_mode!(argv)
+    
+    p[:action]  = get_action(argv[0]) or return HELP_PARAMS
 
-    #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]
+    return HELP_PARAMS if p[:action] == :help
 
-    #TODO Some validation on the params
+    p[:branch]  = get_branch(argv[1])
+    p[:origin]  = get_origin(argv[2])
+    
+    # If in explain mode, the user doesn't have to specify a branch or be on in
+    # actual repo to get the explanation. 
+    # Of course if he is, the explanation will be made better by using contextual info.
+    if p[:explain]
+      p[:branch] ||= "branch_to_#{p[:action]}"
+      p[:current_branch] = begin
+        get_current_branch
+      rescue NotOnGitRepositoryError, InvalidBranchError
+        'current_branch'
+      end
 
-    p
+    else
+      return HELP_PARAMS unless p[:branch]
+      p[:current_branch] = get_current_branch
+    end
+    return p
   end
 
   def explain_mode!(argv)
@@ -23,14 +45,13 @@ module GitRemoteBranch
       false
     end
   end
+  
+  def silent!(argv)
+    !!argv.delete('--silent')
+  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 :rename if COMMANDS[:rename][:aliases].include?(a)
-    return nil
+    ALIAS_REVERSE_MAP[action.to_s.downcase]
   end
 
   def get_branch(branch)
@@ -41,12 +62,23 @@ module GitRemoteBranch
     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\)/
+  private
+    BRANCH_LISTING_COMMAND = 'git branch -l'.freeze
+  
+  public
+    def get_current_branch
+      #This is sensitive to checkouts of branches specified with wrong case
+      
+      listing = capture_process_output("#{BRANCH_LISTING_COMMAND}")[1]
+      raise(NotOnGitRepositoryError, listing.chomp) if listing =~ /Not a git repository/i
+      
+      current_branch = listing.scan(/^\*\s+(.+)/).flatten.first
+      
+      if current_branch =~ /\(no branch\)/
+        raise InvalidBranchError, ["Couldn't identify the current local branch. The branch listing was:",
+          BRANCH_LISTING_COMMAND.red, 
+          listing].join("\n")
+      end
+      current_branch.strip
     end
-    raise "Couldn't identify the current local branch."
-  end
 end

data/lib/version.rb

@@ -0,0 +1,14 @@
+module GitRemoteBranch  
+  module VERSION #:nodoc:
+    MAJOR    = 0
+    MINOR    = 2
+    TINY     = 6
+    
+    STRING   = [MAJOR, MINOR, TINY].join('.').freeze
+  end
+  
+  NAME          = 'git_remote_branch'.freeze
+  COMPLETE_NAME = "#{NAME} #{VERSION::STRING}".freeze  
+  COMMAND_NAME  = 'grb'.freeze
+  SHORT_NAME    = COMMAND_NAME
+end

data/tasks/gem.rake

@@ -0,0 +1,73 @@
+require 'yaml'
+
+require 'rake/gempackagetask'
+
+task :clean => :clobber_package
+
+spec = Gem::Specification.new do |s|
+  s.name                  = GitRemoteBranch::NAME
+  s.version               = GitRemoteBranch::VERSION::STRING
+  s.summary               = "git_remote_branch eases the interaction with remote branches"
+  s.description           = "git_remote_branch is a learning tool to ease the interaction with " +
+                            "remote branches in simple situations."
+
+  s.authors               = ['Mathieu Martin', 'Carl Mercier']
+  s.email                 = "webmat@gmail.com"
+  s.homepage              = "http://github.com/webmat/git_remote_branch"
+  s.rubyforge_project     = 'grb'
+
+  s.has_rdoc              = false
+  
+  s.test_files            = Dir['test/**/*']
+  s.files                 = Dir['**/*'].reject{|f| f =~ /\Apkg|\Acoverage|\.gemspec\Z/}
+  
+  s.executable            = 'grb'
+  s.bindir                = "bin"
+  s.require_path          = "lib"
+  
+  s.add_dependency( 'colored', '>= 1.1' )
+end
+
+#Creates clobber_package, gem, package and repackage tasks
+#Note on clobber_package: fortunately, this will clobber the CODE package
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+TAG_COMMAND = "git tag -m 'Tagging version #{GitRemoteBranch::VERSION::STRING}' -a v#{GitRemoteBranch::VERSION::STRING}"
+task :tag_warn do
+  puts  "*" * 40,
+        "Don't forget to tag the release:",
+        '',
+        "  " + TAG_COMMAND,
+        '',
+        "or run rake tag",
+        "*" * 40
+end
+task :tag do
+  sh TAG_COMMAND
+end
+task :gem => :tag_warn
+
+namespace :gem do
+  desc "Update the gemspec for GitHub's gem server"
+  task :github do
+    File.open("#{GitRemoteBranch::NAME}.gemspec", 'w'){|f| f.puts YAML::dump(spec) }
+    puts "gemspec generated here: #{GitRemoteBranch::NAME}.gemspec"
+  end
+  
+  desc 'Upload gem to rubyforge.org'
+  task :rubyforge => :gem do
+    sh 'rubyforge login'
+    sh "rubyforge add_release grb grb 'release #{GitRemoteBranch::VERSION::STRING}' pkg/#{spec.full_name}.gem"
+    sh "rubyforge add_file grb grb #{GitRemoteBranch::VERSION::STRING} pkg/#{spec.full_name}.gem"
+  end
+end
+
+task :install => [:clean, :gem] do
+  sh "#{SUDO} gem install pkg/#{spec.full_name}.gem"
+end
+
+task :uninstall do
+  sh "#{SUDO} gem uninstall -v #{GitRemoteBranch::VERSION::STRING} -x #{GitRemoteBranch::NAME}"
+end

data/tasks/test.rake

@@ -0,0 +1,21 @@
+require 'rake/testtask'
+
+desc "Run all tests"
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+namespace :test do
+  desc "Run functional tests"
+  Rake::TestTask.new(:functional) do |t|
+    t.pattern = 'test/functional/**/*_test.rb'
+    t.verbose = true
+  end
+
+  desc "Run unit tests"
+  Rake::TestTask.new(:unit) do |t|
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.verbose = true
+  end
+end