octopolo 0.3.6 → 0.4.0

data/lib/octopolo/github/pull_request_creator.rb

@@ -1,16 +1,10 @@
+require_relative "issue_creator"
 require_relative "../renderer"
 require 'tempfile'
 
 module Octopolo
   module GitHub
-    class PullRequestCreator
-      include ConfigWrapper
-      # for instantiating the pull request creator
-      attr_accessor :repo_name
-      attr_accessor :options
-      # for caputuring the created pull request information
-      attr_accessor :number
-      attr_accessor :pull_request_data
+    class PullRequestCreator < IssueCreator
 
       # Public: Create a pull request for the given repo with the given options
       #
@@ -20,23 +14,7 @@ module Octopolo
       #   destination_branch: Which branch to merge into
       #   source_branch: Which branch to be merged
       def initialize repo_name, options
-        self.repo_name = repo_name
-        self.options = options
-      end
-
-      # Public: Create a pull request for the given repo with the given options
-      #
-      # repo_name - Full name ("account/repo") of the repo in question
-      # options - Hash of pull request information
-      #   title: Title of the pull request
-      #   destination_branch: Which branch to merge into
-      #   source_branch: Which branch to be merged
-      #
-      # Returns the PullRequestCreator instance
-      def self.perform repo_name, options
-        new(repo_name, options).tap do |creator|
-          creator.perform
-        end
+        super(repo_name, options)
       end
 
       # Public: Create the pull request
@@ -47,21 +25,11 @@ module Octopolo
         result = GitHub.create_pull_request(repo_name, destination_branch, source_branch, title, body)
         # capture the information
         self.number = result.number
-        self.pull_request_data = result
+        self.data = result
       rescue => e
         raise CannotCreate, e.message
       end
 
-      # Public: The created pull request's details
-      def pull_request_data
-        @pull_request_data || raise(NotYetCreated)
-      end
-
-      # Public: The created pull request's number
-      def number
-        @number || raise(NotYetCreated)
-      end
-
       # Public: Branch to merge the pull request into
       #
       # Returns a String with the branch name
@@ -76,74 +44,21 @@ module Octopolo
         options[:source_branch] || raise(MissingAttribute)
       end
 
-      # Public: Title of the pull request
-      #
-      # Returns a String with the title
-      def title
-        options[:title] || raise(MissingAttribute)
-      end
-
-      # Public: The Pivotal Tracker story IDs associated with the pull request
-      #
-      # Returns an Array of Strings
-      def pivotal_ids
-        options[:pivotal_ids] || []
-      end
-
-      # Public: Jira Issue IDs associated with the pull request
+      # Public: Rendering template for body property
       #
-      # Returns an Array of Strings
-      def jira_ids
-        options[:jira_ids] || []
+      # Returns Name of template file
+      def renderer_template
+        Renderer::PULL_REQUEST_BODY
       end
 
-      # Public: Jira Url associated with the pull request
-      #
-      # Returns Jira Url
-      def jira_url
-        config.jira_url
-      end
 
-      # Public: The body (primary copy) of the pull request
+      # Public: Temporary file for body editing
       #
-      # Returns a String
-      def body
-        output = Renderer.render Renderer::PULL_REQUEST_BODY, body_locals
-        output = edit_body(output) if options[:editor]
-        output
-      end
-
-      def edit_body(body)
-        return body unless ENV['EDITOR']
-
-        # Open the file, write the contents, and close it
-        tempfile = Tempfile.new(['octopolo_pull_request', '.md'])
-        tempfile.write(body)
-        tempfile.close
-
-        # Allow the user to edit the file
-        system "#{ENV['EDITOR']} #{tempfile.path}"
-
-        # Reopen the file, read the contents, and delete it
-        tempfile.open
-        output = tempfile.read
-        tempfile.unlink
-
-        output
-      end
-
-      # Public: The local variables to pass into the template
-      def body_locals
-        {
-          pivotal_ids: pivotal_ids,
-          jira_ids: jira_ids,
-          jira_url: jira_url,
-        }
+      # Returns Name of temporary file
+      def body_edit_temp_name
+        'octopolo_pull_request'
       end
 
-      MissingAttribute = Class.new(StandardError)
-      NotYetCreated = Class.new(StandardError)
-      CannotCreate = Class.new(StandardError)
     end
   end
 end

data/lib/octopolo/renderer.rb

@@ -5,6 +5,7 @@ module Octopolo
   class Renderer
     # Constants for the template file names
     PULL_REQUEST_BODY = "pull_request_body"
+    ISSUE_BODY = "issue_body"
 
     # Public: Render a given ERB template
     #

data/lib/octopolo/scripts/issue.rb

