git-topic 0.2.4.1 → 0.2.5

data/History.rdoc

@@ -1,3 +1,13 @@
+===   0.2.5
+
+* issues closed
+  - 9   git comments <spec> now asks for the right range.
+  - 11  git comments now falls back to name-rev, so works even for remote
+        branches.
+  - 16  shorthand aliases not installed by git-topic setup.
+  - 17  git comment reports to the user if they entered a blank comment.
+  - 20  refspecs now use +, i.e. they autoforce.
+
 ====  0.2.4.1
 
 * issue 14 closed. Added --completion-help like output to

data/VERSION.yml

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

data/lib/git_topic.rb

@@ -233,25 +233,10 @@ module GitTopic
 
       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
+      added_comments = 
+        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
@@ -259,25 +244,63 @@ module GitTopic
             ".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
-          notes_from_initial_comments
+          raise "Inappropriate namespace for comments: [#{namespace}]"
         end
+
+      if added_comments
+        report "Your comments have been saved."
       else
-        raise "Inappropriate namespace for comments: [#{namespace}]"
+        report "You did not write any comments.  Nothing to save."
       end
-
-      report "Your comments have been saved."
     end
 
     def comments( spec=nil, opts={} )
       args = [ spec ].compact
+      if args.empty? && current_branch.nil?
+        if guess = guess_branch
+          args << guess_branch
+
+          puts "
+            You are not on a branch and no topic branch was specified.  Using
+            alternate name for HEAD, #{guess}.
+          ".oneline
+        else
+          puts "
+            You are not on a branch and no topic branch was specified.  I could
+            not find an appropriate name for HEAD to guess.
+          "
+          return
+        end
+      end
+
       unless existing_comments? *args
         puts "There are no comments on this branch."
         return
       end
 
-      git "log origin/master.. --show-notes=#{notes_ref *args} --no-standard-notes",
+      range = "origin/master..#{remote_branch *args}"
+      git "log #{range} --show-notes=#{notes_ref *args} --no-standard-notes",
           :show => true
     end
 
@@ -333,7 +356,7 @@ module GitTopic
       cmds = []
 
       cmds <<(
-        "config --add remote.origin.fetch refs/notes/reviews/*:refs/notes/reviews/*"
+        "config --add remote.origin.fetch +refs/notes/reviews/*:refs/notes/reviews/*"
       ) unless has_setup_refspec?
 
       cmds <<(
@@ -356,10 +379,6 @@ module GitTopic
         "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.",
@@ -416,7 +435,7 @@ module GitTopic
     def has_setup_refspec?
       fetch_refspecs = capture_git( "config --get-all remote.origin.fetch" ).split( "\n" )
       fetch_refspecs.any? do |refspec|
-        refspec == "refs/notes/reviews/*:refs/notes/reviews/*"
+        refspec == "+refs/notes/reviews/*:refs/notes/reviews/*"
       end
     end
 

data/lib/git_topic/comment.rb

@@ -247,10 +247,17 @@ module GitTopic::Comment
                             notes,
                             content,
                             :author => git_author_name_short )
-      
+
       File.open( edit_file, 'w' ){ |f| f.write( notes_with_reply )}
-      git "notes --ref #{notes_ref} edit -F #{edit_file}",
-          :must_succeed => true
+
+
+      if notes_with_reply != notes
+        git "notes --ref #{notes_ref} edit -F #{edit_file}",
+            :must_succeed => true
+      else
+        # No comments to add.
+        return false
+      end
     end
 
     def attrib( author, indent=0, max_w=16 )

data/lib/git_topic/git.rb

@@ -56,6 +56,19 @@ module GitTopic::Git
       capture_git( "notes --ref #{ref} show" ).chomp
     end
 
+    def current_branch
+      @@current_branch ||= capture_git( "branch --no-color" ).split( "\n" ).find do |b|
+        b =~ %r{^\*}
+      end[ 2..-1 ]
+      @@current_branch = nil if @@current_branch == '(no branch)'
+
+      @@current_branch
+    end
+
+    def guess_branch
+      capture_git( "name-rev --name-only HEAD" )
+    end
+
 
     def display_git_output?
       @@display_git_output ||= false

