parse_a_changelog 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 386dfd71c49f61ffdd42469141d5a687d4facdd7e2322303a3dd34a92a3b028b
-  data.tar.gz: d2799e8f10212c91a043e96360ae7597c996c4c7ae4cfee125bd0a9d21227cd8
+  metadata.gz: e045590cfc9f23d38e8f2defb7eef9e0922d03abb4912a8b7b89f241e71e1163
+  data.tar.gz: 22fb2fbc1e1a1cdee66307a2808b83ca1469028d9bae4f94e86f260f6169e1f5
 SHA512:
-  metadata.gz: c88acee63ea012d034a5e32fa0dea5dd91da06b99a67e69720df013f8e7f565904c02ff754542b6bcb83f8a9558bf4c1ec882221951bb1ff2915f8144a7b7e6c
-  data.tar.gz: e0272cdd7d0a62cc0f04447641fd7531b66facaaf411475cd35285f549f82ff193a1f826cb541910b636fc9155d60fc7e07c5383b5e2afbd3478f1e78a975da3
+  metadata.gz: 4c7f832c309f8ce46d459ba44016213b89ecd5465e6a6395f8b8fe2142deae05da2894a133fead184b0fc9d555eba54cc6251c211c267dfe8e1feff98496aa44
+  data.tar.gz: 3dd90696a9fd42f3e05ec0d3c3f2faed89dc0fb50089382cd144f3772288ad6ef3272da5a31ed440ef38fc323582b0a73cd20dce1b0a29b3082bdf1c1259c713

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.1.0] - 2020-11-12
+### Added
+- Allow for metadata section in version string.
+  [cyberark/parse-a-changelog#34](https://github.com/cyberark/parse-a-changelog/issues/34)
+
 ## [1.0.2] - 2020-08-26
 ### Fixed
 - Added support for semver pre-releases.
@@ -67,7 +72,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Open source license and contributing information
 - Change log and versioning information
 
-[Unreleased]: https://github.com/cyberark/parse-a-changelog/compare/v1.0.2...HEAD
+[Unreleased]: https://github.com/cyberark/parse-a-changelog/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/cyberark/parse-a-changelog/compare/v1.0.2...v1.1.0
 [1.0.2]: https://github.com/cyberark/parse-a-changelog/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/cyberark/parse-a-changelog/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/cyberark/parse-a-changelog/compare/v0.2.3...v1.0.0

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.0

data/lib/grammar.tt

@@ -4,20 +4,20 @@ grammar KeepAChangelog
   end
 
   rule changelog_header
-    '# Changelog' "\n"
-    'All notable changes to this project will be documented in this file.' "\n"
-    "\n"
-    'The format is based on [Keep a Changelog](http' 's'? '://keepachangelog.com/en/1.0.0/)' "\n"
-    'and this project adheres to [Semantic Versioning](http' 's'? '://semver.org/spec/v2.0.0.html).' "\n"
-    "\n"
+    '# Changelog' new_line
+    'All notable changes to this project will be documented in this file.' new_line
+    new_line
+    'The format is based on [Keep a Changelog](http' 's'? '://keepachangelog.com/en/1.0.0/)' new_line
+    'and this project adheres to [Semantic Versioning](http' 's'? '://semver.org/spec/v2.0.0.html).' new_line
+    new_line
   end
 
   rule unreleased_section
-    unreleased_header change_section? ("\n" change_section)*
+    unreleased_header change_section? (new_line change_section)*
   end
 
   rule unreleased_header
-    '## ' '['? 'Unreleased' ']'? "\n"
+    '## ' '['? 'Unreleased' ']'? new_line
   end
 
   rule change_section
@@ -25,11 +25,11 @@ grammar KeepAChangelog
   end
 
   rule change_header
-    '### ' ('Added' / 'Changed' / 'Deprecated' / 'Removed' / 'Fixed' / 'Security') "\n"
+    '### ' ('Added' / 'Changed' / 'Deprecated' / 'Removed' / 'Fixed' / 'Security') new_line
   end
 
   rule change
-    ('- ' / '  ') (!"\n" .)+ "\n"?
+    ('- ' / '  ') (!new_line .)+ new_line?
   end
 
   rule releases_section
@@ -37,22 +37,26 @@ grammar KeepAChangelog
   end
 
   rule release
-    "\n" release_header change_section? ("\n" change_section)*
+    new_line release_header change_section? (new_line change_section)*
   end
 
   rule release_header
-    '## ' '['? release_version ']'? ' - ' release_date "\n"
+    '## ' '['? release_version ']'? ' - ' release_date new_line
   end
 
   rule release_version
-    [0-9]+ '.' [0-9]+ '.' [0-9]+ pre_release_version
+    [0-9]+ '.' [0-9]+ '.' [0-9]+ pre_release_version metadata
   end
 
   rule pre_release_version
-    ( '-' [0-9A-Za-z-]+ pre_release_group* ) / ''
+    ( '-' [0-9A-Za-z-]+ dot_separated_group* ) / ''
+  end
+
+  rule metadata
+    ( '+' [0-9A-Za-z-]+ dot_separated_group*  ) / ''
   end
 
-  rule pre_release_group
+  rule dot_separated_group
     '.' [0-9A-Za-z-]+
   end
 
@@ -61,19 +65,19 @@ grammar KeepAChangelog
   end
 
   rule diff_section
-    "\n" unreleased_diff release_diff*  initial_release?
+    new_line unreleased_diff release_diff*  initial_release?
   end
 
   rule unreleased_diff
-    '[Unreleased]: ' release_url "\n"
+    '[Unreleased]: ' release_url new_line
   end
 
   rule initial_release
-    '[' release_version ']: ' 'https://github.com/' (!'/' .)+ '/' (!'/' .)+ '/releases/tag/v' release_version "\n"
+    '[' release_version ']: ' 'https://github.com/' (!'/' .)+ '/' (!'/' .)+ '/releases/tag/v' release_version new_line
   end
 
   rule release_diff
-    '[' release_version ']: ' release_url "\n"
+    '[' release_version ']: ' release_url new_line
   end
 
   rule release_url
@@ -83,4 +87,8 @@ grammar KeepAChangelog
   rule diff_version
     'HEAD' / ( 'v' release_version )
   end
+        
+  rule new_line
+    "\n"
+  end
 end

data/lib/parse_a_changelog.rb

@@ -10,15 +10,17 @@ module ParseAChangelog
       parser = KeepAChangelogParser.new
       result = parser.parse(file)
 
-      if !result
-        raise ParseError.new(failure_message(parser))
+      unless result
+        raise parser_error(
+                parser.failure_line, parser.failure_column, parser.failure_reason
+              )
       end
-
+      
       result
     end
 
-    def failure_message(parser)
-      parser.failure_reason.split(' after ')[0]
+    def parser_error(line, column, reason)
+      ParseError.new("line #{line}, column #{column}: #{reason}")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse_a_changelog
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - John Tuttle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 description: Uses a grammar describing the keep-a-changelog format to attempt to parse
   a given file.
 email: jtuttle.develops@gmail.com