pivotal-github 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ec9bc112f32b279089cbca37fa39bcd8a72bc07
-  data.tar.gz: dc07621e400fc821a175df1e928ff4c31e6c4193
+  metadata.gz: 5672ce3f4df8fdbdea49b112f1537d6ade0700c6
+  data.tar.gz: d6e4d7f5c7ad72b974eeebac0dc39e641b6f556c
 SHA512:
-  metadata.gz: 0580d4c0e1175daf5cee0f09c69561bca87c6c2eefc20065666424d52c9e0391f0dbb8ff609aefcf9f9fee00fee561c6731b8af98025ca812b9f9f108076623d
-  data.tar.gz: c731e0102496125328146b8514c3c366306e32c0a063df1abd120ca4ea76d7f6f0e4add67489998db5a11397ccb201cf76010ddf52d8fbb4437cd38739989f7d
+  metadata.gz: 023d5468e238d7ebc8f4e82c1d029fb59ee2cf19bc2030ee9ed5ba010dd3e9feb36c819bfcb9c8ad4f064f0fe8db7ad28cf46a956353f387c003c6933e315d7f
+  data.tar.gz: bf5acac1a04b0844c5594dbea15361c9b7b6c61307521d3dc8fe2876ec2344eaf920a3efcf6faf677a68b1b2ad815938432c9322b6f6616ed41bdada7807d5fe

data/README.md

@@ -25,7 +25,7 @@ The full set of commands is as follows:
 For example, when on a branch called `add-markdown-support-62831853`, the `git story-commit` command automatically adds `[#62831853]` to the commit message:
 
     $ git story-commit -am "Add foo bars"
-	[add-markdown-support-62831853 6f56414] Add foo bars
+    [add-markdown-support-62831853 6f56414] Add foo bars
 
 The commit message is multiline and includes the story id:
 
@@ -62,7 +62,7 @@ Either the `-f` flag or the `-d` flag can be combined with other flags, yielding
 `git story commit` supports multiple story numbers as well. For example, with a branch called `add-things-62831853-31415926`, we could deliver both stories as follows:
 
     $ git story-commit -dam "Remove baz quuxes"
-	[add-things-62831853-31415926 7g56429] Remove baz quuxes
+    [add-things-62831853-31415926 7g56429] Remove baz quuxes
 
 The message here is
 
@@ -72,38 +72,39 @@ The message here is
 
 #### Options
 
