git-topic 0.1.6.3 → 0.1.6.4

data/lib/git_topic.rb

@@ -43,22 +43,28 @@ module GitTopic
     # 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?
+      if topic.nil?
+        raise "
+          Current branch is not a topic branch.  Switch to a topic branch or
+          supply an argument.
+        ".oneline if current_topic.nil?
+
+        topic = current_topic
+      else
+        raise "
+          Specified topic #{topic} does not refer to a topic branch.
+        " unless branches.include? wip_branch( topic )
+      end
+      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",
+        ("checkout master" if strip_namespace( topic ) == current_topic),
         "branch -D #{wip_branch( topic )}"
-      ]
+      ].compact
     end
 
     # Produce status like

data/lib/tasks/annotations.rake

@@ -0,0 +1,20 @@
+require 'rails/source_annotation_extractor'
+
+desc "Enumerate all annotations (use notes:optimize, :fixme, :todo for focus)"
+task :notes do
+  SourceAnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", :tag => true
+end
+
+namespace :notes do
+  ["OPTIMIZE", "FIXME", "TODO"].each do |annotation|
+    # desc "Enumerate all #{annotation} annotations"
+    task annotation.downcase.intern do
+      SourceAnnotationExtractor.enumerate annotation
+    end
+  end
+
+  desc "Enumerate a custom annotation, specify with ANNOTATION=CUSTOM"
+  task :custom do
+    SourceAnnotationExtractor.enumerate ENV['ANNOTATION']
+  end
+end

data/spec/git_topic_spec.rb

@@ -15,9 +15,15 @@ describe GitTopic do
     FileUtils.rm_rf   './tmp'
     FileUtils.mkdir   './tmp'
 
-    %w(fresh in-progress origin).each do |repo|
-      FileUtils.cp_r "spec/template/#{repo}",   './tmp'
+    # Copy our repos into tmp
+    %w(fresh in-progress).each do |d|
+      FileUtils.mkdir "./tmp/#{d}"
+      FileUtils.cp_r "spec/template/#{d}",          "./tmp/#{d}/.git"
+    end
+    FileUtils.cp_r "spec/template/origin",          './tmp'
+    FileUtils.cp_r "spec/template/origin-fresh",    './tmp'
 
+    %w(origin origin-fresh fresh in-progress).each do |repo|
       # set template branches to their proper name (i.e. matching @user)
       Dir.chdir "./tmp/#{repo}"
       git_branches.each do |orig_name|
@@ -25,6 +31,7 @@ describe GitTopic do
         system(
           "git branch -m #{orig_name} #{new_name}"
         ) unless orig_name == new_name
+        system "git fetch --prune > /dev/null 2> /dev/null"
       end
       Dir.chdir @starting_dir
     end
@@ -91,14 +98,28 @@ describe GitTopic do
   end
 
   # }}}
- 
 
   describe "#work_on" do
 
+      share_examples_for "#work_on general cases" do
+
+        it "
+          should trim namespaces from args and output a warning
+        ".oneline do
+
+          git_branch.should_not                   == "wip/davidjh/topic"
+          GitTopic.work_on "wip/#{@user}/topic"
+          git_branch.should                       == "wip/davidjh/topic"
+        end
+
+      end
+
     describe "in fresh" do
       before( :each ) { use_repo( 'fresh' )}
       after( :each )  { Dir.chdir( '..' )}
 
+      it_should_behave_like "#work_on general cases"
+
       it "
        should create (and switch to) a new branch with a name that matches the
        given topic, in the wip namespace.  A remote tracking branch should also
@@ -122,6 +143,7 @@ describe GitTopic do
       before( :each ) { use_repo( 'in-progress' )}
       after( :each )  { Dir.chdir( '..' )}
 
+      it_should_behave_like "#work_on general cases"
 
       it "should switch to (rather than create) an existing topic branch" do
         git_branches.should include( "wip/#{@user}/zombie-basic" )
