danger-changelog 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dda179f0ffebc733fa943723d9b16c6db3720beab1e5c43ee57746cb6f20577
-  data.tar.gz: b1797cb0bd4d0eef3aead4e9a0409c057205d995efc3d56f200f106055900fe9
+  metadata.gz: 03270bfff2f0983bbf17c710358dfb6850d727f28afa131593deaed8c6824c0f
+  data.tar.gz: 8723e715d8f3f357e3d72d8e181c3d9174085de6c32ea79a87fbdbcf61160085
 SHA512:
-  metadata.gz: 897e573a11db0076fd9c7bb745b5c8f39d47d94f4d2b69b298a1565cade582a9aaadf17d0667b48a1d9569bc0566558000e9baaec7bf9a6054d4818ed5475f1d
-  data.tar.gz: c92f5ae706ada26bb3006adffae2df8aef0b79de05d1f6464257918004511a7bdc926a2430c6386d32961df4011c3e48b29162dea763a98865087e6df8fd4375
+  metadata.gz: 21fe62c2ce3142983ad12dcdee2dca0e3e1246ed376924619dba25151bd4556608f978d1e1b2225a9cfc5ae548eca5302e48a589b1e70711fafc01f759a09d2e
+  data.tar.gz: 02c819d7ec4819b83c76c146778beb44f9a9c716726113d41d5cbaee70523ca91ed0c137b5dd92c52540b34a1e24faaa8dab846f73ea72c4cbd73a99e2232d22

data/.github/workflows/danger.yml

@@ -0,0 +1,23 @@
+name: Danger
+on:
+  pull_request:
+    types: [ opened, reopened, edited, synchronize ]
+jobs:
+  danger:
+    name: Danger
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - name: Run Danger
+        run: |
+          # the personal token is public, this is ok, base64 encode to avoid tripping Github
+          TOKEN=$(echo -n Z2hwX0xNQ3VmanBFeTBvYkZVTWh6NVNqVFFBOEUxU25abzBqRUVuaAo= | base64 --decode)
+          DANGER_GITHUB_API_TOKEN=$TOKEN bundle exec danger --verbose

data/.github/workflows/lint.yml

