gitx 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59f45788834b6e13ec3fd859fe45cde1d4f84f1205866f0b72dd6800d40b6e5d
-  data.tar.gz: a08cd9beca1c16bc02f5654ed056e7e93d89e21df5914cb7507c04d679b6f1ec
+  metadata.gz: 3794617867e08f0a15468dd3291883d22bed44fa9dfde0350cf120e5c5c8890c
+  data.tar.gz: 827802ca75c6a1f4243fa628a12dc3cc1e9b11afef91d587fc9fe4ae4a9b2b6e
 SHA512:
-  metadata.gz: 8d464966f06a39cadd33a9830130c5f25edbed7eccba994ce96fee827a1f8e9cdaa75dd4c3553338774b15fb5de2ce5185882034e506c6057b6d1a12f92b67d9
-  data.tar.gz: ac922c59dae45ed1d87c5e86c719628e2dfc55d13daffb9b9891cc01ced3672573c2916dbb6b9290fe8ae6ef5fe846322d71e574bf7c092bf39c32f249c35a22
+  metadata.gz: ae00b7739d6b3488d0ae4ae588d776c1a004eeb36167587699d2c0dae2ec49902dfc78d122f1edcab7e9ce47a3cecfd36efe59491bce0d663562058e08975f57
+  data.tar.gz: 8727bf623a20f50a6de72088a0e1106e26ccd1ba974d66471e2ed0f8643ffe3c04ec299b6d4343df3816f8c881af3588497e7a2fd9806627c418d461933d24dc

data/lib/gitx/github.rb

@@ -17,6 +17,7 @@ module Gitx
       #
       # This footer will automatically be stripped from the pull request description
     MESSAGE
+    PULL_REQEST_TEMPLATE_FILE='.github/PULL_REQUEST_TEMPLATE.md'
 
     def find_or_create_pull_request(branch)
       pull_request = find_pull_request(branch)
@@ -82,6 +83,7 @@ module Gitx
       description_template = []
       description_template << "#{description}\n" if description
       description_template << changelog
+      description_template << "#{pull_request_template}\n" if pull_request_template
 
       ask_editor(description_template.join("\n"), editor: repo.config['core.editor'], footer: PULL_REQUEST_FOOTER)
     end
@@ -90,6 +92,14 @@ module Gitx
       options[:title] || branch.gsub(/[-_]/, ' ')
     end
 
+    def pull_request_template_file
+      File.expand_path(PULL_REQEST_TEMPLATE_FILE)
+    end
+
+    def pull_request_template
+      @pull_request_template ||= File.exist?(pull_request_template_file) ? File.read(pull_request_template_file) : nil
+    end
+
     # authorization token used for github API calls
     # the token is cached on the filesystem for future use
     # @return [String] auth token stored in git (current repo, user config or installed global settings)

data/lib/gitx/version.rb

@@ -1,3 +1,3 @@
 module Gitx
-  VERSION = '4.1.0'.freeze
+  VERSION = '4.1.1'.freeze
 end

data/spec/gitx/cli/review_command_spec.rb

@@ -63,8 +63,12 @@ describe Gitx::Cli::ReviewCommand do
       end
     end
     context 'when target branch is not nil and pull request does not exist' do
+      subject(:review) do
+        VCR.use_cassette('pull_request_does_not_exist') do
+          cli.review 'feature-branch'
+        end
+      end
       let(:authorization_token) { '123123' }
-      let(:changelog) { '* made some fixes' }
       let(:fake_update_command) { double('fake update command', update: nil) }
       let(:new_pull_request) do
         {
@@ -77,21 +81,18 @@ describe Gitx::Cli::ReviewCommand do
         }
       end
       let(:changelog) { "* old commit\n\n* new commit" }
+      let(:pull_request_body) { changelog }
       let(:pull_request_description) { 'description' }
       before do
         allow(cli).to receive(:authorization_token).and_return(authorization_token)
         expect(executor).to receive(:execute).with('git', 'checkout', 'feature-branch').ordered
         expect(executor).to receive(:execute).with('git', 'update').ordered
         expect(executor).to receive(:execute).with('git', 'log', 'origin/main...feature-branch', '--reverse', '--no-merges', '--pretty=format:* %B').and_return(changelog).ordered
-        expect(cli).to receive(:ask_editor).with(changelog, hash_including(footer: Gitx::Github::PULL_REQUEST_FOOTER)).and_return(pull_request_description)
+        expect(cli).to receive(:ask_editor).with(pull_request_body, hash_including(footer: Gitx::Github::PULL_REQUEST_FOOTER)).and_return(pull_request_description)
 
         stub_request(:post, 'https://api.github.com/repos/wireframe/gitx/pulls')
           .with(body: { base: 'main', head: 'feature-branch', title: 'feature branch', body: pull_request_description }.to_json)
           .to_return(status: 201, body: new_pull_request.to_json, headers: { 'Content-Type' => 'application/json' })
-
-        VCR.use_cassette('pull_request_does_not_exist') do
-          cli.review 'feature-branch'
-        end
       end
       it 'creates github pull request' do
         should meet_expectations
@@ -99,6 +100,28 @@ describe Gitx::Cli::ReviewCommand do
       it 'runs expected commands' do
         should meet_expectations
       end
+      context 'when PULL_REQUEST_TEMPLATE file exists' do
+        let(:pull_request_template) do
+          "## Summary\nPut your summary here\n## Artifacts\n- list\n- your\n-artifacts"
+        end
+        let(:pull_request_body) do
+          "#{changelog}\n#{pull_request_template}\n"
+        end
+        before do
+          expect(cli).to receive(:pull_request_template).and_return(pull_request_template).twice
+
+          stub_request(:post, 'https://api.github.com/repos/wireframe/gitx/pulls')
+            .with(body: { base: 'main', head: 'feature-branch', title: 'feature branch', body: pull_request_description }.to_json)
+            .to_return(status: 201, body: new_pull_request.to_json, headers: { 'Content-Type' => 'application/json' })
+        end
+
+        it 'creates github pull request' do
+          should meet_expectations
+        end
+        it 'runs expected commands' do
+          should meet_expectations
+        end
+      end
     end
     context 'when authorization_token is missing' do
       let(:authorization_token) { nil }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitx
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Ryan Sonnek
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit