danger-changelog 0.7.0 → 0.8.0

data/spec/changelog_spec.rb

@@ -24,22 +24,21 @@ describe Danger::Changelog do
 
       context 'without CHANGELOG changes' do
         before do
-          allow(changelog.git).to receive(:modified_files).and_return(['some-file.txt'])
-          allow(changelog.git).to receive(:added_files).and_return(['some-file.txt'])
+          allow(changelog.git).to receive_messages(modified_files: ['some-file.txt'], added_files: ['some-file.txt'])
         end
 
         it 'complains when no CHANGELOG can be found' do
           expect(subject).to be false
           expect(status_report[:errors]).to eq []
           expect(status_report[:warnings]).to eq ["Unless you're refactoring existing code or improving documentation, please update CHANGELOG.md."]
-          expect(status_report[:markdowns].map(&:message)).to eq ["Here's an example of a CHANGELOG.md entry:\n\n```markdown\n* [#123](https://github.com/dblock/danger-changelog/pull/123): Being dangerous - [@dblock](https://github.com/dblock).\n```\n"]
+          expect(status_report[:markdowns].map(&:message).first).to include("Here's an example of a CHANGELOG.md entry:")
+          expect(status_report[:markdowns].map(&:message).first).to match(%r{\* \[#\d+\]\(https://github\.com/.+/pull/\d+\): .+ - \[@.+\]\(https://github\.com/.+\)\.})
         end
       end
 
       context 'with CHANGELOG changes' do
         before do
-          allow(changelog.git).to receive(:modified_files).and_return([changelog.filename])
-          allow(changelog.git).to receive(:added_files).and_return([])
+          allow(changelog.git).to receive_messages(modified_files: [changelog.filename], added_files: [])
         end
 
         it 'has no complaints' do
@@ -59,23 +58,23 @@ describe Danger::Changelog do
       context 'without CHANGELOG changes' do
         context 'when something was modified' do
           before do
-            allow(changelog.git).to receive(:modified_files).and_return(['some-file.txt'])
-            allow(changelog.git).to receive(:added_files).and_return(['another-file.txt'])
+            allow(changelog.git).to receive_messages(modified_files: ['some-file.txt'], added_files: ['another-file.txt'])
           end
 
           it 'complains when no CHANGELOG can be found' do
             expect(subject).to be false
             expect(status_report[:errors]).to eq []
             expect(status_report[:warnings]).to eq ["Unless you're refactoring existing code or improving documentation, please update #{changelog.filename}."]
-            expect(status_report[:markdowns].map(&:message)).to eq ["Here's an example of a #{changelog.filename} entry:\n\n```markdown\n* [#123](https://github.com/dblock/danger-changelog/pull/123): Being dangerous - [@dblock](https://github.com/dblock).\n```\n"]
+            expect(status_report[:markdowns].map(&:message).first).to include("Here's an example of a #{changelog.filename} entry:")
+            expect(status_report[:markdowns].map(&:message).first).to match(%r{\* \[#\d+\]\(https://github\.com/.+/pull/\d+\): .+ - \[@.+\]\(https://github\.com/.+\)\.})
           end
         end
 
         context 'with a README.md' do
           before do
-            allow(changelog.git).to receive(:modified_files).and_return(['README.md'])
-            allow(changelog.git).to receive(:added_files).and_return([])
+            allow(changelog.git).to receive_messages(modified_files: ['README.md'], added_files: [])
           end
+
           it 'has no complaints' do
             expect(subject).to be true
             expect(status_report[:errors]).to eq []
@@ -88,8 +87,7 @@ describe Danger::Changelog do
           context 'name' do
             before do
               changelog.ignore_files = ['WHATEVER.md']
-              allow(changelog.git).to receive(:modified_files).and_return(['WHATEVER.md'])
-              allow(changelog.git).to receive(:added_files).and_return([])
+              allow(changelog.git).to receive_messages(modified_files: ['WHATEVER.md'], added_files: [])
             end
 
             it 'has no complaints' do
@@ -99,11 +97,11 @@ describe Danger::Changelog do
               expect(status_report[:markdowns]).to eq []
             end
           end
+
           context 'mixed' do
             before do
               changelog.ignore_files = ['WHATEVER.md', /\.txt$/]
-              allow(changelog.git).to receive(:modified_files).and_return(['WHATEVER.md'])
-              allow(changelog.git).to receive(:added_files).and_return(['one.txt', 'two.txt'])
+              allow(changelog.git).to receive_messages(modified_files: ['WHATEVER.md'], added_files: ['one.txt', 'two.txt'])
             end
 
             it 'has no complaints' do
@@ -118,8 +116,7 @@ describe Danger::Changelog do
 
       context 'with a new CHANGELOG' do
         before do
-          allow(changelog.git).to receive(:modified_files).and_return([])
-          allow(changelog.git).to receive(:added_files).and_return([changelog.filename])
+          allow(changelog.git).to receive_messages(modified_files: [], added_files: [changelog.filename])
         end
 
         it 'has no complaints' do
@@ -132,8 +129,7 @@ describe Danger::Changelog do
 
       context 'with CHANGELOG changes' do
         before do
-          allow(changelog.git).to receive(:modified_files).and_return([changelog.filename])
-          allow(changelog.git).to receive(:added_files).and_return([])
+          allow(changelog.git).to receive_messages(modified_files: [changelog.filename], added_files: [])
         end
 
         it 'has no complaints' do

data/spec/config_spec.rb

@@ -10,6 +10,7 @@ describe Danger::Changelog::Config do
         expect(changelog.placeholder_line).to eq "* Your contribution here.\n"
       end
     end
+
     context 'when without markdown star' do
       before do
         Danger::Changelog.config.placeholder_line = "Nothing yet.\n"
@@ -40,49 +41,61 @@ describe Danger::Changelog::Config do
       end
     end
   end
+
   describe 'format' do
     it 'default' do
       expect(Danger::Changelog.config.format).to eq :intridea
     end
+
     it 'with an invalid format' do
       expect { Danger::Changelog.config.format = :foobar }.to raise_error ArgumentError, 'Invalid format: foobar'
     end
+
     it 'with a string' do
-      expect { Danger::Changelog.config.format = 'intridea' }.to_not raise_error
+      expect { Danger::Changelog.config.format = 'intridea' }.not_to raise_error
     end
+
     it 'with a symbol' do
-      expect { Danger::Changelog.config.format = :intridea }.to_not raise_error
+      expect { Danger::Changelog.config.format = :intridea }.not_to raise_error
     end
+
     Danger::Changelog::Parsers::FORMATS.each_pair do |format, parser|
       context format do
         before do
           Danger::Changelog.config.format = format
         end
+
         it 'sets format' do
           expect(Danger::Changelog.config.format).to eq format
         end
+
         it 'creates parser' do
           expect(Danger::Changelog.config.parser).to be_a parser
         end
       end
     end
   end
+
   describe 'ignore_files' do
     it 'default' do
       expect(Danger::Changelog.config.ignore_files).to eq(['README.md'])
     end
+
     context 'with a file name' do
       before do
         Danger::Changelog.config.ignore_files = 'WHATEVER.md'
       end
+
       it 'transforms it into an array' do
         expect(Danger::Changelog.config.ignore_files).to eq(['WHATEVER.md'])
       end
     end
+
     context 'with multiple names' do
       before do
         Danger::Changelog.config.ignore_files = ['WHATEVER.md', /\*.md$/]
       end
+
       it 'transforms it into an array' do
         expect(Danger::Changelog.config.ignore_files).to eq(['WHATEVER.md', /\*.md$/])
       end

data/spec/intridea/changelog_entry_line_spec.rb

@@ -92,6 +92,7 @@ describe Danger::Changelog::ChangelogEntryLine do
 
     context 'no transformation required' do
       let(:pr_title) { 'Test' }
+
       it 'uses title as is' do
         expect(described_class.example(github)).to eq '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).'
       end
@@ -99,6 +100,7 @@ describe Danger::Changelog::ChangelogEntryLine do
 
     context 'with lowercase title' do
       let(:pr_title) { 'test' }
+
       it 'capitalizes it' do
         expect(described_class.example(github)).to eq '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).'
       end
@@ -106,6 +108,7 @@ describe Danger::Changelog::ChangelogEntryLine do
 
     context 'with a trailing period' do
       let(:pr_title) { 'Test.' }
+
       it 'removes it' do
         expect(described_class.example(github)).to eq '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).'
       end

data/spec/intridea/changelog_file_spec.rb

@@ -2,50 +2,63 @@ require 'spec_helper'
 
 describe Danger::Changelog::ChangelogFile do
   subject do
-    Danger::Changelog::ChangelogFile.new(filename).tap(&:parse)
+    described_class.new(filename).tap(&:parse)
   end
 
   describe 'with the default format checker' do
     context 'minimal example' do
       let(:filename) { File.expand_path('fixtures/minimal.md', __dir__) }
+
       it 'exists?' do
         expect(subject.exists?).to be true
       end
+
       it 'bad_lines?' do
         expect(subject.bad_lines).to eq []
         expect(subject.bad_lines?).to be false
       end
+
       it 'is valid' do
         expect(subject.bad_lines?).to be false
       end
+
       it 'has your contribution here' do
         expect(subject.global_failures?).to be false
       end
     end
+
     context 'missing your contribution here' do
       let(:filename) { File.expand_path('fixtures/missing_your_contribution_here.md', __dir__) }
+
       it 'is valid' do
         expect(subject.bad_lines?).to be false
       end
+
       it 'is missing your contribution here' do
         expect(subject.global_failures?).to be true
       end
     end
+
     context 'does not exist' do
       let(:filename) { 'whatever.md' }
+
       it 'exists?' do
         expect(subject.exists?).to be false
       end
+
       it 'bad_lines?' do
         expect(subject.bad_lines).to be_empty
         expect(subject.bad_lines?).to be false
       end
     end
+
     context 'with bad lines' do
       let(:filename) { File.expand_path('fixtures/lines.md', __dir__) }
+
       it 'is invalid' do
         expect(subject.bad_lines?).to be true
       end
+
       it 'reports all bad lines' do
         expect(subject.bad_lines).to eq [
           ["Missing star - [@dblock](https://github.com/dblock).\n", 'does not start with a star, does not include a pull request link'],
@@ -57,26 +70,33 @@ describe Danger::Changelog::ChangelogFile do
           ["* [#1](https://github.com/dblock/danger-changelog/pull/1): Unbalanced ] - [@dblock](https://github.com/dblock).\n", 'too many parenthesis']
         ]
       end
+
       it 'has your contribution here' do
         expect(subject.global_failures?).to be false
       end
     end
+
     context 'with a line that has an extra trailing space' do
       let(:filename) { File.expand_path('fixtures/extra_trailing_space.md', __dir__) }
+
       it 'is invalid' do
         expect(subject.bad_lines?).to be true
       end
+
       it 'reports all bad lines' do
         expect(subject.bad_lines).to eq [
           ["* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra trailing space - [@dblock](https://github.com/dblock). \n", 'has an extra trailing space, is missing a period at the end of the line']
         ]
       end
     end
+
     context 'with bad dates' do
       let(:filename) { File.expand_path('fixtures/dates.md', __dir__) }
+
       it 'is invalid' do
         expect(subject.bad_lines?).to be true
       end
+
       it 'reports all bad dates' do
         expect(subject.bad_lines).to eq [
           ["### 1.2.3 (1/2/2018)\n"],
@@ -86,11 +106,14 @@ describe Danger::Changelog::ChangelogFile do
         ]
       end
     end
+
     context 'with bad semver' do
       let(:filename) { File.expand_path('fixtures/semver.md', __dir__) }
+
       it 'is invalid' do
         expect(subject.bad_lines?).to be true
       end
+
       it 'reports all bad dates' do
         expect(subject.bad_lines).to eq [
           ["### 0 (2018/1/1)\n"],
@@ -99,11 +122,14 @@ describe Danger::Changelog::ChangelogFile do
         ]
       end
     end
+
     context 'with imbalanced parenthesis' do
       let(:filename) { File.expand_path('fixtures/imbalanced.md', __dir__) }
+
       it 'is invalid' do
         expect(subject.bad_lines?).to be true
       end
+
       it 'reports all bad lines' do
         expect(subject.bad_lines).to eq [
           ["### 0.0.0)\n"],

data/spec/intridea/changelog_line_parser_spec.rb

@@ -5,6 +5,7 @@ describe Danger::Changelog::ChangelogLineParser do
     context 'changelog entry line' do
       context 'when valid' do
         let(:line) { '* [#123](https://github.com/dblock/danger-changelog/pull/123): Test - [@dblock](https://github.com/dblock).' }
+
         it 'returns ChangelogEntryLine' do
           expect(described_class.parse(line)).to be_a(Danger::Changelog::ChangelogEntryLine)
         end
@@ -26,6 +27,7 @@ describe Danger::Changelog::ChangelogLineParser do
 
     context 'changelog your contribution here line' do
       let(:line) { "* Your contribution here.\n" }
+
       it 'returns ChangelogPlaceholderLine' do
         expect(described_class.parse(line)).to be_a(Danger::Changelog::ChangelogPlaceholderLine)
       end
@@ -34,6 +36,7 @@ describe Danger::Changelog::ChangelogLineParser do
     context 'changelog header line' do
       context 'when one hash' do
         let(:line) { '# Version 1.1.1' }
+
         it 'returns ChangelogHeaderLine' do
           expect(described_class.parse(line)).to be_a(Danger::Changelog::ChangelogHeaderLine)
         end
@@ -41,6 +44,7 @@ describe Danger::Changelog::ChangelogLineParser do
 
       context 'when two hashes' do
         let(:line) { '## Version 1.1.1' }
+
         it 'returns ChangelogHeaderLine' do
           expect(described_class.parse(line)).to be_a(Danger::Changelog::ChangelogHeaderLine)
         end
@@ -48,6 +52,7 @@ describe Danger::Changelog::ChangelogLineParser do
 
       context 'when three hashes' do
         let(:line) { '### Version 1.1.1' }
+
         it 'returns ChangelogHeaderLine' do
           expect(described_class.parse(line)).to be_a(Danger::Changelog::ChangelogHeaderLine)
         end

data/spec/intridea/changelog_spec.rb

@@ -27,6 +27,7 @@ describe Danger::Changelog do
 
         context 'without a CHANGELOG file' do
           let(:filename) { 'does-not-exist' }
+
           it 'complains' do
             expect(subject).to be false
             expect(status_report[:errors]).to eq ['The does-not-exist file does not exist.']
@@ -37,8 +38,7 @@ describe Danger::Changelog do
           let(:filename) { File.expand_path('fixtures/minimal.md', __dir__) }
 
           before do
-            allow(changelog.git).to receive(:modified_files).and_return([filename])
-            allow(changelog.git).to receive(:added_files).and_return([])
+            allow(changelog.git).to receive_messages(modified_files: [filename], added_files: [])
           end
 
           it 'has no complaints' do
@@ -54,6 +54,7 @@ describe Danger::Changelog do
             end
 
             let(:filename) { File.expand_path('fixtures/customized.md', __dir__) }
+
             it 'is ok' do
               expect(subject).to be true
               expect(status_report[:errors]).to eq []
@@ -103,6 +104,7 @@ describe Danger::Changelog do
 
           context 'minimal example' do
             let(:filename) { File.expand_path('fixtures/minimal.md', __dir__) }
+
             it 'is ok' do
               expect(subject).to be true
               expect(status_report[:errors]).to eq []
@@ -128,6 +130,7 @@ describe Danger::Changelog do
 
           context 'with bad lines' do
             let(:filename) { File.expand_path('fixtures/lines.md', __dir__) }
+
             it 'complains' do
               expect(subject).to be false
               expect(status_report[:errors]).to eq ["One of the lines below found in #{filename} doesn't match the [expected format](https://github.com/dblock/danger-changelog/blob/master/README.md#whats-a-correctly-formatted-changelog-file). Please make it look like the other lines, pay attention to version numbers, periods, spaces and date formats."]
@@ -143,6 +146,21 @@ describe Danger::Changelog do
               ]
             end
           end
+
+          context 'with a contribution line starting with a -' do
+            let(:filename) { File.expand_path('fixtures/validation_result.md', __dir__) }
+
+            it 'cannot be parsed' do
+              expect(subject).to be false
+              expect(status_report[:errors]).to eq ["One of the lines below found in #{filename} doesn't match the [expected format](https://github.com/dblock/danger-changelog/blob/master/README.md#whats-a-correctly-formatted-changelog-file). Please make it look like the other lines, pay attention to version numbers, periods, spaces and date formats."]
+              expect(status_report[:warnings]).to eq []
+              expect(status_report[:markdowns].map(&:message)).to eq [
+                "```markdown\n- [#67](https://github.com/dblock/danger-changelog/pull/67): Various build updates - [@bob](https://github.com/bob).\ndoes not start with a star\n```\n",
+                "```markdown\n- [#68](https://github.com/dblock/danger-changelog/pull/68): Properly render `example` - [@janet](https://github.com/janet).\ndoes not start with a star\n```\n",
+                "```markdown\n- Your contribution here.\ncannot be parsed\n```\n"
+              ]
+            end
+          end
         end
       end
     end

data/spec/intridea/fixtures/validation_result.md

@@ -0,0 +1,6 @@
+### Next
+#### Fixes
+- [#67](https://github.com/dblock/danger-changelog/pull/67): Various build updates - [@bob](https://github.com/bob).
+- [#68](https://github.com/dblock/danger-changelog/pull/68): Properly render `example` - [@janet](https://github.com/janet).
+- Your contribution here.
+* Your contribution here.

data/spec/keep_a_changelog/changelog_spec.rb

@@ -26,12 +26,12 @@ describe Danger::Changelog do
 
       context 'with CHANGELOG changes' do
         before do
-          allow(changelog.git).to receive(:modified_files).and_return([filename])
-          allow(changelog.git).to receive(:added_files).and_return([])
+          allow(changelog.git).to receive_messages(modified_files: [filename], added_files: [])
         end
 
         context 'valid file' do
           let(:filename) { File.expand_path('fixtures/complete.md', __dir__) }
+
           it 'has no complaints' do
             expect(subject).to be true
             expect(status_report[:errors]).to eq []
@@ -42,6 +42,7 @@ describe Danger::Changelog do
 
         context 'with lines containing links' do
           let(:filename) { File.expand_path('fixtures/lines_with_links.md', __dir__) }
+
           it 'is valid' do
             expect(subject).to be true
             expect(status_report[:errors]).to eq []
@@ -52,6 +53,7 @@ describe Danger::Changelog do
 
         context 'missing a version header' do
           let(:filename) { File.expand_path('fixtures/missing_a_version_header.md', __dir__) }
+
           it 'complains' do
             expect(subject).to be false
             expect(status_report[:errors]).to eq [
@@ -67,6 +69,7 @@ describe Danger::Changelog do
 
         context 'invalid line' do
           let(:filename) { File.expand_path('fixtures/invalid_line.md', __dir__) }
+
           it 'complains' do
             expect(subject).to be false
             expect(status_report[:errors]).to eq [

data/spec/plugin_spec.rb

@@ -2,8 +2,9 @@ require 'spec_helper'
 
 describe Danger::DangerChangelog do
   subject do
-    Danger::DangerChangelog.new(nil)
+    described_class.new(nil)
   end
+
   it 'is a Danger plugin' do
     expect(subject).to be_a Danger::Plugin
   end

data/spec/pr_metadata_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe Danger::Changelog::PRMetadata do
+  describe '.from_github_plugin' do
+    context 'when github is nil' do
+      it 'returns nil' do
+        expect(described_class.from_github_plugin(nil)).to be_nil
+      end
+    end
+
+    context 'when github has no pr_json' do
+      let(:github) { instance_double(Danger::DangerfileGitHubPlugin, pr_json: nil) }
+
+      it 'returns nil' do
+        expect(described_class.from_github_plugin(github)).to be_nil
+      end
+    end
+
+    context 'when github has pr_json' do
+      subject(:metadata) { described_class.from_github_plugin(github) }
+
+      let(:github) do
+        instance_double(
+          Danger::DangerfileGitHubPlugin,
+          pr_json: { 'number' => 123, 'html_url' => 'https://github.com/org/repo/pull/123' },
+          pr_title: 'Add feature',
+          pr_author: 'dblock'
+        )
+      end
+
+      it 'creates metadata from github plugin' do
+        expect(metadata.pr_json).to eq('number' => 123, 'html_url' => 'https://github.com/org/repo/pull/123')
+        expect(metadata.pr_title).to eq 'Add feature'
+        expect(metadata.pr_author).to eq 'dblock'
+      end
+    end
+
+    context 'when github plugin raises Octokit::Error' do
+      let(:github) do
+        instance_double(Danger::DangerfileGitHubPlugin)
+      end
+
+      [Octokit::Unauthorized, Octokit::TooManyRequests, Octokit::Forbidden].each do |error_class|
+        context "with #{error_class}" do
+          before do
+            allow(github).to receive(:pr_json).and_raise(error_class.new)
+          end
+
+          it 'returns nil to allow fallback' do
+            expect(described_class.from_github_plugin(github)).to be_nil
+          end
+        end
+      end
+    end
+  end
+
+  describe '.from_event_file' do
+    context 'when path is nil' do
+      it 'returns nil' do
+        expect(described_class.from_event_file(nil)).to be_nil
+      end
+    end
+
+    context 'when file does not exist' do
+      it 'returns nil' do
+        expect(described_class.from_event_file('/nonexistent/path.json')).to be_nil
+      end
+    end
+
+    context 'when file contains pull_request event' do
+      subject(:metadata) { described_class.from_event_file(event_file.path) }
+
+      let(:event_file) { Tempfile.new(['github_event', '.json']) }
+      let(:event_data) do
+        {
+          'pull_request' => {
+            'number' => 456,
+            'html_url' => 'https://github.com/org/repo/pull/456',
+            'title' => 'Fix bug',
+            'user' => { 'login' => 'contributor' }
+          }
+        }
+      end
+
+      before do
+        event_file.write(JSON.generate(event_data))
+        event_file.close
+      end
+
+      after { event_file.unlink }
+
+      it 'creates metadata from event file' do
+        expect(metadata.pr_json).to eq event_data['pull_request']
+        expect(metadata.pr_title).to eq 'Fix bug'
+        expect(metadata.pr_author).to eq 'contributor'
+      end
+    end
+
+    context 'when file contains non-PR event' do
+      let(:event_file) { Tempfile.new(['github_event', '.json']) }
+      let(:event_data) { { 'push' => { 'ref' => 'refs/heads/main' } } }
+
+      before do
+        event_file.write(JSON.generate(event_data))
+        event_file.close
+      end
+
+      after { event_file.unlink }
+
+      it 'returns nil' do
+        expect(described_class.from_event_file(event_file.path)).to be_nil
+      end
+    end
+  end
+
+  describe '.fallback' do
+    subject(:metadata) { described_class.fallback }
+
+    it 'returns metadata with example values' do
+      expect(metadata.pr_json).to eq('number' => 123, 'html_url' => 'https://github.com/org/repo/pull/123')
+      expect(metadata.pr_title).to eq 'Your contribution'
+      expect(metadata.pr_author).to eq 'username'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 ROOT = Pathname.new(File.expand_path('..', __dir__))
-$LOAD_PATH.unshift((ROOT + 'lib').to_s)
-$LOAD_PATH.unshift((ROOT + 'spec').to_s)
+$LOAD_PATH.unshift("#{ROOT}lib".to_s)
+$LOAD_PATH.unshift("#{ROOT}spec".to_s)
 
 require 'bundler/setup'
 require 'pry'
@@ -42,6 +42,6 @@ end
 
 require 'active_support'
 
-Dir[File.join(File.dirname(__FILE__), 'support', '**/*.rb')].each do |file|
+Dir[File.join(File.dirname(__FILE__), 'support', '**/*.rb')].sort.each do |file|
   require file
 end