@@ -0,0 +1,140 @@
+require_relative "../scripts"
+require_relative "../github"
+require_relative "../github/issue"
+require_relative "../github/issue_creator"
+require_relative "../pivotal/story_commenter"
+require_relative "../jira/story_commenter"
+
+module Octopolo
+  module Scripts
+    class Issue
+      include CLIWrapper
+      include ConfigWrapper
+      include GitWrapper
+
+      attr_accessor :title
+      attr_accessor :issue
+      attr_accessor :pivotal_ids
+      attr_accessor :jira_ids
+      attr_accessor :label
+      attr_accessor :options
+
+      def self.execute(options={})
+        new(options).execute
+      end
+
+      def initialize(options={})
+        @options = options
+      end
+
+      def execute
+        GitHub.connect do
+          ask_questionaire
+          create_issue
+          update_pivotal
+          update_jira
+          update_label
+          open_in_browser
+        end
+      end
+
+      # Protected: Ask questions to create an issue
+      def ask_questionaire
+        announce
+        ask_title
+        ask_label
+        ask_pivotal_ids if config.use_pivotal_tracker
+        ask_jira_ids if config.use_jira
+      end
+      protected :ask_questionaire
+
+      # Protected: Announce to the user the branches the issue will reference
+      def announce
+        cli.say "Preparing an issue for #{config.github_repo}."
+      end
+      protected :announce
+
+      # Protected: Ask for a title for the issue
+      def ask_title
+        self.title = cli.prompt "Title:"
+      end
+      protected :ask_title
+
+      # Protected: Ask for a label for the issue
+      def ask_label
+        choices = Octopolo::GitHub::Label.get_names(label_choices).concat(["None"])
+        response = cli.ask(label_prompt, choices)
+        self.label = Hash[label_choices.map{|l| [l.name,l]}][response]
+      end
+      protected :ask_label
+
+      # Protected: Ask for a Pivotal Tracker story IDs
+      def ask_pivotal_ids
+        self.pivotal_ids = cli.prompt("Pivotal Tracker story ID(s):").split(/[\s,]+/)
+      end
+      protected :ask_pivotal_ids
+
+      # Protected: Ask for a Pivotal Tracker story IDs
+      def ask_jira_ids
+        self.jira_ids = cli.prompt("Jira story ID(s):").split(/[\s,]+/)
+      end
+      protected :ask_pivotal_ids
+
+      # Protected: Create the issue
+      #
+      # Returns a GitHub::Issue object
+      def create_issue
+        self.issue = GitHub::Issue.create config.github_repo, issue_attributes
+      end
+      protected :create_issue
+
+      # Protected: The attributes to send to create the issue
+      #
+      # Returns a Hash
+      def issue_attributes
+        {
+          title: title,
+          pivotal_ids: pivotal_ids,
+          jira_ids: jira_ids,
+          editor: options[:editor]
+        }
+      end
+      protected :issue_attributes
+
+      # Protected: Handle the newly created issue
+      def open_in_browser
+        cli.copy_to_clipboard issue.url
+        cli.open issue.url
+      end
+      protected :open_in_browser
+
+      def label_prompt
+        'Label:'
+      end
+
+      def label_choices
+        Octopolo::GitHub::Label.all
+      end
+
+      def update_pivotal
+        pivotal_ids.each do |story_id|
+          Pivotal::StoryCommenter.new(story_id, issue.url).perform
+        end if pivotal_ids
+      end
+      protected :update_pivotal
+
+      def update_jira
+        jira_ids.each do |story_id|
+          Jira::StoryCommenter.new(story_id, issue.url).perform
+        end if jira_ids
+      end
+      protected :update_jira
+
+      def update_label
+        issue.add_labels(label) if label
+      end
+      protected :update_label
+
+    end
+  end
+end

data/lib/octopolo/scripts/pull_request.rb

@@ -1,22 +1,16 @@
 require_relative "../scripts"
+require_relative "../scripts/issue"
 require_relative "../github"
 require_relative "../pivotal/story_commenter"
 require_relative "../jira/story_commenter"
 
 module Octopolo
   module Scripts
-    class PullRequest
-      include CLIWrapper
-      include ConfigWrapper
-      include GitWrapper
-
-      attr_accessor :title
+    class PullRequest < Issue
       attr_accessor :pull_request
-      attr_accessor :pivotal_ids
-      attr_accessor :jira_ids
       attr_accessor :destination_branch
-      attr_accessor :label
-      attr_accessor :options
+
+      alias_method :issue, :pull_request
 
       def self.execute(destination_branch=nil, options={})
         new(destination_branch, options).execute
@@ -38,7 +32,7 @@ module Octopolo
           update_pivotal
           update_jira
           update_label
-          open_pull_request
+          open_in_browser
         end
       end
 
@@ -66,32 +60,6 @@ module Octopolo
       end
       private :alert_reserved_and_exit
 
-      # Private: Ask for a title for the pull request
-      def ask_title
-        self.title = cli.prompt "Title:"
-      end
-      private :ask_title
-
-      # Private: Ask for a label for the pull request
-      def ask_label
-        choices = Octopolo::GitHub::Label.get_names(label_choices).concat(["None"])
-        response = cli.ask(label_prompt, choices)
-        self.label = Hash[label_choices.map{|l| [l.name,l]}][response]
-      end
-      private :ask_label
-
-      # Private: Ask for a Pivotal Tracker story IDs
-      def ask_pivotal_ids
-        self.pivotal_ids = cli.prompt("Pivotal Tracker story ID(s):").split(/[\s,]+/)
-      end
-      private :ask_pivotal_ids
-
-      # Private: Ask for a Pivotal Tracker story IDs
-      def ask_jira_ids
-        self.jira_ids = cli.prompt("Jira story ID(s):").split(/[\s,]+/)
-      end
-      private :ask_pivotal_ids
-
       # Private: Create the pull request
       #
       # Returns a GitHub::PullRequest object
@@ -115,40 +83,6 @@ module Octopolo
       end
       private :pull_request_attributes
 
-      # Private: Handle the newly created pull request
-      def open_pull_request
-        cli.copy_to_clipboard pull_request.url
-        cli.open pull_request.url
-      end
-      private :open_pull_request
-
-      def label_prompt
-        'Label:'
-      end
-
-      def label_choices
-        Octopolo::GitHub::Label.all
-      end
-
-      def update_pivotal
-        pivotal_ids.each do |story_id|
-          Pivotal::StoryCommenter.new(story_id, pull_request.url).perform
-        end if pivotal_ids
-      end
-      private :update_pivotal
-
-      def update_jira
-        jira_ids.each do |story_id|
-          Jira::StoryCommenter.new(story_id, pull_request.url).perform
-        end if jira_ids
-      end
-      private :update_jira
-
-      def update_label
-        pull_request.add_labels(label) if label
-      end
-      private :update_label
-
     end
   end
 end

data/lib/octopolo/templates/issue_body.erb

