git-topic 0.1.6.4 → 0.2.1

data/.vimspell.utf8.add

@@ -0,0 +1,9 @@
+git-topic
+workflow
+wip
+namespace
+Rebase
+TODOs
+autocomplete
+autocompletion
+dir

data/README.rdoc

@@ -1,11 +1,21 @@
-= git-topic
+=       git-topic
 
 git-topic is a git command to help with a particular kind of workflow, in which
 all work is written by an author, and reviewed by someone else.
 
-== Workflow in brief
 
-=== Doing Work
+=       Requirements
+
+* git-topic has only been tested on debian flavours of linux.  Other unix-like
+  environments should work.
+* git >= 1.7.1        (older versions may work, except for comment and comments
+                      commands)
+* ruby >= 1.9.2-rc1   (older versions may work)
+
+
+=       Workflow
+==      Workflow in brief
+===     Doing Work
 
 1.      Create a topic branch in the wip namespace.
 2.      Do some work.
@@ -17,7 +27,7 @@ all work is written by an author, and reviewed by someone else.
 2.      Do some work, resolve the reviewer's issues.
 3.      go to step 3, above.
 
-=== Reviewing
+===     Reviewing
 
 1.          Create a local branch from a review branch somebody else pushed.
 2.          Review their work.
@@ -27,9 +37,8 @@ all work is written by an author, and reviewed by someone else.
             the review namespace.
 
 
-== Workflow without git-topic
-
-=== Working on a topic (e.g. feature, or bugfix) foo
+==      Workflow without git-topic
+===     Working on a topic (e.g. feature, or bugfix) foo
 
     # Create a new branch and switch to it.
     git checkout -b wip/hal/foo
@@ -60,7 +69,7 @@ all work is written by an author, and reviewed by someone else.
 
 
 
-=== Reviewing a  topic (no proposed changes)
+===     Reviewing a  topic (no proposed changes)
 
     # update origin
     git fetch origin
@@ -86,19 +95,19 @@ all work is written by an author, and reviewed by someone else.
 
 
 
-=== Reviewing a topc (proposed changes)
+===     Reviewing a topic (proposed changes)
 
 As above, but if, after examining the code you feel some changes are
 appropriate, you can either:
 
-==== do them yourself and have the other person review and merge
+====    do them yourself and have the other person review and merge
 
     # do some changes, then destroy the old review branch and make a new one
     # with the cleaned up code.  Now the owner is changed from djh to hal, so
     # djh must review and merge into master
     git push origin review/djh/bar:review/hal/bar :review/djh/bar
 
-==== do some (or no) changes, but with some TODOs for the original author.
+====    do some (or no) changes, but with some TODOs for the original author.
 
     # do your changes on review/djh/bar
 
@@ -110,9 +119,8 @@ appropriate, you can either:
     # review/djh/bar
 
 
-== Workflow with git-topic
-
-=== Doing Work
+==      Workflow with git-topic
+===     Doing Work
 
     # Work on a (possibly new, possibly rejected) topic
     git topic work-on <topic>
@@ -121,7 +129,7 @@ appropriate, you can either:
     git topic done [<topic>]
 
 
-=== Reviewing
+===     Reviewing
 
     # see if we have any topics to review (or rejected topics to fix up)
     git topic status
@@ -131,10 +139,18 @@ appropriate, you can either:
     # happy with the review, get it into master
     git topic accept
 
-    # unhappy with the review, push it to rejected
+    # unhappy with the review
+    # edit files to add file-specific comments (see git-topic comment --help for
+    # details).
+   
+    # save your file specific comments, and launch an editor to enter general
+    # comments about the topic.
+    git topic comment
+
+    # push the topic to rejected.
     git topic reject
 
-== Again, but with aliases
+==      Again, but with aliases
 
     # first install aliases
     #   add --local if you don't want to update your global aliases
@@ -144,6 +160,10 @@ appropriate, you can either:
     #   git w <topic>
     git work-on <topic>
 
+    # see reviewer's comments
+    git comments
+
+    # finished, submit work
     git done
 
 
@@ -157,22 +177,32 @@ appropriate, you can either:
 
     git accept
     # or
+    git comment
     git reject
 
-==  Misc
+==      Bash autocompletion
+
+See git-topic --completion-help for details.  In short, you have to do some
+manual work, because loading completions as a gem is too slow (see Misc, below,
+and ruby issue 3465[1]).
+
+1.  Make sure you source share/completion.bash __before__ sourcing git's standard
+    completion.
+
+2.  Copy bin/git-topic-completion to your gem env's default bin dir, overriding
+    the generated git-topic-completion.  Otherwise, autocompletion will be too
+    slow to be useful.
+
+==      Misc
 
 At present the binary is stupidly slow.  Actually, the binary is not slow, but
 all rubygems binaries are slow.  See ruby issue 3465[1].  One way around this is
