git-pivotal-tracker-integration 1.1.0 → 1.2.0

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

@@ -0,0 +1,242 @@
+# 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
+
+  # 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
+
+  # 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
+  # @return [void]
+  def self.merge(story)
+    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[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 hierarcy, 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
+    root_branch = get_config @@KEY_ROOT_BRANCH, :branch
+    root_remote = get_config @@KEY_ROOT_REMOTE, :branch
+
+    print "Checking for trivial merge from #{development_branch} to #{root_branch}... "
+
+    GitPivotalTrackerIntegration::Util::Shell.exec "git fetch #{root_remote}"
+
+    remote_tip = GitPivotalTrackerIntegration::Util::Shell.exec "git rev-parse #{root_remote}/#{root_branch}"
+    local_tip = GitPivotalTrackerIntegration::Util::Shell.exec "git rev-parse #{root_branch}"
+    common_ancestor = GitPivotalTrackerIntegration::Util::Shell.exec "git merge-base #{root_branch} #{development_branch}"
+
+    if remote_tip != local_tip || local_tip != common_ancestor
+      abort "FAIL"
+    end
+
+    puts "OK"
+  end
+
+  private
+
+  @@KEY_REMOTE = "remote"
+
+  @@KEY_ROOT_BRANCH = "root-branch"
+
+  @@KEY_ROOT_REMOTE = "root-remote"
+
+  @@RELEASE_BRANCH_NAME = "pivotal-tracker-release"
+
+end
+

data/lib/git-pivotal-tracker-integration/util/shell.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/util/util"
+
+# Utilties for dealing with the shell
+class GitPivotalTrackerIntegration::Util::Shell
+
+  # Executes a command
+  #
+  # @param [String] command the command to execute
+  # @param [Boolean] abort_on_failure whether to +Kernel#abort+ with +FAIL+ as
+  #   the message when the command's +Status#existstatus+ is not +0+
+  # @return [String] the result of the command
+  def self.exec(command, abort_on_failure = true)
+    result = `#{command}`
+    if $?.exitstatus != 0 && abort_on_failure
+      abort "FAIL"
+    end
+
+    result
+  end
+
+end

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

@@ -0,0 +1,128 @@
+# 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/util"
+require "highline/import"
+require "pivotal-tracker"
+
+# Utilties for dealing with +PivotalTracker::Story+s
+class GitPivotalTrackerIntegration::Util::Story
+
+  # Print a human readable version of a story.  This pretty prints the title,
+  # description, and notes for the story.
+  #
+  # @param [PivotalTracker::Story] story the story to pretty print
+  # @return [void]
+  def self.pretty_print(story)
+    print_label @@LABEL_TITLE
+    print_value story.name
+
+    description = story.description
+    if !description.nil? && !description.empty?
+      print_label "Description"
+      print_value description
+    end
+
+    PivotalTracker::Note.all(story).sort_by { |note| note.noted_at }.each_with_index do |note, index|
+      print_label "Note #{index + 1}"
+      print_value note.text
+    end
+
+    puts
+  end
+
+  # Selects a Pivotal Tracker story by doing the following steps:
+  #
+  # @param [PivotalTracker::Project] project the project to select stories from
+  # @param [String, nil] filter a filter for selecting the story to start.  This
+  #   filter can be either:
+  #   * a story id: selects the story represented by the id
+  #   * a story type (feature, bug, chore): offers the user a selection of stories of the given type
+  #   * +nil+: offers the user a selection of stories of all types
+  # @param [Fixnum] limit The number maximum number of stories the user can choose from
+  # @return [PivotalTracker::Story] The Pivotal Tracker story selected by the user
+  def self.select_story(project, filter = nil, limit = 5)
+    story = nil
+
+    if filter =~ /[[:digit:]]/
+      story = project.stories.find filter.to_i
+    else
+      story = find_story project, filter, limit
+    end
+
+    story
+  end
+
+  private
+
+  @@CANDIDATE_STATES = ["rejected", "unstarted", "unscheduled"]
+
+  @@LABEL_DESCRIPTION = "Description"
+
+  @@LABEL_TITLE = "Title"
+
+  @@LABEL_WIDTH = @@LABEL_DESCRIPTION.length + 2
+
+  @@CONTENT_WIDTH = HighLine.new.output_cols - @@LABEL_WIDTH
+
+  def self.print_label(label)
+    print "%#{@@LABEL_WIDTH}s" % ["#{label}: "]
+  end
+
+  def self.print_value(value)
+    if value.nil? || value.empty?
+      puts ""
+    else
+      value.scan(/\S.{0,#{@@CONTENT_WIDTH - 2}}\S(?=\s|$)|\S+/).each_with_index do |line, index|
+        if index == 0
+          puts line
+        else
+          puts "%#{@@LABEL_WIDTH}s%s" % ["", line]
+        end
+      end
+    end
+  end
+
+  def self.find_story(project, type, limit)
+    story = nil
+
+    criteria = {
+      :current_state => @@CANDIDATE_STATES,
+      :limit => limit
+    }
+    if type
+      criteria[:story_type] = type
+    end
+
+    candidates = project.stories.all criteria
+    if candidates.length == 1
+      story = candidates[0]
+    else
+      story = choose do |menu|
+        menu.prompt = "Choose story to start: "
+
+        candidates.each do |story|
+          name = type ? story.name : "%-7s %s" % [story.story_type.upcase, story.name]
+          menu.choice(name) { story }
+        end
+      end
+
+      puts
+    end
+
+    story
+  end
+
+end

data/lib/git-pivotal-tracker-integration/util/util.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 utilities for the project
+module GitPivotalTrackerIntegration::Util
+end

data/lib/git-pivotal-tracker-integration/version-update/gradle.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/version-update/version_update"
+
+# A version updater for dealing with _typical_ Gradle projects.  This updater
+# assumes that the version of the current project is stored within a
+# +gradle.properties+ file in the root of the repository.  This properties
+# file should have an entry with a key of +version+ and version number as the key.
+class GitPivotalTrackerIntegration::VersionUpdate::Gradle
+
+  # Creates an instance of this updater
+  #
+  # @param [String] root The root of the repository
+  def initialize(root)
+    @gradle_properties = File.expand_path "gradle.properties", root
+
+    if File.exist? @gradle_properties
+      groups = nil
+      File.open(@gradle_properties, "r") do |file|
+        groups = file.read().scan(/version[=:](.*)/)
+      end
+      @version = groups[0] ? groups[0][0]: nil
+    end
+  end
+
+  # Whether this updater supports updating this project
+  #
+  # @return [Boolean] +true+ if a valid version number was found on
+  #   initiialization, +false+ otherwise
+  def supports?
+    !@version.nil?
+  end
+
+  # The current version of the project
+  #
+  # @return [String] the current version of the project
+  def current_version
+    @version
+  end
+
+  # Update the version of the project
+  #
+  # @param [String] new_version the version to update the project to
+  # @return [void]
+  def update_version(new_version)
+    contents = File.read(@gradle_properties)
+    contents = contents.gsub(/(version[=:])#{@version}/, "\\1#{new_version}")
+    File.open(@gradle_properties, "w") { |file| file.write(contents) }
+  end
+
+end