@@ -0,0 +1,22 @@
+<%= description %>
+
+Deploy Plan
+-----------
+Describe how this change will be deployed.
+
+Rollback Plan
+-------------
+Describe how this change can be rolled back.
+
+URLs
+----
+<% pivotal_ids.each do |pivotal_id| -%>
+* [pivotal tracker story <%= pivotal_id %>](https://www.pivotaltracker.com/story/show/<%= pivotal_id %>)
+<% end -%>
+<% jira_ids.each do |jira_id| -%>
+* [Jira issue <%= jira_id %>](<%= jira_url %>/browse/<%= jira_id %>)
+<% end -%>
+
+QA Plan
+-------
+Provide a detailed QA plan, or other developers will retain the right to mock you mercilessly.

data/lib/octopolo/version.rb

@@ -1,3 +1,3 @@
 module Octopolo
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

data/spec/octopolo/github/issue_creator_spec.rb

@@ -0,0 +1,217 @@
+require "spec_helper"
+require_relative "../../../lib/octopolo/github/issue_creator"
+
+module Octopolo
+  module GitHub
+    describe IssueCreator do
+      let(:creator) { IssueCreator.new repo_name, options }
+      let(:repo_name) { "foo/bar" }
+      let(:options) { {} }
+      let(:title) { "title" }
+      let(:body) { "body" }
+      let(:pivotal_ids) { %w(123 456) }
+      let(:jira_ids) { %w(123 456) }
+      let(:jira_url) { "https://example-jira.com" }
+
+      context ".perform repo_name, options" do
+        let(:creator) { stub }
+
+        it "instantiates a creator and perfoms it" do
+          IssueCreator.should_receive(:new).with(repo_name, options) { creator }
+          creator.should_receive(:perform)
+          IssueCreator.perform(repo_name, options).should == creator
+        end
+      end
+
+      context ".new repo_name, options" do
+        it "remembers the repo name and options" do
+          creator = IssueCreator.new repo_name, options
+          creator.repo_name.should == repo_name
+          creator.options.should == options
+        end
+      end
+
+      context "#perform" do
+        let(:data) { stub(:mash, number: 123) }
+
+        before do
+          creator.stub({
+            title: title,
+            body: body,
+          })
+        end
+
+        it "generates the issue with the given details and retains the information" do
+          GitHub.should_receive(:create_issue).with(repo_name, title, body, labels: []) { data }
+          creator.perform.should == data
+          creator.number.should == data.number
+          creator.data.should == data
+        end
+
+        it "raises CannotCreate if any exception occurs" do
+          GitHub.should_receive(:create_issue).and_raise(Octokit::UnprocessableEntity)
+          expect { creator.perform }.to raise_error(IssueCreator::CannotCreate)
+        end
+      end
+
+      context "#number" do
+        let(:number) { 123 }
+
+        it "returns the stored issue number" do
+          creator.number = number
+          creator.number.should == number
+        end
+
+        it "raises an exception if no issue has been created yet" do
+          creator.number = nil
+          expect { creator.number }.to raise_error(IssueCreator::NotYetCreated)
+        end
+      end
+
+      context "#data" do
+        let(:details) { stub(:data) }
+
+        it "returns the stored issue details" do
+          creator.data = details
+          creator.data.should == details
+        end
+
+        it "raises an exception if no information has been captured yet" do
+          creator.data = nil
+          expect { creator.data }.to raise_error(IssueCreator::NotYetCreated)
+        end
+      end
+
+      context "#title" do
+        context "having the option set" do
+          before { creator.options[:title] = title }
+
+          it "fetches from the options" do
+            creator.title.should == title
+          end
+        end
+
+        it "raises an exception if it's missing" do
+          creator.options[:title] = nil
+          expect { creator.title }.to raise_error(IssueCreator::MissingAttribute)
+        end
+      end
+
+      context "#pivotal_ids" do
+        it "fetches from the options" do
+          creator.options[:pivotal_ids] = pivotal_ids
+          creator.pivotal_ids.should == pivotal_ids
+        end
+
+        it "defaults to an empty array if it's missing" do
+          creator.options[:pivotal_ids] = nil
+          creator.pivotal_ids.should == []
+        end
+      end
+
+      context "#body_locals" do
+        let(:urls) { %w(link1 link2) }
+
+        before do
+          creator.stub({
+            pivotal_ids: pivotal_ids,
+            jira_ids: jira_ids,
+            jira_url: jira_url,
+          })
+        end
+        it "includes the necessary keys to render the template" do
+          creator.body_locals[:pivotal_ids].should == creator.pivotal_ids
+          creator.body_locals[:jira_ids].should == creator.jira_ids
+          creator.body_locals[:jira_url].should == creator.jira_url
+        end
+      end
+
+      context "#edit_body" do
+        let(:path) { stub(:path) }
+        let(:body) { stub(:string) }
+        let(:tempfile) { stub(:tempfile) }
+        let(:edited_body) { stub(:edited_body) }
+
+        before do
+          Tempfile.stub(:new) { tempfile }
+          tempfile.stub(path: path, write: nil, read: edited_body, unlink: nil, close: nil, open: nil)
+          creator.stub(:system)
+        end
+
+        context "without the $EDITOR env var set" do
+          before do
+            stub_const('ENV', {'EDITOR' => nil})
+          end
+
+          it "returns the un-edited output" do
+            creator.edit_body(body).should == body
+          end
+        end
+
+        context "with the $EDITOR env set" do
+
+          before do
+            stub_const('ENV', {'EDITOR' => 'vim'})
+          end
+
+          it "creates a tempfile, write default contents, and close it" do
+            Tempfile.should_receive(:new).with(['octopolo_issue', '.md']) { tempfile }
+            tempfile.should_receive(:write).with(body)
+            tempfile.should_receive(:close)
+            creator.edit_body body
+          end
+
+          it "edits the tempfile with the $EDITOR" do
+            tempfile.should_receive(:path) { path }
+            creator.should_receive(:system).with("vim #{path}")
+            creator.edit_body body
+          end
+
+          it "reopens the file, gets the contents, and deletes the temp file" do
+            tempfile.should_receive(:open)
+            tempfile.should_receive(:read) { edited_body }
+            tempfile.should_receive(:unlink)
+            creator.edit_body body
+          end
+
+          it "returns the user edited output" do
+            creator.edit_body(body).should == edited_body
+          end
+        end
+      end
+
+      context "#body" do
+        let(:locals) { stub(:hash) }
+        let(:output) { stub(:string) }
+
+        before do
+          creator.stub({
+            body_locals: locals,
+          })
+        end
+
+        it "renders the body template with the body locals" do
+          Renderer.should_receive(:render).with(Renderer::ISSUE_BODY, locals) { output }
+          creator.body.should == output
+        end
+
+        context "when the editor option is set" do
+          let(:edited_output) { stub(:output) }
+
+          before do
+            creator.stub({
+              body_locals: locals,
+              options: { editor: true }
+            })
+          end
+
+          it "calls the edit_body method" do
+            Renderer.should_receive(:render).with(Renderer::ISSUE_BODY, locals) { output }
+            creator.should_receive(:edit_body).with(output) { edited_output }
+            creator.body.should == edited_output
+          end
+        end
+      end
+    end
+  end
+end