-to modify yor PATH so you invoke the binary directly (instead of the rubygem
+to modify your PATH so you invoke the binary directly (instead of the rubygem
 wrapper).  Alternatively, put up with a 300ms load time until you have a ruby
 with the issue fixed.
 
-==  Obvious Features Missing
-
-1.  shell autocomplete
-
 
-== Note on Patches/Pull Requests
+==      Note on Patches/Pull Requests
 
 1.  Fork the project.
 2.  Make your feature addition or bug fix.
@@ -183,10 +213,10 @@ with the issue fixed.
     can ignore when I pull)
 5.  Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+==      Copyright
 
-Copyright (c) 2010 David J. Hamilton. See LICENSE for details.
+Copyright © 2010 David J. Hamilton. See LICENSE for details.
 
-== References
+==      References
 
 1. http://redmine.ruby-lang.org/issues/show/3465

data/Rakefile

@@ -33,11 +33,21 @@ begin
       git work-on <topic>
 
       see README.rdoc for more (any) details.
+
+
+      To make use of bash autocompletion, you must do the following:
+
+        1.  Make sure you source share/completion.bash before you source git's completion.
+        2.  Optionally, copy git-topic-completion to your gem's bin directory.
+            This is to sidestep ruby issue 3465 which makes loading gems far too
+            slow for autocompletion.
     }
     gem.email = "git-topic@hjdivad.com"
     gem.homepage = "http://github.com/hjdivad/git-topic"
     gem.authors = ["David J. Hamilton"]
 
+    gem.files.exclude 'git-topic'
+
     if File.exists? 'Gemfile'
       require 'bundler'
       bundler = Bundler.load

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
-:minor: 1
-:patch: 6
-:build: "4"
+:minor: 2
+:patch: 1
+:build: 

data/bin/git-topic-completion

