git-pivotal-tracker-integration 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a4c85be1137c7421af33a78659d9b9249533e1a
-  data.tar.gz: 00fd6f4fb8ebc93a351bfa7207d7f0d641f342f8
+  metadata.gz: af83c4208875d093dba4ab8cd22ea6f157179c41
+  data.tar.gz: ac6a9da4a881480cceca563859bbfce3016b572f
 SHA512:
-  metadata.gz: 3818abcd8243550a5edcd0449c0d1289b3ada53af8a0730522da9d37d9badf782915ab65f32614e83545226ed6d2ceff6762f5978ecb19f5a123f4f01b4a12f2
-  data.tar.gz: 441b962e073172b9035c7e052cdcc2f92878d9dad403c6ca9f5c4d6791fa21f312ef97b88c5e43c421cd6da93bbb831a299f049e30ca93fc08eae189eb1344e2
+  metadata.gz: 5e6a3d913df8b5c473aa16eb8d624d7e9abec62dd10cf959195f41c68c90b5bb48c253c5aacf858be6d4917705edfc7fbf9b4bc2d40bd5476985b06028f4a92c
+  data.tar.gz: 8ff57d1fd8e35a4d28803a522612ee77dada8c74ecc1746e5c1d0279e875cec4db3f64b3f4f9fc2695a5ab0b73808e75dabc15ec876eff89d2288e39ce658b49

data/README.md

@@ -1,4 +1,6 @@
 # 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)
 
 `git-pivotal-tracker-integration` provides a set of additional Git commands to help developers when working with [Pivotal Tracker][pivotal-tracker].
 
@@ -6,7 +8,7 @@
 
 
 ## Installation
-`git-pivotal-tracker-integration` requires at least **Ruby 2.0.0** and **Git 1.8.2.1** in order to run.  In order to install it, do the following:
+`git-pivotal-tracker-integration` requires at least **Ruby 1.8.7** and **Git 1.8.2.1** in order to run.  It is tested against Rubies _1.8.7_, _1.9.3_, and _2.0.0_.  In order to install it, do the following:
 
 ```plain
 $ gem install git-pivotal-tracker-integration
@@ -133,3 +135,34 @@ Merge 12345678-lorem-ipsum to master
 ```
 
 After merging, the development branch is deleted and the changes are pushed to the remote repository.
