danger-changelog 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fb5aff25f4ccf5fc339a15cf5a542348e92929f87d0b41945f190c08caee0db
-  data.tar.gz: d4f672480a57b9c21fcd75f68ec0153917ce308d263e8cc4fe41df14be644c5f
+  metadata.gz: 23ffe294b89bbc0ab12ea04d4ec4047537296e946185c8c429d2a0342b99f5f3
+  data.tar.gz: 12d61d6e00b7bafda8f4007b12219f33a11b0b3e12b5442404fb2ff419b263e8
 SHA512:
-  metadata.gz: 3623da33104a8ef38cc1a05916afc9ed22c1294e93e3e39c6520d29b69ded74357d31045398b25c596a8083abd2b5194a0653248b4f151512b94fec08468f18c
-  data.tar.gz: b31a67bcd03090eb70bdbbd5b64b8ba903a9df163b4a60dae4f18757efab974bcdf0c252ea5ad88d5ef3949e8c9c885769456f1efab4271a20018b883b7ff570
+  metadata.gz: 844b03efdd6dbda1f354d0473471ff768d0fe39774521f5e5d092b8b2cc1febcbae5bda93fef8f9da6488e3c4b13c1fb385303b10e37debd7d546a953687875d
+  data.tar.gz: 94016cf396222b1b0c06eb78b3c940eddc7bf3b4f7fd0114ee5a7779317067f8f33ca4e58348ff629a6c99f470977878676c9c803b47c56ef83d267b3196fbd2

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-12-16 11:08:47 -0500 using RuboCop version 0.61.1.
+# on 2018-12-20 12:04:45 -0500 using RuboCop version 0.61.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

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 0.4.1 (2018/12/20)
+
+* [#37](https://github.com/dblock/danger-changelog/issues/37): Allow for parenthesis and brackets around versions and dates - [@dblock](https://github.com/dblock).
+* [#38](https://github.com/dblock/danger-changelog/pull/38): Check for imbalanced parenthesis and brackets - [@dblock](https://github.com/dblock).
+
 ### 0.4.0 (2018/12/16)
 
 * [#35](https://github.com/dblock/danger-changelog/pull/35): Check that dates in headers are ISO8601 - [@dblock](https://github.com/dblock).

data/README.md

@@ -1,7 +1,7 @@
 # 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, and that they’re always terminated with a period.
+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)

data/lib/changelog/changelog_line/changelog_entry_line.rb

@@ -5,6 +5,7 @@ module Danger
     # A CHANGELOG.md line represents the change entry.
     class ChangelogEntryLine < ChangelogLine
       def valid?
+        return false unless balanced?(line)
         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\-\_]+\).$}
 

data/lib/changelog/changelog_line/changelog_header_line.rb

@@ -2,17 +2,25 @@ module Danger
   module Changelog
     # A CHANGELOG.md line represents the version header.
     class ChangelogHeaderLine < ChangelogLine
+      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
+      ISO8601_DATE = %r{(?<date>([0-9]{4})[-/]?(1[0-2]|0?[1-9])[-/]+(3[01]|0?[1-9]|[12][0-9]))}.freeze
+
       def valid?
