octopolo 0.2.1 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmZjNjJhODc5NWM1Y2VhM2YxMDhjY2I2NDNmMzRmN2QyYThjN2ZlNg==
+    YWJiMDZmMWJkMWE1YjhkOWY2YzY3MDY4YWI3M2E0MDRmZDUxNDg3Mg==
   data.tar.gz: !binary |-
-    NTg0ZTc3OTYxNTM2MjM3YjE2YmYzNGFkY2E4OTc2MGRlMWRiOTQyYw==
+    YjFhNGU3NzdkODFiYmM4YjBlYjIzNjc2ZWI5Y2E2YzVmOWM0OGViMQ==
 SHA512:
   metadata.gz: !binary |-
-    MzBhNzI3MDVjZGY0Y2MxZWM4ZjI0YTU5OGM1ZmY4YWI1OTYwODk3MWMzMjIx
-    MjczMmMyNGM4ZjBkODIzNTk4NmJjNzZjYjliOWVhMDNjMjA1NWE0MTljMDE3
-    MDA4YjhlZmFlY2NmNDI5MDQ3ZDNmYTY3OGJhMGY2NTY3OTY4ZWY=
+    Njk1YjE0Mjk0ZjRhZThhZGE4OGU2YTE0ZmI3MjM3ZjEzYTEzOGI0NmZiN2E5
+    NjcxZWMxYzQ5ZTg3Y2VlMDMzMzA2NDFjZTQ5NDUzMTdkNGNmNjcyZmEwZTBj
+    YTY3YzNiNTE2OTEyOGFlZTQ4OTIwYjgzNDdkMmZiN2VlNDQxODY=
   data.tar.gz: !binary |-
-    ZjkwOGJiZDU1MzQ0NzJhODU1YmM0NjQ2ZDA2ZTdkMDQ5OWEzZTZhOGFhZDhm
-    Y2U5NjRiNjRmNzEwMjhiNTA4MjRjMWQ1Zjg3MzQ0ODMwZDc5MTAxM2U2ZGZi
-    YWY1NTQxZjU4N2Q1N2NmMzg0MTVlNDA1MDg4ZTkzOTA2NTFjODQ=
+    NDA2OTA3ODIyNTk5NWQxOTU1ZTdkZDBhNWE0ODkxNGUzNjgwMDJhYWQwNDkw
+    MGJmYzgxZjFhZDgxZDYxMDQwMzQ3NmNlOTliNTM1ZGQzODg2OGJmNDI4NzFl
+    OTk5ODQyZjliMTNjYjE3YmIzYjQ4ZWYyNjZlZDM3YjBkZTA1NmY=

data/CHANGELOG.markdown

@@ -1,3 +1,4 @@
+#### v0.3.0
 #### v0.2.1
 #### v0.1.4
 #### v0.2.0

data/lib/octopolo.rb

@@ -12,4 +12,8 @@ module Octopolo
     @config ||= Octopolo::Config.parse
   end
 
+  def self.user_config
+    @user_config ||= Octopolo::UserConfig.parse
+  end
+
 end

data/lib/octopolo/commands/pull_request.rb

@@ -1,13 +1,17 @@
 desc "Create a pull request from the current branch to the application's designated deploy branch."
 command 'pull-request' do |c|
   config = Octopolo::Config.parse
+  user_config = Octopolo::UserConfig.parse
 
   c.desc "Branch to create the pull request against"
   c.flag [:d, :dest, :destination], :arg_name => "destination_branch", :default_value => config.deploy_branch
 
+  c.desc "Use $EDITOR to update PR description before creating"
+  c.switch [:e, :editor], :default_value => user_config.editor
+
   c.action do |global_options, options, args|
     require_relative '../scripts/pull_request'
     options = global_options.merge(options)
-    Octopolo::Scripts::PullRequest.execute options[:destination]
+    Octopolo::Scripts::PullRequest.execute options[:destination], options
   end
 end

data/lib/octopolo/github/pull_request_creator.rb

@@ -1,4 +1,5 @@
 require_relative "../renderer"
+require 'tempfile'
 
 module Octopolo
   module GitHub
@@ -107,7 +108,28 @@ module Octopolo
       #
       # Returns a String
       def body
-        Renderer.render Renderer::PULL_REQUEST_BODY, body_locals
+        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

data/lib/octopolo/scripts/pull_request.rb

@@ -16,13 +16,15 @@ module Octopolo
       attr_accessor :jira_ids
       attr_accessor :destination_branch
       attr_accessor :label
+      attr_accessor :options
 
-      def self.execute(destination_branch=nil)
-        new(destination_branch).execute
+      def self.execute(destination_branch=nil, options={})
+        new(destination_branch, options).execute
       end
 
-      def initialize(destination_branch=nil)
+      def initialize(destination_branch=nil, options={})
         @destination_branch = destination_branch || default_destination_branch
+        @options = options
       end
 
       def default_destination_branch
@@ -108,6 +110,7 @@ module Octopolo
           source_branch: git.current_branch,
           pivotal_ids: pivotal_ids,
           jira_ids: jira_ids,
+          editor: options[:editor]
         }
       end
       private :pull_request_attributes

data/lib/octopolo/user_config.rb

@@ -4,6 +4,7 @@ module Octopolo
     attr_accessor :github_user
     attr_accessor :github_token
     attr_accessor :full_name
+    attr_accessor :editor
     attr_accessor :pivotal_token
     attr_accessor :attributes # keep the whole hash
 
@@ -79,6 +80,13 @@ module Octopolo
       @full_name || ENV["USER"]
     end
 
+    # Public: Always use the $EDITOR when available
+    #
+    # Returns a value or false
+    def editor
+      @editor || false
+    end
+
     # Public: The GitHub username
     #
     # If none is stored, generate it for the user.

data/lib/octopolo/version.rb

@@ -1,3 +1,3 @@
 module Octopolo
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/octopolo/github/pull_request_creator_spec.rb

@@ -154,6 +154,60 @@ module Octopolo
         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_pull_request', '.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) }
@@ -168,6 +222,23 @@ module Octopolo
           Renderer.should_receive(:render).with(Renderer::PULL_REQUEST_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::PULL_REQUEST_BODY, locals) { output }
+            creator.should_receive(:edit_body).with(output) { edited_output }
+            creator.body.should == edited_output
+          end
+        end
       end
     end
   end

data/spec/octopolo/scripts/pull_request_spec.rb

@@ -188,6 +188,7 @@ module Octopolo
             source_branch: git.current_branch,
             pivotal_ids: subject.pivotal_ids,
             jira_ids: subject.jira_ids,
+            editor: nil
           }
         end
       end

data/spec/octopolo/user_config_spec.rb

@@ -119,6 +119,19 @@ module Octopolo
       end
     end
 
+    context "#editor" do
+      let(:config) { UserConfig.new }
+
+      it "returns the configured value" do
+        config.editor = true
+        config.editor.should == true
+      end
+
+      it "returns false otherwise" do
+        config.editor.should == false
+      end
+    end
+
     context "#github_user" do
       let(:config) { UserConfig.new }
       let(:username) { "joeperson" }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octopolo
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Patrick Byrne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2015-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake