danger-changelog 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03270bfff2f0983bbf17c710358dfb6850d727f28afa131593deaed8c6824c0f
-  data.tar.gz: 8723e715d8f3f357e3d72d8e181c3d9174085de6c32ea79a87fbdbcf61160085
+  metadata.gz: e13e8dd279d1b68b2703760929b9c2ab4420db154c5420f27c8f6e6a25834719
+  data.tar.gz: a6d5eb4a335dc87df1d586f7f644da0965bb88f7040049797684ac315b3c1ee8
 SHA512:
-  metadata.gz: 21fe62c2ce3142983ad12dcdee2dca0e3e1246ed376924619dba25151bd4556608f978d1e1b2225a9cfc5ae548eca5302e48a589b1e70711fafc01f759a09d2e
-  data.tar.gz: 02c819d7ec4819b83c76c146778beb44f9a9c716726113d41d5cbaee70523ca91ed0c137b5dd92c52540b34a1e24faaa8dab846f73ea72c4cbd73a99e2232d22
+  metadata.gz: 7ad171e3366fafab0a20cbf65b5a67e8b77d1fd0d0833f8c45d2668b7e796d51556e939c337ecb08ea67f23462a13902c31034a315102a596747a08e48ef8699
+  data.tar.gz: d191579322f931bbc1e4848cc7c4252c3a5a617a1e3291f9c96d11ceb2171156b487b9879ff5f6631a3de8c44c10b1388dcf2d8b1ce491588cb4248605dc0b7d

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: [ '2.7' ]
+        ruby-version: [ '2.7', '3.1', '3.3' ]
     steps:
       - name: Checkout
         uses: actions/checkout@v3

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  NewCops: enable
   Exclude:
     - vendor/**/*
 
@@ -11,7 +12,7 @@ Style/Documentation:
 Metrics:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 256
 
 Style/FrozenStringLiteralComment:
@@ -19,9 +20,12 @@ Style/FrozenStringLiteralComment:
 
 Naming/PredicateName:
   Enabled: true
-  NameWhitelist:
+  AllowedMethods:
     - is_a?
     - have_you_updated_changelog?
     - is_changelog_format_correct?
 
 inherit_from: .rubocop_todo.yml
+require:
+  - rubocop-rake
+  - rubocop-rspec

data/.rubocop_todo.yml