-        return true if line.strip =~ /^\#{1,4}\s[\w\s]*$/ # title
-        return true if line.strip =~ /^\#{1,4}\s(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-]+)*))?$/ # no date at all
-        return true if line.strip =~ /^\#{1,4}\s(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-]+)*))?\s\(\w*\)$/ # next date
-        return true if line.strip =~ %r{^\#{1,4}\s(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-]+)*))?\s\(([0-9]{4})[-/]?(1[0-2]|0?[1-9])[-/]+(3[01]|0?[1-9]|[12][0-9])\)$} # iso 8601 date
+        stripped_line = line.strip
 
-        false
+        m = stripped_line.match(/^#{HASHES}\s[\w\s\:]*$/) # 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.nil? && balanced?(stripped_line)
       end
 
       def self.validates_as_changelog_line?(line)
-        return true if line =~ /^\#{1,4}\s.+/
+        return true if line =~ /^#{HASHES}\s.+/
 
         false
       end

data/lib/changelog/changelog_line/changelog_line.rb

@@ -2,6 +2,10 @@ module Danger
   module Changelog
     # An abstract CHANGELOG.md line.
     class ChangelogLine
+      NON_DELIMITERS = /[^(){}\[\]]*/.freeze
+      PAIRED = /\(#{NON_DELIMITERS}\)|\{#{NON_DELIMITERS}\}|\[#{NON_DELIMITERS}\]/.freeze
+      DELIMITER = /[(){}\[\]]/.freeze
+
       attr_accessor :line
 
       def initialize(line)
@@ -22,6 +26,13 @@ module Danger
       def self.validates_as_changelog_line?(_line)
         abort "You need to include a function for #{self} for validates_as_changelog_line?"
       end
+
+      # https://stackoverflow.com/questions/25979364/ruby-regex-for-matching-brackets
+      def balanced?(line_with_parens)
+        line_with_parens = line_with_parens.dup
+        line_with_parens.gsub!(PAIRED, ''.freeze) while line_with_parens =~ PAIRED
+        line_with_parens !~ DELIMITER
+      end
     end
   end
 end

data/lib/changelog/gem_version.rb

@@ -1,3 +1,3 @@
 module Changelog
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.1'.freeze
 end

data/spec/changelog_file_spec.rb

@@ -41,7 +41,7 @@ describe Danger::Changelog::ChangelogFile do
     end
   end
   context 'with bad lines' do
-    let(:filename) { File.expand_path('fixtures/changelogs/with_bad_lines.md', __dir__) }
+    let(:filename) { File.expand_path('fixtures/changelogs/lines.md', __dir__) }
     it 'is invalid' do
       expect(subject.bad_lines?).to be true
     end
@@ -51,7 +51,9 @@ describe Danger::Changelog::ChangelogFile do
         "* [#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",
         "# [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).\n",
-        "* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).\n"
+        "* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).\n",
+        "* [#1](https://github.com/dblock/danger-changelog/pull/1): Unbalanced ( - [@dblock](https://github.com/dblock).\n",
+        "* [#1](https://github.com/dblock/danger-changelog/pull/1): Unbalanced ] - [@dblock](https://github.com/dblock).\n"
       ]
     end
     it 'has your contribution here' do
@@ -59,7 +61,7 @@ describe Danger::Changelog::ChangelogFile do
     end
   end
   context 'with bad dates' do
-    let(:filename) { File.expand_path('fixtures/changelogs/with_bad_dates.md', __dir__) }
+    let(:filename) { File.expand_path('fixtures/changelogs/dates.md', __dir__) }
     it 'is invalid' do
       expect(subject.bad_lines?).to be true
     end
@@ -73,7 +75,7 @@ describe Danger::Changelog::ChangelogFile do
     end
   end
   context 'with bad semver' do
-    let(:filename) { File.expand_path('fixtures/changelogs/with_bad_semver.md', __dir__) }
+    let(:filename) { File.expand_path('fixtures/changelogs/semver.md', __dir__) }
     it 'is invalid' do
       expect(subject.bad_lines?).to be true
     end
@@ -85,4 +87,21 @@ describe Danger::Changelog::ChangelogFile do
       ]
     end
   end
+  context 'with imbalanced parenthesis' do
+    let(:filename) { File.expand_path('fixtures/changelogs/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

data/spec/changelog_spec.rb

@@ -188,7 +188,7 @@ describe Danger::Changelog do
           end
 
           context 'with bad lines' do
-            let(:filename) { File.expand_path('fixtures/changelogs/with_bad_lines.md', __dir__) }
+            let(:filename) { File.expand_path('fixtures/changelogs/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. Please make it look like the other lines, pay attention to version numbers, periods, spaces and date formats."]
@@ -198,7 +198,9 @@ describe Danger::Changelog do
                 "```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)\n```\n",
                 "```markdown\n# [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).\n```\n",
-                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).\n```\n"
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).\n```\n",
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): Unbalanced ( - [@dblock](https://github.com/dblock).\n```\n",
+                "```markdown\n* [#1](https://github.com/dblock/danger-changelog/pull/1): Unbalanced ] - [@dblock](https://github.com/dblock).\n```\n"
               ]
             end
           end

data/spec/fixtures/changelogs/dates.md

@@ -0,0 +1,13 @@
+## Changelog
+
+### 1.2.3 (Next)
+### 1.2.3 - Next
+### 1.2.3 (2018/1/2)
+### 1.2.3 (2018-1-2)
+### 1.2.3 (2018-01-02)
+### 1.2.3 (2018/01/02)
+### 1.2.3 (1/2/2018)
+### 1.2.3 (2018/13/1)
+### 1.2.3 (2018/13)
+### 1.2.3 (2018/1/1/3)
+### 1.2.3 - 2018/01/02

data/spec/fixtures/changelogs/imbalanced.md

@@ -0,0 +1,7 @@
+### 0.0.0)
+### (0.0.1
+### 1.2.3 (2018/1/1
+### 0.1.0 2018/1/1)
+### 0 ((2018/1/1)
+### 0. [2018/1/1)
+### 0.1. (2018/1/1)]

data/spec/fixtures/changelogs/{with_bad_lines.md → lines.md}

@@ -5,4 +5,6 @@ Missing star - [@dblock](https://github.com/dblock).
 * [#1](https://github.com/dblock/danger-changelog/pull/1): No final period - [@dblock](https://github.com/dblock)
 # [#1](https://github.com/dblock/danger-changelog/pull/1): Hash instead of star - [@dblock](https://github.com/dblock).
 * [#1](https://github.com/dblock/danger-changelog/pull/1): Extra period. - [@dblock](https://github.com/dblock).
+* [#1](https://github.com/dblock/danger-changelog/pull/1): Unbalanced ( - [@dblock](https://github.com/dblock).
+* [#1](https://github.com/dblock/danger-changelog/pull/1): Unbalanced ] - [@dblock](https://github.com/dblock).
 * Your contribution here.

data/spec/fixtures/changelogs/{with_bad_semver.md → semver.md}

@@ -1,5 +1,8 @@
 ## Changelog
 
+### Changed:
+### Fixed:
+
 ### 0.0.0
 ### 0.0.1
 ### 1.2.3 (2018/1/1)
@@ -10,3 +13,7 @@
 ### 0.0.4
 ### 10.2.3-DEV-SNAPSHOT
 ### 99999999999999999999999.999999999999999999.99999999999999999
+
+### 0.1.1 [2018/1/1]
+### [0.1.1] [2018/1/1]
+## [0.2.2] - 2017-06-20

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-changelog
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - dblock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-16 00:00:00.000000000 Z
+date: 2018-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -193,11 +193,12 @@ files:
 - 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/lines.md
 - spec/fixtures/changelogs/minimal.md
 - spec/fixtures/changelogs/missing_your_contribution_here.md
-- spec/fixtures/changelogs/with_bad_dates.md
-- spec/fixtures/changelogs/with_bad_lines.md
-- spec/fixtures/changelogs/with_bad_semver.md
+- spec/fixtures/changelogs/semver.md
 - spec/spec_helper.rb
 homepage: https://github.com/dblock/danger-changelog
 licenses:
@@ -232,9 +233,10 @@ test_files:
 - 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/lines.md
 - spec/fixtures/changelogs/minimal.md
 - spec/fixtures/changelogs/missing_your_contribution_here.md
-- spec/fixtures/changelogs/with_bad_dates.md
-- spec/fixtures/changelogs/with_bad_lines.md
-- spec/fixtures/changelogs/with_bad_semver.md
+- spec/fixtures/changelogs/semver.md
 - spec/spec_helper.rb

data/spec/fixtures/changelogs/with_bad_dates.md

@@ -1,25 +0,0 @@
-## Changelog
-
-### 1.2.3 (Next)
-
-* Your contribution here.
-
-### 1.2.3 (2018/1/2)
-
-* [#1](https://github.com/dblock/danger-changelog/pull/1): Change - [@dblock](https://github.com/dblock).
-
-### 1.2.3 (1/2/2018)
-
-* [#1](https://github.com/dblock/danger-changelog/pull/1): Change - [@dblock](https://github.com/dblock).
-
-### 1.2.3 (2018/13/1)
-
-* [#1](https://github.com/dblock/danger-changelog/pull/1): Change - [@dblock](https://github.com/dblock).
-
-### 1.2.3 (2018/13)
-
-* [#1](https://github.com/dblock/danger-changelog/pull/1): Change - [@dblock](https://github.com/dblock).
-
-### 1.2.3 (2018/1/1/3)
-
-* [#1](https://github.com/dblock/danger-changelog/pull/1): Change - [@dblock](https://github.com/dblock).