git-topic 0.1.1

data/git-topic.gemspec

@@ -0,0 +1,127 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{git-topic}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David J. Hamilton"]
+  s.date = %q{2010-07-08}
+  s.default_executable = %q{git-topic}
+  s.description = %q{
+      gem command around reviewed topic branches.  Supports workflow of the form:
+
+      # alexander:
+      git work-on <topic>
+      git done
+
+      # bismarck:
+      git status    # notice a review branch
+      git review <topic>
+      # happy, merge into master, push and cleanup
+      git accept
+
+      git review <topic2>
+      # unhappy
+      git reject
+
+      # alexander:
+      git status    # notice rejected topic
+      git work-on <topic>
+
+      see README.rdoc for more (any) details.
+    }
+  s.email = %q{git-topic@hjdivad.com}
+  s.executables = ["git-topic"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     ".gvimrc",
+     ".rspec",
+     ".rvmrc",
+     ".vimproject",
+     ".vimrc",
+     "Gemfile",
+     "Gemfile.lock",
+     "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "autotest/discover.rb",
+     "bin/git-topic",
+     "git-topic.gemspec",
+     "lib/git-topic.rb",
+     "lib/util.rb",
+     "spec/git-topic_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/template/origin/HEAD",
+     "spec/template/origin/config",
+     "spec/template/origin/description",
+     "spec/template/origin/hooks/applypatch-msg.sample",
+     "spec/template/origin/hooks/commit-msg.sample",
+     "spec/template/origin/hooks/post-commit.sample",
+     "spec/template/origin/hooks/post-receive.sample",
+     "spec/template/origin/hooks/post-update.sample",
+     "spec/template/origin/hooks/pre-applypatch.sample",
+     "spec/template/origin/hooks/pre-commit.sample",
+     "spec/template/origin/hooks/pre-rebase.sample",
+     "spec/template/origin/hooks/prepare-commit-msg.sample",
+     "spec/template/origin/hooks/update.sample",
+     "spec/template/origin/info/exclude",
+     "spec/template/origin/objects/0a/da6d051b94cd0df50f5a0b7229aec26f0d2cdf",
+     "spec/template/origin/objects/0c/e06c616769768f09f5e629cfcc68eabe3dee81",
+     "spec/template/origin/objects/20/049991cdafdce826f5a3c01e10ffa84d6997ec",
+     "spec/template/origin/objects/33/1d827fd47fb234af54e3a4bbf8c6705e9116cc",
+     "spec/template/origin/objects/41/51899b742fd6b1c873b177b9d13451682089bc",
+     "spec/template/origin/objects/44/ffd9c9c8b52b201659e3ad318cdad6ec836b46",
+     "spec/template/origin/objects/4b/825dc642cb6eb9a060e54bf8d69288fbee4904",
+     "spec/template/origin/objects/55/eeb01bdf874d1a35870bcf24a970c475c63344",
+     "spec/template/origin/objects/8d/09f9b8d80ce282218125cb0cbf53cccf022203",
+     "spec/template/origin/objects/b4/8e68d5cac189af36abe48e893d11c24b7b2a19",
+     "spec/template/origin/objects/c0/838ed2ee8f2e83c8bda859fc5e332b92f0a5a3",
+     "spec/template/origin/objects/cd/f7b9dbc4911a0d1404db54cde2ed448f6a6afd",
+     "spec/template/origin/objects/d2/6b33daea1ed9823a189992bba38fbc913483c1",
+     "spec/template/origin/objects/fe/4e254557e19f338f40ccfdc00a7517771db880",
+     "spec/template/origin/refs/heads/master",
+     "spec/template/origin/refs/heads/rejected/davidjh/krakens",
+     "spec/template/origin/refs/heads/review/davidjh/pirates",
+     "spec/template/origin/refs/heads/review/user24601/ninja-basic",
+     "spec/template/origin/refs/heads/review/user24601/zombie-basic"
+  ]
+  s.homepage = %q{http://github.com/hjdivad/git-topic}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{git command around reviewed topic branches}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/git-topic_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+  end
+end
+

data/lib/git-topic.rb

@@ -0,0 +1,375 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'active_support'
+require 'active_support/core_ext/hash/keys'
+
+require 'util'
+
+
+module GitTopic
+  GlobalOptKeys = [ :verbose, :help, :verbose_given ]
+
+  class << self
+
+    # Switch to a branch for the given topic.
+    def work_on( topic, opts={} )
+      raise "Topic must be specified" if topic.nil?
+
+      # setup a remote branch, if necessary
+      wb = wip_branch( topic )
+      git(
+        "push origin HEAD:#{wb}"
+      ) unless remote_branches.include? "origin/#{wb}"
+      # switch to the new branch
+      git [ switch_to_branch( wb, "origin/#{wb}" )]
+     
+      # Check for rejected branch
+      rej_branch = rejected_branch( topic )
+      if remote_branches.include? "origin/#{rej_branch}"
+        git [
+          "reset --hard origin/#{rej_branch}",
+          "push origin :#{rej_branch} HEAD:#{wb}",
+        ]
+      end
+    end
+
+    # Done with the given topic.  If none is specified, then topic is assumed to
+    # be the current branch (if it's a topic branch).
+    def done( topic=nil, opts={} )
+      raise(
+        "Branch must be a topic branch"
+      ) unless current_branch =~ %r{^wip/}
+      raise(
+        "Working tree must be clean"
+      ) unless working_tree_clean?
+
+      topic = current_topic if topic.nil?
+
+      wb = wip_branch( topic )
+      rb = review_branch( topic )
+      git [
+        "push origin #{wb}:#{rb} :#{wb}",
+        "checkout master",
+        "branch -D #{wip_branch( topic )}"
+      ]
+    end
+
+    # Produce status like
+    #
+    #   # There are 2 topics you can review.
+    #   #
+    #   # from davidjh:
+    #   #   zombies
+    #   #   pirates
+    #   # from king-julian:
+    #   #   fish
+    #   #   whales
+    #   #
+    #   # 2 of your topics were rejected.
+    #   #   dragons
+    #   #   liches
+    def status( opts={} )
+      opts.assert_valid_keys  :prepended, :prepended_given, *GlobalOptKeys
+
+      sb = ''
+      rb = remote_branches_organized
+      review_ut   = rb[:review]
+      rejected_ut = rb[:rejected]
+
+      unless review_ut.empty?
+        prep = review_ut.size == 1 ? "is 1" : "are #{review_ut.size}"
+        sb << "# There #{prep} #{'topic'.pluralize( review_ut.size )} you can review.\n\n"
+
+        sb << review_ut.map do |user, topics|
+          sb2 = "  from #{user}:\n"
+          sb2 << topics.map{|t| "    #{t}"}.join( "\n" )
+          sb2
+        end.join( "\n" )
+      end
+
+      rejected_topics = rejected_ut[ user ] || []
+      unless rejected_topics.empty?
+        sb << "\n" unless review_ut.empty?
+        verb = rejected_topics.size  == 1 ? 'is' : 'are'
+        sb << "\n#{rejected_topics.size} of your topics #{verb} rejected.\n    "
+        sb << rejected_topics.join( "\n    " )
+      end
+
+      sb.gsub! "\n", "\n# "
+      sb << "\n" unless sb.empty?
+      print sb
+
+      if opts[ :prepended ]
+        print "#\n" unless sb.empty?
+        git "status", :show => true
+      end
+    end
+
+    # Switch to a review branch to check somebody else's code.
+    def review( spec=nil, opts={} )
+      rb = remote_branches_organized
+      review_branches = rb[:review]
+
+      if spec.nil?
+        # select the oldest (by HEAD) topic, if any exist
+        if review_branches.empty?
+          puts "nothing to review."
+          return
+        end
+
+        user, topic = oldest_review_user_topic
+      else
+        user, topic = spec.split( '/' )
+      end
+
+      if remote_topic_branch = find_remote_review_branch( topic )
+        git [
+          switch_to_branch(
+            review_branch( topic, user ),
+            remote_topic_branch )]
+      else
+        raise "No review topic found matching ‘#{spec}’"
+      end
+    end
+
+    # Accept the branch currently being reviewed.
+    def accept( topic=nil, opts={} )
+      raise "Must be on a review branch." unless on_review_branch?
+      
+      # switch to master
+      # merge review branch, assuming FF
+      # push master, destroy remote
+      # destroy local
+      user, topic           = user_topic_name( current_branch )
+
+      local_review_branch   = current_branch
+      ff_merge = git [
+          "checkout master",
+          "merge --ff-only #{local_review_branch}",
+      ]
+
+      unless ff_merge
+        git "checkout #{local_review_branch}"
+        raise "
+          review branch is not up to date: merge not a fast-forward.  Either
+          rebase or reject this branch.
+        ".cleanup
+      end
+
+      rem_review_branch   = find_remote_review_branch( topic ).gsub( %r{^origin/}, '' )
+      git [
+        "push origin :#{rem_review_branch}",
+        "branch -d #{local_review_branch}"
+      ]
+    end
+
+    # Reject the branch currently being reviewed.
+    def reject( topic=nil, opts={} )
+      raise "Must be on a review branch." unless on_review_branch?
+
+      # switch to master
+      # push to rejected, destroy remote
+      # destroy local
+      user, topic = user_topic_name( current_branch )
+
+      rem_review_branch   = find_remote_review_branch( topic ).gsub( %r{^origin/}, '' )
+      rem_rej_branch      = remote_rejected_branch( topic, user )
+      git [
+        "checkout master",
+        "push origin #{current_branch}:#{rem_rej_branch} :#{rem_review_branch}",
+        "branch -D #{current_branch}"
+      ]
+    end
+
+    def install_aliases( opts={} )
+      opts.assert_valid_keys  :local, :local_given, *GlobalOptKeys
+
+      flags = "--global" unless opts[:local]
+
+      git [
+        "config #{flags} alias.work-on  'topic work-on'",
+        "config #{flags} alias.done     'topic done'",
+        "config #{flags} alias.review   'topic review'",
+        "config #{flags} alias.accept   'topic accept'",
+        "config #{flags} alias.reject   'topic reject'",
+
+        "config #{flags} alias.w        'topic work-on'",
+        "config #{flags} alias.r        'topic review'",
+        "config #{flags} alias.st       'topic status --prepended'",
+      ]
+    end
+
+
+    private
+
+
+    def backup_branch( topic )
+      "backup/#{user}/#{topic}"
+    end
+
+    def wip_branch( topic )
+      "wip/#{user}/#{topic}"
+    end
+
+    def rejected_branch( topic )
+      "rejected/#{user}/#{topic}"
+    end
+
+    def review_branch( topic, user=user )
+      "review/#{user}/#{topic}"
+    end
+
+    def remote_rejected_branch( topic, user=user )
+      "rejected/#{user}/#{topic}"
+    end
+
+
+    def find_remote_review_branch( topic )
+      others_review_branches.find{|b| b.index topic}
+    end
+
+
+    def user_topic_name( branch )
+      if branch =~ %r{^origin}
+        branch =~ %r{^\S*?/\S*?/(\S*?)/(\S*)}
+        [$1, $2]
+      else
+        branch =~ %r{^\S*?/(\S*?)/(\S*)}
+        [$1, $2]
+      end
+    end
+
+
+    def user
+      @@user ||= (ENV['USER'] || `whoami`)
+    end
+
+    def current_topic
+      current_branch =~ %r{wip/\S*?/(\S*)}
+      $1
+    end
+
+    def current_branch
+      @@current_branch ||= capture_git( "branch --no-color" ).split( "\n" ).find do |b|
+        b =~ %r{^\*}
+      end[ 2..-1 ]
+    end
+
+    def branches
+      @@branches ||= capture_git( "branch --no-color" ).split( "\n" ).map{|b| b[2..-1]}
+    end
+
+    def remote_branches
+      @@remote_branches ||= capture_git( "branch -r --no-color" ).split( "\n" ).map{|b| b[2..-1]}
+    end
+
+    def others_review_branches
+      remote_branches.select do
+        |b| b =~ %r{/review/}
+      end.reject do |b|
+        b =~ %r{/#{user}/}
+      end
+    end
+
+    def remote_branches_organized
+      @@remote_branches_organized ||= (
+        rb = remote_branches.dup
+        # Convert a bunch of remote branch names, like
+        #   origin/HEAD -> origin/masterr
+        #   origin/master
+        #   origin/review/user1/topic1
+        #   origin/something-else
+        #   origin/rejected/user2/topic2
+        #
+        # Into a hash with keys 'review' and 'rejected' pointing to hashes of
+        # user-topic(s) pairs.
+        rb.map!{|s| s.gsub( /->.*/, '')}
+        rb.map!{|s| s.strip.split( '/' )}
+        namespace_ut = rb.group_by{|remote, namespace, user, topic| namespace if topic}
+        namespace_ut.reject!{|k,v| not %w(rejected review).include? k}
+
+        namespace_ut.each do |k,v|
+          v.each{|a| a.shift( 2 )}
+          v = namespace_ut[k] = v.group_by{|user, topic| user if topic}
+          v.each{|kk,vv| vv.each(&:shift); vv.flatten!}
+        end
+
+        namespace_ut.symbolize_keys!
+        namespace_ut[:review] ||= {}
+        namespace_ut[:rejected] ||= {}
+
+        namespace_ut[:review].reject!{|k,v| k == user}
+        namespace_ut
+      )
+    end
+
+    def oldest_review_branch
+      return nil if others_review_branches.empty?
+
+      commits_by_age = capture_git([
+        "log --date-order --reverse --pretty=format:%d",
+        "^origin/master #{others_review_branches.join( ' ' )}",
+      ].join( " " )).split( "\n" )
+
+      commits_by_age.find do |ref|
+        # no ‘,’, i.e. only one ref matches the commit
+        ref.index( ',' ).nil?
+      end.strip[ 1..-2 ] # chomp the leading and trailing parenthesis
+    end
+
+    def oldest_review_user_topic
+      user_topic_name( oldest_review_branch )
+    end
+
+    def on_review_branch?
+      current_branch =~ %r{^review/}
+    end
+
+    def working_tree_clean?
+      git [ "diff --quiet", "diff --quiet --cached" ]
+      $?.success?
+    end
+
+    def working_tree_dirty?
+      not working_tree_clean?
+    end
+
+
+    def display_git_output?
+      @@display_git_output ||= false
+    end
+
+    def display_git_output!
+      @@display_git_output = true
+    end
+
+
+    def switch_to_branch( branch, tracking=nil )
+      if branches.include?( branch )
+        "checkout #{branch}"
+      else
+        "checkout -b #{branch} #{tracking}"
+      end
+    end
+
+    def cmd_redirect_suffix( opts )
+      if !opts[:show] && !display_git_output?
+        "> /dev/null 2> /dev/null"
+      end
+    end
+
+    def git( cmds=[], opts={} )
+      cmds  = [cmds] if cmds.is_a? String
+      redir = cmd_redirect_suffix( opts )
+      system cmds.map{|c| "git #{c} #{redir}"}.join( " && " )
+    end
+
+    def capture_git( cmds=[] )
+      cmds = [cmds] if cmds.is_a? String
+      redir = "2> /dev/null" unless display_git_output?
+      `#{cmds.map{|c| "git #{c} #{redir}"}.join( " && " )}`
+    end
+  end
+end
+

data/lib/util.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'active_support'
+require 'active_support/inflector'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/string/inflections'
+
+
+class String
+    def cleanup
+        indent = (index /^([ \t]+)/; $1) || ''
+        regex = /^#{Regexp::escape( indent )}/
+        strip.gsub regex, ''
+    end
+
+    def oneline
+        strip.gsub( /\n\s+/, '' )
+    end
+
+    # Annoyingly, the useful version of pluralize in texthelpers isn't in the
+    # string core extensions.
+    def pluralize_with_count( count )
+      count > 1 ? pluralize_without_count : singularize
+    end
+    alias_method_chain :pluralize, :count
+end
+
+
+class Object
+    # Deep duplicate via remarshaling.  Not always applicable.
+    def ddup
+        Marshal.load( Marshal.dump( self ))
+    end
+end