@@ -142,9 +164,25 @@ describe GitTopic do
         git_remote_branches.should        include( "wip/#{@user}/krakens" )
         git_head.should                   == '44ffd9c9c8b52b201659e3ad318cdad6ec836b46'
       end
+
+      it "
+        should use (and then destroy) the review branch for the topic, if one
+        exists
+      ".oneline do
+
+        git_remote_branches.should        include( "rejected/#{@user}/krakens" )
+        GitTopic.work_on    'krakens'
+        git_branch.should                 == "wip/#{@user}/krakens"
+        git_remote_branches.should_not    include( "rejected/#{@user}/krakens" )
+        git_remote_branches.should        include( "wip/#{@user}/krakens" )
+        git_head.should                   == '44ffd9c9c8b52b201659e3ad318cdad6ec836b46'
+      end
+
     end
-  end
+ 
+    pending "with no origin"
 
+  end
 
   describe "#done" do
 
@@ -185,6 +223,53 @@ describe GitTopic do
         end
       end
 
+      describe "with an argument" do
+
+        it "should fail for non-wip branch arguments" do
+          git_branches.should_not         include( "wip/#{@user}/invalid-branch" )
+          lambda{ GitTopic.done( 'invalid-branch' )}.should raise_error
+        end
+
+        it "should succeed for superfluous wip-branch arguments" do
+          git_branches.should             include( "wip/#{@user}/zombie-basic" )
+          git_remote_branches.should_not  include( "review/#{@user}/zombie-basic" )
+          GitTopic.work_on 'zombie-basic'
+          GitTopic.done( 'zombie-basic' )
+         
+          git_branches.should_not         include( "wip/#{@user}/zombie-basic" )
+          git_remote_branches.should      include( "review/#{@user}/zombie-basic" )
+          git_remote_branches.should_not  include( "wip/#{@user}/zombie-basic" )
+          git_branch.should               == 'master'
+        end
+
+        it "
+          should succeed for wip-branch arguments, and leave the user on the
+          same branch
+        ".oneline do
+          git_branches.should             include( "wip/#{@user}/pirates-advanced" )
+          git_branches.should             include( "wip/#{@user}/zombie-basic" )
+          git_remote_branches.should_not  include( "review/#{@user}/zombie-basic" )
+
+          GitTopic.work_on  'pirates-advanced'
+          GitTopic.done     'zombie-basic'
+
+          git_branch.should               == "wip/#{@user}/pirates-advanced"
+          git_branches.should_not         include( "wip/#{@user}/zombie-basic" )
+          git_remote_branches.should      include( "review/#{@user}/zombie-basic" )
+          git_remote_branches.should_not  include( "wip/#{@user}/zombie-basic" )
+        end
+
+        it "should succeed for fully-qualified wip-branch arguments" do
+          git_branches.should             include( "wip/#{@user}/zombie-basic" )
+          git_remote_branches.should_not  include( "review/#{@user}/zombie-basic" )
+          GitTopic.done( "wip/#{@user}/zombie-basic" )
+         
+          git_branches.should_not         include( "wip/#{@user}/zombie-basic" )
+          git_remote_branches.should      include( "review/#{@user}/zombie-basic" )
+          git_remote_branches.should_not  include( "wip/#{@user}/zombie-basic" )
+          git_branch.should               == 'master'
+        end
+      end
     end
   end
 
@@ -227,6 +312,9 @@ describe GitTopic do
         @output.should          =~ /# On branch master/
       end
     end
+
+    pending "with useless args"
+
   end
 
   describe "#review" do
@@ -250,7 +338,7 @@ describe GitTopic do
       after( :each )  { Dir.chdir '..' }
 
       it "
-        should create a local tracking branch for the most recent remote review
+        should create a local tracking branch for the oldest remote review
         branch if none was specified
       " do
 
@@ -284,6 +372,11 @@ describe GitTopic do
         lambda{ GitTopic.review( 'fakeuser/faketopic' )}.should raise_error
       end
     end