@@ -1,7 +1,133 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-05-08 17:23:39 -0400 using RuboCop version 0.73.0.
+# on 2024-04-12 18:13:29 UTC using RuboCop version 1.63.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'danger-changelog.gemspec'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'spec/intridea/changelog_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/changelog/plugin.rb'
+
+# Offense count: 2
+Lint/MixedRegexpCaptureTypes:
+  Exclude:
+    - 'lib/changelog/changelog_line/changelog_header_line.rb'
+
+# Offense count: 30
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/changelog_spec.rb'
+    - 'spec/config_spec.rb'
+    - '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_spec.rb'
+    - 'spec/keep_a_changelog/changelog_spec.rb'
+
+# Offense count: 9
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 12
+
+# Offense count: 10
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
+  Exclude:
+    - 'spec/changelog_spec.rb'
+    - 'spec/config_spec.rb'
+    - '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/keep_a_changelog/changelog_spec.rb'
+    - 'spec/plugin_spec.rb'
+
+# Offense count: 25
+RSpec/MultipleExpectations:
+  Max: 8
+
+# Offense count: 44
+# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
+# SupportedStyles: always, named_only
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/changelog_spec.rb'
+    - 'spec/intridea/changelog_file_spec.rb'
+    - 'spec/intridea/changelog_spec.rb'
+    - 'spec/keep_a_changelog/changelog_spec.rb'
+    - 'spec/plugin_spec.rb'
+
+# Offense count: 32
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 7
+
+# Offense count: 2
+RSpec/RepeatedExampleGroupBody:
+  Exclude:
+    - 'spec/intridea/changelog_header_line_spec.rb'
+
+# Offense count: 2
+RSpec/RepeatedExampleGroupDescription:
+  Exclude:
+    - 'spec/intridea/changelog_header_line_spec.rb'
+
+# Offense count: 4
+RSpec/RepeatedIncludeExample:
+  Exclude:
+    - 'spec/intridea/changelog_entry_line_spec.rb'
+    - 'spec/intridea/changelog_header_line_spec.rb'
+
+# Offense count: 10
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
+# Include: **/*_spec.rb
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/changelog_spec.rb'
+    - 'spec/config_spec.rb'
+    - '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/keep_a_changelog/changelog_spec.rb'
+    - 'spec/plugin_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/intridea/changelog_entry_line_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Rake/Desc:
+  Exclude:
+    - 'Rakefile'

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 0.7.1 (2024/04/12)
+
+* [#63](https://github.com/dblock/danger-changelog/pull/63): Fix: report on lines that start with a - and cannot be parsed - [@dblock](https://github.com/dblock).
+* [#64](https://github.com/dblock/danger-changelog/pull/64): Upgraded to RuboCop 1.63.1 - [@dblock](https://github.com/dblock).
+
 ### 0.7.0 (2023/11/21)
 
 * [#62](https://github.com/dblock/danger-changelog/pull/62): Migrate CI from Travis to GitHub Actions - [@mathroule](https://github.com/mathroule).

data/Gemfile

@@ -10,8 +10,10 @@ group :development, :test do
   gem 'guard-rspec', '~> 4.7'
   gem 'listen', '3.0.7'
   gem 'pry'
-  gem 'rake', '~> 10.0'
+  gem 'rake', '~> 13.2.1'
   gem 'rspec', '~> 3.4'
-  gem 'rubocop', '~> 0.73.0'
+  gem 'rubocop', '~> 1.63.1'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
   gem 'yard', '~> 0.9.11'
 end

data/danger-changelog.gemspec

@@ -1,6 +1,6 @@
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'changelog/gem_version.rb'
+require 'changelog/gem_version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'danger-changelog'
@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/changelog/changelog_line/changelog_entry_line.rb

@@ -12,8 +12,8 @@ module Danger
         validation_result.error! 'too many parenthesis' unless balanced?(line)
         return false if validation_result.invalid?
 
-        return true if line =~ %r{^\*\s[\`[:upper:]].*[^.,] \- \[\@[\w\d\-\_]+\]\(https:\/\/github\.com\/.*[\w\d\-\_]+\).$}
-        return true if line =~ %r{^\*\s\[\#\d+\]\(https:\/\/github\.com\/.*\d+\)\: [\`[:upper:]].*[^.,] \- \[\@[\w\d\-\_]+\]\(https:\/\/github\.com\/.*[\w\d\-\_]+\).$}
+        return true if line =~ %r{^\*\s[`[:upper:]].*[^.,] - \[@[\w\d\-_]+\]\(https://github\.com/.*[\w\d\-_]+\).$}
+        return true if line =~ %r{^\*\s\[\#\d+\]\(https://github\.com/.*\d+\): [`[:upper:]].*[^.,] - \[@[\w\d\-_]+\]\(https://github\.com/.*[\w\d\-_]+\).$}
 
         validation_result.error! 'does not start with a star' unless ChangelogEntryLine.starts_with_star?(line)
         validation_result.error! 'does not include a pull request link' unless ChangelogEntryLine.with_pr_link?(line)
@@ -22,8 +22,8 @@ module Danger
         validation_result.error! 'has an extra trailing space' if ChangelogEntryLine.ends_with_space?(line)
         validation_result.error! 'is missing a period at the end of the line' unless ChangelogEntryLine.ends_with_period?(line)
         validation_result.error! 'has an extra period or comma at the end of the description' if
-          line =~ %r{^\*\s[\`[:upper:]].*[.,] \- \[\@[\w\d\-\_]+\]\(https:\/\/github\.com\/.*[\w\d\-\_]+\).$} ||
-          line =~ %r{^\*\s\[\#\d+\]\(https:\/\/github\.com\/.*\d+\)\: [\`[:upper:]].*[.,] \- \[\@[\w\d\-\_]+\]\(https:\/\/github\.com\/.*[\w\d\-\_]+\).$}
+          line =~ %r{^\*\s[`[:upper:]].*[.,] - \[@[\w\d\-_]+\]\(https://github\.com/.*[\w\d\-_]+\).$} ||
+          line =~ %r{^\*\s\[\#\d+\]\(https://github\.com/.*\d+\): [`[:upper:]].*[.,] - \[@[\w\d\-_]+\]\(https://github\.com/.*[\w\d\-_]+\).$}
 
         false
       end
@@ -72,21 +72,21 @@ module Danger
 
       # checks whether line contains a MARKDOWN  link to a PR
       def self.with_pr_link?(line)
-        return true if line =~ %r{\[\#\d+\]\(http[s]?:\/\/github\.com\/.*\d+[\/]?\)}
+        return true if line =~ %r{\[\#\d+\]\(https?://github\.com/.*\d+/?\)}
 
         false
       end
 
       # checks whether line contains a capitalized Text, treated as a description
       def self.with_changelog_description?(line)
-        return true if line =~ /[\`[:upper:]].*/
+        return true if line =~ /[`[:upper:]].*/
 
         false
       end
 
       # checks whether line contains a MARKDOWN  link to an author
       def self.with_author_link?(line)
-        return true if line =~ %r{\[\@[\w\d\-\_]+\]\(http[s]?:\/\/github\.com\/.*[\w\d\-\_]+[\/]?\)}
+        return true if line =~ %r{\[@[\w\d\-_]+\]\(https?://github\.com/.*[\w\d\-_]+/?\)}
 
         false
       end

data/lib/changelog/changelog_line/changelog_header_line.rb

@@ -2,8 +2,8 @@ module Danger
   module Changelog
     # A CHANGELOG.md line represents the version header.
     class ChangelogHeaderLine < ChangelogLine
-      OPEN_PARENS = /[\(\[\{]?/.freeze
-      CLOSE_PARENS = /[\)\]\}]?/.freeze
+      OPEN_PARENS = /[(\[{]?/.freeze
+      CLOSE_PARENS = /[)\]}]?/.freeze
 
       HASHES = /\#{1,4}/.freeze
       SEMVER = /(?<semver>(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)/.freeze
@@ -12,9 +12,9 @@ module Danger
       def valid?
         stripped_line = line.strip
 
-        m = stripped_line.match(/^#{HASHES}\s#{OPEN_PARENS}[\w\s\:]*#{CLOSE_PARENS}$/) # title
+        m = stripped_line.match(/^#{HASHES}\s#{OPEN_PARENS}[\w\s:]*#{CLOSE_PARENS}$/) # title
         m ||= stripped_line.match(/^#{HASHES}\s#{OPEN_PARENS}#{SEMVER}#{CLOSE_PARENS}$/) # semver only
-        m ||= stripped_line.match(/^#{HASHES}\s#{OPEN_PARENS}#{SEMVER}#{CLOSE_PARENS}[\s\-]+#{OPEN_PARENS}(#{ISO8601_DATETIME}|\w*)#{CLOSE_PARENS}$/) # semver and ISO 8601 date & time or next version description
+        m ||= stripped_line.match(/^#{HASHES}\s#{OPEN_PARENS}#{SEMVER}#{CLOSE_PARENS}[\s-]+#{OPEN_PARENS}(#{ISO8601_DATETIME}|\w*)#{CLOSE_PARENS}$/) # semver and ISO 8601 date & time or next version description
 
         !m.nil? && balanced?(stripped_line)
       end

data/lib/changelog/changelog_line/changelog_line.rb

@@ -6,8 +6,7 @@ module Danger
       PAIRED = /\(#{NON_DELIMITERS}\)|\{#{NON_DELIMITERS}\}|\[#{NON_DELIMITERS}\]/.freeze
       DELIMITER = /[(){}\[\]]/.freeze
 
-      attr_accessor :line
-      attr_accessor :validation_result
+      attr_accessor :line, :validation_result
 
       def initialize(line)
         self.line = line

data/lib/changelog/config.rb

@@ -10,7 +10,7 @@ module Danger
         ignore_files
       ].freeze
 
-      ACCESSORS = ATTRIBUTES.map { |name| "#{name}=".to_sym }
+      ACCESSORS = ATTRIBUTES.map { |name| :"#{name}=" }
 
       DELEGATORS = ATTRIBUTES + ACCESSORS
 

data/lib/changelog/gem_version.rb

@@ -1,3 +1,3 @@
 module Changelog
-  VERSION = '0.7.0'.freeze
+  VERSION = '0.7.1'.freeze
 end

data/lib/changelog/parsers/intridea_format.rb

@@ -4,9 +4,9 @@ module Danger
       class IntrideaFormat < Base
         def bad_line_message(filename)
           "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.'
+            '[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.'
         end
 
         def parse(filename)
@@ -17,7 +17,10 @@ module Danger
 
             changelog_line = ChangelogLineParser.parse(line)
 
-            if changelog_line.nil? || changelog_line.invalid?
+            if changelog_line.nil?
+              notify_of_bad_line line, 'cannot be parsed'
+              next
+            elsif changelog_line.invalid?
               detail = changelog_line.validation_result.to_s if changelog_line.validation_result&.invalid?
               notify_of_bad_line line, detail
               next

data/lib/changelog/parsers/keep_a_changelog.rb

@@ -4,14 +4,14 @@ module Danger
       class KeepAChangelog < Base
         def bad_line_message(filename)
           "One of the lines below found in #{filename} doesn't match the " \
-          '[expected format](https://keepachangelog.com).'
+            '[expected format](https://keepachangelog.com).'
         end
 
         def parse(filename)
           blocks = parse_into_blocks(File.open(filename).each_line)
 
           if contains_header_block?(blocks.first)
-            blocks = blocks[1..-1]
+            blocks = blocks[1..]
           else
             notify_of_global_failure(
               'The changelog is missing the version header for the Keep A ' \
@@ -61,9 +61,9 @@ module Danger
           return false unless block
           return false unless block.first == '# Changelog'
 
-          regex = %r{All notable changes to this project will be documented in this file. The format is based on \[Keep a Changelog\]\(https://keepachangelog.com/en/\d\.\d\.\d/\), and this project adheres to \[Semantic Versioning\]\(https:\/\/semver.org\/spec\/v2.0.0.html\).}
+          regex = %r{All notable changes to this project will be documented in this file. The format is based on \[Keep a Changelog\]\(https://keepachangelog.com/en/\d\.\d\.\d/\), and this project adheres to \[Semantic Versioning\]\(https://semver.org/spec/v2.0.0.html\).}
 
-          block_content = block[1..-1].join(' ')
+          block_content = block[1..].join(' ')
 
           regex.match?(block_content)
         end
@@ -73,7 +73,7 @@ module Danger
         end
 
         def markdown_list_item_or_continuation?(line)
-          /^(?:[\*-]\s|  )/.match?(line)
+          /^(?:[*-]\s|  )/.match?(line)
         end
       end
     end

data/lib/changelog/plugin.rb

@@ -28,7 +28,7 @@ module Danger
     end
 
     # Run all checks.
-    # @param format [Symbol] the format to check against
+    # @param parser [Symbol] the parser to check with
     # @return [Boolean] true when the check passes
     def check(parser = Danger::Changelog::Config.format)
       warn '[DEPRECATION] `check` is deprecated. Set format with `.format` and use `check!` instead.'

data/spec/changelog_spec.rb

@@ -24,8 +24,7 @@ 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
@@ -38,8 +37,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
@@ -59,8 +57,7 @@ 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
@@ -73,9 +70,9 @@ describe Danger::Changelog do
 
         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 +85,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 +95,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 +114,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 +127,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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-changelog
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - dblock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-21 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -84,6 +84,7 @@ files:
 - spec/intridea/fixtures/minimal.md
 - spec/intridea/fixtures/missing_your_contribution_here.md
 - spec/intridea/fixtures/semver.md
+- spec/intridea/fixtures/validation_result.md
 - spec/keep_a_changelog/changelog_spec.rb
 - spec/keep_a_changelog/fixtures/complete.md
 - spec/keep_a_changelog/fixtures/invalid_line.md
@@ -95,7 +96,8 @@ files:
 homepage: https://github.com/dblock/danger-changelog
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -111,32 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A danger.systems plugin that is OCD about your CHANGELOG.
-test_files:
-- spec/changelog_spec.rb
-- spec/config_spec.rb
-- 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
+test_files: []