data/lib/git_topic/naming.rb

@@ -29,6 +29,18 @@ module GitTopic::Naming
       "rejected/#{user}/#{strip_namespace topic}"
     end
 
+    def remote_branch( spec=current_branch )
+      parts = topic_parts( spec )
+
+      remote_branches.find do |remote_branch|
+        bp = topic_parts( remote_branch )
+
+        parts.all? do |part, value|
+          bp[part] == value
+        end
+      end
+    end
+
 
     def find_remote_review_branch( topic )
       others_review_branches.find{|b| b.index topic}
@@ -57,7 +69,10 @@ module GitTopic::Naming
     def topic_parts( ref, opts={} )
       p = {}
       parts = ref.split( '/' )
+
+      parts.shift if parts.first == 'remotes'
       parts.shift if parts.first == "origin"
+
       case parts.size
       when 3
         p[:namespace], p[:user], p[:topic] = parts
@@ -100,12 +115,6 @@ module GitTopic::Naming
       $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

data/spec/comment_spec.rb

@@ -333,9 +333,11 @@ describe GitTopic::Comment do
       lambda{ notes_from_reply_to_comments }.should     raise_error
     end
 
-    it "should add the users' comments as replies to the originals" do
+    it "
+      should add the users' comments as replies to the originals and return true
+    ".oneline do
       self.should_receive( :existing_comments? ).     and_return( true )
-      self.should_receive( :existing_comments ).       and_return( ExistingComment )
+      self.should_receive( :existing_comments ).      and_return( ExistingComment )
       self.should_receive( :git_dir ).                and_return( "." )
       self.should_receive( :git_author_name_short ).  and_return( "Spec 456" )
       self.should_receive( :notes_ref ).
@@ -348,9 +350,27 @@ describe GitTopic::Comment do
         File.read( "./COMMENT_EDITMSG" ).should           == CommentWithReply
       end
 
-      lambda{ notes_from_reply_to_comments }.should_not   raise_error
+      lambda do
+        notes_from_reply_to_comments.should               == true
+      end.should_not                                      raise_error
     end
 
+    it "should return false if the user added no comments" do
+      self.should_receive( :existing_comments? ).     and_return( true )
+      self.should_receive( :existing_comments ).      and_return( ExistingComment )
+      self.should_receive( :git_dir ).                and_return( "." )
+      self.should_receive( :git_author_name_short ).  and_return( "Spec 456" )
+      self.should_not_receive( :notes_ref )
+      self.stub!( :invoke_git_editor ) do |path|
+        File.open( path, 'w' ) do |f|
+          f.write ExistingComment.lines.map{ |l| "# #{l}" }.join
+        end
+      end
+      self.should_receive( :invoke_git_editor )
+      self.should_not_receive( :git )
+
+      notes_from_reply_to_comments.should             == false
+    end
   end
 
 

data/spec/git_topic_comment_spec.rb

@@ -319,6 +319,46 @@ describe GitTopic do
           "refs/notes/reviews/user24601/ninja-basic"
         ).should                                        == SecondComment
       end
+
+      it "should report success to the user" do
+        GitTopic.should_receive( :invoke_git_editor ).once
+        GitTopic.should_receive(
+          :git_author_name_short
+        ).once.and_return( "Spec 123" )
+
+        lambda{ GitTopic.comment }.should_not           raise_error
+        @output.should                                  =~ /comments have been saved/i
+      end
+
+      it "should fail (and report the failure) if the user entered no comments" do
+        git_notes_list(
+          "refs/notes/reviews/user24601/ninja-basic"
+        ).should_not                                    be_empty
+        git_notes_show(
+          "refs/notes/reviews/user24601/ninja-basic"
+        ).should                                        == FirstComment
+
+        GitTopic.stub!( :invoke_git_editor ) do |path|
+          File.open( path, 'w' ) do |f|
+            f.write FirstComment.lines.map{ |l| "# #{l}" }.join
+          end
+        end
+        GitTopic.should_receive( :invoke_git_editor ).once
+        GitTopic.should_receive(
+          :git_author_name_short
+        ).once.and_return( "Spec 123" )
+
+        lambda{ GitTopic.comment }.should_not           raise_error
+        git_notes_list(
+          "refs/notes/reviews/user24601/ninja-basic"
+        ).should_not                                    be_empty
+
+        git_notes_show(
+          "refs/notes/reviews/user24601/ninja-basic"
+        ).should                                        == FirstComment
+
+        @output.should                                  =~ /nothing to save/i
+      end
     end
 
 

