git_reflow 0.8.10 → 0.9.0

data/spec/lib/git_reflow/git_helpers_spec.rb

@@ -14,6 +14,20 @@ describe GitReflow::GitHelpers do
     stub_run_for Gitacular
   end
 
+  describe ".default_editor" 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') }
+    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') }
+    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" }
@@ -42,7 +56,7 @@ describe GitReflow::GitHelpers do
     it { is_expected.to eq('reenhanced.spectacular') }
 
     context "remote origin url isn't set" do
-      let(:origin_url) { nil }
+      let(:origin_url) { '' }
       it { is_expected.to eq('') }
     end
 
@@ -58,7 +72,7 @@ describe GitReflow::GitHelpers do
     it { is_expected.to eq('this-is-the.shit') }
 
     context "remote origin url isn't set" do
-      let(:origin_url) { nil }
+      let(:origin_url) { '' }
       it { is_expected.to eq('') }
     end
 
@@ -68,6 +82,16 @@ describe GitReflow::GitHelpers do
     end
   end
 
+  describe '.default_base_branch' do
+    subject { Gitacular.default_base_branch }
+    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') }
+    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'" }
@@ -97,6 +121,68 @@ describe GitReflow::GitHelpers do
     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" }
+
+      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)
+      end
+
+      it { is_expected.to eq 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" }
+      end
+    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
+
+  describe ".merge_commit_template" do
+    subject { Gitacular.merge_commit_template }
+
+    context "template file exists" do
+      let(:root_dir) { "/some_repo" }
+      let(:template_content) { "Template content" }
+
+      before do
+        allow(Gitacular).to receive(:git_root_dir).and_return(root_dir)
+        allow(File).to receive(:exist?).with("#{root_dir}/.github/MERGE_COMMIT_TEMPLATE.md").and_return(true)
+        allow(File).to receive(:read).with("#{root_dir}/.github/MERGE_COMMIT_TEMPLATE.md").and_return(template_content)
+      end
+
+      it { is_expected.to eq 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" }
+      end
+    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
+
   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' }
@@ -157,26 +243,43 @@ describe GitReflow::GitHelpers do
     end
   end
 
-  describe ".append_to_squashed_commit_message(message)" do
-    let(:original_squash_message) { "Oooooo, SQUASH IT" }
+  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(:squash_path)             { "#{root_dir}/.git/SQUASH_MSG" }
-    let(:tmp_squash_path)         { "#{root_dir}/.git/tmp_squash_msg" }
+    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_squashed_commit_message(message) }
+    subject                       { Gitacular.append_to_merge_commit_message(message) }
 
     it "appends the message to git's SQUASH_MSG temp file" do
       tmp_file = double('file')
-      allow(File).to receive(:open).with(tmp_squash_path, "w").and_yield(tmp_file)
-      allow(File).to receive(:exists?).with(squash_path).and_return(true)
-      allow(File).to receive(:foreach).with(squash_path).and_yield(original_squash_message)
+      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)
       expect(tmp_file).to receive(:puts).with(message)
-      expect(tmp_file).to receive(:puts).with(original_squash_message)
+      expect(tmp_file).to receive(:puts).with(original_commit_message)
 
       expect { subject }.to have_run_commands_in_order [
-        "mv #{tmp_squash_path} #{squash_path}"
+        "mv #{tmp_merge_message_path} #{merge_message_path}"
       ]
     end
+
+    context "when doing a direct merge" 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')
+        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)
+        expect(tmp_file).to receive(:puts).with(message)
+        expect(tmp_file).to receive(:puts).with(original_commit_message)
+
+        expect { subject }.to have_run_commands_in_order [
+          "mv #{tmp_merge_message_path} #{merge_message_path}"
+        ]
+      end
+    end
   end
 end

data/spec/lib/git_reflow/git_server/git_hub/pull_request_spec.rb

@@ -86,21 +86,21 @@ describe GitReflow::GitServer::GitHub::PullRequest do
           pull_request: {
             number: existing_pull_request.number,
             comments: [{author: comment_author}],
-            reviews: []
+            reviews: [{author: existing_pull_request.user.login}]
           },
           issue: {
             number: existing_pull_request.number,
-            comments: [{author: comment_author}]
+            comments: [{author: comment_author}, {author: existing_pull_request.user.login}]
           }
         )
       end
-      specify { expect(subject).to eql(existing_pull_comments.to_a + existing_issue_comments.to_a) }
+      specify { expect(subject).to eql(existing_pull_comments.to_a + existing_issue_comments.to_a - [existing_pull_request.user.login]) }
     end
 
     context "Testing Nil Comments" do
       before do
         stub_request(:get, "https://api.github.com/repos/reenhanced/repo/pulls/2/comments?access_token=a1b2c3d4e5f6g7h8i9j0").
-         with(:headers => {'Accept'=>'application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1', 'Accept-Charset'=>'utf-8', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'token a1b2c3d4e5f6g7h8i9j0', 'User-Agent'=>'Github API Ruby Gem 0.15.0'}).
+         with(:headers => {'Accept'=>'application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1', 'Accept-Charset'=>'utf-8', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'token a1b2c3d4e5f6g7h8i9j0', 'User-Agent'=>'Github API Ruby Gem 0.18.2'}).
          to_return(:status => 200, :body => "", :headers => {})
 
         FakeGitHub.new(
@@ -133,7 +133,7 @@ describe GitReflow::GitServer::GitHub::PullRequest do
           number: existing_pull_request.number,
           owner: existing_pull_request.user.login,
           comments: [{author: 'tito'}, {author: 'bobby'}, {author: 'ringo'}],
-          reviews:  [{author: 'nature-boy'}]
+          reviews:  [{author: 'ringo'}, {author: 'nature-boy'}]
         },
         issue: {
           number: existing_pull_request.number,
@@ -484,7 +484,7 @@ describe GitReflow::GitServer::GitHub::PullRequest do
       allow(GitReflow.git_server).to receive(:connection).and_return(github_api)
       allow(GitReflow.git_server).to receive(:get_build_status).and_return(Struct.new(:state, :description, :target_url).new())
       allow_any_instance_of(GitReflow::GitServer::PullRequest).to receive(:commit_message_for_merge).and_return('Bingo')
-      allow_any_instance_of(GitReflow).to receive(:append_to_squashed_commit_message).and_return(true)
+      allow_any_instance_of(GitReflow).to receive(:append_to_merge_commit_message).and_return(true)
     end
 
     context "and force-merging" do

data/spec/lib/git_reflow/git_server/pull_request_spec.rb

@@ -364,7 +364,7 @@ describe GitReflow::GitServer::PullRequest do
     subject { pr.merge! inputs }
 
     before do
-      allow(GitReflow).to receive(:append_to_squashed_commit_message)
+      allow(GitReflow).to receive(:append_to_merge_commit_message)
       allow(pr).to receive(:commit_message_for_merge).and_return(commit_message_for_merge)
     end
 
@@ -376,7 +376,7 @@ describe GitReflow::GitServer::PullRequest do
       it "updates both feature and destination branch and squash-merges feature into base branch" do
         expect(GitReflow).to receive(:update_current_branch)
         expect(GitReflow).to receive(:fetch_destination).with(pr.base_branch_name)
-        expect(GitReflow).to receive(:append_to_squashed_commit_message).with(pr.commit_message_for_merge)
+        expect(GitReflow).to receive(:append_to_merge_commit_message).with(pr.commit_message_for_merge)
         expect { subject }.to have_run_commands_in_order [
           "git checkout #{pr.base_branch_name}",
           "git pull origin #{pr.base_branch_name}",
@@ -470,6 +470,12 @@ describe GitReflow::GitServer::PullRequest do
       before  { allow(pr).to receive(:approvals).and_return(['sally', 'joey']) }
       specify { expect(subject).to include "\nLGTM given by: @sally, @joey\n" }
     end
+
+    context "with custom merge commit message template" do
+      before { allow(GitReflow).to receive(:merge_commit_template).and_return("Super cool changes") }
+      specify { expect(subject).to include "Super cool changes" }
+      specify { expect(subject).to_not include "\nMerges ##{pr.number}\n" }
+    end
   end
 
   context "#cleanup_feature_branch?" do
@@ -490,7 +496,7 @@ describe GitReflow::GitServer::PullRequest do
         it     { should be_truthy }
       end
 
-      context "and user choose not to cleanup" do
+      context "and user chooses not to cleanup" do
         before { expect(pr).to receive(:ask).with('Would you like to push this branch to your remote repo and cleanup your feature branch? ').and_return('no') }
         it     { should be_falsy }
       end

data/spec/lib/git_reflow/workflow_spec.rb

@@ -12,16 +12,153 @@ describe GitReflow::Workflow do
   describe ".current" do
     subject { GitReflow::Workflow.current }
 
+    before do
+      allow(GitReflow::Workflows::Core).to receive(:load_raw_workflow)
+    end
+
     context "when no workflow is set" do
       before  { allow(GitReflow::Config).to receive(:get).with("reflow.workflow").and_return('') }
       specify { expect( subject ).to eql(GitReflow::Workflows::Core) }
     end
 
-    context "when a workflow is set" do
+    context "when a global workflow is set" do
       let(:workflow_path) { File.join(File.expand_path("../../../fixtures", __FILE__), "/awesome_workflow.rb") }
 
       before  { allow(GitReflow::Config).to receive(:get).with("reflow.workflow").and_return(workflow_path) }
-      specify { expect( subject ).to eql(GitReflow::Workflow::AwesomeWorkflow) }
+      specify { expect( subject ).to eql(GitReflow::Workflows::Core) }
+    end
+
+    context "when a local workflow is set" do
+      let(:workflow_content) do
+        <<~WORKFLOW_CONTENT
+          command :dummy do
+            GitReflow.say "derp"
+          end
+        WORKFLOW_CONTENT
+      end
+
+      before do
+        allow(File).to receive(:exists?).with("#{GitReflow.git_root_dir}/Workflow").and_return(true)
+        allow(File).to receive(:read).with("#{GitReflow.git_root_dir}/Workflow").and_return(workflow_content)
+        expect(GitReflow::Workflows::Core).to receive(:load_raw_workflow).with(workflow_content).and_call_original
+      end
+
+      specify { expect( subject ).to respond_to(:dummy) }
+      specify { expect( subject ).to eql(GitReflow::Workflows::Core) }
+    end
+
+    context "when both a local and a global workflow are set" do
+      let(:workflow_path) { File.join(File.expand_path("../../../fixtures", __FILE__), "/awesome_workflow.rb") }
+      let(:workflow_content) do
+        <<~WORKFLOW_CONTENT
+          command :dummy do
+            GitReflow.say "derp"
+          end
+        WORKFLOW_CONTENT
+      end
+
+      before  do
+        allow(File).to receive(:exists?).with("#{GitReflow.git_root_dir}/Workflow").and_return(true)
+        allow(File).to receive(:read).with("#{GitReflow.git_root_dir}/Workflow").and_return(workflow_content)
+        allow(GitReflow::Config).to receive(:get).with("reflow.workflow").and_return(workflow_path)
+        allow(GitReflow::Workflows::Core).to receive(:load_raw_workflow).and_call_original
+      end
+
+      specify { expect(subject).to respond_to(:dummy) }
+      specify { expect(subject).to eql(GitReflow::Workflows::Core) }
+    end
+  end
+
+  describe ".before" do
+    it "executes the block before the command" do
+      GitReflow::Workflows::Core.load_raw_workflow <<~WORKFLOW_CONTENT
+        command :yips do
+          puts "Yips."
+        end
+
+        before :yips do
+          puts "Would you like a donut?"
+        end
+      WORKFLOW_CONTENT
+
+      allow(GitReflow::Workflows::Core).to receive(:load_workflow).and_return(true)
+
+      expect { GitReflow.workflow.yips }.to have_output "Would you like a donut?\nYips."
+    end
+
+    it "executes blocks sequentially by order of appearance" do
+      GitReflow::Workflows::Core.load_raw_workflow <<~WORKFLOW_CONTENT
+        command :yips do
+          puts "Yips."
+        end
+
+        before :yips do
+          puts "Cupcake?"
+        end
+
+        before :yips do
+          puts "Would you like a donut?"
+        end
+      WORKFLOW_CONTENT
+
+      allow(GitReflow::Workflows::Core).to receive(:load_workflow).and_return(true)
+
+      expect { GitReflow.workflow.yips }.to have_output "Cupcake?\nWould you like a donut?\nYips."
+    end
+
+    it "proxies any arguments returned to the command" do
+      GitReflow::Workflows::Core.load_raw_workflow <<~WORKFLOW_CONTENT
+        command :yips, arguments: { spiced: false } do |**params|
+          puts params[:spiced] ? "Too spicy." : "Yips."
+        end
+
+        before :yips do
+          puts "Wasabe?"
+          { spiced: true }
+        end
+      WORKFLOW_CONTENT
+
+      allow(GitReflow::Workflows::Core).to receive(:load_workflow).and_return(true)
+
+      expect { GitReflow.workflow.yips }.to have_output "Wasabe?\nToo spicy."
+    end
+  end
+
+  describe ".after" do
+    it "executes the block after the command" do
+      GitReflow::Workflows::Core.load_raw_workflow <<~WORKFLOW_CONTENT
+        command :vroom do
+          puts "Vroom"
+        end
+
+        after :vroom do
+          puts "VROOOOM"
+        end
+      WORKFLOW_CONTENT
+
+      allow(GitReflow::Workflows::Core).to receive(:load_workflow).and_return(true)
+
+      expect { GitReflow.workflow.vroom }.to have_output "Vroom\nVROOOOM"
+    end
+
+    it "executes blocks sequentially by order of appearance" do
+      GitReflow::Workflows::Core.load_raw_workflow <<~WORKFLOW_CONTENT
+        command :vroom do
+          puts "Vroom"
+        end
+
+        after :vroom do
+          puts "Vrooom"
+        end
+
+        after :vroom do
+          puts "VROOOOM"
+        end
+      WORKFLOW_CONTENT
+
+      allow(GitReflow::Workflows::Core).to receive(:load_workflow).and_return(true)
+
+      expect { GitReflow.workflow.vroom }.to have_output "Vroom\nVrooom\nVROOOOM"
     end
   end
 
@@ -31,28 +168,70 @@ describe GitReflow::Workflow do
         include GitReflow::Workflow
       end
       workflow.command :bogus do
-        "Woohoo"
+        GitReflow.say "Woohoo"
       end
 
-      expect(DummyWorkflow.bogus).to eql("Woohoo")
+      expect { DummyWorkflow.bogus }.to have_said("Woohoo")
     end
 
     it "creates a method for a bogus command with arguments" do
-      workflow.command :bogus, arguments: [:feature_branch] do |**params|
-        "Woohoo #{params[:feature_branch]}!"
+      workflow.command :bogus, arguments: { feature_branch: nil } do |**params|
+        GitReflow.say "Woohoo #{params[:feature_branch]}!"
       end
 
-      expect(DummyWorkflow.bogus(feature_branch: "donuts")).to eql("Woohoo donuts!")
+      expect { DummyWorkflow.bogus(feature_branch: "arguments") }.to have_said("Woohoo arguments!")
     end
 
-    it "creates a class method for a bogus command with default options" do
-      workflow.command :bogus, arguments: [:feature_branch], defaults: {decoration: 'sprinkles'} do |**params|
+    it "creates a class method for a bogus command with default arguments" do
+      workflow.command :bogus, arguments: { feature_branch: nil, decoration: "sprinkles" } do |**params|
         donut_excitement = "Woohoo #{params[:feature_branch]}"
         donut_excitement += " with #{params[:decoration]}" if params[:decoration]
-        "#{donut_excitement}!"
+        GitReflow.say "#{donut_excitement}!"
+      end
+
+      expect { DummyWorkflow.bogus(feature_branch: "donuts") }.to have_said("Woohoo donuts with sprinkles!")
+    end
+
+    it "creates a class method for a bogus command with flags" do
+      workflow.command :bogus, flags: { feature_branch: nil } do |**params|
+        GitReflow.say "Woohoo #{params[:feature_branch]}!"
+      end
+
+      expect { DummyWorkflow.bogus(feature_branch: "flags") }.to have_said("Woohoo flags!")
+    end
+
+    it "creates a class method for a bogus command with default flags" do
+      workflow.command :bogus, flags: { feature_branch: "donuts" } do |**params|
+        GitReflow.say "Woohoo #{params[:feature_branch]}!"
+      end
+
+      expect { DummyWorkflow.bogus }.to have_said("Woohoo donuts!")
+    end
+
+    it "creates a class method for a bogus command with switches" do
+      workflow.command :bogus, switches: { feature_branch: nil } do |**params|
+        GitReflow.say "Woohoo #{params[:feature_branch]}!"
+      end
+
+      expect { DummyWorkflow.bogus(feature_branch: "switches") }.to have_said("Woohoo switches!")
+    end
+
+    it "creates a class method for a bogus command with default switches" do
+      workflow.command :bogus, switches: { feature_branch: "donuts" } do |**params|
+        GitReflow.say "Woohoo #{params[:feature_branch]}!"
       end
 
-      expect(DummyWorkflow.bogus(feature_branch: "donuts")).to eql("Woohoo donuts with sprinkles!")
+      expect { DummyWorkflow.bogus }.to have_said("Woohoo donuts!")
+    end
+  end
+
+  describe ".use(workflow_name)" do
+    it "Uses a pre-existing workflow as a basis" do
+      allow(GitReflow::Workflows::Core).to receive(:load_workflow)
+      expect(GitReflow::Workflows::Core).to receive(:load_workflow)
+        .with(workflow.workflows["FlatMergeWorkflow"])
+        .and_return(true)
+      workflow.use "FlatMergeWorkflow"
     end
   end