git_reflow 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e834acddb09b38d8cf8514276ffffb362686ab63e207a2ee12d86c1e0d1d9a5
-  data.tar.gz: cb8b074c0b5a54d4dc6c5924d07c1ea0b3361f9fafa4f1f6e79ac5bd63be144d
+  metadata.gz: 3f15edd7ea0d9df95980438cf9e846bd6b3e07829ef05adcc63c7b548c55c623
+  data.tar.gz: f315bc14d8ce7873db9f3e4708da9db581bec1bff63d2302465eb356450a2196
 SHA512:
-  metadata.gz: f1e43bfcc3e2ca7d6df9ebfcb87a52ed27088023ea0aed9554e7c49cd6c418a0a7e96f1cb2579e115265849b28fbec16bc01b531a9ffa8d19f49a1a6f062ef21
-  data.tar.gz: 3e6cced31705172b348ec8c6a29d5ab5ab033288d61e8ef8854ee48a31094d475b128f11cb19f4f7068596dde71202c3c8c96ac96698479e1823bf4cec3dbda9
+  metadata.gz: bf83e0671b38cd6b3e2f1a008068ad038cee28177ead79a1646994987b0e24141aeb41b0ee191e3856f7f0032df703b66b6a08e41949e319e68ad7dbea9e0bc1
+  data.tar.gz: 948128297b7ba1a38476fb48a81e1f238745a04966295e8506556cf61c1efacc32a98ea8d2966af43ffaa09a536c03790b6b04f129f65bab779ddfd5e9eeb5ed

data/.rubocop.yml

@@ -1,2 +1,9 @@
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
 Metrics/LineLength:
   Max: 120
+Style/ModuleFuction:
+  EnforcedStyle: extend_self
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -1,13 +1,29 @@
 # Changelog
 
-## [Unreleased](https://github.com/reenhanced/gitreflow/tree/HEAD)
+## [v0.9.6](https://github.com/reenhanced/gitreflow/tree/v0.9.6) (2021-11-05)
 
