spire-git-pivotal-tracker 1.0.0

data/lib/git-pivotal-tracker-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 '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,109 @@
+# 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'
+require 'github_api'
+
+# 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 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
+
+    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 associated 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 associated with the current development branch
+  # @return [void]
+  def story=(story)
+    GitPivotalTrackerIntegration::Util::Git.set_config KEY_STORY_ID, story.id, :branch
+  end
+
+  def github
+    token = GitPivotalTrackerIntegration::Util::Git.get_config GITHUB_API_OAUTH_TOKEN
+
+    if (token.empty?)
+      token = ask("Github OAuth Token (help.github.com/articles/creating-an-access-token-for-command-line-use): ").strip
+      GitPivotalTrackerIntegration::Util::Git.set_config(GITHUB_API_OAUTH_TOKEN, token, :local)
+    end
+
+    repo = GitPivotalTrackerIntegration::Util::Git.repo_name
+
+    ::Github.new(:oauth_token => token, :org => "spire-inc", :repo => repo, :user => "spire-inc")
+  end
+
+  private
+
+  KEY_API_TOKEN = 'pivotal.api-token'.freeze
+
+  KEY_PROJECT_ID = 'pivotal.project-id'.freeze
+
+  KEY_STORY_ID = 'pivotal-story-id'.freeze
+
+  GITHUB_API_OAUTH_TOKEN = 'workflow.github.oauth'.freeze
+  GITHUB_API_REPO_TOKEN = 'workflow.github.repo'.freeze
+
+end

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

@@ -0,0 +1,57 @@
+# 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(argument)
+    GitPivotalTrackerIntegration::Util::Git.verify_uncommitted_changes!
+
+    github = @configuration.github
+
+    story = @configuration.story(@project)
+
+    branch_name = GitPivotalTrackerIntegration::Util::Git.branch_name
+
+    print 'Creating PR on Github... '
+    pr = github.pull_requests.create(
+      user: github.user,
+      repo: github.repo,
+      base: GitPivotalTrackerIntegration::Util::Git.root_branch,
+      head: branch_name,
+      title: "Fixing #{branch_name}",
+      body: "#{story.name}\n#{story.description}\nPivotal Task: #{story.url}"
+    )
+    puts 'OK'
+    print 'Finishing story on Pivotal Tracker... '
+    story.update(
+      :current_state => 'finished',
+      :owned_by => GitPivotalTrackerIntegration::Util::Git.get_config('user.name')
+    )
+    puts 'OK'
+  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,67 @@
+# 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',
+      :owned_by => GitPivotalTrackerIntegration::Util::Git.get_config('user.name')
+    )
+    puts 'OK'
+  end
+
+end

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