+
+### `git release [issue]`
+This command creates a release for a story.  It does this by updating the version string in the project and creating a tag.  This command can be run in two ways.  First it can be run specifying the release that you want to create.
+
+```plain
+$ git release 12345678
+```
+The other way the command can be run without specifying anything.  In this case, it will select the first release story (based on the backlog's order).
+
+```plain
+$ git release
+      Title: Lorem ipsum dolor sit amet, consectetur adipiscing elitattributes
+```
+
+Once a story has been selected by one of the two methods, the command then prompts for the release version and next development version.
+
+```plain
+$ git release
+      Title: Lorem ipsum dolor sit amet, consectetur adipiscing elitattributes
+
+Enter release version (current: 1.0.0.BUILD-SNAPSHOT): 1.0.0.M1
+Enter next development version (current: 1.0.0.BUILD-SNAPSHOT): 1.1.0.BUILD-SNAPSHOT
+Creating tag v1.0.0.M1... OK
+Pushing to origin... OK
+```
+
+Once these have been entered, the version string for the current project is updated to the release version and a tag is created.  Then the version string for the current project is updated to the next development version and a new commit along the original branch is created.  Finally the tag and changes are pushed to the remote sever.
+
+Version update is currently supported for the following kinds of projects.  If you do not see a project type that you would like supported, please open an issue or submit a pull request.
+
+* Gradle

data/bin/git-finish

@@ -1,5 +1,19 @@
 #!/usr/bin/env ruby -U
+# Git Pivotal Tracker Integration
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
-require "git-pivotal-tracker-integration/finish"
+require "git-pivotal-tracker-integration/command/finish"
 
-Finish.new().run
+GitPivotalTrackerIntegration::Command::Finish.new().run

data/bin/git-release

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby -U
+# Git Pivotal Tracker Integration
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "git-pivotal-tracker-integration/command/release"
+
+GitPivotalTrackerIntegration::Command::Release.new().run ARGV[0]

data/bin/git-start

@@ -1,5 +1,19 @@
 #!/usr/bin/env ruby -U
+# Git Pivotal Tracker Integration
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
-require "git-pivotal-tracker-integration/start"
+require "git-pivotal-tracker-integration/command/start"
 
-Start.new(ARGV).run
+GitPivotalTrackerIntegration::Command::Start.new().run ARGV[0]

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

@@ -0,0 +1,47 @@
+# Git Pivotal Tracker Integration
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# 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"
+
+# An abstract base class for all commands
+# @abstract Subclass and override {#run} to implement command functionality
+class GitPivotalTrackerIntegration::Command::Base
+
+  # Common initialization functionality for all command classes.  This
+  # enforces that:
+  # * the command is being run within a valid Git repository
+  # * the user has specified their Pivotal Tracker API token
+  # * all communication with Pivotal Tracker will be protected with SSL
+  # * the user has configured the project id for this repository
+  def initialize
+    @repository_root = GitPivotalTrackerIntegration::Util::Git.repository_root
+    @configuration = GitPivotalTrackerIntegration::Command::Configuration.new
+
+    PivotalTracker::Client.token = @configuration.api_token
+    PivotalTracker::Client.use_ssl = true
+
+    @project = PivotalTracker::Project.find @configuration.project_id
+  end
+
+  # The main entry point to the command's execution
+  # @abstract Override this method to implement command functionality
+  def run
+    raise NotImplementedError
+  end
+
+end

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

@@ -13,19 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "git-pivotal-tracker-integration/pivotal_configuration"
-require "pivotal-tracker"
-
-class Base
-
-  def initialize
-    PivotalTracker::Client.token = PivotalConfiguration.api_token
-    PivotalTracker::Client.use_ssl = true
-    @project = PivotalTracker::Project.find PivotalConfiguration.project_id
-  end
-
-  def current_branch
-    `git branch`.scan(/\* (.*)/)[0][0]
-  end
+require "git_pivotal_tracker_integration"
 
+# A module encapsulating the commands for the project
+module GitPivotalTrackerIntegration::Command
 end

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

@@ -0,0 +1,92 @@
+# Git Pivotal Tracker Integration
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# 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"
+
+# A class that exposes configuration that commands can use
+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.
+  #
+  # @return [String] The user's Pivotal Tracker API token
+  def api_token
+    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
+      puts
+    end
+
+    api_token
+  end
+
+  # Returns the Pivotal Tracker project id for this repository.  If this id
+  # has not been configuration, prompts the user for the value.  The value is
+  # checked for in the _inherited_ Git configuration, but is stored in the
+  # _local_ Git configuration so that it is specific to this repository.
+  #
+  # @return [String] The repository's Pivotal Tracker project id
+  def project_id
+    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: "
+
+        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
+      puts
+    end
+
+    project_id
+  end
+
+  # 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
+  def story(project)
+    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
+  # @return [void]
+  def story=(story)
+    GitPivotalTrackerIntegration::Util::Git.set_config @@KEY_STORY_ID, story.id, :branch
+  end
+
+  private
+
+  @@KEY_API_TOKEN = "pivotal.api-token"
+
+  @@KEY_PROJECT_ID = "pivotal.project-id"
+
+  @@KEY_STORY_ID = "pivotal-story-id"
+
+end

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

@@ -0,0 +1,36 @@
+# Git Pivotal Tracker Integration
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# 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"
+
+# The class that encapsulates finishing a Pivotal Tracker Story
+class GitPivotalTrackerIntegration::Command::Finish < GitPivotalTrackerIntegration::Command::Base
+
+  # Finishes a Pivotal Tracker story by doing the following steps:
+  # * Check that the pending merge will be trivial
+  # * Merge the development branch into the root branch
+  # * Delete the development branch
+  # * Push changes to remote
+  #
+  # @return [void]
+  def run
+    GitPivotalTrackerIntegration::Util::Git.trivial_merge?
+    GitPivotalTrackerIntegration::Util::Git.merge(@configuration.story @project)
+    GitPivotalTrackerIntegration::Util::Git.push GitPivotalTrackerIntegration::Util::Git.branch_name
+  end
+
+end

data/lib/git-pivotal-tracker-integration/command/prepare-commit-msg.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+# Git Pivotal Tracker Integration
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+CURRENT_BRANCH=$(git branch | grep "*" | sed "s/* //")
+STORY_ID=$(git config branch.$CURRENT_BRANCH.pivotal-story-id)
+
+if [[ $2 != "commit" && -n $STORY_ID ]]; then
+	ORIG_MSG_FILE="$1"
+	TEMP=$(mktemp /tmp/git-XXXXX)
+
+	(printf "\n\n[#$STORY_ID]" ; cat "$1") > "$TEMP"
+	cat "$TEMP" > "$ORIG_MSG_FILE"
+fi

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

@@ -0,0 +1,56 @@
+# Git Pivotal Tracker Integration
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# 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"
+
+# The class that encapsulates releasing a Pivotal Tracker Story
+class GitPivotalTrackerIntegration::Command::Release < GitPivotalTrackerIntegration::Command::Base
+
+  # Releases a Pivotal Tracker story by doing the following steps:
+  # * Update the version to the release version
+  # * Create a tag for the release version
+  # * Update the version to the new development version
+  # * Push tag and changes to remote
+  #
+  # @param [String, nil] filter a filter for selecting the release to start.  This
+  #   filter can be either:
+  #   * a story id
+  #   * +nil+
+  # @return [void]
+  def run(filter)
+    story = GitPivotalTrackerIntegration::Util::Story.select_story(@project, filter.nil? ? "release" : filter, 1)
+    GitPivotalTrackerIntegration::Util::Story.pretty_print story
+
+    updater = [
+      GitPivotalTrackerIntegration::VersionUpdate::Gradle.new(@repository_root)
+    ].find { |candidate| candidate.supports? }
+
+    current_version = updater.current_version
+    release_version = ask("Enter release version (current: #{current_version}): ")
+    next_version = ask("Enter next development version (current: #{current_version}): ")
+
+    updater.update_version release_version
+    GitPivotalTrackerIntegration::Util::Git.create_release_tag release_version, story
+    updater.update_version next_version
+    GitPivotalTrackerIntegration::Util::Git.create_commit "#{next_version} Development", story
+
+    GitPivotalTrackerIntegration::Util::Git.push GitPivotalTrackerIntegration::Util::Git.branch_name, "v#{release_version}"
+  end
+
+end

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

@@ -0,0 +1,64 @@
+# Git Pivotal Tracker Integration
+# Copyright (c) 2013 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# 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"
+
+# The class that encapsulates starting a Pivotal Tracker Story
+class GitPivotalTrackerIntegration::Command::Start < GitPivotalTrackerIntegration::Command::Base
+
+  # Starts a Pivotal Tracker story by doing the following steps:
+  # * Create a branch
+  # * Add default commit hook
+  # * Start the story on Pivotal Tracker
+  #
+  # @param [String, nil] filter a filter for selecting the story to start.  This
+  #   filter can be either:
+  #   * a story id
+  #   * a story type (feature, bug, chore)
+  #   * +nil+
+  # @return [void]
+  def run(filter)
+    story = GitPivotalTrackerIntegration::Util::Story.select_story @project, filter
+
+    GitPivotalTrackerIntegration::Util::Story.pretty_print story
+
+    development_branch_name = development_branch_name story
+    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")
+
+    start_on_tracker story
+  end
+
+  private
+
+  def development_branch_name(story)
+    branch_name = "#{story.id}-" + ask("Enter branch name (#{story.id}-<branch-name>): ")
+    puts
+    branch_name
+  end
+
+  def start_on_tracker(story)
+    print "Starting story on Pivotal Tracker... "
+    story.update(:current_state => "started")
+    puts "OK"
+  end
+
+end