webmat-git_remote_branch 0.2.1 → 0.2.2

data/README

@@ -1,48 +1,56 @@
-Why git_remote_branch?
+==== Why git_remote_branch? ====
 
 The basic idea for git_remote_branch is to trivialize the interaction with 
-remote branches in simple situations.
-Things we mean by 'simple situations':
-- The local and remote name are the same
+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
+==== Installation ====
+
+sudo gem install webmat-git_remote_branch --source=http://gems.github.com
 
-(Not yet published as a gem)
-(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
+==== Usage ====
 
 Notes: 
 - parts between brackets are optional
 - When 'origin_server' is not specified, the name 'origin' is assumed.
 
-$ grb [-h]    #=> Displays help
-
 Available commands (with aliases):
 
-create (alias: new)
-Create a new local branch as well as a corresponding remote branch.
+== 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 (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 (aliases: follow grab) ==
 Track an existing remote branch locally.
 
 
@@ -50,7 +58,7 @@ $ grb track branch_name [origin_server]
 
 
 
-History
+==== History ====
 
 This script was originally created by Carl Mercier and made public on his blog 
 here:
@@ -58,12 +66,12 @@ here:
 No nonsense GIT, part 1: git-remote-branch
 http://blog.carlmercier.com/2008/01/25/no-nonsense-git-part-1-git-remote-branch/
 
-For now I just want to document the changes I make to it. I'm not sure if I'll 
-keep this alive, it depends on if he wants to keep evolving it himself in a 
-public repo.
+
+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?)

data/Rakefile

@@ -43,6 +43,9 @@ namespace :gem do
 
   desc "Uninstall the .gem"
   task :uninstall do
-    `#{SUDO} gem uninstall #{NAME}`
+    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

@@ -1,8 +1,4 @@
-- Put in evidence the tutorial part of each grb action
-  - colorize the git commands
-  - Add 'explain' / 'show' command
 - tests :-)
-- re-architect the code a bit?
 - better exit status behavior
 - Add verification if remote delete didn't work
 - New functionality:
@@ -13,31 +9,11 @@
     git checkout master
     git branch --track -f branch_name origin/branch_name
     (yay! we don't have to delete the local one...)
-- make into a gem?
-  - that installs a grb command in the path?
-
-Fix that problem:
-  mathieu@ml code (master)$ grbd follow aaron
-  git_remote_branch version 0.2.1
-  ----------------------------------------------------------------------
-
-  Executing: git branch --track aaron origin/aaron
-  fatal: Not a valid object name: 'origin/aaron'.
-
-
-  mathieu@ml code (master)$ git fetch
-  remote: Counting objects: 87, done.
-  remote: Compressing objects: 100% (45/45), done.
-  remote: Total 51 (delta 13), reused 40 (delta 5)
-  Unpacking objects: 100% (51/51), done.
-  From git@github.com:webmat/priv_repo
-   * [new branch]      aaron      -> origin/aaron
-
-  mathieu@ml code (master)$ grbd follow aaron
-  git_remote_branch version 0.2.1
-  ----------------------------------------------------------------------
-
-  Executing: git branch --track aaron origin/aaron
-
-
-  
+- 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

@@ -1,33 +1,22 @@
 #!/usr/bin/env ruby
 
-# Check out the README (or try grb -h) before you screw up your repos ;-)
+# Check out the README (or try 'grb help') before you screw up your repos ;-)
+
+require "#{File.dirname(__FILE__)}/../lib/git_remote_branch"
 
-require File.expand_path( File.join( [File.dirname(__FILE__)] + %w{ .. lib git_remote_branch } ) )
 include GitRemoteBranch
 
 print_welcome
 
-p = read_params
+p = read_params(ARGV)
 
 if p[:action] == :help
   print_usage
   exit 0
 end
 
-if p[:current_branch].nil?
-  puts 'You must specify a branch'
-  print_usage
-  exit 1
-end
-
-case p[:action]
-  when :create
-    create_branch(p[:branch], p[:origin], p[:current_branch])
-  when :delete
-    delete_branch(p[:branch], p[:origin], p[:current_branch])
-  when :track
-    track_branch(p[:branch], p[:origin])
-  else
-    print_usage
-    exit 1
+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

@@ -1,108 +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.1'
+  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}"'
+      ]
+    },
 
-  CMD_ALIASES = {
-    :create => %w{create new},
-    :delete => %w{delete destroy kill remove},
-    :track  => %w{track follow grab fetch},
+    :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}", '-' * 70, ''
+    puts "git_remote_branch version #{VERSION}", ''
   end
 
   def print_usage
     puts <<-HELP
   Usage:
 
-  git_remote_branch create branch_name [origin_server]
-  -or-
-  git_remote_branch delete branch_name [origin_server]
-  -or-
-  git_remote_branch track branch_name [origin_server]
-  
-  If origin_server is not specified, the name 'origin' is assumed
+  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:
-  #{ CMD_ALIASES.keys.map{|k| k.to_s}.sort.map {|k| 
-    "#{k}: #{CMD_ALIASES[k.to_sym].join(', ')}" }.join("\n  ") }
+  #{ COMMANDS.keys.map{|k| k.to_s}.sort.map {|cmd| 
+    "#{cmd}: #{COMMANDS[cmd.to_sym][:aliases].join(', ')}" }.join("\n  ") }
   HELP
   end
 
-  def execute_cmd(cmd)
-    res, out, err = steal_pipes do
-                                  `#{cmd}`
-                                end
-    return res, out, err
+  def execute_action(action, branch_name, origin, current_branch)
+    cmds = COMMANDS[action][:commands].map{ |c| eval(c) }.compact
+    execute_cmds(cmds)
   end
 
-  def execute_cmds(*cmds)
-    cmds.flatten.each do |c|
-      puts "Executing: #{c}"
-      `#{c}`
-      puts ""
-    end
-  end
+  def explain_action(action, branch_name, origin, current_branch)
+    cmds = COMMANDS[action][:commands].map{ |c| eval(c) }.compact
 
-  def create_branch(branch_name, origin, current_branch)
-    cmd = []
-    cmd << "git push origin #{current_branch}:refs/heads/#{branch_name}"
-    cmd << "git fetch #{origin}"
-    cmd << "git branch --track #{branch_name} #{origin}/#{branch_name}"
-    cmd << "git checkout #{branch_name}"
-    execute_cmds(cmd)
+    puts "List of operations to do to #{COMMANDS[action][:description]}:", ''
+    puts_cmd cmds
+    puts ''
   end
 
-  def delete_branch(branch_name, origin, current_branch)
-    cmd = []
-    cmd << "git push #{origin} :refs/heads/#{branch_name}"
-    cmd << "git checkout master" if current_branch == branch_name
-    cmd << "git branch -d #{branch_name}"
-    execute_cmds(cmd)
-  end
-
-  def track_branch(branch_name, origin)
-    cmd = ["git branch --track #{branch_name} #{origin}/#{branch_name}"]
-    execute_cmds(cmd)
-  end
-
-  def get_current_branch
-    x = `git branch -l`
-    x.each_line do |l|
-      return l.sub("*","").strip if l[0] == 42
+  def execute_cmds(*cmds)
+    cmds.flatten.each do |c|
+      puts_cmd c
+      `#{c}`
+      puts ''
     end
-
-    puts "Couldn't identify the current local branch."
-    return nil
   end
 
-  def get_action
-    a = ARGV[0].downcase
-    return :create if CMD_ALIASES[:create].include?(a)
-    return :delete if CMD_ALIASES[:delete].include?(a)
-    return :track  if CMD_ALIASES[:track].include?(a)
-    return nil
-  end
-
-  def get_branch
-    ARGV[1].downcase
-  end
-
-  def get_origin
-    return ARGV[2] if ARGV.size > 2 
-    return "origin"
-  end
-
-  def read_params
-    p={}
-    begin
-      p[:action] = get_action
-      p[:branch] = get_branch
-      p[:origin] = get_origin
-      p[:current_branch] = get_current_branch
-      p
-    rescue
-      {:action=>:help}
+  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

@@ -4,7 +4,7 @@ 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 with attribute readers
+# Once instantiated you can access the 3 full repo locations through attribute readers
 # remote, local1 and local2.
 class GitHelper
   include FileUtils

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: webmat-git_remote_branch
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Mathieu Martin
@@ -12,8 +12,16 @@ cert_chain: []
 
 date: 2008-06-13 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: colored
+  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: 
@@ -28,8 +36,7 @@ files:
 - TODO
 - bin/grb
 - lib/git_remote_branch.rb
-- vendor/try_require/try_require.rb
-- vendor/capture_fu/capture_fu.rb
+- lib/param_reader.rb
 - test/git_helper.rb
 - test/test_helper.rb
 - test/unit/git_helper_test.rb

data/vendor/capture_fu/capture_fu.rb

@@ -1,60 +0,0 @@
-# This is a very early version of capture_fu. 
-# See github.com/webmat/capture_fu for more info.
-module CaptureFu
-  VERSION = '0.0.1'
-
-  def capture_output(&block)
-    real_out, real_err = $stdout, $stderr
-    result = fake_out = fake_err = nil
-    begin
-      fake_out, fake_err = Helpers::PipeStealer.new, Helpers::PipeStealer.new
-      $stdout, $stderr = fake_out, fake_err
-      result = yield
-    ensure
-      $stdout, $stderr = real_out, real_err
-    end
-    return result, fake_out.captured, fake_err.captured
-  end
-
-  # This first implementation is only intended for batch executions.
-  # You can't pipe stuff programmatically to the child process.
-  def capture_process_output(command)
-
-    #capture stderr in the same stream
-    command << ' 2>&1' unless Helpers.stderr_already_redirected(command)
-
-    out = `#{command}`
-    return $?.exitstatus, out
-  end
-
-
-  private
-
-  module Helpers
-    
-    def self.stderr_already_redirected(command)
-      #Already redirected to stdout (valid for Windows)
-      return true if command =~ /2>&1\s*\Z/
-
-      #Redirected to /dev/null (this is clearly POSIX-dependent)
-      return true if command =~ /2>\/dev\/null\s*\Z/
-
-      return false
-    end
-
-    class PipeStealer < File
-      attr_reader :captured
-      def initialize
-        @captured = ''
-      end
-      def write(s)
-        @captured << s
-      end
-      def captured
-        return nil if @captured.empty?
-        @captured.dup
-      end
-    end
-
-  end #Helper module
-end

data/vendor/try_require/try_require.rb

@@ -1,18 +0,0 @@
-# This is a very early version of try_require. 
-# See github.com/webmat/try_require for more info.
-def try_require(what, &block)
-  loaded, require_result = false, nil 
-
-  begin
-    require_result = require what
-    loaded = true 
-
-  rescue LoadError => ex
-    puts "Unable to require '#{what}'", "#{ex.class}: #{ex.message}"
-  end 
-
-  yield if loaded and block_given? 
-
-  require_result
-end
-