pivotal-integration 1.6.0.1

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

@@ -0,0 +1,63 @@
+# 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_relative 'command'
+require_relative 'configuration'
+require_relative '../util/git'
+require_relative '../util/story'
+require 'pivotal-tracker'
+
+# An abstract base class for all commands
+# @abstract Subclass and override {#run} to implement command functionality
+class PivotalIntegration::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(options = {})
+    @options = options
+    @repository_root = PivotalIntegration::Util::Git.repository_root
+    @configuration = PivotalIntegration::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(*arguments)
+    raise NotImplementedError
+  end
+
+  def story
+    if @options[:story_id]
+      @configuration.project.stories.find(@options[:story_id])
+    else
+      @configuration.story
+    end
+  end
+
+  class << self
+    attr_reader :description
+
+    def desc(text)
+      @description = text
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# 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_relative '../../pivotal_integration'
+
+# A module encapsulating the commands for the project
+module PivotalIntegration::Command
+end

data/lib/pivotal-integration/command/comment.rb

@@ -0,0 +1,31 @@
+# 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_relative 'base'
+require 'pivotal-tracker'
+
+# The class that encapsulates assigning current Pivotal Tracker Story to a user
+class PivotalIntegration::Command::Comment < PivotalIntegration::Command::Base
+  desc "Add a comment to the current story"
+
+  def run(*arguments)
+    comment = arguments.first
+    abort "A comment must be provided." unless comment
+
+    print "Adding comment to story ##{story.id}... "
+    PivotalIntegration::Util::Story.add_comment(story, comment)
+    puts 'OK'
+  end
+end

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

@@ -0,0 +1,129 @@
+# 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_relative 'command'
+require_relative '../util/git'
+require 'highline/import'
+require 'pivotal-tracker'
+
+# A class that exposes configuration that commands can use
+class PivotalIntegration::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 multiple repositories.
+  #
+  # @return [String] The user's Pivotal Tracker API token
+  def api_token
+    api_token = PivotalIntegration::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
+      PivotalIntegration::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 = PivotalIntegration::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
+
+      PivotalIntegration::Util::Git.set_config KEY_PROJECT_ID, project_id, :local
+      puts
+    end
+
+    project_id
+  end
+
+  # Returns the Pivotal Tracker project for this repository.  If it is not
+  # configured yet, prompts the user for the value.
+  #
+  # @return [PivotalTracker::Project] The repository's Pivotal Tracker project
+  def project
+    PivotalTracker::Project.find project_id
+  end
+
+  # Returns the Pivotal Tracker user 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 user id
+  def user
+    user = PivotalIntegration::Util::Git.get_config KEY_USER, :inherited
+
+    if user.empty?
+      user = choose do |menu|
+        menu.prompt = 'Choose your user name associated with this repository: '
+
+        PivotalTracker::Project.all.map{ |p| p.memberships.all.map(&:name) }.flatten.uniq.each do |owner|
+          menu.choice(owner) { owner }
+        end
+      end
+
+      PivotalIntegration::Util::Git.set_config KEY_USER, user.inspect, :local
+    end
+
+    user
+  end
+
+  # Returns the story associated with the current development branch
+  #
+  # @return [PivotalTracker::Story] the story associated with the current development branch
+  def story
+    story_id = PivotalIntegration::Util::Git.get_config KEY_STORY_ID, :branch
+    if story_id.empty?
+      abort("You need to be on started story branch to do this!")
+    else
+      project.stories.find(story_id)
+    end
+  end
+
+  # Stores the story associated with the current development branch
+  #
+  # @param [PivotalTracker::Story] story the story associated with the current development branch
+  # @return [void]
+  def story=(story)
+    PivotalIntegration::Util::Git.set_config KEY_STORY_ID, story.id, :branch
+  end
+
+  private
+
+  KEY_API_TOKEN = 'pivotal.api-token'.freeze
+
+  KEY_USER = 'pivotal.user'.freeze
+
+  KEY_PROJECT_ID = 'pivotal.project-id'.freeze
+
+  KEY_STORY_ID = 'pivotal-story-id'.freeze
+
+end

data/lib/pivotal-integration/command/estimate.rb

@@ -0,0 +1,53 @@
+# 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_relative 'base'
+
+# The class that encapsulates starting a Pivotal Tracker Story
+class PivotalIntegration::Command::Estimate < PivotalIntegration::Command::Base
+  desc "Assign an estimate to the current story"
+
+  def run(*arguments)
+    score = arguments.first
+
+    unless score
+      case story.estimate
+      when -1
+        puts "Story is currently unestimated."
+      else
+        puts "Story is currently estimated #{story.estimate}."
+      end
+
+      score = self.class.collect_estimation(@configuration.project)
+    end
+
+    case score
+      when -1
+        print 'Changing to unestimated... '
+      else
+        print "Changing estimation to #{score}... "
+    end
+
+    PivotalIntegration::Util::Story.estimate(story, score)
+    puts 'OK'
+  end
+
+  def self.collect_estimation(project)
+    possible_scores = project.point_scale.split(',')
+    score = -1
+    score = ask("Choose an estimation for this story [#{possible_scores.join(', ')}, enter for none]: ") until possible_scores.include?(score) or score.blank?
+    score.blank? ? -1 : score
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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_relative 'base'
+
+# The class that encapsulates finishing a Pivotal Tracker Story
+class PivotalIntegration::Command::Finish < PivotalIntegration::Command::Base
+  desc "Finish working on a story"
+
+  # 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(*arguments)
+    no_complete = arguments.delete('--no-complete')
+    no_delete = arguments.delete('--no-delete')
+    no_merge = arguments.delete('--no-merge')
+    pull_request = arguments.delete('--pull-request') || PivotalIntegration::Util::Git.finish_mode == :pull_request
+
+    if pull_request
+      PivotalIntegration::Util::Git.push PivotalIntegration::Util::Git.branch_name
+      PivotalIntegration::Util::Git.create_pull_request(@configuration.story)
+      PivotalIntegration::Util::Story.mark(@configuration.story, :finished)
+      return
+    end
+
+    unless no_merge
+      PivotalIntegration::Util::Git.trivial_merge?
+      PivotalIntegration::Util::Git.merge(@configuration.story, no_complete, no_delete)
+    end
+
+    PivotalIntegration::Util::Git.push PivotalIntegration::Util::Git.branch_name
+  end
+
+end

data/lib/pivotal-integration/command/info.rb

@@ -0,0 +1,30 @@
+# 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_relative 'base'
+require 'pivotal-tracker'
+
+# The class that encapsulates assigning current Pivotal Tracker Story to a user
+class PivotalIntegration::Command::Info < PivotalIntegration::Command::Base
+  desc "Get information on the current story"
+
+  def run(*arguments)
+    if story
+      PivotalIntegration::Util::Story.pretty_print story
+    else
+      abort "No story currently selected."
+    end
+  end
+end

data/lib/pivotal-integration/command/label.rb

@@ -0,0 +1,33 @@
+# 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_relative 'base'
+require_relative '../util/label'
+require 'pivotal-tracker'
+
+MODES = %w(add remove list once)
+
+# The class that encapsulates starting a Pivotal Tracker Story
+class PivotalIntegration::Command::Label < PivotalIntegration::Command::Base
+  desc "Manage labels for the current story"
+
+  # Adds labels for active story.
+  # @return [void]
+  def run(mode, *labels)
+    abort "You need to specify mode first [#{MODES}], e.g. 'git label add to_qa'" unless MODES.include? mode
+
+    PivotalIntegration::Util::Label.send(mode, story, *labels)
+  end
+end

data/lib/pivotal-integration/command/mark.rb

@@ -0,0 +1,44 @@
+# 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_relative 'base'
+require 'pivotal-tracker'
+
+# The class that encapsulates assigning current Pivotal Tracker Story to a user
+class PivotalIntegration::Command::Mark < PivotalIntegration::Command::Base
+  desc "Mark the current story with a given state"
+
+  STATES = %w(unstarted started finished delivered rejected accepted)
+
+  # Assigns story to user.
+  # @return [void]
+  def run(*arguments)
+    state = arguments.first
+    state = choose_state if state.nil? or !STATES.include?(state)
+
+    PivotalIntegration::Util::Story.mark(story, state)
+  end
+
+  private
+
+  def choose_state
+    choose do |menu|
+      menu.prompt = 'Choose story state from above list: '
+      STATES.each do |state|
+        menu.choice(state)
+      end
+    end
+  end
+end

data/lib/pivotal-integration/command/new.rb

@@ -0,0 +1,52 @@
+# 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_relative 'base'
+require 'pivotal-tracker'
+
+# The class that encapsulates starting a Pivotal Tracker Story
+class PivotalIntegration::Command::New < PivotalIntegration::Command::Base
+  desc "Create a new story"
+
+  STORY_TYPES = %w(feature bug chore release)
+  def run(*arguments)
+    options = self.class.collect_type_and_name(arguments)
+
+    puts
+    print 'Creating new story on Pivotal Tracker... '
+    PivotalIntegration::Util::Story.new(@configuration.project, *options)
+    puts 'OK'
+  end
+
+  class << self
+    def collect_type_and_name(arguments)
+      type = STORY_TYPES.include?(arguments.first.try(:downcase)) ? arguments.shift : choose_type
+      type = type.downcase.to_sym
+
+      name = arguments.shift || ask('Provide a name for the new story: ')
+
+      [name, type]
+    end
+
+  private
+
+    def choose_type
+      choose do |menu|
+        menu.prompt = 'What type of story do you want to create: '
+        STORY_TYPES.each { |type| menu.choice(type.titleize) }
+      end
+    end
+  end
+end

data/lib/pivotal-integration/command/open.rb

@@ -0,0 +1,31 @@
+# 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_relative 'base'
+require 'pivotal-tracker'
+require 'launchy'
+
+# The class that encapsulates assigning current Pivotal Tracker Story to a user
+class PivotalIntegration::Command::Open < PivotalIntegration::Command::Base
+  desc "Open the current story or project in a web browser."
+
+  def run(*arguments)
+    if arguments.first.try(:downcase) == 'project'
+      Launchy.open "https://www.pivotaltracker.com/s/projects/#{story.project_id}"
+    else
+      Launchy.open story.url
+    end
+  end
+end

data/lib/pivotal-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/pivotal-integration/command/release.rb

@@ -0,0 +1,54 @@
+# 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_relative 'base'
+require_relative '../version-update/gradle'
+
+# The class that encapsulates releasing a Pivotal Tracker Story
+class PivotalIntegration::Command::Release < PivotalIntegration::Command::Base
+  desc "Create a release for a story"
+
+  # 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 = PivotalIntegration::Util::Story.select_story(@project, filter.nil? ? 'release' : filter, 1)
+    PivotalIntegration::Util::Story.pretty_print story
+
+    updater = [
+      PivotalIntegration::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
+    PivotalIntegration::Util::Git.create_release_tag release_version, story
+    updater.update_version next_version
+    PivotalIntegration::Util::Git.create_commit "#{next_version} Development", story
+
+    PivotalIntegration::Util::Git.push PivotalIntegration::Util::Git.branch_name, "v#{release_version}"
+  end
+
+end