spire-git-pivotal-tracker 1.0.0

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'
+
+# Utilities 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,124 @@
+# 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'
+
+# Utilities 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)
+    if filter =~ /[[:digit:]]/
+      story = project.stories.find filter.to_i
+    else
+      story = find_story project, filter, limit
+    end
+
+    story
+  end
+
+  private
+
+  CANDIDATE_STATES = %w(rejected unstarted unscheduled).freeze
+
+  LABEL_DESCRIPTION = 'Description'.freeze
+
+  LABEL_TITLE = 'Title'.freeze
+
+  LABEL_WIDTH = (LABEL_DESCRIPTION.length + 2).freeze
+
+  CONTENT_WIDTH = (HighLine.new.output_cols - LABEL_WIDTH).freeze
+
+  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)
+    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
+  #   initialization, +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

data/lib/git-pivotal-tracker-integration/version-update/version_update.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 version update implementations
+module GitPivotalTrackerIntegration::VersionUpdate
+end

data/lib/git_pivotal_tracker_integration.rb

@@ -0,0 +1,18 @@
+# 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.
+
+# The root module for the project
+module GitPivotalTrackerIntegration
+end

data/spec/git-pivotal-tracker-integration/command/base_spec.rb

@@ -0,0 +1,38 @@
+# 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 'spec_helper'
+require 'git-pivotal-tracker-integration/command/base'
+require 'git-pivotal-tracker-integration/command/configuration'
+require 'git-pivotal-tracker-integration/util/git'
+
+describe GitPivotalTrackerIntegration::Command::Base do
+
+  before do
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    @project = double('project')
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:repository_root)
+    GitPivotalTrackerIntegration::Command::Configuration.any_instance.should_receive(:api_token)
+    GitPivotalTrackerIntegration::Command::Configuration.any_instance.should_receive(:project_id)
+    PivotalTracker::Project.should_receive(:find).and_return(@project)
+    @base = GitPivotalTrackerIntegration::Command::Base.new
+  end
+
+  it 'should not run' do
+    lambda { @base.run }.should raise_error
+  end
+end

data/spec/git-pivotal-tracker-integration/command/configuration_spec.rb

@@ -0,0 +1,91 @@
+# 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 'spec_helper'
+require 'git-pivotal-tracker-integration/command/configuration'
+require 'git-pivotal-tracker-integration/util/git'
+require 'pivotal-tracker'
+
+describe GitPivotalTrackerIntegration::Command::Configuration do
+
+  before do
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+    @configuration = GitPivotalTrackerIntegration::Command::Configuration.new
+  end
+
+  it 'should not prompt the user for the API token if it is already configured' do
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:get_config).with('pivotal.api-token', :inherited).and_return('test_api_token')
+
+    api_token = @configuration.api_token
+
+    expect(api_token).to eq('test_api_token')
+  end
+
+  it 'should prompt the user for the API token if it is not configured' do
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:get_config).with('pivotal.api-token', :inherited).and_return('')
+    @configuration.should_receive(:ask).and_return('test_api_token')
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:set_config).with('pivotal.api-token', 'test_api_token', :global)
+
+    api_token = @configuration.api_token
+
+    expect(api_token).to eq('test_api_token')
+  end
+
+  it 'should not prompt the user for the project id if it is already configured' do
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:get_config).with('pivotal.project-id', :inherited).and_return('test_project_id')
+
+    project_id = @configuration.project_id
+
+    expect(project_id).to eq('test_project_id')
+  end
+
+  it 'should prompt the user for the API token if it is not configured' do
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:get_config).with('pivotal.project-id', :inherited).and_return('')
+    menu = double('menu')
+    menu.should_receive(:prompt=)
+    PivotalTracker::Project.should_receive(:all).and_return([
+      PivotalTracker::Project.new(:id => 'id-2', :name => 'name-2'),
+      PivotalTracker::Project.new(:id => 'id-1', :name => 'name-1')])
+    menu.should_receive(:choice).with('name-1')
+    menu.should_receive(:choice).with('name-2')
+    @configuration.should_receive(:choose) { |&arg| arg.call menu }.and_return('test_project_id')
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:set_config).with('pivotal.project-id', 'test_project_id', :local)
+
+    project_id = @configuration.project_id
+
+    expect(project_id).to eq('test_project_id')
+  end
+
+  it 'should persist the story when requested' do
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:set_config).with('pivotal-story-id', 12345678, :branch)
+
+    @configuration.story = PivotalTracker::Story.new(:id => 12345678)
+  end
+
+  it 'should return a story when requested' do
+    project = double('project')
+    stories = double('stories')
+    story = double('story')
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:get_config).with('pivotal-story-id', :branch).and_return('12345678')
+    project.should_receive(:stories).and_return(stories)
+    stories.should_receive(:find).with(12345678).and_return(story)
+
+    result = @configuration.story project
+
+    expect(result).to be(story)
+  end
+
+end

data/spec/git-pivotal-tracker-integration/command/finish_spec.rb

@@ -0,0 +1,45 @@
+# 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 'spec_helper'
+require 'git-pivotal-tracker-integration/command/configuration'
+require 'git-pivotal-tracker-integration/command/finish'
+require 'git-pivotal-tracker-integration/util/git'
+require 'pivotal-tracker'
+
+describe GitPivotalTrackerIntegration::Command::Finish do
+
+  before do
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    @project = double('project')
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:repository_root)
+    GitPivotalTrackerIntegration::Command::Configuration.any_instance.should_receive(:api_token)
+    GitPivotalTrackerIntegration::Command::Configuration.any_instance.should_receive(:project_id)
+    PivotalTracker::Project.should_receive(:find).and_return(@project)
+    @finish = GitPivotalTrackerIntegration::Command::Finish.new
+  end
+
+  it 'should run' do
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:trivial_merge?)
+    GitPivotalTrackerIntegration::Command::Configuration.any_instance.should_receive(:story)
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:merge)
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:branch_name).and_return('master')
+    GitPivotalTrackerIntegration::Util::Git.should_receive(:push).with('master')
+
+    @finish.run nil
+  end
+end