pivotal-github 0.6.4 → 0.6.5

data/README.md

@@ -1,6 +1,6 @@
 # pivotal-github
 
-The `pivotal-github` gem facilitates a Pivotal Tracker–GitHub workflow inspired by [Logical Reality](http://lrdesign.com/). As per usual, there are several projects (notably [git-flow](https://github.com/nvie/gitflow) and [git-pivotal](https://github.com/trydionel/git-pivotal)) that implement similar solutions, but none met my exact needs.
+The `pivotal-github` gem facilitates a Pivotal Tracker–GitHub workflow inspired by the workflow used by [Logical Reality](http://lrdesign.com/). As per usual, there are several projects (notably [git-flow](https://github.com/nvie/gitflow) and [git-pivotal](https://github.com/trydionel/git-pivotal)) that implement similar solutions, but none met my exact needs.
 
 ## Installation
 
@@ -93,7 +93,7 @@ Additionally, `git story-pull` accepts any options valid for `git pull`.
     $ git checkout master
     $ git merge --no-ff --log 6283185-add-markdown-support
 
-Note that this effectively changes the default merge behavior from fast-forward to no-fast-forward, which makes it possible to see from `git log` which of the commit objects together have implemented a story. As noted in [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/),
+Note that this effectively changes the default merge behavior from fast-forward to no-fast-forward, which makes it possible to use `git log` to see which of the commit objects together have implemented a story. As noted in [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model/),
 
 > The `--no-ff` flag causes the merge to always create a new commit object, even if the merge could be performed with a fast-forward. This avoids losing information about the historical existence of a feature branch and groups together all commits that together added the feature… Yes, it will create a few more (empty) commit objects, but the gain is much bigger that that cost.
 
@@ -101,10 +101,13 @@ In addition, the `--log` option puts the commit messages from the individual com
 
 Because of the way options are chained, passing `--ff` or `--no-log` to `git story-merge` will override the `--no-ff` or `--log` flags (respectively) and thus restore the default behavior of `git merge`.
 
+Finally, experience shows that it's easy to forget to mark a story finished when making the final commit. As a reminder, the `git story-merge` command exits with a warning if the most recent commit doesn't contain 'Finishes' or 'Delivers' (or 'Finished' or 'Delivered'). This behavior can be overriden with the `--run` option. (I wanted to use `-f` and `--force`, but those interact badly with the default `git merge` options.)
+
 #### Options
 
     Usage: git story-merge [options]
         -d, --development BRANCH         development branch (defaults to master)
+	    -r, --run                        run without marking story finished
         -h, --help                       this usage guide
 
 Additionally, `git story-merge` accepts any options valid for `git merge`.
@@ -115,12 +118,15 @@ Additionally, `git story-merge` accepts any options valid for `git merge`.
 
     $ git story-pull-request
 
-Experience shows that, when using `git story-commit` it's easy to forget to mark the story finished when making the last commit. As a reminder, the `git story-pull-request` command exits with a warning if the most recent commit doesn't contain 'Finishes' or 'Delivers' (or 'Finished' or 'Delivered'). This warning can be overriden with the `--force` flag.
+By default, `git story-pull-request` issues a `git story-push` as well, just in case the local branch hasn't yet been pushed up to the remote repository. This step can be skipped with the `--skip` option.
+
+As with `git story-merge`, by default `git story-pull-request` exits with a warning if the most recent commit doesn't finish the story.
 
 #### Options
 
     Usage: git story-pull-request [options]
-        -f, --force                      run without marking story finished
+    	-r, --run                        run without marking story finished
+        -s, --skip                       skip `git story-push`
         -h, --help                       this usage guide
 
 ### story-open

data/lib/pivotal-github/command.rb

@@ -55,5 +55,5 @@ class Command
       args.inject([]) do |opts, opt|
         opts << (opt =~ /^-/ ? opt : opt.inspect)
       end.join(' ')      
-    end  
+    end
 end

data/lib/pivotal-github/finished_command.rb

@@ -0,0 +1,28 @@
+# By devault, command runs only when story is finished
+class FinishedCommand < Command
+
+  def run!
+    check_finishes unless run?
+    system cmd
+  end
+
+  private
+
+    # Checks to see if the most recent commit finishes the story
+    # We look for 'Finishes' or 'Delivers' and issue a warning if neither is
+    # in the most recent commit. (Also supports 'Finished' and 'Delivered'.)
+    def check_finishes
+      unless `git log -1` =~ /Finishe(s|d)|Deliver(s|ed)/
+        warning =  "Warning: Unfinished story\n"
+        warning += "Run `git commit --amend` to add 'Finishes' or 'Delivers' "
+        warning += "to the commit message\n"
+        warning += "Use --force to override"
+        $stderr.puts warning
+        exit 1
+      end
+    end
+
+    def run?
+      options.run
+    end
+end

data/lib/pivotal-github/story_merge.rb

@@ -1,6 +1,7 @@
 require 'pivotal-github/command'
+require 'pivotal-github/finished_command'
 
-class StoryMerge < Command
+class StoryMerge < FinishedCommand
 
   def parser
     OptionParser.new do |opts|
@@ -9,6 +10,12 @@ class StoryMerge < Command
               "development branch (defaults to master)") do |opt|
         self.options.development = opt
       end
+      # I wanted to use '-f' and '--force', but those interact
+      # badly with the default `git merge` options.
+      opts.on("-r", "--run", 
+              "run without marking story finished") do |opt|
+        self.options.run = opt
+      end
       opts.on_tail("-h", "--help", "this usage guide") do
         puts opts.to_s; exit 0
       end
@@ -28,10 +35,6 @@ class StoryMerge < Command
     lines.join("\n")
   end
 
-  def run!
-    system cmd
-  end
-
   private
 
     def development_branch

data/lib/pivotal-github/story_pull_request.rb

@@ -1,13 +1,17 @@
 require 'pivotal-github/command'
+require 'pivotal-github/finished_command'
 
-class StoryPullRequest < Command
+class StoryPullRequest < FinishedCommand
 
   def parser
     OptionParser.new do |opts|
       opts.banner = "Usage: git story-pull-request [options]"
-      opts.on("-f", "--force", 
-              "run without marking story finished") do |f|
-        self.options.force = f
+      opts.on("-r", "--run",
+              "run without marking story finished") do |opt|
+        self.options.run = opt
+      end
+      opts.on("-s", "--skip", "skip `git story-push`") do |opt|
+        self.options.skip = opt
       end
       opts.on_tail("-h", "--help", "this usage guide") do
         puts opts.to_s; exit 0
@@ -18,18 +22,17 @@ class StoryPullRequest < Command
   # Returns a command appropriate for executing at the command line
   # I.e., 'open https://www.pivotaltracker.com/story/show/6283185'
   def cmd
-    "open #{uri}"
+    if skip?
+      "open #{uri}"
+    else
+      "git story-push && open #{uri}"
+    end
   end
 
   def uri
     "#{origin_uri}/pull/new/#{story_branch}"
   end
 
-  def run!
-    check_finishes unless force?
-    system cmd
-  end
-
   private
 
     # Returns the remote URI for the repository
@@ -38,21 +41,7 @@ class StoryPullRequest < Command
       `git config --get remote.origin.url`.strip.chomp('.git')
     end
 
-    # Checks to see if the most recent commit finishes the story
-    # We look for 'Finishes' or 'Delivers' and issue a warning if neither is
-    # in the most recent commit. (Also supports 'Finished' and 'Delivered'.)
-    def check_finishes
-      unless `git log -1` =~ /Finishe(s|d)|Deliver(s|ed)/
-        warning =  "Warning: Unfinished story\n"
-        warning += "Run `git commit --amend` to add 'Finishes' or 'Delivers' "
-        warning += "to the commit message\n"
-        warning += "Use --force to override"
-        $stderr.puts warning
-        exit 1
-      end
-    end
-
-    def force?
-      options.force
+    def skip?
+      options.skip
     end
 end

data/lib/pivotal-github/version.rb

@@ -1,5 +1,5 @@
 module Pivotal
   module Github
-    VERSION = "0.6.4"
+    VERSION = "0.6.5"
   end
 end

data/spec/commands/story_pull_request_spec.rb

@@ -9,11 +9,18 @@ describe StoryPullRequest do
   end
   subject { command }
 
-  its(:cmd) { should == "open #{command.uri}" }
+  its(:cmd) { should =~ /open #{command.uri}/ }
+  its(:cmd) { should =~ /git story-push/ }
 
   describe "command-line command" do
     subject { `bin/git-story-pull-request --debug` }
     it { should =~ /pull\/new/ }
     it { should_not =~ /\.git/ }
+    it { should =~ /git story-push/ }
+
+    describe "with a skip option" do
+      subject { `bin/git-story-pull-request --skip --debug` }
+      it { should_not =~ /git story-push/ }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pivotal-github
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
   prerelease: 
 platform: ruby
 authors:
@@ -38,6 +38,7 @@ files:
 - bin/story-open
 - lib/pivotal-github.rb
 - lib/pivotal-github/command.rb
+- lib/pivotal-github/finished_command.rb
 - lib/pivotal-github/options.rb
 - lib/pivotal-github/story_commit.rb
 - lib/pivotal-github/story_merge.rb
@@ -47,6 +48,7 @@ files:
 - lib/pivotal-github/story_push.rb
 - lib/pivotal-github/version.rb
 - pivotal-github.gemspec
+- spec/commands/FinishedCommand.rb
 - spec/commands/command_spec.rb
 - spec/commands/story_commit_spec.rb
 - spec/commands/story_merge_spec.rb
@@ -81,6 +83,7 @@ signing_key:
 specification_version: 3
 summary: See the README for full documentation
 test_files:
+- spec/commands/FinishedCommand.rb
 - spec/commands/command_spec.rb
 - spec/commands/story_commit_spec.rb
 - spec/commands/story_merge_spec.rb