git-topic 0.1.1

data/spec/git-topic_spec.rb

@@ -0,0 +1,378 @@
+require 'spec_helper'
+
+require 'fileutils'
+
+
+describe GitTopic do
+
+  before( :all ) do
+    @starting_dir   = Dir.pwd
+    @user           = ENV['USER'] || `whoami`
+  end
+
+  before( :each ) do
+    # setup the directories
+    FileUtils.rm_rf   './tmp'
+    FileUtils.mkdir   './tmp'
+
+    %w(fresh in-progress dirty origin).each do |repo|
+      FileUtils.cp_r "spec/template/#{repo}",   './tmp'
+
+      # set template branches to their proper name (i.e. matching @user)
+      Dir.chdir "./tmp/#{repo}"
+      git_branches.each do |orig_name|
+        new_name = orig_name.gsub( 'USER', @user )
+        system(
+          "git branch -m #{orig_name} #{new_name}"
+        ) unless orig_name == new_name
+      end
+      Dir.chdir @starting_dir
+    end
+    Dir.chdir         './tmp'
+
+    # capture output
+    @output         = ''
+    @err            = ''
+    $stdout.stub!( :write ) { |*args| @output.<<( *args )}
+    $stderr.stub!( :write ) { |*args| @err.<<( *args )}
+  end
+
+  after( :each ) { Dir.chdir @starting_dir }
+
+
+  # helpers # {{{
+
+  def git_branch
+    all_branches    = `git branch --no-color`.split( "\n" )
+    current_branch  = all_branches.find{|b| b =~ /^\*/}
+
+    current_branch[ 2..-1 ] unless current_branch.nil?
+  end
+
+  def git_head
+    `git rev-parse HEAD`.chomp
+  end
+
+  def git_config( key )
+    `git config #{key}`.chomp
+  end
+
+  def git_branch_merge
+    git_config "branch.#{git_branch}.merge"
+  end
+
+  def git_branch_remote
+    git_config "branch.#{git_branch}.remote"
+  end
+
+  def git_branches
+    `git branch --no-color`.split( "\n" ).map do |bn|
+      bn.gsub /^\*?\s*/, ''
+    end
+  end
+
+  def git_remote_branches
+    `git branch -r --no-color`.split( "\n" ).map do |bn|
+      bn.gsub! %r{^\s*origin/}, ''
+      bn.gsub! %r{ ->.*$}, ''
+      bn
+    end
+  end
+
+  # }}}
+ 
+
+  describe "#work_on" do
+
+    describe "in fresh" do
+      before( :each ) { Dir.chdir( 'fresh' )}
+      after( :each )  { Dir.chdir( '..' )}
+
+      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
+       be set up.
+      ".oneline do
+
+        GitTopic.work_on( 'topic' )
+        git_branch.should               == "wip/#{@user}/topic"
+        git_branch_remote.should        == 'origin'
+        git_branch_merge.should         == "refs/heads/wip/#{@user}/topic"
+      end
+
+      it "should fail if no topic is given" do
+        lambda { GitTopic.work_on( nil )}.should  raise_error
+      end
+
+    end
+
+    describe "in in-progress" do
+
+      before( :each ) { Dir.chdir( 'in-progress' )}
+      after( :each )  { Dir.chdir( '..' )}
+
+
+      it "should switch to (rather than create) an existing topic branch" do
+        git_branches.should include( "wip/#{@user}/zombie-basic" )
+        lambda{ GitTopic.work_on  'zombie-basic' }.should_not raise_error
+
+        git_branch.should   == "wip/#{@user}/zombie-basic"
+      end
+
+      it "
+        should use (and then destroy) the rejected 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
+
+
+  describe "#done" do
+
+    describe "in in-progress" do
+
+      before( :each ) { Dir.chdir 'in-progress' }
+      after( :each )  { Dir.chdir '..' }
+
+      describe "without an argument" do
+
+        it "should fail if the working tree is dirty" do
+          GitTopic.work_on 'zombie-basic'
+          File.open( 'foo', 'w' ){|f| f.puts "some content" }
+          system "git add -N foo"
+
+          lambda{ GitTopic.done }.should raise_error
+        end
+
+        it "should fail if not on a wip branch" do
+          `git checkout master > /dev/null 2> /dev/null`
+          lambda{ GitTopic.done }.should raise_error
+        end
+
+        it "
+          should push the wip branch to origin in the review namespace, delete the
+          local branch, and leave the user on master
+        ".oneline 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
+         
+          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
+
+  describe "#status" do
+
+    describe "with pending review branches" do
+
+      before( :each ) { Dir.chdir 'in-progress' }
+      after( :each )  { Dir.chdir '..' }
+
+
+      it "should not show my review branches, but it should show others'" do
+        git_remote_branches.should      include 'review/davidjh/pirates'
+
+        GitTopic.status
+        @output.should_not      be_nil
+
+        @output.should_not      =~ /^#\s*pirates\s*$/m
+        @output.should          =~ /^#\s*ninja-basic\s*$/m
+        @output.should          =~ /^#\s*zombie-basic\s*$/m
+      end
+
+      it "should show my rejected topics" do
+        git_remote_branches.should      include 'rejected/davidjh/krakens'
+        GitTopic.status
+        @output.should_not      be_nil
+
+        @output.should          =~ /^#\s*krakens\s*$/m
+      end
+
+    end
+
+    describe "passed the --prepended flag" do
+      before( :each ) { Dir.chdir 'in-progress' }
+      after( :each )  { Dir.chdir '..' }
+
+      it "should invoke git status before producing its output" do
+        GitTopic.status( :prepended => true )
+        @output.should_not      be_nil
+        @output.should          =~ /# On branch master/
+      end
+    end
+  end
+
+  describe "#review" do
+
+    describe "with no review branches" do
+      before( :each ) { Dir.chdir 'fresh' }
+      after( :each )  { Dir.chdir '..' }
+
+      it "should report that there is nothing to do" do
+        git_remote_branches.each do |b|
+          b.should_not    =~ /review/
+        end
+
+        GitTopic.review
+        @output.should    =~ /nothing to review/
+      end
+    end
+
+    describe "with some review branches" do
+      before( :each ) { Dir.chdir 'in-progress' }
+      after( :each )  { Dir.chdir '..' }
+
+      it "
+        should create a local tracking branch for the most recent remote review
+        branch if none was specified
+      " do
+
+        git_remote_branches.should      include 'review/user24601/zombie-basic'
+        GitTopic.review
+        git_branch.should               == 'review/user24601/zombie-basic'
+        git_branch_remote.should        == 'origin'
+        git_branch_merge.should         == 'refs/heads/review/user24601/zombie-basic'
+      end
+
+      it "should create a local tracking branch for the specified topic" do
+        git_remote_branches.should      include 'review/user24601/ninja-basic'
+        GitTopic.review( 'user24601/ninja-basic' )
+        git_branch.should               == 'review/user24601/ninja-basic'
+        git_branch_remote.should        == 'origin'
+        git_branch_merge.should         == 'refs/heads/review/user24601/ninja-basic'
+      end
+
+      it "should error if an illegal topic is specified" do
+        lambda{ GitTopic.review( 'fakeuser/faketopic' )}.should raise_error
+      end
+    end
+  end
+
+  describe "#accept" do
+
+    describe "while on a review branch" do
+      before( :each ) do
+        Dir.chdir 'in-progress'
+        GitTopic.review 'user24601/zombie-basic'
+      end
+      after( :each ) { Dir.chdir '..' }
+
+      describe "with no specified argument" do
+        it "
+          should merge to master, push master and destroy the local and remote
+          branches when the merge is a fast-forward merge
+        ".oneline do
+
+          git_branch.should               == 'review/user24601/zombie-basic'
+          GitTopic.accept
+          git_branch.should               == 'master'
+          git_branches.should_not         include( 'review/user24601/zombie-basic' )
+          git_remote_branches.should_not  include( 'review/user24601/zombie-basic' )
+
+          git_head.should                 == '0ce06c616769768f09f5e629cfcc68eabe3dee81'
+        end
+      end
+    end
+
+    describe "while on a review branch that does not FF" do
+      before( :each ) do
+        Dir.chdir 'in-progress'
+        system "
+          git checkout master > /dev/null 2> /dev/null && 
+          git merge wip/prevent-ff > /dev/null 2> /dev/null
+        "
+        @original_git_Head    = git_head
+        GitTopic.review 'user24601/zombie-basic'
+      end
+      after( :each ) { Dir.chdir '..' }
+
+      it "should refuse to accept the review branch" do
+        git_branch.should                 == 'review/user24601/zombie-basic'
+        lambda{ GitTopic.accept }.should  raise_error
+        git_branch.should                 == 'review/user24601/zombie-basic'
+        git_remote_branches.should        include( 'review/user24601/zombie-basic' )
+
+        system "git checkout master > /dev/null 2> /dev/null"
+        git_head.should                   == @original_git_Head
+      end
+    end
+
+    describe "while not on a review branch" do
+      before( :each ) { Dir.chdir 'in-progress' }
+      after( :each ) { Dir.chdir '..' }
+
+      it "should fail" do
+        lambda{ GitTopic.accept }.should    raise_error
+      end
+    end
+
+  end
+
+  describe "#reject" do
+
+    describe "while on a review branch" do
+      before( :each ) do
+        Dir.chdir 'in-progress'
+        GitTopic.review 'user24601/zombie-basic'
+      end
+      after( :each ) { Dir.chdir '..' }
+
+      describe "with no specified argument" do
+        it "
+          should move branch to the rejected namespace and destroy the local and
+          remote review branches
+        ".oneline do
+
+          git_branch.should               == 'review/user24601/zombie-basic'
+          GitTopic.reject
+          git_branch.should               == 'master'
+          git_branches.should_not         include( 'review/user24601/zombie-basic' )
+          git_remote_branches.should_not  include( 'review/user24601/zombie-basic' )
+          git_remote_branches.should      include( 'rejected/user24601/zombie-basic' )
+        end
+      end
+    end
+    
+    describe "while not on a review branch" do
+      before( :each ) { Dir.chdir 'in-progress' }
+      after( :each ) { Dir.chdir '..' }
+
+      it "should fail" do
+        lambda{ GitTopic.reject }.should    raise_error
+      end
+    end
+  end
+
+
+  describe "#install_aliases" do
+    it "should install aliases" do
+      GitTopic.install_aliases  :local => true
+      git_config( 'alias.work-on' ).should    == 'topic work-on'
+      git_config( 'alias.done' ).should       == 'topic done'
+      git_config( 'alias.review' ).should     == 'topic review'
+      git_config( 'alias.accept' ).should     == 'topic accept'
+      git_config( 'alias.reject' ).should     == 'topic reject'
+
+      git_config( 'alias.w' ).should          == 'topic work-on'
+      git_config( 'alias.r' ).should          == 'topic review'
+      git_config( 'alias.st' ).should         == 'topic status --prepended'
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+require 'git-topic'
+
+
+# Disable caching on GitTopic for specs since we're calling the methods directly
+# rather than assuming atmoic invocations.
+module GitTopic
+  class << self
+    %w( current_branch remote_branches remote_branches_organized branches
+        ).each do |m|
+
+      define_method( "#{m}_with_nocache" ) do
+        rv = send( "#{m}_without_nocache" )
+        self.class_variable_set( "@@#{m}", nil )
+        rv
+      end
+      alias_method_chain m.to_sym, :nocache
+    end
+
+    def git_with_implicit_capture( cmds=[], opts={} )
+      if opts[:show]
+        puts capture_git( cmds )
+      else
+        git_without_implicit_capture( cmds, opts )
+      end
+    end
+    alias_method_chain  :git, :implicit_capture
+  end
+end
+
+
+# Track original $stdout, $stderr write methods so we can “unmock” them for
+# debugging
+
+class << $stdout
+  alias_method :real_write, :write
+end
+class << $stderr
+  alias_method :real_write, :write
+end
+
+
+class Object
+  def debug
+    # For debugging, restore stubbed write
+    class << $stdout
+      alias_method :write, :real_write
+    end
+    class << $stderr
+      alias_method :write, :real_write
+    end
+
+    require 'ruby-debug'
+    debugger
+  end
+end

data/spec/template/origin/HEAD

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

data/spec/template/origin/config

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

data/spec/template/origin/description

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

data/spec/template/origin/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/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/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/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/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/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/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 --