@@ -0,0 +1,58 @@
+#!/usr/bin/ruby -w
+
+
+module GitTopic; end
+
+module GitTopic::Completion
+  class << self
+
+    def user
+      ENV['USER']
+    end
+
+    def branches
+      `git branch -a --no-color`.split( "\n" ).map do |l|
+        l.gsub( /->.*$/, '' )[ 2..-1 ]
+      end
+    end
+
+    def others_review_branches
+      branches.map do |b|
+        b =~ %r{^remotes/origin/review/(.*)} && $1
+      end.reject do |b|
+        b =~ %r{^#{user}/}
+      end.compact
+    end
+
+    def my_reject_review_and_local_wip_branches
+      branches.map do |b|
+        b =~ %r{^(wip)/#{user}/(.*)}                      ||
+        b =~ %r{^remotes/origin/(rejected)/#{user}/(.*)}  ||
+        b =~ %r{^remotes/origin/(review)/#{user}/(.*)}
+        suggestion = [$1,$2].compact.join("/")
+        suggestion unless suggestion.strip.empty?
+      end.compact
+    end
+
+    def complete
+      suggestions = 
+        case ARGV.shift
+        # TODO 2: if we let accept/reject take args, simply return
+        # others_review_branches here
+        when "accept"
+        when "reject"
+        when "done"
+          # nothing
+        when "work-on"
+          my_reject_review_and_local_wip_branches
+        when "review"
+          others_review_branches
+        end || []
+
+      suggestions.each{ |s| puts s }
+    end
+
+  end
+end
+
+GitTopic::Completion.complete

data/lib/core_ext.rb

@@ -7,22 +7,84 @@ require 'active_support/core_ext/string/inflections'
 
 
 class String
-    def cleanup
-        indent = (index /^([ \t]+)/; $1) || ''
-        regex = /^#{Regexp::escape( indent )}/
-        strip.gsub regex, ''
-    end
+  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
 
-    def oneline
-        strip.gsub( /\n\s+/, '' )
+  def wrap( width, heading_indentation=nil, heading=nil )
+    # TODO 2: if indentation is nil, compute indentation
+    heading_indentation   ||= 0
+    heading               ||= ""
+    
+    indentation = heading.size + heading_indentation
+    indent      = ' ' * indentation
+    sbuf        = "#{indent}"
+    line_w      = indentation
+
+    original_indentation = nil
+
+    new_line = lambda do
+      sbuf << "\n#{indent}"
+      line_w  = indentation
     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
+    start_of_line = lambda { line_w == indentation }
+
+    split( "\n" ).each do |line|
+      if original_indentation.nil?
+        line =~ /^(\s*)/
+        original_indentation = $1.size
+      end
+
+      if line =~ /^\s{#{original_indentation}}\s/
+        sbuf << "\n#{indent}" unless start_of_line.call
+        sbuf << line.slice( original_indentation, line.size )
+        new_line.call
+        next
+      end
+
+      leading_space = 
+        start_of_line.call  ? '' : ' '
+      line.gsub!( %r/^\s{,#{original_indentation}}/, leading_space )
+      line.split( /(\s+)/ ).each do |word|
+        next if start_of_line.call && word.strip.empty?
+
+        if line_w + word.size <= width
+          sbuf << word
+          line_w += word.size
+        elsif start_of_line.call
+          sbuf << word[0...(size - indentation)]
+          new_line.call
+          word.slice! (size - indentation), word.size
+        else
+          new_line.call
+          redo
+        end
+      end
     end
-    alias_method_chain :pluralize, :count
+   
+    sbuf[ 0...heading.size ] = heading
+
+    sbuf
+  end
+
+  def wrap!( width, heading_indentation=nil, heading=nil )
+    self.replace wrap( width, heading_indentation, heading )
+  end
+
 end
 
 

data/lib/git_topic.rb

@@ -7,13 +7,18 @@ require 'active_support/core_ext/hash/keys'
 require 'core_ext'
 require 'git_topic/git'
 require 'git_topic/naming'
+require 'git_topic/comment'
 
 
 module GitTopic
   include GitTopic::Git
   include GitTopic::Naming
+  include GitTopic::Comment
 
-  GlobalOptKeys = [ :verbose, :help, :verbose_given, :version ]
+  GlobalOptKeys = [
+    :verbose, :help, :verbose_given, :version, :completion_help,
+    :completion_help_given
+  ]
 
 
   class << self
@@ -25,7 +30,7 @@ module GitTopic
       # setup a remote branch, if necessary
       wb = wip_branch( topic )
       git(
-        "push origin HEAD:#{wb}"
+        "push origin HEAD:refs/heads/#{wb}"
       ) unless remote_branches.include? "origin/#{wb}"
       # switch to the new branch
       git [ switch_to_branch( wb, "origin/#{wb}" )]
@@ -35,11 +40,22 @@ module GitTopic
       if remote_branches.include? "origin/#{rej_branch}"
         git [
           "reset --hard origin/#{rej_branch}",
-          "push origin :#{rej_branch} HEAD:#{wb}",
+          "push origin :refs/heads/#{rej_branch} HEAD:refs/heads/#{wb}",
         ]
       end
+
+      # Reset upstream, if specified
+      if opts[:upstream]
+        git "reset --hard #{opts[:upstream]}"
+      end
+
+      report "Switching branches to work on #{topic}."
+      if existing_comments?
+        report "You have reviewer comments on this topic."
+      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={} )
@@ -61,12 +77,15 @@ module GitTopic
       wb = wip_branch( topic )
       rb = review_branch( topic )
       git [
-        "push origin #{wb}:#{rb} :#{wb}",
+        "push origin refs/heads/#{wb}:refs/heads/#{rb} :refs/heads/#{wb}",
         ("checkout master" if strip_namespace( topic ) == current_topic),
         "branch -D #{wip_branch( topic )}"
       ].compact
+
+      report "Completed topic #{topic}.  It has been pushed for review."
     end
 
+
     # Produce status like
     #
     #   # There are 2 topics you can review.
@@ -118,12 +137,13 @@ module GitTopic
       end
     end
 
+
     # Switch to a review branch to check somebody else's code.
-    def review( spec=nil, opts={} )
+    def review( ref=nil, opts={} )
       rb = remote_branches_organized
       review_branches = rb[:review]
 
-      if spec.nil?
+      if ref.nil?
         # select the oldest (by HEAD) topic, if any exist
         if review_branches.empty?
           puts "nothing to review."
@@ -132,12 +152,12 @@ module GitTopic
           user, topic = oldest_review_user_topic
         end
       else
-        p             = topic_parts( spec )
+        p             = topic_parts( ref )
         user, topic   = p[:user], p[:topic]
       end
 
       if remote_topic_branch = find_remote_review_branch( topic )
-        # Get the actual user/topic, e.g. to get the user if spec only specifies
+        # Get the actual user/topic, e.g. to get the user if ref only specifies
         # the topic.
         real_user, real_topic = user_topic_name( remote_topic_branch )
         git [
@@ -145,13 +165,17 @@ module GitTopic
             review_branch( real_topic, real_user ),
             remote_topic_branch )]
       else
-        raise "No review topic found matching ‘#{spec}’"
+        raise "No review topic found matching ‘#{ref}’"
       end
+
+      report  "Reviewing topic #{user}/#{topic}."
     end
 
+
     # Accept the branch currently being reviewed.
     def accept( topic=nil, opts={} )
       raise "Must be on a review branch." unless on_review_branch?
+      raise "Working tree must be clean" unless working_tree_clean?
       
       # switch to master
       # merge review branch, assuming FF
@@ -175,14 +199,95 @@ module GitTopic
 
       rem_review_branch   = find_remote_review_branch( topic ).gsub( %r{^origin/}, '' )
       git [
-        "push origin master :#{rem_review_branch}",
+        "push origin master :refs/heads/#{rem_review_branch}",
         "branch -d #{local_review_branch}"
       ]
+
+      report  "Accepted topic #{user}/#{topic}."
+    end
+
+
+    def comment( opts={} )
+      diff_legal = 
+        git( "diff --diff-filter=ACDRTUXB --quiet" )          && 
+        git( "diff --cached --diff-filter=ACDRTUXB --quiet" ) && 
+        $?.success?
+    
+      raise "
+        Diffs are not comments.  Files have been added, deleted or had their
+        modes changed.  See
+          git diff --diff-filter=ACDRTUXB
+        for a list of changes preventing git-topic comment from saving your
+        comments.
+      ".cleanup unless diff_legal
+
+
+      diff_empty          = git( "diff --diff-filter=M --quiet" ) && $?.success?
+
+      case current_namespace
+      when "wip"
+        if existing_comments?
+          raise "
+            diff → comments not allowed when replying.  Please make sure your
+            working tree is completely clean and then invoke git-topic comment
+            again.
+          ".oneline unless diff_empty
+
+          notes_from_reply_to_comments
+        else
+          puts "No comments to reply to.  See git-topic comment --help for usage."
+          return
+        end
+      when "review"
+        if existing_comments?
+          if opts[ :force_update ]
+            notes_from_initial_comments( "edit" )
+          else
+            raise "
+              diff → comments not allowed when replying.  Please make sure your
+              working tree is completely clean and then invoke git-topic comment
+              again.
+            ".oneline unless diff_empty
+
+            notes_from_reply_to_comments
+          end
+        else
+          notes_from_initial_comments
+        end
+      else
+        raise "Inappropriate namespace for comments: [#{namespace}]"
+      end
+
+      report "Your comments have been saved."
+    end
+
+    def comments( opts={} )
+      unless existing_comments?
+        puts "There are no comments on this branch."
+        return
+      end
+
+      git "log origin/master.. --show-notes=#{notes_ref} --no-standard-notes"
     end
 
+
     # Reject the branch currently being reviewed.
-    def reject( topic=nil, opts={} )
+    def reject( topic_or_opts=nil, opts={} )
+      if topic_or_opts.is_a? Hash
+        topic = nil
+        opts = topic_or_opts
+      else
+        topic = topic_or_opts
+      end
+
       raise "Must be on a review branch." unless on_review_branch?
+      unless working_tree_clean?
+        if opts[:save_comments]
+          comment
+        else
+          raise "Working tree must be clean without --save-comments."
+        end
+      end
 
       # switch to master
       # push to rejected, destroy remote
@@ -191,13 +296,21 @@ module GitTopic
 
       rem_review_branch   = find_remote_review_branch( topic ).gsub( %r{^origin/}, '' )
       rem_rej_branch      = remote_rejected_branch( topic, user )
+
+      refspecs = [
+        "refs/heads/#{current_branch}:refs/heads/#{rem_rej_branch}",
+        ":refs/heads/#{rem_review_branch}",
+      ].join( " " )
       git [
         "checkout master",
-        "push origin #{current_branch}:#{rem_rej_branch} :#{rem_review_branch}",
+        "push origin #{refspecs}",
         "branch -D #{current_branch}"
       ]
+
+      report  "Rejected topic #{user}/#{topic}"
     end
 
+
     def install_aliases( opts={} )
       opts.assert_valid_keys  :local, :local_given, *GlobalOptKeys
 
@@ -209,11 +322,31 @@ module GitTopic
         "config #{flags} alias.review   'topic review'",
         "config #{flags} alias.accept   'topic accept'",
         "config #{flags} alias.reject   'topic reject'",
+        "config #{flags} alias.comment  'topic comment'",
+        "config #{flags} alias.comments 'topic comments'",
 
         "config #{flags} alias.w        'topic work-on'",
         "config #{flags} alias.r        'topic review'",
         "config #{flags} alias.st       'topic status --prepended'",
       ]
+
+      report  "Aliases installed Successfully.",
+              "
+                Error installing aliases.  re-run with --verbose flag for
+                details.
+              ".oneline
+    end
+
+
+    protected
+
+    def report( success_msg, error_msg=nil )
+      if $?.success?
+        puts success_msg
+      else
+        error_msg ||= "Error running command.  re-run with --verbose for details"
+        raise error_msg
+      end
     end
 
   end