git-topic 0.1.1

data/.gitignore

@@ -0,0 +1,4 @@
+/tmp
+/pkg
+/.yardoc
+/doc

data/.gvimrc

@@ -0,0 +1,23 @@
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+" Setup tabs and vimproject
+
+Project .vimproject
+
+tabnew
+tabnew
+tabnew
+tabnew
+tabnew
+tabnew
+tabnew
+tabnew
+tabnew
+
+tabdo Project
+tabdo wincmd l
+tabdo wincmd n
+
+1tabn
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+winpos 433 25

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2-rc1

data/.vimproject

@@ -0,0 +1,26 @@
+project=$PWD cd=. {
+ History.txt
+ LICENSE
+ README.rdoc
+ README.txt
+ Rakefile
+ bin=bin {
+  git-topic
+ }
+ lib=lib {
+  git-topic.rb
+  util.rb
+ }
+ spec=spec {
+  git-topic_spec.rb
+  spec_helper.rb
+ }
+}
+
+
+
+
+
+
+
+ vim:wfw fdl=1:

data/.vimrc

@@ -0,0 +1 @@
+let $RUBYOPT = 'lib' 

data/Gemfile

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+source :gemcutter
+
+gem 'activesupport'
+gem 'trollop'
+gem 'gemcutter'
+
+group :development do
+  gem 'jeweler'
+  gem 'rake'
+  gem 'rspec',  '>= 2.0.0.beta.16'
+  gem 'ZenTest'
+  gem 'yard'
+end
+
+
+
+# vim:ft=ruby:

data/Gemfile.lock

@@ -0,0 +1,63 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.3.3)
+    ZenTest (4.3.3)
+    activesupport (2.3.8)
+    activesupport (2.3.8)
+    diff-lcs (1.1.2)
+    diff-lcs (1.1.2)
+    gemcutter (0.5.0)
+      json_pure
+    gemcutter (0.5.0)
+      json_pure
+    git (1.2.5)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.3)
+    json_pure (1.4.3)
+    rake (0.8.7)
+    rake (0.8.7)
+    rspec (2.0.0.beta.16)
+      rspec-core (= 2.0.0.beta.16)
+      rspec-expectations (= 2.0.0.beta.16)
+      rspec-mocks (= 2.0.0.beta.16)
+    rspec (2.0.0.beta.16)
+      rspec-core (= 2.0.0.beta.16)
+      rspec-expectations (= 2.0.0.beta.16)
+      rspec-mocks (= 2.0.0.beta.16)
+    rspec-core (2.0.0.beta.16)
+    rspec-core (2.0.0.beta.16)
+    rspec-expectations (2.0.0.beta.16)
+      diff-lcs (>= 1.1.2)
+    rspec-expectations (2.0.0.beta.16)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.16)
+    rspec-mocks (2.0.0.beta.16)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    trollop (1.16.2)
+    trollop (1.16.2)
+    yard (0.5.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest
+  activesupport
+  gemcutter
+  jeweler
+  rake
+  rspec (>= 2.0.0.beta.16)
+  trollop
+  yard

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2010-03-05
+
+* 1 major enhancement
+
+  * Birthday!
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David J. Hamilton
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,192 @@
+= 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
+
+1.      Create a topic branch in the wip namespace.
+2.      Do some work.
+3.      Rebase to create a nice commit history.
+4.      Push to the review namespace.  If the wip branch was pushed (e.g.
+        because you work on multiple machines) destroy it on the remote.
+
+1.      Create a local branch from a rejected branch.
+2.      Do some work, resolve the reviewer's issues.
+3.      go to step 3, above.
+
+=== Reviewing
+
+1.          Create a local branch from a review branch somebody else pushed.
+2.          Review their work.
+3.  a.i.    Accept; merge (fast-forward) master
+    ii.     Destroy the review branch. 
+    b.      Reject; add notes and push to the rejected namespace and remove from
+            the review namespace.
+
+
+== 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
+
+    # do some work, create lots of temporary commits
+    # when ready to get the code into master, first update so we're rebasing against
+    # the latest code
+    git fetch origin
+
+    # rebase against latest code
+    git rebase --interactive origin/master
+
+    # when done rebasing so wip/hal/foo now has a nice clean commit history, push to
+    # a review branch and destroy the remote wip branch
+    git push origin wip/hal/foo:review/hal/foo  :wip/hal/foo
+
+    # alternatively if you never pushed your wip branch to the remote there's no
+    # need to destroy it, instead only push your local wip branch as a review branch
+    #
+    # git push origin wip/hal/foo:review/hal/foo
+
+
+    # later, after your changes have been merged into master, you can delete your
+    # local branch
+    #
+    # git checkout master
+    # git branch -d wip/hal/foo
+
+
+
+=== Reviewing a  topic (no proposed changes)
+
+    # update origin
+    git fetch origin
+
+    # notice there's a review branch
+    git branch -r
+
+    # create a local branch that tracks the remote review branch
+    git checkout -b review/djh/bar origin/review/djh/bar
+
+    # examine code and examine the local (proposed) commits
+    git log master..
+
+    # when done reviewing, merge into master
+    git checkout master
+    # This should be a fast-forward merge.  If not, it's because something has been
+    # added to master since the rebase
+    git merge review/djh/bar
+    git branch -d review/djh/bar
+
+    # update the new master and destroy the old review branch
+    git push origin master :review/djh/bar
+
+
+
+=== Reviewing a topc (proposed changes)
+
+As above, but if, after examining the code you feel some changes are
+appropriate, you can either:
+
+1.  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
+
+2.  do some (or no) changes, but with some TODOs for the original author.
+
+    # do your changes on review/djh/bar
+
+    # then update the remote, moving the branch to rejected, indicating the
+    # author has some TODOs left.
+    git push origin review/djh/bar:rejected/djh/bar :review/djh/bar
+
+    # when the author has resolved the TODOs they will move the branch back to
+    # review/djh/bar
+
+
+== Workflow with git-topic
+
+=== Doing Work
+
+    # Work on a (possibly new, possibly rejected) topic
+    git topic work-on <topic>
+
+    # done with topic; push it for someone to review
+    git topic done [<topic>]
+
+
+=== Reviewing
+
+    # see if we have any topics to review (or rejected topics to fix up)
+    git topic status
+
+    git topic review [<topic>]
+
+    # happy with the review, get it into master
+    git topic accept
+
+    # unhappy with the review, push it to rejected
+    git topic reject
+
+== Again, but with aliases
+
+    # first install aliases
+    #   add --local if you don't want to update your global aliases
+    git topic install-aliases
+
+    # alternatively
+    #   git w <topic>
+    git work-on <topic>
+
+    git done
+
+
+    # does status --prepend so you get git status output as well as git topic
+    # status
+    git st
+
+    # alternatively
+    #   git r <topic>
+    git review <topic>
+
+    git accept
+    # or
+    git reject
+
+==  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
+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
+
+1.  Fork the project.
+2.  Make your feature addition or bug fix.
+3.  Add tests for it. This is important so I don't break it in a
+    future version unintentionally.
+4.  Commit, do not mess with rakefile, version, or history.  (if you want to
+    have your own version, that is fine but bump version in a commit by itself I
+    can ignore when I pull)
+5.  Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 David J. Hamilton. See LICENSE for details.
+
+== References
+
+[1] http://redmine.ruby-lang.org/issues/show/3465

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake'
+
+Dir[ 'lib/tasks/**/*' ].each{ |l| require l }
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "git-topic"
+    gem.summary = %Q{git command around reviewed topic branches}
+    gem.description = %Q{
+      gem command around reviewed topic branches.  Supports workflow of the form:
+
+      # alexander:
+      git work-on <topic>
+      git done
+
+      # bismarck:
+      git status    # notice a review branch
+      git review <topic>
+      # happy, merge into master, push and cleanup
+      git accept
+
+      git review <topic2>
+      # unhappy
+      git reject
+
+      # alexander:
+      git status    # notice rejected topic
+      git work-on <topic>
+
+      see README.rdoc for more (any) details.
+    }
+    gem.email = "git-topic@hjdivad.com"
+    gem.homepage = "http://github.com/hjdivad/git-topic"
+    gem.authors = ["David J. Hamilton"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "cucumber", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc "Run all specs."
+task :spec do
+  sh "bundle exec rspec spec"
+end
+
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  desc "Try (and fail) to run yardoc to get an error message."
+  task :yard do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/bin/git-topic

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'trollop'
+require 'git-topic'
+
+
+module GitTopic
+  SubCommands = %w(work-on done status review accept reject install-aliases)
+
+  class << self
+    def run
+      global_opts = Trollop::options do
+        banner "
+          Manage a topic/review workflow.
+
+          Commands are:
+            #{SubCommands.join( "
+            " )}
+
+            Global Options:
+        ".cleanup
+
+        opt :verbose,   "Verbose output, including complete traces on errors."
+        stop_on     SubCommands
+      end
+
+      cmd       = ARGV.shift
+      cmd_opts  = Trollop::options do
+        case cmd
+        when "work-on"
+          banner "
+            work-on <topic>
+
+            Switches to a local work-in-progress (wip) branch for <topic>.  The
+            branch (and a matching remote branch) is created if necessary.
+
+            If this is a rejected topic, work will continue from the state of
+            the rejected topic branch.
+          ".cleanup
+        when /done(-with)?/
+          banner "
+            done
+
+            Indicate that this topic branch is ready for review.  Push to a
+            remote review branch and switch back to master.
+          ".cleanup
+        when "status"
+          banner "
+            status
+
+            Print a status, showing rejected branches to work on and branches
+            that can be reviewed.
+
+            Options:
+          ".cleanup
+          opt   :prepended,
+                "
+                  Prepend status to git status output (for a complete view of
+                  status).
+                ".oneline,
+                :default => false
+        when "review"
+          banner "
+            review [<topic>]
+
+            Review <topic>.  If <topic> is unspecified, review the oldest (by HEAD) topic.
+          ".cleanup
+        when "accept"
+          banner "
+            accept
+
+            Accept the current in-review topic, merging it to master and
+            cleaning up the remote branch.  This will fail if the branch does
+            not merge as a fast-forward in master.  If that happens, the topic
+            should either be rejected, or you can manually rebase.
+          ".cleanup
+        when "reject"
+          banner "
+            reject
+
+            Reject the current in-review topic.
+          ".cleanup
+        when "install-aliases"
+          banner "
+            install-aliases
+
+            Install aliases to make git topic nicer to work with.  The aliases are as follows:
+
+            w[ork-on]   topic work-on
+            done        topic done
+            r[eview]    topic review
+            accept      topic accept
+            reject      topic reject
+
+            st          topic status --prepended
+
+            Options:
+          ".cleanup
+
+          opt   :local,
+                "
+                  Install aliases non-globally (i.e. in .git/config instead of
+                  $HOME/.gitconfig
+                ".oneline,
+                :default => false
+        end
+      end
+
+      opts = global_opts.merge( cmd_opts )
+      display_git_output! if opts[:verbose]
+
+      case cmd
+      when "work-on"
+        topic             = ARGV.shift
+        work_on           topic, opts
+      when /done(-with)?/
+        topic             = ARGV.shift
+        done              topic, opts
+      when "status"
+        status            opts
+      when "review"
+        spec              = ARGV.shift
+        review            spec, opts
+      when "accept"
+        topic             = ARGV.shift
+        accept            topic, opts
+      when "reject"
+        topic             = ARGV.shift
+        reject            topic, opts
+      when "install-aliases"
+        install_aliases   opts
+      end
+    rescue => error
+      puts "Error: #{error.message}"
+      puts error.backtrace.join( "\n" ) if opts[:verbose]
+    end
+  end
+end
+
+
+GitTopic::run
+