@@ -0,0 +1,16 @@
+name: Lint
+on: [ push, pull_request ]
+jobs:
+  rubocop:
+    name: RuboCop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - name: RuboCop
+        run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Test
+on: [ push, pull_request ]
+jobs:
+  test:
+    name: Test (Ruby ${{ matrix.ruby-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: [ '2.7' ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run test
+        run: bundle exec rake spec

data/.gitignore

@@ -3,3 +3,4 @@ pkg
 .idea/
 Gemfile.lock
 .yardoc
+vendor/bundle

data/.rubocop.yml

@@ -14,4 +14,14 @@ Metrics:
 Metrics/LineLength:
   Max: 256
 
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: true
+  NameWhitelist:
+    - is_a?
+    - have_you_updated_changelog?
+    - is_changelog_format_correct?
+
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,45 +1,7 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-07-28 16:00:45 -0400 using RuboCop version 0.61.1.
+# on 2020-05-08 17:23:39 -0400 using RuboCop version 0.73.0.
 # 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: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
-  Exclude:
-    - 'lib/changelog/plugin.rb'
-
-# Offense count: 1
-# Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
-Lint/UselessAccessModifier:
-  Exclude:
-    - 'lib/changelog/changelog_line/changelog_line_parser.rb'
-
-# Offense count: 2
-# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
-# NamePrefix: is_, has_, have_
-# NamePrefixBlacklist: is_, has_, have_
-# NameWhitelist: is_a?
-# MethodDefinitionMacros: define_method, define_singleton_method
-Naming/PredicateName:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/changelog/plugin.rb'
-
-# Offense count: 1
-Style/DoubleNegation:
-  Exclude:
-    - 'lib/changelog/changelog_file.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: module_function, extend_self
-Style/ModuleFunction:
-  Exclude:
-    - 'lib/changelog/config.rb'

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## Changelog
 
+### 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).
+* [#61](https://github.com/dblock/danger-changelog/pull/61): Add support for ISO date & time - [@mathroule](https://github.com/mathroule).
+
+### 0.6.1 (2020/05/08)
+
+* [#33](https://github.com/dblock/danger-changelog/issues/33): Attempt to point out known problems in Intridea format - [@dblock](https://github.com/dblock).
+* [#51](https://github.com/dblock/danger-changelog/pull/51): Allow markdown links in keep-a-changelog lines - [@dblock](https://github.com/dblock).
+* [#50](https://github.com/dblock/danger-changelog/pull/50): Added TOC to README - [@dblock](https://github.com/dblock).
+
 ### 0.6.0 (2019/07/28)
 
 * [#47](https://github.com/dblock/danger-changelog/pull/47): Configure `Config#placeholder_line` at plugin level - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -114,7 +114,7 @@ git push origin my-feature-branch -f
 
 ### Check on Your Pull Request
 
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+Go back to your pull request after a few minutes and see whether it passed muster with GitHub Actions. Everything should look green, otherwise fix issues and amend your commit as described above.
 
 ### Be Patient
 

data/Dangerfile

@@ -1,3 +1,4 @@
 # danger.systems
 
+toc.check!
 changelog.check!

data/Gemfile

@@ -1,3 +1,17 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development, :test do
+  gem 'activesupport'
+  gem 'bundler'
+  gem 'danger-toc', '~> 0.2.0'
+  gem 'guard', '~> 2.14'
+  gem 'guard-rspec', '~> 4.7'
+  gem 'listen', '3.0.7'
+  gem 'pry'
+  gem 'rake', '~> 10.0'
+  gem 'rspec', '~> 3.4'
+  gem 'rubocop', '~> 0.73.0'
+  gem 'yard', '~> 0.9.11'
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Daniel Doubrovkine <dblock@dblock.org>
+Copyright (c) 2016-2019 Daniel Doubrovkine <dblock@dblock.org>
 
 MIT License
 

data/README.md

@@ -1,10 +1,27 @@
-# danger-changelog
+# Danger-Changelog
 
 A plugin for [danger.systems](http://danger.systems) that obsessive-compulsively lints your project’s `CHANGELOG.md`.
 It can make sure, for example, that changes are attributed properly, have a valid version number, a date in the ISO8601 format, balanced parenthesis and brackets, and that they’re always terminated with a period.
 
 [![Gem Version](https://badge.fury.io/rb/danger-changelog.svg)](https://badge.fury.io/rb/danger-changelog)
-[![Build Status](https://travis-ci.org/dblock/danger-changelog.svg?branch=master)](https://travis-ci.org/dblock/danger-changelog)
+[![Build Status](https://github.com/dblock/danger-changelog/actions/workflows/test.yml/badge.svg?branch=master&event=push)](https://github.com/dblock/danger-changelog/actions/workflows/test.yml)
+
+# Table of Contents
+
+- [What’s a correctly formatted CHANGELOG file?](#whats-a-correctly-formatted-changelog-file)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration](#configuration)
+  - [changelog.filename](#changelogfilename)
+  - [changelog.format](#changelogformat)
+  - [changelog.placeholder_line](#changelogplaceholder_line)
+  - [changelog.ignore_files](#changelogignore_files)
+- [Checks](#checks)
+  - [changelog.check!](#changelogcheck)
+    - [changelog.have_you_updated_changelog?](#changeloghave_you_updated_changelog)
+    - [changelog.is_changelog_format_correct?](#changelogis_changelog_format_correct)
+- [Contributing](#contributing)
+- [Copyright](#copyright)
 
 ## What's a correctly formatted CHANGELOG file?
 
@@ -90,6 +107,6 @@ See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Copyright
 
-Copyright (c) Daniel Doubrovkine, 2016
+Copyright (c) Daniel Doubrovkine, 2016-2019
 
 MIT License, see [LICENSE](LICENSE.txt) for details.

data/RELEASING.md

@@ -11,7 +11,7 @@ bundle install
 rake
 ```
 
-Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/danger-changelog) for all supported platforms.
+Check that the last build succeeded in [GitHub Actions](https://github.com/dblock/danger-changelog/actions) for all supported platforms.
 
 Increment the version, modify [lib/changelog/gem_version.rb](lib/changelog/gem_version.rb).
 

data/danger-changelog.gemspec

@@ -18,15 +18,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
-
-  spec.add_development_dependency 'activesupport'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'guard', '~> 2.14'
-  spec.add_development_dependency 'guard-rspec', '~> 4.7'
-  spec.add_development_dependency 'listen', '3.0.7'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.4'
-  spec.add_development_dependency 'rubocop', '~> 0.61.1'
-  spec.add_development_dependency 'yard', '~> 0.9.11'
 end

data/lib/changelog/changelog_file.rb

@@ -14,8 +14,10 @@ module Danger
         parser.add_listener(self)
       end
 
-      def add_bad_line(line)
-        @bad_lines << line
+      def add_bad_line(line, detail = nil)
+        return unless line || detail
+
+        @bad_lines << [line, detail].compact
       end
 
       def add_global_failure(message)
@@ -38,7 +40,7 @@ module Danger
       end
 
       def exists?
-        !!@exists
+        @exists
       end
 
       def bad?

data/lib/changelog/changelog_line/changelog_entry_line.rb

@@ -5,10 +5,26 @@ module Danger
     # A CHANGELOG.md line represents the change entry.
     class ChangelogEntryLine < ChangelogLine
       def valid?
-        return false unless balanced?(line)
+        return validation_result.valid? if validation_result
+
+        @validation_result = Parsers::ValidationResult.new
+
+        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\-\_]+\).$}
 
+        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)
+        validation_result.error! 'does not have a description' unless ChangelogEntryLine.with_changelog_description?(line)
+        validation_result.error! 'does not include an author link' unless ChangelogEntryLine.with_author_link?(line)
+        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\-\_]+\).$}
+
         false
       end
 
@@ -40,6 +56,20 @@ module Danger
         false
       end
 
+      # checks whether line ends with a space
+      def self.ends_with_space?(line)
+        return true if line =~ /[[:blank:]]\n$/
+
+        false
+      end
+
+      # checks whether line ends with a period
+      def self.ends_with_period?(line)
+        return true if line =~ /\.\n$/
+
+        false
+      end
+
       # 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+[\/]?\)}

data/lib/changelog/changelog_line/changelog_header_line.rb

@@ -7,14 +7,14 @@ module Danger
 
       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
-      ISO8601_DATE = %r{(?<date>([0-9]{4})[-/]?(1[0-2]|0?[1-9])[-/]+(3[01]|0?[1-9]|[12][0-9]))}.freeze
+      ISO8601_DATETIME = %r{(?<datetime>([0-9]{4})[-/]?(1[0-2]|0?[1-9])[-/]+(3[01]|0?[1-9]|[12][0-9])(T[0-9]{2}:[0-9]{2}:[0-9]{2})?Z?)}.freeze
 
       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}#{SEMVER}#{CLOSE_PARENS}$/) # semver only
-        m ||= stripped_line.match(/^#{HASHES}\s#{OPEN_PARENS}#{SEMVER}#{CLOSE_PARENS}[\s\-]+#{OPEN_PARENS}(#{ISO8601_DATE}|\w*)#{CLOSE_PARENS}$/) # semver and iso 8601 date 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

@@ -7,9 +7,11 @@ module Danger
       DELIMITER = /[(){}\[\]]/.freeze
 
       attr_accessor :line
+      attr_accessor :validation_result
 
       def initialize(line)
         self.line = line
+        self.validation_result = nil
       end
 
       # Match the line with the validation rules

data/lib/changelog/changelog_line/changelog_line_parser.rb

@@ -16,12 +16,12 @@ module Danger
         changelog_line_class.new(line)
       end
 
-      private_class_method
-
       def self.available_changelog_lines
         # Order is important
         [ChangelogPlaceholderLine, ChangelogEntryLine, ChangelogHeaderLine]
       end
+
+      private_class_method :available_changelog_lines
     end
   end
 end

data/lib/changelog/config.rb

@@ -1,7 +1,7 @@
 module Danger
   module Changelog
     module Config
-      extend self
+      module_function
 
       ATTRIBUTES = %i[
         placeholder_line
@@ -14,7 +14,9 @@ module Danger
 
       DELEGATORS = ATTRIBUTES + ACCESSORS
 
-      attr_accessor(*Config::ATTRIBUTES)
+      class << self
+        attr_accessor(*Config::ATTRIBUTES)
+      end
 
       def placeholder_line=(value)
         if value

data/lib/changelog/gem_version.rb

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

data/lib/changelog/parsers/base.rb

@@ -14,8 +14,8 @@ module Danger
 
         private
 
-        def notify_of_bad_line(message)
-          listeners.each { |changelog| changelog.add_bad_line(message) }
+        def notify_of_bad_line(message, detail = nil)
+          listeners.each { |changelog| changelog.add_bad_line(message, detail) }
         end
 
         def notify_of_global_failure(message)

data/lib/changelog/parsers/intridea_format.rb

@@ -18,7 +18,8 @@ module Danger
             changelog_line = ChangelogLineParser.parse(line)
 
             if changelog_line.nil? || changelog_line.invalid?
-              notify_of_bad_line line
+              detail = changelog_line.validation_result.to_s if changelog_line.validation_result&.invalid?
+              notify_of_bad_line line, detail
               next
             end
 

data/lib/changelog/parsers/keep_a_changelog.rb

@@ -16,7 +16,7 @@ module Danger
             notify_of_global_failure(
               'The changelog is missing the version header for the Keep A ' \
               'Changelog format. See <https://keepachangelog.com> to see ' \
-              'the format of the header'
+              'the format of the header.'
             )
           end
 
@@ -42,7 +42,7 @@ module Danger
           lines.each do |line|
             line = line.chomp
 
-            if /##?[^#]/.match?(line)
+            if /^##?[^#]/.match?(line)
               blocks << block.dup unless block.empty?
               block.clear
             end

data/lib/changelog/parsers/validation_result.rb

@@ -0,0 +1,31 @@
+module Danger
+  module Changelog
+    module Parsers
+      class ValidationResult
+        def initialize
+          @errors = []
+        end
+
+        attr_reader :errors
+
+        def valid?
+          errors.empty?
+        end
+
+        def invalid?
+          !valid?
+        end
+
+        def error!(message)
+          errors << message
+        end
+
+        def to_s
+          return nil if valid?
+
+          errors.join(', ')
+        end
+      end
+    end
+  end
+end

data/lib/changelog/parsers.rb

@@ -1,4 +1,5 @@
 require 'changelog/parsers/base'
+require 'changelog/parsers/validation_result'
 require 'changelog/parsers/intridea_format'
 require 'changelog/parsers/keep_a_changelog'
 

data/lib/changelog/plugin.rb

@@ -75,15 +75,16 @@ module Danger
       if changelog_file.exists?
         changelog_file.parse
         changelog_file.bad_lines.each do |line|
-          markdown <<-MARKDOWN
-```markdown
-#{line}```
+          markdown <<~MARKDOWN
+            ```markdown
+            #{line.map(&:strip).join("\n")}
+            ```
           MARKDOWN
         end
         messaging.fail(parser.bad_line_message(filename), sticky: false) if changelog_file.bad_lines?
 
         changelog_file.global_failures.each do |failure|
-          messaging.fail(failure, sticy: false)
+          messaging.fail(failure, sticky: false)
         end
 
         changelog_file.good?
@@ -96,12 +97,12 @@ module Danger
     private
 
     def warn_update_changelog
-      markdown <<-MARKDOWN
-Here's an example of a #{filename} entry:
+      markdown <<~MARKDOWN
+        Here's an example of a #{filename} entry:
 
-```markdown
-#{Danger::Changelog::ChangelogEntryLine.example(github)}
-```
+        ```markdown
+        #{Danger::Changelog::ChangelogEntryLine.example(github)}
+        ```
       MARKDOWN
       warn "Unless you're refactoring existing code or improving documentation, please update #{filename}.", sticky: false
     end