git-topic 0.2.5 → 0.2.6

data/lib/git_topic/logger.rb

@@ -0,0 +1,51 @@
+module GitTopic
+  class << self; attr_accessor :global_opts end
+  self.global_opts = {}
+
+  class << self
+    %w( debug info warn error fatal unknown ).each do |m|
+      define_method m do |*args, &block|
+        GitTopic::Logger.send( m, *args, &block )
+      end
+    end
+  end
+end
+
+
+module GitTopic::Logger
+  class << self
+    def add method, undecorated_message, *args, &block
+      return if GitTopic.global_opts[:no_log]
+
+      message = 
+        unless undecorated_message.blank?
+          sprintf '%-5s %s %s',
+                  method.upcase,
+                  DateTime.now.strftime( '[%d %b %Y  %H:%M:%S]' ),
+                  undecorated_message
+        else
+          ''
+        end
+
+      logger.send method, message, *args, &block
+    end
+
+    %w( debug info warn error fatal unknown ).each do |m|
+      define_method m do |*args, &block|
+        GitTopic::Logger.add( m, *args, &block )
+      end
+    end
+
+
+    protected
+
+    def logger
+      @logger ||= (
+        log_dir = "#{ENV['HOME']}/.git_topic"
+        FileUtils.mkdir( log_dir ) unless File.exists? log_dir
+
+        ActiveSupport::BufferedLogger.new "#{ENV['HOME']}/.git_topic/log"
+      )
+    end
+  end
+end

data/lib/git_topic/naming.rb

@@ -21,24 +21,35 @@ module GitTopic::Naming
       "rejected/#{user}/#{strip_namespace topic}"
     end
 
-    def review_branch( topic, user=user )
-      "review/#{user}/#{strip_namespace topic}"
+    def review_branch( topic, user=user, opts={} )
+      rb = "review/#{user}/#{strip_namespace topic}"
+      if opts[:remote]
+        "origin/#{rb}"
+      else
+        rb
+      end
     end
 
     def remote_rejected_branch( topic, user=user )
       "rejected/#{user}/#{strip_namespace topic}"
     end
 
-    def remote_branch( spec=current_branch )
+    def remote_branch( spec=current_branch, opts={} )
       parts = topic_parts( spec )
 
-      remote_branches.find do |remote_branch|
+      rb = remote_branches.find do |remote_branch|
         bp = topic_parts( remote_branch )
 
         parts.all? do |part, value|
           bp[part] == value
         end
       end
+
+      if opts[:strip_remote]
+        rb.gsub %r{^origin/}, ''
+      else
+        rb
+      end
     end
 
 
@@ -82,7 +93,7 @@ module GitTopic::Naming
       when 1
         p[:topic] = parts.first
       else
-        raise "Unexpected topic: #{ref}"
+        return nil
       end
 
       if opts[:lookup] && p[:user].nil?
@@ -123,14 +134,32 @@ module GitTopic::Naming
       @@remote_branches ||= capture_git( "branch -r --no-color" ).split( "\n" ).map{|b| b[2..-1]}
     end
 
-    def others_review_branches
+    def review_branches
       remote_branches.select do
         |b| b =~ %r{/review/}
-      end.reject do |b|
+      end
+    end
+
+    def others_review_branches
+      review_branches.reject do |b|
+        b =~ %r{/#{user}/}
+      end
+    end
+
+    def user_review_branches  user=user
+      review_branches.select do |b|
         b =~ %r{/#{user}/}
       end
     end
 
+    # Returns review branches as a hash of namespace → user → topic* hashes,
+    # e.g.
+    #
+    #   {
+    #     :review   => { 'davidjh' => [ 'topic1', 'topic2' ]},
+    #     :rejected => { 'davidjh' => [ 'topic3' ]}
+    #   }
+    #
     def remote_branches_organized
       @@remote_branches_organized ||= (
         rb = remote_branches.dup
@@ -177,6 +206,20 @@ module GitTopic::Naming
       end.strip[ 1..-2 ] # chomp the leading and trailing parenthesis
     end
 
+    def newest_pending_branch
+      return nil if user_review_branches.empty?
+
+      commits_by_age = capture_git([
+        "log --date-order --pretty=format:%d",
+        "^origin/master #{user_review_branches.join( ' ' )}",
+      ].join( " " )).split( "\n" )
+
+      commits_by_age.find do |ref|
+        # no ‘,’, i.e. only one ref matches the commit
+        !ref.strip.empty? && 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
@@ -187,7 +230,7 @@ module GitTopic::Naming
 
   end
 
-  def self.included( base )
+  def self.included base
     base.extend ClassMethods
   end
 end

data/spec/comment_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 DiffWithNonCommentAddition = %Q{

data/spec/git_topic_abandon_spec.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe GitTopic do
+
+  describe "#abandon" do
+    before( :each ){ use_repo 'in-progress' }
+
+
+    shared_examples_for    :abandon_when_passed_an_argument do
+      it "should error if the arg does not name a topic" do
+        λ do
+          GitTopic.abandon  'non-existant-topic'
+        end.should    raise_error
+      end
+
+      it "should remove the specified wip topic, locally and remotely" do
+        branch  = "wip/#{@user}/zombie-basic"
+
+        previous_local_branches   = git_branches
+        previous_remote_branches  = git_remote_branches
+        previous_local_branches.should                    include branch
+        previous_remote_branches.should                   include branch
+
+        λ{ GitTopic.abandon "wip/#{@user}/zombie-basic" }.should_not  raise_error
+
+        git_branches.should         == ( previous_local_branches - [ branch ])
+        git_remote_branches.should  == ( previous_remote_branches - [ branch ])
+      end
+
+      it "should remove the specified review topic" do
+        branch  = "review/#{@user}/pirates"
+
+        previous_remote_branches  = git_remote_branches
+        previous_remote_branches.should                   include branch
+
+        λ{ GitTopic.abandon 'pirates' }.should_not       raise_error
+
+        git_remote_branches.should  == ( previous_remote_branches - [ branch ])
+      end
+    end
+
+
+    describe "when on a wip topic branch" do
+      before  :each do
+        λ{ GitTopic.work_on  'a-new-topic' }.should_not    raise_error
+      end
+
+      it_should_behave_like :abandon_when_passed_an_argument
+
+      it "should remove the local topic" do
+        branch  = "wip/#{@user}/a-new-topic"
+
+        previous_local_branches   = git_branches
+        previous_remote_branches  = git_remote_branches
+        previous_local_branches.should                    include branch
+        previous_remote_branches.should                   include branch
+
+        λ{ GitTopic.abandon }.should_not  raise_error
+
+        git_branches.should         == ( previous_local_branches - [ branch ])
+        git_remote_branches.should  == ( previous_remote_branches - [ branch ])
+      end
+    end
+
+    describe "when on a review topic branch" do
+      before  :each do
+        λ{ GitTopic.review }.should_not    raise_error
+        git_head.should                     == '0ce06c616769768f09f5e629cfcc68eabe3dee81'
+      end
+
+      it_should_behave_like :abandon_when_passed_an_argument
+
+      it "should error" do
+        λ{ GitTopic.abandon }.should   raise_error
+      end
+    end
+
+    describe "when on a rejected topic branch" do
+      before  :each do
+        λ{ GitTopic.work_on  'krakens' }.should_not  raise_error
+        git_head.should                               == '44ffd9c9c8b52b201659e3ad318cdad6ec836b46'
+      end
+      it_should_behave_like :abandon_when_passed_an_argument
+
+      it "should remove the topic, locally and remotely" do
+        branch  = "wip/#{@user}/krakens"
+
+        previous_local_branches   = git_branches
+        previous_remote_branches  = git_remote_branches
+        previous_local_branches.should                    include branch
+        previous_remote_branches.should                   include branch
+
+        λ{ GitTopic.abandon }.should_not  raise_error
+
+        git_branches.should         == ( previous_local_branches - [ branch ])
+        git_remote_branches.should  == ( previous_remote_branches - [ branch ])
+      end
+    end
+
+    describe "when on some other branch" do
+      before  :each do
+        system "git checkout -q master > /dev/null 2> /dev/null"
+      end
+      it_should_behave_like :abandon_when_passed_an_argument
+
+      it "should error" do
+        λ{ GitTopic.abandon }.should   raise_error
+      end
+    end
+  end
+end

data/spec/git_topic_accept_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 
@@ -36,25 +37,28 @@ describe GitTopic do
 
         it "should fail if the working tree is dirty" do
           dirty_branch!
-          lambda{ GitTopic.accept }.should    raise_error
+          λ{ GitTopic.accept }.should    raise_error
         end
       end
     end
 
+    # Normally the user should not even wind up in this state because +review+
+    # will complain if the branch does not automatically fast-forward.
     describe "while on a review branch that does not FF" do
       before( :each ) do
         use_repo 'in-progress'
+        GitTopic.review 'user24601/zombie-basic'
         system "
           git checkout master > /dev/null 2> /dev/null && 
           git merge origin/wip/prevent-ff > /dev/null 2> /dev/null
         "
         @original_git_Head    = git_head
-        GitTopic.review 'user24601/zombie-basic'
+        system "git checkout --quiet review/user24601/zombie-basic"
       end
 
       it "should refuse to accept the review branch" do
         git_branch.should                 == 'review/user24601/zombie-basic'
-        lambda{ GitTopic.accept }.should  raise_error
+        λ{ GitTopic.accept }.should  raise_error
         git_branch.should                 == 'review/user24601/zombie-basic'
         git_remote_branches.should        include( 'review/user24601/zombie-basic' )
 
@@ -67,7 +71,7 @@ describe GitTopic do
       before( :each ) { use_repo 'in-progress' }
 
       it "should fail" do
-        lambda{ GitTopic.accept }.should    raise_error
+        λ{ GitTopic.accept }.should    raise_error
       end
     end
   end

data/spec/git_topic_comment_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 GeneralCommentOnly = %Q{
@@ -24,9 +25,30 @@ Spec 123:           I have some general comments, mostly relating to the quality
                     This should take care of our issues with zombies.
 }.strip
 
+FirstCommentMultiParagraph = %Q{
+Spec 123:           I have some general comments, mostly relating to the quality
+                    of our zombie-control policies.  Basically, they're not
+                    working.
+
+./zombies
+
+  Line 2
+    Spec 123:       I suggest we do the following instead:
+                        zombies.each{ |z| reason_with( z )}
+                        zomies.select do |z|
+                          z.unconvinced?
+                        end.each do |z|
+                          destroy z
+                        end
+                    This should take care of our issues with zombies.
+
+                    On another subject entirely, I rather like herring.
+}.strip
+
 FirstCommentUpdated = %Q{
 Spec 123:           I agree, though I wonder if maybe we've become a little too
                     obsessed with bacon. Umm, wait, sorry, wrong thread.
+
                                 There is no way this is going to work.  Sorry, but there's just not.
 
 ./ninjas
@@ -114,7 +136,7 @@ describe GitTopic do
           f.puts %Q{
             I have some general comments, mostly relating to the quality of our
             zombie-control policies.  Basically, they're not working.
-          }.cleanup
+          }.unindent
         end
       end
     end
@@ -176,7 +198,7 @@ describe GitTopic do
             #       destroy z
             #     end
             # This should take care of our issues with zombies.
-          }.cleanup
+          }.unindent
         end
         lambda{ GitTopic.comment }.should     raise_error
       end
@@ -214,7 +236,7 @@ describe GitTopic do
             #       destroy z
             #     end
             # This should take care of our issues with zombies.
-          }.cleanup
+          }.unindent
         end
         GitTopic.should_receive( :invoke_git_editor ).once
         GitTopic.should_receive(
@@ -233,6 +255,38 @@ describe GitTopic do
         git_diff.should                                 be_empty
       end
 
+      it "should respect paragraph breaks (double newline) in formatting" do
+        File.open( 'zombies', 'a' ) do |f|
+          f.puts %Q{
+            # I suggest we do the following instead:
+            #     zombies.each{ |z| reason_with( z )}
+            #     zomies.select do |z|
+            #       z.unconvinced?
+            #     end.each do |z|
+            #       destroy z
+            #     end
+            # This should take care of our issues with zombies.
+            #
+            # On another subject entirely, I rather like herring.
+          }.unindent
+        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/zombie-basic"
+        ).should_not                                    be_empty
+
+        git_notes_show(
+          "refs/notes/reviews/user24601/zombie-basic"
+        ).should                                        == FirstCommentMultiParagraph
+
+        git_diff.should                                 be_empty
+      end
+
     end
 
 
@@ -261,7 +315,7 @@ describe GitTopic do
             #       destroy z
             #     end
             # This should take care of our issues with zombies.
-          }.cleanup
+          }.unindent
         end
 
         lambda{ GitTopic.comment }.should             raise_error
@@ -273,7 +327,7 @@ describe GitTopic do
             # I suggest we do the following instead:
             #   everyone.giveup
             # This should take care of our issues with zombies.
-          }.cleanup
+          }.unindent
         end
 
         GitTopic.should_receive( :invoke_git_editor ).once
@@ -281,7 +335,6 @@ describe GitTopic do
           :git_author_name_short
         ).once.and_return( "Spec 123" )
 
-
         lambda do
           GitTopic.comment  :force_update => true
         end.should_not                                  raise_error
@@ -401,7 +454,7 @@ describe GitTopic do
             #       destroy z
             #     end
             # This should take care of our issues with zombies.
-          }.cleanup
+          }.unindent
         end
 
         lambda{ GitTopic.comment }.should               raise_error