danger-changelog 0.6.0 → 0.6.1

data/spec/config_spec.rb

@@ -1,13 +1,21 @@
-require File.expand_path('spec_helper', __dir__)
+require 'spec_helper'
 
 describe Danger::Changelog::Config do
   describe 'placeholder_line' do
+    context 'an instance of a dangerfile' do
+      let(:dangerfile) { testing_dangerfile }
+      let(:changelog) { dangerfile.changelog }
+
+      it 'defaults placeholder_line' 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"
       end
 
-      it 'ads missing star and saves configuration' do
+      it 'adds missing star and saves configuration' do
         expect(Danger::Changelog.config.placeholder_line).to eq "* Nothing yet.\n"
       end
     end
@@ -17,7 +25,7 @@ describe Danger::Changelog::Config do
         Danger::Changelog.config.placeholder_line = '* Nothing yet.'
       end
 
-      it 'ads missing trailing newline and saves configuration' do
+      it 'adds missing trailing newline and saves configuration' do
         expect(Danger::Changelog.config.placeholder_line).to eq "* Nothing yet.\n"
       end
     end

data/spec/{changelog_entry_line_spec.rb → intridea/changelog_entry_line_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('spec_helper', __dir__)
+require 'spec_helper'
 
 describe Danger::Changelog::ChangelogEntryLine do
   it_behaves_like 'validates as changelog entry line', '* Valid without PR link - [@dblock](https://github.com/dblock).'

data/spec/intridea/changelog_file_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe Danger::Changelog::ChangelogFile do
+  subject do
+    Danger::Changelog::ChangelogFile.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'],
+          ["* [#1](https://github.com/dblock/danger-changelog/pull/1) - Not a colon - [@dblock](https://github.com/dblock).\n"],
+          ["* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)\n", 'is missing a period at the end of the line'],
+          ["# [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).\n", 'does not start with a star'],
+          ["* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).\n", 'has an extra period or comma at the end of the description'],
+          ["* [#1](https://github.com/dblock/danger-changelog/pull/1): Unbalanced ( - [@dblock](https://github.com/dblock).\n", 'too many parenthesis'],
+          ["* [#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"],
+          ["### 1.2.3 (2018/13/1)\n"],
+          ["### 1.2.3 (2018/13)\n"],
+          ["### 1.2.3 (2018/1/1/3)\n"]
+        ]
+      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"],
+          ["### 0. (2018/1/1)\n"],
+          ["### 0.1. (2018/1/1)\n"]
+        ]
+      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"],
+          ["### (0.0.1\n"],
+          ["### 1.2.3 (2018/1/1\n"],
+          ["### 0.1.0 2018/1/1)\n"],
+          ["### 0 ((2018/1/1)\n"],
+          ["### 0. [2018/1/1)\n"],
+          ["### 0.1. (2018/1/1)]\n"]
+        ]
+      end
+    end
+  end
+end

data/spec/{changelog_header_line_spec.rb → intridea/changelog_header_line_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('spec_helper', __dir__)
+require 'spec_helper'
 
 describe Danger::Changelog::ChangelogHeaderLine do
   it_behaves_like 'validates as changelog header line', '# 1.0.1'

data/spec/{changelog_line_parser_spec.rb → intridea/changelog_line_parser_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('spec_helper', __dir__)
+require 'spec_helper'
 
 describe Danger::Changelog::ChangelogLineParser do
   context 'parse' do

data/spec/{changelog_placeholder_line_spec.rb → intridea/changelog_placeholder_line_spec.rb}

@@ -1,9 +1,11 @@
-require File.expand_path('spec_helper', __dir__)
+require 'spec_helper'
 
 describe Danger::Changelog::ChangelogPlaceholderLine do
+  let(:config) { Danger::Changelog.config }
+
   context 'with a custom placeholder line' do
     before do
-      Danger::Changelog.config.placeholder_line = "* Nothing yet here.\n"
+      config.placeholder_line = "* Nothing yet here.\n"
     end
 
     context 'when line is equal to placeholder_line from config' do
@@ -19,7 +21,7 @@ describe Danger::Changelog::ChangelogPlaceholderLine do
 
   context 'with a blank placeholder line' do
     before do
-      Danger::Changelog.config.placeholder_line = nil
+      config.placeholder_line = nil
     end
 
     context 'when line is not blank' do

data/spec/intridea/changelog_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe Danger::Changelog do
+  describe 'with Dangerfile' do
+    let(:dangerfile) { testing_dangerfile }
+    let(:changelog) { dangerfile.changelog }
+    let(:status_report) { changelog.status_report }
+
+    describe 'in a PR' do
+      before do
+        # typical PR JSON looks like https://raw.githubusercontent.com/danger/danger/bffc246a11dac883d76fc6636319bd6c2acd58a3/spec/fixtures/pr_response.json
+        changelog.env.request_source.pr_json = {
+          'number' => 123,
+          'title' => 'being dangerous',
+          'html_url' => 'https://github.com/dblock/danger-changelog/pull/123',
+          'user' => {
+            'login' => 'dblock'
+          }
+        }
+      end
+
+      context 'is_changelog_format_correct?' do
+        subject do
+          changelog.filename = filename
+          changelog.is_changelog_format_correct?
+        end
+
+        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.']
+          end
+        end
+
+        context 'with CHANGELOG changes' 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([])
+          end
+
+          it 'has no complaints' do
+            expect(subject).to be true
+            expect(status_report[:errors]).to eq []
+            expect(status_report[:warnings]).to eq []
+            expect(status_report[:markdowns]).to eq []
+          end
+
+          context 'customized' do
+            before do
+              changelog.placeholder_line = "* Nothing yet.\n"
+            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 []
+              expect(status_report[:warnings]).to eq []
+              expect(status_report[:markdowns]).to eq []
+            end
+          end
+
+          context 'missing your contribution here' do
+            let(:filename) { File.expand_path('fixtures/missing_your_contribution_here.md', __dir__) }
+
+            context 'when placeholder line is customized' do
+              before do
+                changelog.placeholder_line = "* Nothing yet.\n"
+              end
+
+              it 'complains' do
+                expect(subject).to be false
+                expect(status_report[:errors]).to eq ["Please put back the `* Nothing yet.` line into #{filename}."]
+                expect(status_report[:warnings]).to eq []
+                expect(status_report[:markdowns]).to eq []
+              end
+            end
+
+            context 'when placeholder line is default' do
+              it 'complains' do
+                expect(subject).to be false
+                expect(status_report[:errors]).to eq ["Please put back the `* Your contribution here.` line into #{filename}."]
+                expect(status_report[:warnings]).to eq []
+                expect(status_report[:markdowns]).to eq []
+              end
+            end
+
+            context 'when placeholder line is nil' do
+              before do
+                changelog.placeholder_line = nil
+              end
+
+              it 'is ok' do
+                expect(subject).to be true
+                expect(status_report[:errors]).to eq []
+                expect(status_report[:warnings]).to eq []
+                expect(status_report[:markdowns]).to eq []
+              end
+            end
+          end
+
+          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 []
+              expect(status_report[:warnings]).to eq []
+              expect(status_report[:markdowns]).to eq []
+            end
+
+            context 'when placeholder line is nil' do
+              before do
+                changelog.placeholder_line = nil
+              end
+
+              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."]
+                expect(status_report[:warnings]).to eq []
+                expect(status_report[:markdowns].map(&:message)).to eq [
+                  "```markdown\n* Your contribution here.\ndoes not include a pull request link, does not include an author link\n```\n"
+                ]
+              end
+            end
+          end
+
+          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."]
+              expect(status_report[:warnings]).to eq []
+              expect(status_report[:markdowns].map(&:message)).to eq [
+                "```markdown\nMissing star - [@dblock](https://github.com/dblock).\ndoes not start with a star, does not include a pull request link\n```\n",
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1) - Not a colon - [@dblock](https://github.com/dblock).\n```\n",
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)\nis missing a period at the end of the line\n```\n",
+                "```markdown\n# [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).\ndoes not start with a star\n```\n",
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).\nhas an extra period or comma at the end of the description\n```\n",
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): Unbalanced ( - [@dblock](https://github.com/dblock).\ntoo many parenthesis\n```\n",
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): Unbalanced ] - [@dblock](https://github.com/dblock).\ntoo many parenthesis\n```\n"
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/intridea/fixtures/extra_trailing_space.md

@@ -0,0 +1,3 @@
+### Changelog
+
+* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra trailing space - [@dblock](https://github.com/dblock). 

data/spec/keep_a_changelog/changelog_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Danger::Changelog do
+  let(:dangerfile) { testing_dangerfile }
+  let(:changelog) { dangerfile.changelog }
+  let(:status_report) { changelog.status_report }
+
+  describe 'in a PR' do
+    before do
+      changelog.env.request_source.pr_json = {
+        'number' => 123,
+        'title' => 'being dangerous',
+        'html_url' => 'https://github.com/dblock/danger-changelog/pull/123',
+        'user' => {
+          'login' => 'dblock'
+        }
+      }
+    end
+
+    context 'is_changelog_format_correct?' do
+      subject do
+        changelog.format = :keep_a_changelog
+        changelog.filename = filename
+        changelog.is_changelog_format_correct?
+      end
+
+      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([])
+        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 []
+            expect(status_report[:warnings]).to eq []
+            expect(status_report[:markdowns]).to eq []
+          end
+        end
+
+        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 []
+            expect(status_report[:warnings]).to eq []
+            expect(status_report[:markdowns]).to eq []
+          end
+        end
+
+        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 [
+              "One of the lines below found in #{filename} doesn't match the [expected format](https://keepachangelog.com).",
+              'The changelog is missing the version header for the Keep A Changelog format. See <https://keepachangelog.com> to see the format of the header.'
+            ]
+            expect(status_report[:warnings]).to eq []
+            expect(status_report[:markdowns].map(&:message)).to eq [
+              "```markdown\nAll notable changes to this project will be documented in this file.\n```\n"
+            ]
+          end
+        end
+
+        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 [
+              "One of the lines below found in #{filename} doesn't match the [expected format](https://keepachangelog.com)."
+            ]
+            expect(status_report[:warnings]).to eq []
+            expect(status_report[:markdowns].map(&:message)).to eq [
+              "```markdown\nInvalid line by [@tylerfortune8](https://github.com/tylerfortune8).\n```\n"
+            ]
+          end
+        end
+      end
+    end
+  end
+end