git-pivotal-tracker-integration 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ab6418812979b1d65b9e4c9d33a67975836f6c8
-  data.tar.gz: 45724b0f38f57772b3aeeac354c9ebebdec5ab5f
+  metadata.gz: 66744288befe65d8035b2d7a43272279638c29d1
+  data.tar.gz: 5c32fce8530761fb62d760b87437c990c97aec55
 SHA512:
-  metadata.gz: f24d98487c07c4202880bf4bba635b4c6d5dd7e366cf154250653b0a040e5af8ee47024c161b129b89905ad9916d2df0711ad343c4764ef33efd22d2e98e0e8f
-  data.tar.gz: a1a44ebbbc319615ca85f75db4bde6a43cd3e3468456e2405ed5984393add4dbc70110f81efb938ebee357c88ca5e15d741b9cde9193f2343c5b2d96548fafc5
+  metadata.gz: 11e9572c059a8e47ca41dbe7b655a1188af613b24adc84f78a3c2896f8dfc62bd824617b0a03a87482e2bd66e3380df358c2e7a9871fd5ed92a4bbc187b53256
+  data.tar.gz: 63592f6a4cddbe4024d569e15dcf4fab816b265b9c51745d4a761ffd60a1225f5b024f0c3a38ea6ea94f4dd00b31c834ea43a29c2df82004ad1dda6ff3b45576

data/README.md

@@ -1,6 +1,9 @@
 # Git Pivotal Tracker Integration
-[![Gem Version](https://badge.fury.io/rb/git-pivotal-tracker-integration.png)](http://badge.fury.io/rb/git-pivotal-tracker-integration)
 [![Build Status](https://travis-ci.org/nebhale/git-pivotal-tracker-integration.png?branch=master)](https://travis-ci.org/nebhale/git-pivotal-tracker-integration)
+[![Gem Version](https://badge.fury.io/rb/git-pivotal-tracker-integration.png)](http://badge.fury.io/rb/git-pivotal-tracker-integration)
+[![Dependency Status](https://gemnasium.com/nebhale/git-pivotal-tracker-integration.png)](http://gemnasium.com/nebhale/git-pivotal-tracker-integration)
+[![Code Climate](https://codeclimate.com/github/nebhale/git-pivotal-tracker-integration.png)](https://codeclimate.com/github/nebhale/git-pivotal-tracker-integration)
+
 
 `git-pivotal-tracker-integration` provides a set of additional Git commands to help developers when working with [Pivotal Tracker][pivotal-tracker].
 
@@ -109,7 +112,7 @@ If it doesn't exist already, a `prepare-commit-msg` commit hook is added to your
 #
 ```
 
-### `git finish`
+### `git finish [--no-complete]`
 This command finishes a story by merging and cleaning up its branch and then pushing the changes to a remote server.  This command can only be run one way.
 
 ```plain
@@ -134,6 +137,14 @@ Merge 12345678-lorem-ipsum to master
 [Completes #12345678]
 ```
 
+If the `--no-complete` option is specified, the `Completed` statement in the commit message will be supressed.
+
+```plain
+Merge 12345678-lorem-ipsum to master
+
+[#12345678]
+```
+
 After merging, the development branch is deleted and the changes are pushed to the remote repository.
 
 ### `git release [issue]`

data/bin/git-finish

@@ -14,6 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git-pivotal-tracker-integration/command/finish"
+require 'git-pivotal-tracker-integration/command/finish'
 
-GitPivotalTrackerIntegration::Command::Finish.new().run
+GitPivotalTrackerIntegration::Command::Finish.new().run ARGV[0]

data/bin/git-release

@@ -14,6 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git-pivotal-tracker-integration/command/release"
+require 'git-pivotal-tracker-integration/command/release'
 
 GitPivotalTrackerIntegration::Command::Release.new().run ARGV[0]

data/bin/git-start

@@ -14,6 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git-pivotal-tracker-integration/command/start"
+require 'git-pivotal-tracker-integration/command/start'
 
 GitPivotalTrackerIntegration::Command::Start.new().run ARGV[0]

data/lib/git-pivotal-tracker-integration/command/base.rb

@@ -13,10 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git-pivotal-tracker-integration/command/command"
-require "git-pivotal-tracker-integration/command/configuration"
-require "git-pivotal-tracker-integration/util/git"
-require "pivotal-tracker"
+require 'git-pivotal-tracker-integration/command/command'
+require 'git-pivotal-tracker-integration/command/configuration'
+require 'git-pivotal-tracker-integration/util/git'
+require 'pivotal-tracker'
 
 # An abstract base class for all commands
 # @abstract Subclass and override {#run} to implement command functionality

data/lib/git-pivotal-tracker-integration/command/command.rb

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git_pivotal_tracker_integration"
+require 'git_pivotal_tracker_integration'
 
 # A module encapsulating the commands for the project
 module GitPivotalTrackerIntegration::Command

data/lib/git-pivotal-tracker-integration/command/configuration.rb

@@ -13,10 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git-pivotal-tracker-integration/command/command"
-require "git-pivotal-tracker-integration/util/git"
-require "highline/import"
-require "pivotal-tracker"
+require 'git-pivotal-tracker-integration/command/command'
+require 'git-pivotal-tracker-integration/util/git'
+require 'highline/import'
+require 'pivotal-tracker'
 
 # A class that exposes configuration that commands can use
 class GitPivotalTrackerIntegration::Command::Configuration
@@ -24,15 +24,15 @@ class GitPivotalTrackerIntegration::Command::Configuration
   # Returns the user's Pivotal Tracker API token.  If this token has not been
   # configured, prompts the user for the value.  The value is checked for in
   # the _inherited_ Git configuration, but is stored in the _global_ Git
-  # configuration so that it can be used across mutiple repositories.
+  # configuration so that it can be used across multiple repositories.
   #
   # @return [String] The user's Pivotal Tracker API token
   def api_token
-    api_token = GitPivotalTrackerIntegration::Util::Git.get_config @@KEY_API_TOKEN, :inherited
+    api_token = GitPivotalTrackerIntegration::Util::Git.get_config KEY_API_TOKEN, :inherited
 
     if api_token.empty?
-      api_token = ask("Pivotal API Token (found at https://www.pivotaltracker.com/profile): ").strip
-      GitPivotalTrackerIntegration::Util::Git.set_config @@KEY_API_TOKEN, api_token, :global
+      api_token = ask('Pivotal API Token (found at https://www.pivotaltracker.com/profile): ').strip
+      GitPivotalTrackerIntegration::Util::Git.set_config KEY_API_TOKEN, api_token, :global
       puts
     end
 
@@ -46,18 +46,18 @@ class GitPivotalTrackerIntegration::Command::Configuration
   #
   # @return [String] The repository's Pivotal Tracker project id
   def project_id
-    project_id = GitPivotalTrackerIntegration::Util::Git.get_config @@KEY_PROJECT_ID, :inherited
+    project_id = GitPivotalTrackerIntegration::Util::Git.get_config KEY_PROJECT_ID, :inherited
 
     if project_id.empty?
       project_id = choose do |menu|
-        menu.prompt = "Choose project associated with this repository: "
+        menu.prompt = 'Choose project associated with this repository: '
 
         PivotalTracker::Project.all.sort_by { |project| project.name }.each do |project|
           menu.choice(project.name) { project.id }
         end
       end
 
-      GitPivotalTrackerIntegration::Util::Git.set_config @@KEY_PROJECT_ID, project_id, :local
+      GitPivotalTrackerIntegration::Util::Git.set_config KEY_PROJECT_ID, project_id, :local
       puts
     end
 
@@ -67,26 +67,26 @@ class GitPivotalTrackerIntegration::Command::Configuration
   # Returns the story associated with the current development branch
   #
   # @param [PivotalTracker::Project] project the project the story belongs to
-  # @return [PivotalTracker::Story] the story assocated with the current development branch
+  # @return [PivotalTracker::Story] the story associated with the current development branch
   def story(project)
-    story_id = GitPivotalTrackerIntegration::Util::Git.get_config @@KEY_STORY_ID, :branch
+    story_id = GitPivotalTrackerIntegration::Util::Git.get_config KEY_STORY_ID, :branch
     project.stories.find story_id.to_i
   end
 
   # Stores the story associated with the current development branch
   #
-  # @param [PivotalTracker::Story] story the story assocated with the current development branch
+  # @param [PivotalTracker::Story] story the story associated with the current development branch
   # @return [void]
   def story=(story)
-    GitPivotalTrackerIntegration::Util::Git.set_config @@KEY_STORY_ID, story.id, :branch
+    GitPivotalTrackerIntegration::Util::Git.set_config KEY_STORY_ID, story.id, :branch
   end
 
   private
 
-  @@KEY_API_TOKEN = "pivotal.api-token"
+  KEY_API_TOKEN = 'pivotal.api-token'.freeze
 
-  @@KEY_PROJECT_ID = "pivotal.project-id"
+  KEY_PROJECT_ID = 'pivotal.project-id'.freeze
 
-  @@KEY_STORY_ID = "pivotal-story-id"
+  KEY_STORY_ID = 'pivotal-story-id'.freeze
 
 end

data/lib/git-pivotal-tracker-integration/command/finish.rb

@@ -13,9 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git-pivotal-tracker-integration/command/base"
-require "git-pivotal-tracker-integration/command/command"
-require "git-pivotal-tracker-integration/util/git"
+require 'git-pivotal-tracker-integration/command/base'
+require 'git-pivotal-tracker-integration/command/command'
+require 'git-pivotal-tracker-integration/util/git'
 
 # The class that encapsulates finishing a Pivotal Tracker Story
 class GitPivotalTrackerIntegration::Command::Finish < GitPivotalTrackerIntegration::Command::Base
@@ -27,9 +27,11 @@ class GitPivotalTrackerIntegration::Command::Finish < GitPivotalTrackerIntegrati
   # * Push changes to remote
   #
   # @return [void]
-  def run
+  def run(argument)
+    no_complete = argument =~ /--no-complete/
+
     GitPivotalTrackerIntegration::Util::Git.trivial_merge?
-    GitPivotalTrackerIntegration::Util::Git.merge(@configuration.story @project)
+    GitPivotalTrackerIntegration::Util::Git.merge(@configuration.story(@project), no_complete)
     GitPivotalTrackerIntegration::Util::Git.push GitPivotalTrackerIntegration::Util::Git.branch_name
   end
 

data/lib/git-pivotal-tracker-integration/command/release.rb

@@ -13,11 +13,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git-pivotal-tracker-integration/command/base"
-require "git-pivotal-tracker-integration/command/command"
-require "git-pivotal-tracker-integration/util/git"
-require "git-pivotal-tracker-integration/util/story"
-require "git-pivotal-tracker-integration/version-update/gradle"
+require 'git-pivotal-tracker-integration/command/base'
+require 'git-pivotal-tracker-integration/command/command'
+require 'git-pivotal-tracker-integration/util/git'
+require 'git-pivotal-tracker-integration/util/story'
+require 'git-pivotal-tracker-integration/version-update/gradle'
 
 # The class that encapsulates releasing a Pivotal Tracker Story
 class GitPivotalTrackerIntegration::Command::Release < GitPivotalTrackerIntegration::Command::Base
@@ -34,7 +34,7 @@ class GitPivotalTrackerIntegration::Command::Release < GitPivotalTrackerIntegrat
   #   * +nil+
   # @return [void]
   def run(filter)
-    story = GitPivotalTrackerIntegration::Util::Story.select_story(@project, filter.nil? ? "release" : filter, 1)
+    story = GitPivotalTrackerIntegration::Util::Story.select_story(@project, filter.nil? ? 'release' : filter, 1)
     GitPivotalTrackerIntegration::Util::Story.pretty_print story
 
     updater = [

data/lib/git-pivotal-tracker-integration/command/start.rb

@@ -13,11 +13,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git-pivotal-tracker-integration/command/base"
-require "git-pivotal-tracker-integration/command/command"
-require "git-pivotal-tracker-integration/util/git"
-require "git-pivotal-tracker-integration/util/story"
-require "pivotal-tracker"
+require 'git-pivotal-tracker-integration/command/base'
+require 'git-pivotal-tracker-integration/command/command'
+require 'git-pivotal-tracker-integration/util/git'
+require 'git-pivotal-tracker-integration/util/story'
+require 'pivotal-tracker'
 
 # The class that encapsulates starting a Pivotal Tracker Story
 class GitPivotalTrackerIntegration::Command::Start < GitPivotalTrackerIntegration::Command::Base
@@ -42,7 +42,7 @@ class GitPivotalTrackerIntegration::Command::Start < GitPivotalTrackerIntegratio
     GitPivotalTrackerIntegration::Util::Git.create_branch development_branch_name
     @configuration.story = story
 
-    GitPivotalTrackerIntegration::Util::Git.add_hook "prepare-commit-msg", File.join(File.dirname(__FILE__), "prepare-commit-msg.sh")
+    GitPivotalTrackerIntegration::Util::Git.add_hook 'prepare-commit-msg', File.join(File.dirname(__FILE__), 'prepare-commit-msg.sh')
 
     start_on_tracker story
   end
@@ -56,12 +56,12 @@ class GitPivotalTrackerIntegration::Command::Start < GitPivotalTrackerIntegratio
   end
 
   def start_on_tracker(story)
-    print "Starting story on Pivotal Tracker... "
+    print 'Starting story on Pivotal Tracker... '
     story.update(
-      :current_state => "started",
-      :owned_by => GitPivotalTrackerIntegration::Util::Git.get_config("user.name")
+      :current_state => 'started',
+      :owned_by => GitPivotalTrackerIntegration::Util::Git.get_config('user.name')
     )
-    puts "OK"
+    puts 'OK'
   end
 
 end

data/lib/git-pivotal-tracker-integration/util/git.rb

@@ -13,8 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git-pivotal-tracker-integration/util/shell"
-require "git-pivotal-tracker-integration/util/util"
+require 'git-pivotal-tracker-integration/util/shell'
+require 'git-pivotal-tracker-integration/util/util'
 
 # Utilities for dealing with Git
 class GitPivotalTrackerIntegration::Util::Git
@@ -26,21 +26,21 @@ class GitPivotalTrackerIntegration::Util::Git
   # @param [Boolean] overwrite whether to overwrite the hook if it already exists
   # @return [void]
   def self.add_hook(name, source, overwrite = false)
-    hooks_directory =  File.join repository_root, ".git", "hooks"
+    hooks_directory =  File.join repository_root, '.git', 'hooks'
     hook = File.join hooks_directory, name
 
     if overwrite || !File.exist?(hook)
       print "Creating Git hook #{name}...  "
 
       FileUtils.mkdir_p hooks_directory
-      File.open(source, "r") do |input|
-        File.open(hook, "w") do |output|
+      File.open(source, 'r') do |input|
+        File.open(hook, 'w') do |output|
           output.write(input.read)
           output.chmod(0755)
         end
       end
 
-      puts "OK"
+      puts 'OK'
     end
   end
 
@@ -48,7 +48,7 @@ class GitPivotalTrackerIntegration::Util::Git
   #
   # @return [String] the name of the currently checked out branch
   def self.branch_name
-    GitPivotalTrackerIntegration::Util::Shell.exec("git branch").scan(/\* (.*)/)[0][0]
+    GitPivotalTrackerIntegration::Util::Shell.exec('git branch').scan(/\* (.*)/)[0][0]
   end
 
   # Creates a branch with a given +name+.  First pulls the current branch to
@@ -60,17 +60,19 @@ class GitPivotalTrackerIntegration::Util::Git
   # @return [void]
   def self.create_branch(name, print_messages = true)
     root_branch = branch_name
-    root_remote = get_config @@KEY_REMOTE, :branch
+    root_remote = get_config KEY_REMOTE, :branch
 
     if print_messages; print "Pulling #{root_branch}... " end
-    GitPivotalTrackerIntegration::Util::Shell.exec "git pull --quiet --ff-only"
-    if print_messages; puts "OK" end
+    GitPivotalTrackerIntegration::Util::Shell.exec 'git pull --quiet --ff-only'
+    if print_messages; puts 'OK'
+    end
 
     if print_messages; print "Creating and checking out #{name}... " end
     GitPivotalTrackerIntegration::Util::Shell.exec "git checkout --quiet -b #{name}"
-    set_config @@KEY_ROOT_BRANCH, root_branch, :branch
-    set_config @@KEY_ROOT_REMOTE, root_remote, :branch
-    if print_messages; puts "OK" end
+    set_config KEY_ROOT_BRANCH, root_branch, :branch
+    set_config KEY_ROOT_REMOTE, root_remote, :branch
+    if print_messages; puts 'OK'
+    end
   end
 
   # Creates a commit with a given message.  The commit includes all change
@@ -98,13 +100,13 @@ class GitPivotalTrackerIntegration::Util::Git
 
     print "Creating tag v#{name}... "
 
-    create_branch @@RELEASE_BRANCH_NAME, false
+    create_branch RELEASE_BRANCH_NAME, false
     create_commit "#{name} Release", story
     GitPivotalTrackerIntegration::Util::Shell.exec "git tag v#{name}"
     GitPivotalTrackerIntegration::Util::Shell.exec "git checkout --quiet #{root_branch}"
-    GitPivotalTrackerIntegration::Util::Shell.exec "git branch --quiet -D #{@@RELEASE_BRANCH_NAME}"
+    GitPivotalTrackerIntegration::Util::Shell.exec "git branch --quiet -D #{RELEASE_BRANCH_NAME}"
 
-    puts "OK"
+    puts 'OK'
   end
 
   # Returns a Git configuration value.  This value is read using the +git
@@ -129,21 +131,21 @@ class GitPivotalTrackerIntegration::Util::Git
 
   # Merges the current branch to its root branch and deletes the current branch
   #
-  # @param [PivotalTracker::Story] story the story associated with the current
-  #   branch
+  # @param [PivotalTracker::Story] story the story associated with the current branch
+  # @param [Boolean] no_complete whether to suppress the +Completes+ statement in the commit message
   # @return [void]
-  def self.merge(story)
+  def self.merge(story, no_complete)
     development_branch = branch_name
-    root_branch = get_config @@KEY_ROOT_BRANCH, :branch
+    root_branch = get_config KEY_ROOT_BRANCH, :branch
 
     print "Merging #{development_branch} to #{root_branch}... "
     GitPivotalTrackerIntegration::Util::Shell.exec "git checkout --quiet #{root_branch}"
-    GitPivotalTrackerIntegration::Util::Shell.exec "git merge --quiet --no-ff -m \"Merge #{development_branch} to #{root_branch}\n\n[Completes ##{story.id}]\" #{development_branch}"
-    puts "OK"
+    GitPivotalTrackerIntegration::Util::Shell.exec "git merge --quiet --no-ff -m \"Merge #{development_branch} to #{root_branch}\n\n[#{no_complete ? '' : 'Completes '}##{story.id}]\" #{development_branch}"
+    puts 'OK'
 
     print "Deleting #{development_branch}... "
     GitPivotalTrackerIntegration::Util::Shell.exec "git branch --quiet -D #{development_branch}"
-    puts "OK"
+    puts 'OK'
   end
 
   # Push changes to the remote of the current branch
@@ -151,15 +153,15 @@ class GitPivotalTrackerIntegration::Util::Git
   # @param [String] refs the explicit references to push
   # @return [void]
   def self.push(*refs)
-    remote = get_config @@KEY_REMOTE, :branch
+    remote = get_config KEY_REMOTE, :branch
 
     print "Pushing to #{remote}... "
-    GitPivotalTrackerIntegration::Util::Shell.exec "git push --quiet #{remote} " + refs.join(" ")
-    puts "OK"
+    GitPivotalTrackerIntegration::Util::Shell.exec "git push --quiet #{remote} " + refs.join(' ')
+    puts 'OK'
   end
 
   # Returns the root path of the current Git repository.  The root is
-  # determined by ascending the path hierarcy, starting with the current
+  # determined by ascending the path hierarchy, starting with the current
   # working directory (+Dir#pwd+), until a directory is found that contains a
   # +.git/+ sub directory.
   #
@@ -169,8 +171,8 @@ class GitPivotalTrackerIntegration::Util::Git
     repository_root = Dir.pwd
 
     until Dir.entries(repository_root).any? { |child| File.directory?(child) && (child =~ /^.git$/) }
-      next_repository_root = File.expand_path("..", repository_root)
-      abort("Current working directory is not in a Git repository") unless repository_root != next_repository_root
+      next_repository_root = File.expand_path('..', repository_root)
+      abort('Current working directory is not in a Git repository') unless repository_root != next_repository_root
       repository_root =  next_repository_root
     end
 
@@ -210,33 +212,33 @@ class GitPivotalTrackerIntegration::Util::Git
   # @return [void]
   def self.trivial_merge?
     development_branch = branch_name
-    root_branch = get_config @@KEY_ROOT_BRANCH, :branch
+    root_branch = get_config KEY_ROOT_BRANCH, :branch
 
     print "Checking for trivial merge from #{development_branch} to #{root_branch}... "
 
     GitPivotalTrackerIntegration::Util::Shell.exec "git checkout --quiet #{root_branch}"
-    GitPivotalTrackerIntegration::Util::Shell.exec "git pull --quiet --ff-only"
+    GitPivotalTrackerIntegration::Util::Shell.exec 'git pull --quiet --ff-only'
     GitPivotalTrackerIntegration::Util::Shell.exec "git checkout --quiet #{development_branch}"
 
     root_tip = GitPivotalTrackerIntegration::Util::Shell.exec "git rev-parse #{root_branch}"
     common_ancestor = GitPivotalTrackerIntegration::Util::Shell.exec "git merge-base #{root_branch} #{development_branch}"
 
     if root_tip != common_ancestor
-      abort "FAIL"
+      abort 'FAIL'
     end
 
-    puts "OK"
+    puts 'OK'
   end
 
   private
 
-  @@KEY_REMOTE = "remote"
+  KEY_REMOTE = 'remote'.freeze
 
-  @@KEY_ROOT_BRANCH = "root-branch"
+  KEY_ROOT_BRANCH = 'root-branch'.freeze
 
-  @@KEY_ROOT_REMOTE = "root-remote"
+  KEY_ROOT_REMOTE = 'root-remote'.freeze
 
-  @@RELEASE_BRANCH_NAME = "pivotal-tracker-release"
+  RELEASE_BRANCH_NAME = 'pivotal-tracker-release'.freeze
 
 end