-	$ git story-commit -h
-	    Usage: git story-commit [options]
-	        -m, --message MESSAGE            add a commit message (including story #)
-	        -f, --finish                     mark story as finished
-	        -d, --deliver                    mark story as delivered
-	        -a, --all                        commit all changed files
-	        -h, --help                       this usage guide
+    $ git story-commit -h
+        Usage: git story-commit [options]
+            -m, --message MESSAGE            add a commit message (including story #)
+            -f, --finish                     mark story as finished
+            -d, --deliver                    mark story as delivered
+            -a, --all                        commit all changed files
+            -h, --help                       this usage guide
 
 Additionally, `git story-commit` accepts any options valid for `git commit`. (`git story-commit` supports the `-a` flag even though that's a valid option to `git commit` so that the compound flag in `git story-commit -am "message"` works.)
 
 ### git story-merge
 
-`git story-merge` merges the current branch into `master`. On a branch called `add-markdown-support-62831853`, `git story-merge` is equivalent to the following:
+`git story-merge` merges the current branch into the target branch (defaults to `master`). On a branch called `add-markdown-support-62831853`, `git story-merge` is equivalent to the following:
 
     $ git checkout master
-    $ git merge --no-ff --log add-markdown-support-62831853
+    $ git merge --no-ff --log add-markdown-support-62831853 -m "#[62831853]"
 
 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 than that cost.
 
-In addition, the `--log` option puts the commit messages from the individual commits in the merge message, which arranges for the merge commit itself to appear in the activity log at Pivotal Tracker. This is especially useful for viewing the full diff represented by the commit.
+The `--log` option puts the commit messages from the individual commits in the merge message, while the `-m` flag adds the story id to the commit (optionally marking it finished or delivered with the `-f` or `-d` flag, respectively). Including the story id arranges for the merge commit itself to appear in the activity log at Pivotal Tracker, which is especially useful for viewing the full diff represented by the story.
 
 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', 'Delivered', 'Fixes', or 'Fixed'). This behavior can be overriden with the `--force` option.
+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', 'Delivered', 'Fixes', or 'Fixed'). This behavior can be overriden with the `--override` option.
 
 #### Options
 
-    Usage: git story-merge [options]
-        -d, --development BRANCH         development branch (defaults to master)
-	    -f, --force                      override unfinished story warning
+    Usage: git story-merge [branch] [options]
+        -o, --override                   override unfinished story warning
+        -f, --finish                     mark story as finished
+        -d, --deliver                    mark story as delivered
         -h, --help                       this usage guide
 
 Additionally, `git story-merge` accepts any options valid for `git merge`.
@@ -121,7 +122,7 @@ As with `git story-merge`, by default `git story-pull-request` exits with a warn
 #### Options
 
     Usage: git story-pull-request [options]
-    	-f, --force                      override unfinished story warning
+        -o, --override                   override unfinished story warning
         -h, --help                       this usage guide
 
 ### story-open

data/lib/pivotal-github/command.rb

@@ -14,7 +14,7 @@ class Command
   def parse
     self.known_options   = Options::known_options(parser, args)
     self.unknown_options = Options::unknown_options(parser, args)
-    parser.parse(known_options)
+    parser.parse!(known_options)
   end
 
   def parser
@@ -40,6 +40,26 @@ class Command
     story_ids.first
   end
 
+  # Returns the message for the story id(s) and action (if any).
+  def message
+    if finish?
+      label = "Finishes #{message_ids}"
+    elsif deliver?
+      label = "Delivers #{message_ids}"
+    else
+      label = message_ids
+    end
+    "[#{label}]"
+  end
+
+  # Returns the story ids formatted for story commits.
+  # For single-id stories, this is just the number preceded by '#', as in
+  # '#62831853'. For multiple-id stories, each story id is precede by '#', as in
+  # '#62831853 #31415926'
+  def message_ids
+    story_ids.map { |id| "##{id}" }.join(' ')
+  end
+
   # Runs a command.
   # If the argument array contains '--debug', returns the command that would
   # have been run.
@@ -77,4 +97,12 @@ class Command
         exit 1
       end
     end
+
+    def finish?
+      options.finish
+    end
+
+    def deliver?
+      options.deliver
+    end
 end

data/lib/pivotal-github/finished_command.rb

@@ -2,7 +2,7 @@
 class FinishedCommand < Command
 
   def run!
-    check_finishes unless force?
+    check_finishes unless override?
     system cmd
   end
 
@@ -26,7 +26,7 @@ class FinishedCommand < Command
       !!(`git log -1`.match(/Finishe(s|d)|Deliver(s|ed)|Fixe(s|d) #\d+/i))
     end
 
-    def force?
-      options.force
+    def override?
+      options.override
     end
 end

data/lib/pivotal-github/story_commit.rb

@@ -24,26 +24,6 @@ class StoryCommit < Command
     end
   end
 
-  # Returns the message for the story id(s) and action (if any).
-  def message
-    if finish?
-      label = "Finishes #{message_ids}"
-    elsif deliver?
-      label = "Delivers #{message_ids}"
-    else
-      label = message_ids
-    end
-    "[#{label}]"
-  end
-
-  # Returns the story ids formatted for story commits.
-  # For single-id stories, this is just the number preceded by '#', as in
-  # '#62831853'. For multiple-id stories, each story id is precede by '#', as in
-  # '#62831853 #31415926'
-  def message_ids
-    story_ids.map { |id| "##{id}" }.join(' ')
-  end
-
   # Returns a command appropriate for executing at the command line.
   # We take care to insert the story number and, if necessary, an indication
   # that the commit finishes the story.
@@ -62,14 +42,6 @@ class StoryCommit < Command
 
   private
 
-    def finish?
-      options.finish
-    end
-
-    def deliver?
-      options.deliver
-    end
-
     def message?
       !options.message.nil?
     end

data/lib/pivotal-github/story_merge.rb

@@ -5,13 +5,17 @@ class StoryMerge < FinishedCommand
 
   def parser
     OptionParser.new do |opts|
-      opts.banner = "Usage: git story-merge [options]"
-      opts.on("-d", "--development BRANCH",
-              "development branch (defaults to master)") do |opt|
-        self.options.development = opt
+      opts.banner = "Usage: git story-merge [branch] [options]"
+      opts.on("-o", "--override", "override unfinished story warning") do |opt|
+        self.options.override = opt
       end
-      opts.on("-f", "--force", "override unfinished story warning") do |opt|
-        self.options.force = opt
+      opts.on("-f", "--finish", "mark story as finished") do |opt|
+        self.options.finish = opt
+        self.options.override = opt
+      end
+      opts.on("-d", "--deliver", "mark story as delivered") do |opt|
+        self.options.deliver = opt
+        self.options.override = opt
       end
       opts.on_tail("-h", "--help", "this usage guide") do
         puts opts.to_s; exit 0
@@ -24,8 +28,9 @@ class StoryMerge < FinishedCommand
   #   git checkout master
   #   git merge --no-ff <story branch>
   def cmd
-    lines = ["git checkout #{development_branch}"]
-    c = ['git merge --no-ff --log']
+    lines = ["git checkout #{target_branch}"]
+    c = ["git merge --no-ff --log"]
+    c << %(-m "#{message}")
     c << argument_string(unknown_options) unless unknown_options.empty?
     c << story_branch
     lines << c.join(' ')
@@ -34,7 +39,10 @@ class StoryMerge < FinishedCommand
 
   private
 
-    def development_branch
-      options.development || 'master'
+    # Returns the name of the branch to be merged into.
+    # If there is anything left in the known options after parsing,
+    # that's the merge branch. Otherwise, it's master.
+    def target_branch
+      self.known_options.first || 'master'
     end
 end

data/lib/pivotal-github/story_pull_request.rb

@@ -6,8 +6,8 @@ class StoryPullRequest < FinishedCommand
   def parser
     OptionParser.new do |opts|
       opts.banner = "Usage: git story-pull-request [options]"
-      opts.on("-f", "--force", "override unfinished story warning") do |opt|
-        self.options.force = opt
+      opts.on("-o", "--override", "override unfinished story warning") do |opt|
+        self.options.override = opt
       end
       opts.on_tail("-h", "--help", "this usage guide") do
         puts opts.to_s; exit 0

data/lib/pivotal-github/version.rb

@@ -1,5 +1,5 @@
 module Pivotal
   module Github
-    VERSION = "0.8.1"
+    VERSION = "0.9.0"
   end
 end

data/spec/commands/story_merge_spec.rb

@@ -17,23 +17,45 @@ describe StoryMerge do
 
   describe "with no options" do
     its(:cmd) { should match /git checkout master/ }
-    its(:cmd) { should match /git merge --no-ff --log #{command.story_branch}/ }
+    its(:cmd) do
+      msg = Regexp.escape("[##{command.story_id}]")
+      branch = command.story_branch
+      should match /git merge --no-ff --log -m "#{msg}" #{branch}/
+    end
+  end
+
+  describe "with the finish option" do
+    let(:command) { StoryMerge.new(['-f']) }
+    its(:cmd) do
+      msg = Regexp.escape("[Finishes ##{command.story_id}]")
+      branch = command.story_branch
+      should match /git merge --no-ff --log -m "#{msg}" #{branch}/
+    end
+  end
+
+  describe "with the delivers option" do
+    let(:command) { StoryMerge.new(['-d']) }
+    its(:cmd) do
+      msg = Regexp.escape("[Delivers ##{command.story_id}]")
+      branch = command.story_branch
+      should match /git merge --no-ff --log -m "#{msg}" #{branch}/
+    end
   end
 
   describe "with a custom development branch" do
-    let(:command) { StoryMerge.new(['-d', 'develop']) }
-    its(:cmd) { should match /git checkout develop/ }
+    let(:command) { StoryMerge.new(['development']) }
+    its(:cmd) { should match /git checkout development/ }
   end
 
   describe "with some unknown options" do
-    let(:command) { StoryMerge.new(['-d', 'develop', '-a', '-z', '--foo']) }
+    let(:command) { StoryMerge.new(['development', '-o', '-a', '-z', '--foo']) }
     it_should_behave_like "story-merge with known options"
     its(:cmd) { should match /-a -z --foo/ }
   end
 
   describe "command-line command" do
-    subject { `bin/git-story-merge --debug -ff -d develop` }
-    it { should match /git checkout develop/ }
-    it { should match /git merge --no-ff --log -ff/ }
+    subject { `bin/git-story-merge --debug development` }
+    it { should match /git checkout development/ }
+    it { should match /git merge --no-ff --log/ }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pivotal-github
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Michael Hartl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies: []
 description: Add commands for Pivotal Tracker-GitHub integration
 email: