github-pivotal-flow 0.0.1

data/lib/github_pivotal_flow/shell.rb

@@ -0,0 +1,21 @@
+# Utilities for dealing with the shell
+module GithubPivotalFlow
+  class 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
+        puts "Failed command: #{command}"
+        abort 'FAIL'
+      end
+
+      result
+    end
+  end
+end

data/lib/github_pivotal_flow/start.rb

@@ -0,0 +1,40 @@
+# The class that encapsulates starting a Pivotal Tracker Story
+module GithubPivotalFlow
+  class Start < GithubPivotalFlow::Command
+    def run!
+      filter = @options[:args]
+      #TODO: Validate the format of the filter argument
+      story = Story.select_story @project, filter
+      Story.pretty_print story
+      story.request_estimation! if story.unestimated?
+      story.create_branch!
+      @configuration.story = story # Tag the branch with story attributes
+      Git.add_hook 'prepare-commit-msg', File.join(File.dirname(__FILE__), 'prepare-commit-msg.sh')
+      unless story.release?
+        @ghclient = GitHubAPI.new(@configuration, :app_url => 'http://github.com/roomorama/github-pivotal-flow')
+        create_pull_request_for_story!(story)
+      end
+      story.mark_started!
+      return 0
+    end
+
+    private
+
+    def create_pull_request_for_story!(story)
+      print "Creating pull-request on Github... "
+      @ghclient.create_pullrequest({:project => @configuration.github_project}.merge(story.params_for_pull_request))
+      puts 'OK'
+    end
+
+    def parse_argv(*args)
+      OptionParser.new do |opts|
+        opts.banner = "Usage: git start <feature|chore|bug|story_id>"
+        opts.on("-t", "--api-token=", "Pivotal Tracker API key") { |k| options[:api_token] = k }
+        opts.on("-p", "--project-id=", "Pivotal Tracker project id") { |p| options[:project_id] = p }
+        opts.on("-n", "--full-name=", "Your Pivotal Tracker full name") { |n| options[:full_name] = n }
+
+        opts.on_tail("-h", "--help", "This usage guide") { put opts.to_s; exit 0 }
+      end.parse!(args)
+    end
+  end
+end

data/lib/github_pivotal_flow/story.rb

@@ -0,0 +1,278 @@
+# Utilities for dealing with +PivotalTracker::Story+s
+module GithubPivotalFlow
+  class Story
+    attr_accessor :story, :branch_name, :root_branch_name
+
+    # 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
+      self.new(story)
+    end
+
+    # @param [PivotalTracker::Story] story the story to wrap
+    def initialize(story, options = {})
+      raise "Invalid PivotalTracker::Story" if story.nil?
+      @story = story
+      @branch_name = options.delete(:branch_name)
+      @branch_suffix = @branch_name.split('-').last if @branch_name
+      @branch_suffix ||= ''
+    end
+
+    def release?
+      story.story_type == 'release'
+    end
+
+    def unestimated?
+      estimate == -1
+    end
+
+    def request_estimation!
+      self.story.update(
+        :estimate => ask('Story is not yet estimated. Please estimate difficulty: ')
+      )
+    end
+
+    def mark_started!
+      print 'Starting story on Pivotal Tracker... '
+      self.story.update(
+          :current_state => 'started',
+          :owned_by => Git.get_config('user.name', :inherited)
+      )
+      puts 'OK'
+    end
+
+    def create_branch!(commit_message = nil)
+      commit_message ||= "Starting [#{story.story_type} ##{story.id}]: #{story.name}"
+      set_branch_suffix
+      print "Creating branch for story with branch name #{branch_name} from #{root_branch_name}... "
+      Git.checkout(root_branch_name)
+      root_origin = Git.get_remote
+      Git.pull_remote
+      Git.create_branch(branch_name, root_branch_name)
+      Git.checkout(branch_name)
+      Git.set_config('root-branch', root_branch_name, :branch)
+      Git.set_config('root-remote', root_origin, :branch)
+      Git.commit(commit_message: commit_message, allow_empty: true)
+      Git.publish(branch_name)
+    end
+
+    def merge_to_root!(commit_message = nil, options = {})
+      commit_message ||= "Merge #{branch_name} to #{root_branch_name}"
+      commit_message << "\n\n[#{options[:no_complete] ? '' : 'Completes '}##{story.id}] "
+      print "Merging #{branch_name} to #{root_branch_name}... "
+      Git.checkout(root_branch_name)
+      Git.pull_remote(root_branch_name)
+      Git.merge(branch_name, commit_message: commit_message, no_ff: true)
+      self.delete_branch!
+      Git.publish(root_branch_name)
+      self.cleanup!
+    end
+
+    def merge_release!(commit_message = nil, options = {})
+      commit_message ||= "Release #{story.name}"
+      commit_message << "\n\n[#{options[:no_complete] ? '' : 'Completes '}##{story.id}] "
+      print "Merging #{branch_name} to #{master_branch_name}... "
+      Git.checkout(master_branch_name)
+      Git.pull_remote(master_branch_name)
+      Git.merge(master_branch_name, commit_message: commit_message, no_ff: true)
+      Git.tag(story.name)
+      print "Merging #{branch_name} to #{root_branch_name}... "
+      Git checkout(root_branch_name)
+      Git.pull_remote(root_branch_name)
+      Git.merge(branch_name, commit_message: commit_message, no_ff: true)
+      Git.checkout(master_branch_name)
+      self.delete_branch!
+      Git.publish(master_branch_name)
+      Git.publish(development_branch_name)
+      Git.push_tags
+      self.cleanup!
+    end
+
+    def delete_branch!
+      print "Deleting #{branch_name}... "
+      Git.delete_branch(branch_name)
+      puts 'OK'
+    end
+
+    def cleanup!
+      Git.delete_remote_branch(branch_name)
+    end
+
+    #def create_pull_request!
+    #  Shell.exec("hub pull-request -m \"#{self.name}\n\n#{self.description}\" -b #{root_branch_name} -h #{branch_name}")
+    #end
+
+    def set_branch_suffix
+      @branch_suffix = ask("Enter branch name (#{branch_name_from(branch_prefix, story.id, "<branch-name>")}): ")
+    end
+
+    def branch_name_from(branch_prefix, story_id, branch_name)
+      if story_type == 'release'
+        # For release branches the format is release/5.0
+        "#{Git.get_config('gitflow.prefix.release', :inherited)}/#{branch_name}"
+      else
+        n = "#{branch_prefix}/#{story_id}"
+        n << "-#{branch_name}" unless branch_name.blank?
+        n
+      end
+    end
+
+    def branch_name
+      @branch_name ||= branch_name_from(branch_prefix, story.id, @branch_suffix)
+    end
+
+    def root_branch_name
+      case story_type
+      when 'chore'
+        master_branch_name
+      when 'bug'
+        self.labels.include?('hotfix') ? master_branch_name : development_branch_name
+      else
+        development_branch_name
+      end
+    end
+
+    def master_branch_name
+      Git.get_config('gitflow.branch.master', :inherited)
+    end
+
+    def development_branch_name
+      Git.get_config('gitflow.branch.develop', :inherited)
+    end
+
+    def labels
+      return [] if story.labels.blank?
+      story.labels.split(',').collect(&:strip)
+    end
+
+    def params_for_pull_request
+      {
+        :base => root_branch_name,
+        :head => branch_name,
+        :title => name,
+        :body => description,
+      }
+    end
+
+    def method_missing(m, *args, &block)
+      return @story.send(m, *args, &block)
+    end
+
+    def can_merge?
+      print "Checking for trivial merge from #{branch_name} to #{root_branch_name}... "
+      Git.pull_remote(root_branch_name)
+      root_tip = Shell.exec "git rev-parse #{root_branch_name}"
+      common_ancestor = Shell.exec "git merge-base #{root_branch_name} #{branch_name}"
+
+      if root_tip != common_ancestor
+        abort 'FAIL'
+      end
+
+      puts 'OK'
+    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
+
+    def branch_prefix
+      case self.story_type
+      when 'feature'
+        'feature'
+      when 'bug'
+        self.labels.include?('hotfix') ? 'hotfix' : 'feature'
+      when 'release'
+        'release'
+      when 'chore'
+        'chore'
+      else
+        'misc'
+      end
+    end
+  end
+end

data/spec/github_pivotal_flow/configuration_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+module GithubPivotalFlow
+  describe Configuration do
+
+    before do
+      $stdout = StringIO.new
+      $stderr = StringIO.new
+      @configuration = Configuration.new
+    end
+
+    it 'does not prompt the user for the API token if it is already configured' do
+      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 'prompts the user for the API token if it is not configured' do
+      Git.should_receive(:get_config).with('pivotal.api-token', :inherited).and_return('')
+      @configuration.should_receive(:ask).and_return('test_api_token')
+      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 'does not prompt the user for the project id if it is already configured' do
+      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 'prompts the user for the API token if it is not configured' do
+      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')
+      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 'persists the story when requested' do
+      Git.should_receive(:set_config).with('pivotal-story-id', 12345678, :branch)
+
+      @configuration.story = Story.new(PivotalTracker::Story.new(:id => 12345678))
+    end
+
+    it 'return a story when requested' do
+      project = double('project')
+      stories = double('stories')
+      story = double('story')
+      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_a(Story)
+    end
+  end
+end

data/spec/github_pivotal_flow/finish_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module GithubPivotalFlow
+  describe Finish do
+
+    before do
+      $stdout = StringIO.new
+      $stderr = StringIO.new
+
+      @project = double('project')
+      @story = double('story')
+      Git.should_receive(:repository_root)
+      Configuration.any_instance.should_receive(:api_token)
+      Configuration.any_instance.should_receive(:project_id)
+      PivotalTracker::Project.should_receive(:find).and_return(@project)
+      @finish = Finish.new
+    end
+
+    it 'merges the branch back to its root by default' do
+      Configuration.any_instance.should_receive(:story).and_return(@story)
+      @story.should_receive(:release?).and_return(false)
+      @story.should_receive(:can_merge?).and_return(true)
+      @story.should_receive(:merge_to_root!)
+
+      @finish.run!
+    end
+
+    it 'merges as a release instead if it is a release branch' do
+      Configuration.any_instance.should_receive(:story).and_return(@story)
+      @story.should_receive(:release?).and_return(true)
+      @story.should_receive(:can_merge?).and_return(true)
+      @story.should_receive(:merge_release!)
+
+      @finish.run!
+    end
+  end
+end