-[Full Changelog](https://github.com/reenhanced/gitreflow/compare/v0.9.4...HEAD)
+[Full Changelog](https://github.com/reenhanced/gitreflow/compare/v0.9.5...HEAD)
+
+**Implemented enhancements:**
+
+- Use GitHub PR Templates? [\#251](https://github.com/reenhanced/gitreflow/issues/251)
+
+**Merged pull requests:**
+
+- Introduce configurable PR and merge commit templates [\#252](https://github.com/reenhanced/gitreflow/pull/252) ([codenamev](https://github.com/codenamev))
+
+## [v0.9.5](https://github.com/reenhanced/gitreflow/tree/v0.9.5) (2021-03-25)
+
+[Full Changelog](https://github.com/reenhanced/gitreflow/compare/v0.9.4...v0.9.5)
 
 **Fixed bugs:**
 
 - Deprecation warnings with Ruby 2.7.0 [\#239](https://github.com/reenhanced/gitreflow/issues/239)
 
+**Merged pull requests:**
+
+- Support for Ruby 3.0 [\#249](https://github.com/reenhanced/gitreflow/pull/249) ([codenamev](https://github.com/codenamev))
+
 ## [v0.9.4](https://github.com/reenhanced/gitreflow/tree/v0.9.4) (2020-11-10)
 
 [Full Changelog](https://github.com/reenhanced/gitreflow/compare/v0.9.3...v0.9.4)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_reflow (0.9.5)
+    git_reflow (0.9.6)
       bundler (>= 1.10.0)
       codenamev_bitbucket_api (= 0.4.1)
       colorize (>= 0.8.1)
@@ -68,7 +68,7 @@ GEM
     faraday-http-cache (2.2.0)
       faraday (>= 0.8)
     faraday-net_http (1.0.1)
-    faraday_middleware (1.0.0)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     fiber-local (1.0.0)
     github_api (0.19.0)
@@ -93,16 +93,16 @@ GEM
     httpclient (2.8.3)
     i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    jwt (2.2.2)
+    jwt (2.3.0)
     method_source (1.0.0)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.6.1)
     minitest (5.14.4)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
     nio4r (2.5.7)
-    nokogiri (1.11.2)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
     oauth2 (1.4.7)
       faraday (>= 0.8, < 2.0)
@@ -124,7 +124,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.3)

data/lib/git_reflow/git_helpers.rb

@@ -47,23 +47,29 @@ module GitReflow
     end
 
     def pull_request_template
-      filenames_to_try = %w[.github/PULL_REQUEST_TEMPLATE.md
-                            .github/PULL_REQUEST_TEMPLATE
-                            PULL_REQUEST_TEMPLATE.md
-                            PULL_REQUEST_TEMPLATE].map do |file|
+      custom_template = GitReflow::Config.get('templates.pull-request')
+      filenames_to_try = %w[
+        .github/PULL_REQUEST_TEMPLATE.md
+        .github/PULL_REQUEST_TEMPLATE
+        PULL_REQUEST_TEMPLATE.md
+        PULL_REQUEST_TEMPLATE
+      ].map do |file|
         "#{git_root_dir}/#{file}"
       end
+      filenames_to_try.unshift(custom_template) unless custom_template.empty?
 
       parse_first_matching_template_file(filenames_to_try)
     end
 
     def merge_commit_template
+      custom_template = GitReflow::Config.get('templates.merge-commit')
       filenames_to_try = %w[.github/MERGE_COMMIT_TEMPLATE.md
                             .github/MERGE_COMMIT_TEMPLATE
                             MERGE_COMMIT_TEMPLATE.md
                             MERGE_COMMIT_TEMPLATE].map do |file|
         "#{git_root_dir}/#{file}"
       end
+      filenames_to_try.unshift(custom_template) unless custom_template.empty?
 
       parse_first_matching_template_file(filenames_to_try)
     end

data/lib/git_reflow/version.rb

@@ -1,3 +1,3 @@
 module GitReflow
-  VERSION = "0.9.5"
+  VERSION = "0.9.6"
 end

data/spec/lib/git_reflow/git_helpers_spec.rb

@@ -1,15 +1,15 @@
-require 'spec_helper'
+require "spec_helper"
+
+module Gitacular
+  include GitReflow::GitHelpers
+  extend self
+end
 
 describe GitReflow::GitHelpers do
-  let(:origin_url) { 'git@github.com:reenhanced.spectacular/this-is-the.shit.git' }
+  let(:origin_url) { "git@github.com:reenhanced.spectacular/this-is-the.shit.git" }
 
   before do
-    stub_with_fallback(GitReflow::Config, :get).with('remote.origin.url').and_return(origin_url)
-
-    module Gitacular
-      include GitReflow::GitHelpers
-      extend self
-    end
+    stub_with_fallback(GitReflow::Config, :get).with("remote.origin.url").and_return(origin_url)
 
     stub_run_for Gitacular
   end
@@ -18,83 +18,86 @@ describe GitReflow::GitHelpers do
     subject { Gitacular.default_editor }
 
     context "when the environment has EDITOR set" do
-      before  { allow(ENV).to receive(:[]).with('EDITOR').and_return('emacs') }
-      specify { expect( subject ).to eql('emacs') }
+      before  { allow(ENV).to receive(:[]).with("EDITOR").and_return("emacs") }
+      specify { expect(subject).to eql("emacs") }
     end
 
     context "when the environment has no EDITOR set" do
-      before  { allow(ENV).to receive(:[]).with('EDITOR').and_return(nil) }
-      specify { expect( subject ).to eql('vi') }
+      before  { allow(ENV).to receive(:[]).with("EDITOR").and_return(nil) }
+      specify { expect(subject).to eql("vi") }
     end
   end
 
   describe ".git_root_dir" do
     subject { Gitacular.git_root_dir }
-    it      { expect{ subject }.to have_run_command_silently "git rev-parse --show-toplevel" }
+    it      { expect { subject }.to have_run_command_silently "git rev-parse --show-toplevel" }
   end
 
-  describe '.git_editor_command' do
+  describe ".git_editor_command" do
     subject { Gitacular.git_editor_command }
-    before { ENV['EDITOR'] = 'vim' }
+    before { ENV["EDITOR"] = "vim" }
 
-    it 'defaults to GitReflow config' do
-      allow(GitReflow::Config).to receive(:get).with('core.editor').and_return 'nano'
+    it "defaults to GitReflow config" do
+      allow(GitReflow::Config).to receive(:get).with("core.editor").and_return "nano"
 
-      expect(subject).to eq 'nano'
+      expect(subject).to eq "nano"
     end
 
-    it 'falls back to the environment variable $EDITOR' do
-      allow(GitReflow::Config).to receive(:get).with('core.editor').and_return ''
+    it "falls back to the environment variable $EDITOR" do
+      allow(GitReflow::Config).to receive(:get).with("core.editor").and_return ""
 
-      expect(subject).to eq 'vim'
+      expect(subject).to eq "vim"
     end
   end
 
   describe ".remote_user" do
     subject { Gitacular.remote_user }
 
-    it { is_expected.to eq('reenhanced.spectacular') }
+    it { is_expected.to eq("reenhanced.spectacular") }
 
     context "remote origin url isn't set" do
-      let(:origin_url) { '' }
-      it { is_expected.to eq('') }
+      let(:origin_url) { "" }
+      it { is_expected.to eq("") }
     end
 
     context "remote origin uses HTTP" do
-      let(:origin_url) { 'https://github.com/reenhanced.spectacular/this-is-the.shit.git' }
-      it               { is_expected.to eq('reenhanced.spectacular') }
+      let(:origin_url) { "https://github.com/reenhanced.spectacular/this-is-the.shit.git" }
+      it               { is_expected.to eq("reenhanced.spectacular") }
     end
   end
 
   describe ".remote_repo_name" do
     subject { Gitacular.remote_repo_name }
 
-    it { is_expected.to eq('this-is-the.shit') }
+    it { is_expected.to eq("this-is-the.shit") }
 
     context "remote origin url isn't set" do
-      let(:origin_url) { '' }
-      it { is_expected.to eq('') }
+      let(:origin_url) { "" }
+      it { is_expected.to eq("") }
     end
 
     context "remote origin uses HTTP" do
-      let(:origin_url) { 'https://github.com/reenhanced.spectacular/this-is-the.shit.git' }
-      it               { is_expected.to eq('this-is-the.shit') }
+      let(:origin_url) { "https://github.com/reenhanced.spectacular/this-is-the.shit.git" }
+      it               { is_expected.to eq("this-is-the.shit") }
     end
   end
 
-  describe '.default_base_branch' do
+  describe ".default_base_branch" do
     subject { Gitacular.default_base_branch }
-    it      { is_expected.to eq('master') }
+    it      { is_expected.to eq("master") }
 
-    context 'when configured' do
-      before { allow(GitReflow::Config).to receive(:get).with('reflow.base-branch').and_return('tuba') }
-      it { is_expected.to eq('tuba') }
+    context "when configured" do
+      before { allow(GitReflow::Config).to receive(:get).with("reflow.base-branch").and_return("tuba") }
+      it { is_expected.to eq("tuba") }
     end
   end
 
   describe ".current_branch" do
     subject { Gitacular.current_branch }
-    it      { expect{ subject }.to have_run_command_silently "git branch --no-color | grep '^\* ' | grep -v 'no branch' | sed 's/^* //g'" }
+    it {
+      expect { subject }
+        .to have_run_command_silently "git branch --no-color | grep '^\* ' | grep -v 'no branch' | sed 's/^* //g'"
+    }
   end
 
   describe ".pull_request_template" do
@@ -119,36 +122,29 @@ describe GitReflow::GitHelpers do
 
       it { is_expected.to be_nil }
     end
-  end
-
-  describe ".pull_request_template" do
-    subject { Gitacular.pull_request_template }
-
-    context "template file exists" do
-      let(:root_dir) { "/some_repo" }
-      let(:template_content) { "Template content" }
 
+    context "custom template file configured" do
       before do
-        allow(Gitacular).to receive(:git_root_dir).and_return(root_dir)
-        allow(File).to receive(:exist?).with("#{root_dir}/.github/PULL_REQUEST_TEMPLATE.md").and_return(true)
-        allow(File).to receive(:read).with("#{root_dir}/.github/PULL_REQUEST_TEMPLATE.md").and_return(template_content)
+        allow(GitReflow::Config).to receive(:get).with("templates.pull-request").and_return "pr_template_file.md"
       end
 
-      it { is_expected.to eq template_content }
+      context "template file exists" do
+        let(:template_content) { "Template content" }
 
-      context "when template has mustache tags" do
-        let(:template_content) { "This is the coolest {{current_branch}}" }
-        before { allow(GitReflow).to receive(:current_branch).and_return("tomato") }
-        it { is_expected.to eq "This is the coolest tomato" }
+        before do
+          allow(File).to receive(:exist?).with("pr_template_file.md").and_return(true)
+          allow(File).to receive(:read).with("pr_template_file.md").and_return(template_content)
+        end
+        it { is_expected.to eq template_content }
       end
-    end
 
-    context "template file does not exist" do
-      before do
-        allow(File).to receive(:exist?).and_return(false)
-      end
+      context "template file does not exist" do
+        before do
+          allow(File).to receive(:exist?).and_return(false)
+        end
 
-      it { is_expected.to be_nil }
+        it { is_expected.to be_nil }
+      end
     end
   end
 
@@ -181,27 +177,51 @@ describe GitReflow::GitHelpers do
 
       it { is_expected.to be_nil }
     end
+
+    context "custom template file configured" do
+      before do
+        allow(GitReflow::Config).to receive(:get).with("templates.merge-commit").and_return "merge_template_file.md"
+      end
+
+      context "template file exists" do
+        let(:template_content) { "Template content" }
+
+        before do
+          allow(File).to receive(:exist?).with("merge_template_file.md").and_return(true)
+          allow(File).to receive(:read).with("merge_template_file.md").and_return(template_content)
+        end
+        it { is_expected.to eq template_content }
+      end
+
+      context "template file does not exist" do
+        before do
+          allow(File).to receive(:exist?).and_return(false)
+        end
+
+        it { is_expected.to be_nil }
+      end
+    end
   end
 
   describe ".get_first_commit_message" do
     subject { Gitacular.get_first_commit_message }
-    it      { expect{ subject }.to have_run_command_silently 'git log --pretty=format:"%s" --no-merges -n 1' }
+    it      { expect { subject }.to have_run_command_silently 'git log --pretty=format:"%s" --no-merges -n 1' }
   end
 
   describe ".push_current_branch" do
     subject { Gitacular.push_current_branch }
-    before  { allow(Gitacular).to receive(:current_branch).and_return('bingo') }
-    it      { expect{ subject }.to have_run_command "git push origin bingo" }
+    before  { allow(Gitacular).to receive(:current_branch).and_return("bingo") }
+    it      { expect { subject }.to have_run_command "git push origin bingo" }
   end
 
   describe ".fetch_destination(destination_branch)" do
-    subject { Gitacular.fetch_destination('new-feature') }
-    it      { expect{ subject }.to have_run_command "git fetch origin new-feature" }
+    subject { Gitacular.fetch_destination("new-feature") }
+    it      { expect { subject }.to have_run_command "git fetch origin new-feature" }
   end
 
   describe ".update_destination(destination_branch)" do
-    let(:current_branch)     { 'bananas' }
-    let(:destination_branch) { 'monkey-business' }
+    let(:current_branch)     { "bananas" }
+    let(:destination_branch) { "monkey-business" }
 
     before  { allow(Gitacular).to receive(:current_branch).and_return(current_branch) }
     subject { Gitacular.update_destination(destination_branch) }
@@ -217,7 +237,7 @@ describe GitReflow::GitHelpers do
 
   describe ".update_current_branch" do
     subject { Gitacular.update_current_branch }
-    before  { allow(Gitacular).to receive(:current_branch).and_return('new-feature') }
+    before  { allow(Gitacular).to receive(:current_branch).and_return("new-feature") }
 
     it "updates the remote changes and pushes any local changes" do
       expect { subject }.to have_run_commands_in_order [
@@ -228,9 +248,9 @@ describe GitReflow::GitHelpers do
   end
 
   describe ".update_feature_branch" do
-    options = {base: "base", remote: "remote"}
+    options = { base: "base", remote: "remote" }
     subject { Gitacular.update_feature_branch(options) }
-    before  { allow(Gitacular).to receive(:current_branch).and_return('feature') }
+    before  { allow(Gitacular).to receive(:current_branch).and_return("feature") }
 
     it "calls the correct methods" do
       expect { subject }.to have_run_commands_in_order [
@@ -246,14 +266,14 @@ describe GitReflow::GitHelpers do
   describe ".append_to_merge_commit_message(message)" do
     let(:original_commit_message) { "Oooooo, SQUASH IT" }
     let(:message)                 { "do do the voodoo that you do" }
-    let(:root_dir)                { '/home/gitreflow' }
+    let(:root_dir)                { "/home/gitreflow" }
     let(:merge_message_path)      { "#{root_dir}/.git/SQUASH_MSG" }
     let(:tmp_merge_message_path)  { "#{root_dir}/.git/tmp_merge_msg" }
     before                        { allow(Gitacular).to receive(:git_root_dir).and_return(root_dir) }
     subject                       { Gitacular.append_to_merge_commit_message(message) }
 
     it "appends the message to git's SQUASH_MSG temp file" do
-      tmp_file = double('file')
+      tmp_file = double("file")
       allow(File).to receive(:open).with(tmp_merge_message_path, "w").and_yield(tmp_file)
       allow(File).to receive(:exists?).with(merge_message_path).and_return(true)
       allow(File).to receive(:foreach).with(merge_message_path).and_yield(original_commit_message)
@@ -269,7 +289,7 @@ describe GitReflow::GitHelpers do
       let(:merge_message_path) { "#{root_dir}/.git/MERGE_MSG" }
       subject { Gitacular.append_to_merge_commit_message(message, merge_method: "merge") }
       it "appends the message to git's MERGE_MSG temp file if using a direct merge" do
-        tmp_file = double('file')
+        tmp_file = double("file")
         allow(File).to receive(:open).with(tmp_merge_message_path, "w").and_yield(tmp_file)
         allow(File).to receive(:exists?).with(merge_message_path).and_return(true)
         allow(File).to receive(:foreach).with(merge_message_path).and_yield(original_commit_message)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_reflow
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Valentino Stoll
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal