danger-changelog 0.6.0 → 0.7.0

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/{fixtures/changelogs → intridea/fixtures}/dates.md

@@ -11,3 +11,6 @@
 ### 1.2.3 (2018/13)
 ### 1.2.3 (2018/1/1/3)
 ### 1.2.3 - 2018/01/02
+### 1.2.3 - 2023-09-28
+### 1.2.3 - 2023-09-28Z
+### 1.2.3 - 2023-09-28T21:59:56Z

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

data/spec/keep_a_changelog/fixtures/invalid_line.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2017-06-20
+
+### Added
+
+Invalid line by [@tylerfortune8](https://github.com/tylerfortune8).
+
+### Changed
+
+- Start using "changelog" over "change log" since it's the common usage.
+
+### Removed
+
+- Section about "changelog" vs "CHANGELOG".
+

data/spec/keep_a_changelog/fixtures/lines_with_links.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[unreleased]: https://github.com/example/example/compare/v4.1.0...master
+
+### Added
+
+* [#1](https://github.com/example/example/pull/1): Added danger-changelog - [@dblock](https://github.com/dblock).

data/spec/keep_a_changelog/fixtures/missing_a_version_header.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [1.0.0] - 2017-06-20
+
+### Added
+
+- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
+
+### Changed
+
+- Start using "changelog" over "change log" since it's the common usage.
+
+### Removed
+
+- Section about "changelog" vs "CHANGELOG".
+

data/spec/plugin_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Danger::DangerChangelog do
+  subject do
+    Danger::DangerChangelog.new(nil)
+  end
+  it 'is a Danger plugin' do
+    expect(subject).to be_a Danger::Plugin
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-changelog
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - dblock
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-28 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -24,146 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: listen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.0.7
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.0.7
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.61.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.61.1
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
 description: A danger.systems plugin that is OCD about your CHANGELOG.
 email:
 - dblock@dblock.org
@@ -171,11 +31,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/danger.yml"
+- ".github/workflows/lint.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Dangerfile
@@ -202,31 +64,39 @@ files:
 - lib/changelog/parsers/base.rb
 - lib/changelog/parsers/intridea_format.rb
 - lib/changelog/parsers/keep_a_changelog.rb
+- lib/changelog/parsers/validation_result.rb
 - lib/changelog/plugin.rb
 - lib/danger_changelog.rb
 - lib/danger_plugin.rb
-- spec/changelog_entry_line_spec.rb
-- spec/changelog_file_spec.rb
-- spec/changelog_header_line_spec.rb
-- spec/changelog_line_parser_spec.rb
-- spec/changelog_placeholder_line_spec.rb
 - spec/changelog_spec.rb
 - spec/config_spec.rb
-- spec/fixtures/changelogs/customized.md
-- spec/fixtures/changelogs/dates.md
-- spec/fixtures/changelogs/imbalanced.md
-- spec/fixtures/changelogs/keep_a_changelog.md
-- spec/fixtures/changelogs/lines.md
-- spec/fixtures/changelogs/minimal.md
-- spec/fixtures/changelogs/missing_your_contribution_here.md
-- spec/fixtures/changelogs/semver.md
+- spec/intridea/changelog_entry_line_spec.rb
+- spec/intridea/changelog_file_spec.rb
+- spec/intridea/changelog_header_line_spec.rb
+- spec/intridea/changelog_line_parser_spec.rb
+- spec/intridea/changelog_placeholder_line_spec.rb
+- spec/intridea/changelog_spec.rb
+- spec/intridea/fixtures/customized.md
+- spec/intridea/fixtures/dates.md
+- spec/intridea/fixtures/extra_trailing_space.md
+- spec/intridea/fixtures/imbalanced.md
+- spec/intridea/fixtures/lines.md
+- spec/intridea/fixtures/minimal.md
+- spec/intridea/fixtures/missing_your_contribution_here.md
+- spec/intridea/fixtures/semver.md
+- spec/keep_a_changelog/changelog_spec.rb
+- spec/keep_a_changelog/fixtures/complete.md
+- spec/keep_a_changelog/fixtures/invalid_line.md
+- spec/keep_a_changelog/fixtures/lines_with_links.md
+- spec/keep_a_changelog/fixtures/missing_a_version_header.md
+- spec/plugin_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared/changelog.rb
 homepage: https://github.com/dblock/danger-changelog
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -241,25 +111,32 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A danger.systems plugin that is OCD about your CHANGELOG.
 test_files:
-- spec/changelog_entry_line_spec.rb
-- spec/changelog_file_spec.rb
-- spec/changelog_header_line_spec.rb
-- spec/changelog_line_parser_spec.rb
-- spec/changelog_placeholder_line_spec.rb
 - spec/changelog_spec.rb
 - spec/config_spec.rb
-- spec/fixtures/changelogs/customized.md
-- spec/fixtures/changelogs/dates.md
-- spec/fixtures/changelogs/imbalanced.md
-- spec/fixtures/changelogs/keep_a_changelog.md
-- spec/fixtures/changelogs/lines.md
-- spec/fixtures/changelogs/minimal.md
-- spec/fixtures/changelogs/missing_your_contribution_here.md
-- spec/fixtures/changelogs/semver.md
+- spec/intridea/changelog_entry_line_spec.rb
+- spec/intridea/changelog_file_spec.rb
+- spec/intridea/changelog_header_line_spec.rb
+- spec/intridea/changelog_line_parser_spec.rb
+- spec/intridea/changelog_placeholder_line_spec.rb
+- spec/intridea/changelog_spec.rb
+- spec/intridea/fixtures/customized.md
+- spec/intridea/fixtures/dates.md
+- spec/intridea/fixtures/extra_trailing_space.md
+- spec/intridea/fixtures/imbalanced.md
+- spec/intridea/fixtures/lines.md
+- spec/intridea/fixtures/minimal.md
+- spec/intridea/fixtures/missing_your_contribution_here.md
+- spec/intridea/fixtures/semver.md
+- spec/keep_a_changelog/changelog_spec.rb
+- spec/keep_a_changelog/fixtures/complete.md
+- spec/keep_a_changelog/fixtures/invalid_line.md
+- spec/keep_a_changelog/fixtures/lines_with_links.md
+- spec/keep_a_changelog/fixtures/missing_a_version_header.md
+- spec/plugin_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared/changelog.rb

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-
-cache:
-  directories:
-    - bundle
-
-rvm:
-  - 2.3.1
-
-before_script:
-    - bundle exec danger
-
-script:
-    - bundle exec rake spec