+ 
+    pending "with non-branch arg"
+    pending "with non-review-branch arg"
+    pending "with my-review-branch arg"
+
   end
 
   describe "#accept" do
@@ -318,7 +411,7 @@ describe GitTopic do
         use_repo 'in-progress'
         system "
           git checkout master > /dev/null 2> /dev/null && 
-          git merge wip/prevent-ff > /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'
@@ -345,6 +438,8 @@ describe GitTopic do
       end
     end
 
+    pending "with an arg"
+
   end
 
   describe "#reject" do
@@ -380,6 +475,9 @@ describe GitTopic do
         lambda{ GitTopic.reject }.should    raise_error
       end
     end
+ 
+    pending "with an arg"
+
   end
 
 
@@ -396,6 +494,9 @@ describe GitTopic do
       git_config( 'alias.r' ).should          == 'topic review'
       git_config( 'alias.st' ).should         == 'topic status --prepended'
     end
+
+    pending "with an arg"
+
   end
 end
 

data/spec/template/origin/ORIG_HEAD

@@ -0,0 +1 @@
+0ce06c616769768f09f5e629cfcc68eabe3dee81

data/spec/template/origin/RENAMED-REF

@@ -0,0 +1 @@
+331d827fd47fb234af54e3a4bbf8c6705e9116cc

data/spec/template/origin/objects/65/3d7112dadcacaaae6390612eac58c234f92b18

@@ -0,0 +1,2 @@
+x
��M
+�0@a�9�\��?�D\H�a����H�=��n���Z��@}h+3hB�������d@��]P2D�l	Yʞ�W^�(h������O�

data/spec/template/origin/refs/heads/wip/USER/pirates-advanced

@@ -0,0 +1 @@
+331d827fd47fb234af54e3a4bbf8c6705e9116cc

data/spec/template/origin/refs/heads/wip/USER/zombie-basic

@@ -0,0 +1 @@
+331d827fd47fb234af54e3a4bbf8c6705e9116cc

data/spec/template/origin/refs/heads/wip/prevent-ff

@@ -0,0 +1 @@
+653d7112dadcacaaae6390612eac58c234f92b18

data/spec/template/origin-fresh/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

data/spec/template/origin-fresh/RENAMED-REF

@@ -0,0 +1 @@
+331d827fd47fb234af54e3a4bbf8c6705e9116cc

data/spec/template/origin-fresh/config

@@ -0,0 +1,7 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = true
+	sharedrepository = 1
+[receive]
+	denyNonFastforwards = true

data/spec/template/origin-fresh/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file 'description' to name the repository.

data/spec/template/origin-fresh/hooks/applypatch-msg.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message taken by
+# applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.  The hook is
+# allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "applypatch-msg".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/commit-msg" &&
+	exec "$GIT_DIR/hooks/commit-msg" ${1+"$@"}
+:

data/spec/template/origin-fresh/hooks/commit-msg.sample

@@ -0,0 +1,24 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by git-commit with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}

data/spec/template/origin-fresh/hooks/post-commit.sample

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# An example hook script that is called after a successful
+# commit is made.
+#
+# To enable this hook, rename this file to "post-commit".
+
+: Nothing

data/spec/template/origin-fresh/hooks/post-receive.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script for the "post-receive" event.
+#
+# The "post-receive" script is run after receive-pack has accepted a pack
+# and the repository has been updated.  It is passed arguments in through
+# stdin in the form
+#  <oldrev> <newrev> <refname>
+# For example:
+#  aa453216d1b3e49e7f6f98441fa56946ddcd6a20 68f7abf4e6f922807889f52bc043ecd31b79f814 refs/heads/master
+#
+# see contrib/hooks/ for a sample, or uncomment the next line and
+# rename the file to "post-receive".
+
+#. /usr/share/doc/git-core/contrib/hooks/post-receive-email

data/spec/template/origin-fresh/hooks/post-update.sample

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# An example hook script to prepare a packed repository for use over
+# dumb transports.
+#
+# To enable this hook, rename this file to "post-update".
+
+exec git-update-server-info

data/spec/template/origin-fresh/hooks/pre-applypatch.sample

@@ -0,0 +1,14 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed
+# by applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-applypatch".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/pre-commit" &&
+	exec "$GIT_DIR/hooks/pre-commit" ${1+"$@"}
+:

data/spec/template/origin-fresh/hooks/pre-commit.sample

@@ -0,0 +1,46 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by git-commit with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-commit".
+
+if git-rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
+fi
+
+# If you want to allow non-ascii filenames set this variable to true.
+allownonascii=$(git config hooks.allownonascii)
+
+# Cross platform projects tend to avoid non-ascii filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test "$(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0')"
+then
+	echo "Error: Attempt to add a non-ascii file name."
+	echo
+	echo "This can cause problems if you want to work"
+	echo "with people on other platforms."
+	echo
+	echo "To be portable it is advisable to rename the file ..."
+	echo
+	echo "If you know what you are doing you can disable this"
+	echo "check using:"
+	echo
+	echo "  git config hooks.allownonascii true"
+	echo
+	exit 1
+fi
+
+exec git diff-index --check --cached $against --

data/spec/template/origin-fresh/hooks/pre-rebase.sample

@@ -0,0 +1,169 @@
+#!/bin/sh
+#
+# Copyright (c) 2006, 2008 Junio C Hamano
+#
+# The "pre-rebase" hook is run just before "git-rebase" starts doing
+# its job, and can prevent the command from running by exiting with
+# non-zero status.
+#
+# The hook is called with the following parameters:
+#
+# $1 -- the upstream the series was forked from.
+# $2 -- the branch being rebased (or empty when rebasing the current branch).
+#
+# This sample shows how to prevent topic branches that are already
+# merged to 'next' branch from getting rebased, because allowing it
+# would result in rebasing already published history.
+
+publish=next
+basebranch="$1"
+if test "$#" = 2
+then
+	topic="refs/heads/$2"
+else
+	topic=`git symbolic-ref HEAD` ||
+	exit 0 ;# we do not interrupt rebasing detached HEAD
+fi
+
+case "$topic" in
+refs/heads/??/*)
+	;;
+*)
+	exit 0 ;# we do not interrupt others.
+	;;
+esac
+
+# Now we are dealing with a topic branch being rebased
+# on top of master.  Is it OK to rebase it?
+
+# Does the topic really exist?
+git show-ref -q "$topic" || {
+	echo >&2 "No such branch $topic"
+	exit 1
+}
+
+# Is topic fully merged to master?
+not_in_master=`git-rev-list --pretty=oneline ^master "$topic"`
+if test -z "$not_in_master"
+then
+	echo >&2 "$topic is fully merged to master; better remove it."
+	exit 1 ;# we could allow it, but there is no point.
+fi
+
+# Is topic ever merged to next?  If so you should not be rebasing it.
+only_next_1=`git-rev-list ^master "^$topic" ${publish} | sort`
+only_next_2=`git-rev-list ^master           ${publish} | sort`
+if test "$only_next_1" = "$only_next_2"
+then
+	not_in_topic=`git-rev-list "^$topic" master`
+	if test -z "$not_in_topic"
+	then
+		echo >&2 "$topic is already up-to-date with master"
+		exit 1 ;# we could allow it, but there is no point.
+	else
+		exit 0
+	fi
+else
+	not_in_next=`git-rev-list --pretty=oneline ^${publish} "$topic"`
+	perl -e '
+		my $topic = $ARGV[0];
+		my $msg = "* $topic has commits already merged to public branch:\n";
+		my (%not_in_next) = map {
+			/^([0-9a-f]+) /;
+			($1 => 1);
+		} split(/\n/, $ARGV[1]);
+		for my $elem (map {
+				/^([0-9a-f]+) (.*)$/;
+				[$1 => $2];
+			} split(/\n/, $ARGV[2])) {
+			if (!exists $not_in_next{$elem->[0]}) {
+				if ($msg) {
+					print STDERR $msg;
+					undef $msg;
+				}
+				print STDERR " $elem->[1]\n";
+			}
+		}
+	' "$topic" "$not_in_next" "$not_in_master"
+	exit 1
+fi
+
+exit 0
+
+################################################################
+
+This sample hook safeguards topic branches that have been
+published from being rewound.
+
+The workflow assumed here is:
+
+ * Once a topic branch forks from "master", "master" is never
+   merged into it again (either directly or indirectly).
+
+ * Once a topic branch is fully cooked and merged into "master",
+   it is deleted.  If you need to build on top of it to correct
+   earlier mistakes, a new topic branch is created by forking at
+   the tip of the "master".  This is not strictly necessary, but
+   it makes it easier to keep your history simple.
+
+ * Whenever you need to test or publish your changes to topic
+   branches, merge them into "next" branch.
+
+The script, being an example, hardcodes the publish branch name
+to be "next", but it is trivial to make it configurable via
+$GIT_DIR/config mechanism.
+
+With this workflow, you would want to know:
+
+(1) ... if a topic branch has ever been merged to "next".  Young
+    topic branches can have stupid mistakes you would rather
+    clean up before publishing, and things that have not been
+    merged into other branches can be easily rebased without
+    affecting other people.  But once it is published, you would
+    not want to rewind it.
+
+(2) ... if a topic branch has been fully merged to "master".
+    Then you can delete it.  More importantly, you should not
+    build on top of it -- other people may already want to
+    change things related to the topic as patches against your
+    "master", so if you need further changes, it is better to
+    fork the topic (perhaps with the same name) afresh from the
+    tip of "master".
+
+Let's look at this example:
+
+		   o---o---o---o---o---o---o---o---o---o "next"
+		  /       /           /           /
+		 /   a---a---b A     /           /
+		/   /               /           /
+	       /   /   c---c---c---c B         /
+	      /   /   /             \         /
+	     /   /   /   b---b C     \       /
+	    /   /   /   /             \     /
+    ---o---o---o---o---o---o---o---o---o---o---o "master"
+
+
+A, B and C are topic branches.
+
+ * A has one fix since it was merged up to "next".
+
+ * B has finished.  It has been fully merged up to "master" and "next",
+   and is ready to be deleted.
+
+ * C has not merged to "next" at all.
+
+We would want to allow C to be rebased, refuse A, and encourage
+B to be deleted.
+
+To compute (1):
+
+	git-rev-list ^master ^topic next
+	git-rev-list ^master        next
+
+	if these match, topic has not merged in next at all.
+
+To compute (2):
+
+	git-rev-list master..topic
+
+	if this is empty, it is fully merged to "master".

data/spec/template/origin-fresh/hooks/prepare-commit-msg.sample

@@ -0,0 +1,36 @@
+#!/bin/sh
+#
+# An example hook script to prepare the commit log message.
+# Called by git-commit with the name of the file that has the
+# commit message, followed by the description of the commit
+# message's source.  The hook's purpose is to edit the commit
+# message file.  If the hook fails with a non-zero status,
+# the commit is aborted.
+#
+# To enable this hook, rename this file to "prepare-commit-msg".
+
+# This hook includes three examples.  The first comments out the
+# "Conflicts:" part of a merge commit.
+#
+# The second includes the output of "git diff --name-status -r"
+# into the message, just before the "git status" output.  It is
+# commented because it doesn't cope with --amend or with squashed
+# commits.
+#
+# The third example adds a Signed-off-by line to the message, that can
+# still be edited.  This is rarely a good idea.
+
+case "$2,$3" in
+  merge,)
+    perl -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/; print' "$1" ;;
+
+# ,|template,)
+#   perl -i.bak -pe '
+#      print "\n" . `git diff --cached --name-status -r`
+#	 if /^#/ && $first++ == 0' "$1" ;;
+
+  *) ;;
+esac
+
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"