@@ -0,0 +1,263 @@
+# 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/util/shell'
+require 'git-pivotal-tracker-integration/util/util'
+
+# Utilities for dealing with Git
+class GitPivotalTrackerIntegration::Util::Git
+
+  # Adds a Git hook to the current repository
+  #
+  # @param [String] name the name of the hook to add
+  # @param [String] source the file to use as the source for the created hook
+  # @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'
+    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|
+          output.write(input.read)
+          output.chmod(0755)
+        end
+      end
+
+      puts 'OK'
+    end
+  end
+
+  # Returns the name of the currently checked out branch
+  #
+  # @return [String] the name of the currently checked out branch
+  def self.branch_name
+    GitPivotalTrackerIntegration::Util::Shell.exec('git branch').scan(/\* (.*)/)[0][0]
+  end
+
+  def self.root_branch
+    get_config KEY_ROOT_BRANCH, :branch
+  end
+
+  def self.repo_name
+    GitPivotalTrackerIntegration::Util::Shell.exec('git config -l').scan(/spire\-inc\/(.*)\.git/)[0][0]
+  end
+
+  # Creates a branch with a given +name+.  First pulls the current branch to
+  # ensure that it is up to date and then creates and checks out the new
+  # branch.  If specified, sets branch-specific properties that are passed in.
+  #
+  # @param [String] name the name of the branch to create
+  # @param [Boolean] print_messages whether to print messages
+  # @return [void]
+  def self.create_branch(name, print_messages = true)
+    root_branch = branch_name
+    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
+
+    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
+  end
+
+  # Creates a commit with a given message.  The commit includes all change
+  # files.
+  #
+  # @param [String] message The commit message, which will be appended with
+  #   +[#<story-id]+
+  # @param [PivotalTracker::Story] story the story associated with the current
+  #   commit
+  # @return [void]
+  def self.create_commit(message, story)
+    GitPivotalTrackerIntegration::Util::Shell.exec "git commit --quiet --all --allow-empty --message \"#{message}\n\n[##{story.id}]\""
+  end
+
+  # Creates a tag with the given name.  Before creating the tag, commits all
+  # outstanding changes with a commit message that reflects that these changes
+  # are for a release.
+  #
+  # @param [String] name the name of the tag to create
+  # @param [PivotalTracker::Story] story the story associated with the current
+  #   tag
+  # @return [void]
+  def self.create_release_tag(name, story)
+    root_branch = branch_name
+
+    print "Creating tag v#{name}... "
+
+    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}"
+
+    puts 'OK'
+  end
+
+  def self.verify_uncommitted_changes!
+    result = `git diff --exit-code`
+    if $?.exitstatus != 0
+      abort "You have uncommitted changes!"
+    end
+    result = `git diff --staged --exit-code`
+
+    if $?.exitstatus != 0
+      abort "You have uncommitted staged changes!"
+    end
+  end
+
+  # Returns a Git configuration value.  This value is read using the +git
+  # config+ command. The scope of the value to read can be controlled with the
+  # +scope+ parameter.
+  #
+  # @param [String] key the key of the configuration to retrieve
+  # @param [:branch, :inherited] scope the scope to read the configuration from
+  #   * +:branch+: equivalent to calling +git config branch.branch-name.key+
+  #   * +:inherited+: equivalent to calling +git config key+
+  # @return [String] the value of the configuration
+  # @raise if the specified scope is not +:branch+ or +:inherited+
+  def self.get_config(key, scope = :inherited)
+    if :branch == scope
+      GitPivotalTrackerIntegration::Util::Shell.exec("git config branch.#{branch_name}.#{key}", false).strip
+    elsif :inherited == scope
+      GitPivotalTrackerIntegration::Util::Shell.exec("git config #{key}", false).strip
+    else
+      raise "Unable to get Git configuration for scope '#{scope}'"
+    end
+  end
+
+  # 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 [Boolean] no_complete whether to suppress the +Completes+ statement in the commit message
+  # @return [void]
+  def self.merge(story, no_complete)
+    development_branch = branch_name
+    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[#{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'
+  end
+
+  # Push changes to the remote of the current branch
+  #
+  # @param [String] refs the explicit references to push
+  # @return [void]
+  def self.push(*refs)
+    remote = get_config KEY_REMOTE, :branch
+
+    print "Pushing to #{remote}... "
+    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 hierarchy, starting with the current
+  # working directory (+Dir#pwd+), until a directory is found that contains a
+  # +.git/+ sub directory.
+  #
+  # @return [String] the root path of the Git repository
+  # @raise if the current working directory is not in a Git repository
+  def self.repository_root
+    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
+      repository_root =  next_repository_root
+    end
+
+    repository_root
+  end
+
+  # Sets a Git configuration value.  This value is set using the +git config+
+  # command.  The scope of the set value can be controlled with the +scope+
+  # parameter.
+  #
+  # @param [String] key the key of configuration to store
+  # @param [String] value the value of the configuration to store
+  # @param [:branch, :global, :local] scope the scope to store the configuration value in.
+  #   * +:branch+: equivalent to calling +git config --local branch.branch-name.key value+
+  #   * +:global+: equivalent to calling +git config --global key value+
+  #   * +:local+:  equivalent to calling +git config --local key value+
+  # @return [void]
+  # @raise if the specified scope is not +:branch+, +:global+, or +:local+
+  def self.set_config(key, value, scope = :local)
+    if :branch == scope
+      GitPivotalTrackerIntegration::Util::Shell.exec "git config --local branch.#{branch_name}.#{key} #{value}"
+    elsif :global == scope
+      GitPivotalTrackerIntegration::Util::Shell.exec "git config --global #{key} #{value}"
+    elsif :local == scope
+      GitPivotalTrackerIntegration::Util::Shell.exec "git config --local #{key} #{value}"
+    else
+      raise "Unable to set Git configuration for scope '#{scope}'"
+    end
+  end
+
+  # Checks whether merging the current branch back to its root branch would be
+  # a trivial merge.  A trivial merge is defined as one where the net change
+  # of the merge would be the same as the net change of the branch being
+  # merged.  The easiest way to ensure that a merge is trivial is to rebase a
+  # development branch onto the tip of its root branch.
+  #
+  # @return [void]
+  def self.trivial_merge?
+    development_branch = branch_name
+ 
+    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 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'
+    end
+
+    puts 'OK'
+  end
+
+  private
+
+  KEY_REMOTE = 'remote'.freeze
+
+  KEY_ROOT_BRANCH = 'root-branch'.freeze
+
+  KEY_ROOT_REMOTE = 'root-remote'.freeze
+
+  RELEASE_BRANCH_NAME = 'pivotal-tracker-release'.freeze
+
+end
+