data/spec/git_topic_comments_spec.rb

@@ -93,6 +93,31 @@ describe GitTopic do
 
 
         it "should invoke git log to display the comments" do
+          GitTopic.should_receive( :git ) do |cmd|
+            cmd.should =~ /log/
+            cmd.should =~ %r{origin/master\.\.origin/wip/#{@user}/krakens}
+            cmd.should =~ /--no-standard-notes/
+            cmd.should =~ %r{--show-notes=refs/notes/reviews/#{@user}/krakens}
+          end
+
+          lambda{ GitTopic.comments }.should_not      raise_error
+        end
+      end
+
+      describe "on a commit named by a topic branch with comments" do
+
+        before( :each ) do
+          use_repo        'in-progress'
+          system          "git checkout origin/rejected/#{@user}/krakens > /dev/null 2> /dev/null"
+        end
+
+        it "should report the topic it's guessing to look for comments on" do
+          lambda{ GitTopic.comments }.should_not      raise_error
+          @output.should                              =~ /no topic branch/i
+          @output.should                              =~ /krakens/i
+        end
+
+        it "should guess a topic and show its comments" do
           GitTopic.should_receive( :git ) do |cmd|
             cmd.should =~ /log/
             cmd.should =~ %r{origin/master\.\.}
@@ -102,6 +127,7 @@ describe GitTopic do
 
           lambda{ GitTopic.comments }.should_not      raise_error
         end
+
       end
     end
 

data/spec/git_topic_install_aliases_spec.rb

@@ -4,6 +4,8 @@ require 'spec_helper'
 describe GitTopic do
   
   describe "#install_aliases" do
+    before( :each ){  use_repo 'in-progress' }
+
     it "should install aliases" do
       GitTopic.install_aliases  :local => true
       git_config( 'alias.work-on' ).should    == 'topic work-on'
@@ -13,10 +15,6 @@ describe GitTopic do
       git_config( 'alias.reject' ).should     == 'topic reject'
       git_config( 'alias.comment' ).should    == 'topic comment'
       git_config( 'alias.comments' ).should   == 'topic comments'
-
-      git_config( 'alias.w' ).should          == 'topic work-on'
-      git_config( 'alias.r' ).should          == 'topic review'
-      git_config( 'alias.st' ).should         == 'topic status --prepended'
     end
 
     it "should provide feedback to the user" do

data/spec/git_topic_setup_spec.rb

@@ -11,7 +11,7 @@ describe GitTopic do
 
       %x{ 
         git config --get-all remote.origin.fetch
-      }.should_not                            =~ %r{refs/notes}
+      }.should_not                            =~ %r{\+refs/notes}
 
       GitTopic.setup
 

data/spec/spec_helper.rb

@@ -16,7 +16,8 @@ class << GitTopic
 
     define_method( "#{m}_with_nocache" ) do
       rv = send( "#{m}_without_nocache" )
-      GitTopic::Naming::ClassMethods.class_variable_set( "@@#{m}", nil )
+      GitTopic::Naming::ClassMethods.class_variable_set(  "@@#{m}", nil )
+      GitTopic::Git::ClassMethods.class_variable_set(     "@@#{m}", nil )
       rv
     end
     alias_method_chain m.to_sym, :nocache

metadata

@@ -5,9 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 4
-  - 1
-  version: 0.2.4.1
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - David J. Hamilton
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-14 00:00:00 -07:00
+date: 2010-08-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency