parse_a_changelog 1.3.0 → 1.3.2

data/spec/fixtures/missing_newline_before_unreleased.md

@@ -0,0 +1,30 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+## [Unreleased]
+### Added
+- Added a thing.
+
+### Changed
+- Changed a thing.
+
+## [1.0.0] - 2019-01-03
+### Deprecated
+- Some things were deprecated.
+
+## 0.1.0 - 2018-11-28
+### Removed
+- Removed all
+  the things.
+
+### Fixed
+- Fixed all the bugs from the non-existent previous release.
+
+### Security
+- We are so secure now.
+- The securest.
+
+[Unreleased]: https://github.com/conjurinc/evoke/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/conjurinc/evoke/compare/v0.1.0...v1.0.0

data/spec/fixtures/missing_newline_between_changes.md

@@ -0,0 +1,30 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Added a thing.
+### Changed
+- Changed a thing.
+
+## [1.0.0] - 2019-01-03
+### Deprecated
+- Some things were deprecated.
+
+## 0.1.0 - 2018-11-28
+### Removed
+- Removed all
+  the things.
+
+### Fixed
+- Fixed all the bugs from the non-existent previous release.
+
+### Security
+- We are so secure now.
+- The securest.
+
+[Unreleased]: https://github.com/conjurinc/evoke/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/conjurinc/evoke/compare/v0.1.0...v1.0.0

data/spec/fixtures/missing_release_date.md

@@ -0,0 +1,31 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Added a thing.
+
+### Changed
+- Changed a thing.
+
+## [1.0.0] - 2019-01-03
+### Deprecated
+- Some things were deprecated.
+
+## 0.1.0
+### Removed
+- Removed all
+  the things.
+
+### Fixed
+- Fixed all the bugs from the non-existent previous release.
+
+### Security
+- We are so secure now.
+- The securest.
+
+[Unreleased]: https://github.com/conjurinc/evoke/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/conjurinc/evoke/compare/v0.1.0...v1.0.0

data/spec/fixtures/no_releases.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+### Added
+- Added a thing.
+
+### Changed
+- Changed a thing.

data/spec/fixtures/unknown_change_type.md

@@ -0,0 +1,31 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Added a thing.
+
+### Changed
+- Changed a thing.
+
+## [1.0.0] - 2019-01-03
+### Deprecated
+- Some things were deprecated.
+
+## 0.1.0 - 2018-11-28
+### Squashed
+- Removed all
+  the things.
+
+### Fixed
+- Fixed all the bugs from the non-existent previous release.
+
+### Security
+- We are so secure now.
+- The securest.
+
+[Unreleased]: https://github.com/conjurinc/evoke/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/conjurinc/evoke/compare/v0.1.0...v1.0.0

data/spec/parser_spec.rb

@@ -0,0 +1,163 @@
+require_relative '../lib/parse_a_changelog.rb'
+
+describe ParseAChangelog do
+  subject(:parser) { ParseAChangelog }
+
+  it "parses a correctly-formatted changelog" do
+    expect(parser.parse("spec/fixtures/correct.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+
+  it "parses a 4 digit version" do
+    expect(parser.parse("spec/fixtures/correct_with_4_digit_version.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+
+  it "parses a 4 digit version with version metadata" do
+    expect(parser.parse("spec/fixtures/correct_with_4_digit_version_and_metadata.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+  
+  it "parses a 4 digit version with a release candidate version" do
+    expect(parser.parse("spec/fixtures/correct_with_4_digit_version_and_pre_release.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+  
+  it "parses an initial release tag link" do
+    expect(parser.parse("spec/fixtures/correct_initial_tag.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+
+  it "parses an empty unreleased section" do
+    expect(parser.parse("spec/fixtures/correct_empty_unreleased.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+
+  it "parses an empty diff section" do
+    expect(parser.parse("spec/fixtures/correct_empty_diff.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+
+  it "parses a changelog with no releases" do
+    expect(parser.parse("spec/fixtures/no_releases.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+
+  it "parses a changelog with https header links" do
+    expect(parser.parse("spec/fixtures/correct_https.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+
+  it "parses a changelog with a release candidate version" do
+    expect(parser.parse("spec/fixtures/correct_with_pre_release.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+
+  it "parses a changelog with version metadata" do
+    expect(parser.parse("spec/fixtures/correct_with_metadata.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+
+  it "parses a changelog without a SemVer declaration" do
+    expect(parser.parse("spec/fixtures/correct_no_semver.md")).
+      to be_an_instance_of(Treetop::Runtime::SyntaxNode)
+  end
+
+  it "errors on malformed changelog header" do
+    expect {
+      parser.parse("spec/fixtures/malformed_changelog_header.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 4/)
+  end
+
+  it "errors on malformed unreleased header" do
+    expect {
+      parser.parse("spec/fixtures/malformed_unreleased_header.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 7/)
+  end
+
+  it "errors on malformed release header" do
+    expect {
+      parser.parse("spec/fixtures/malformed_release_header.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 14/)
+  end
+
+  # TODO: this may be too strict as keep-a-changelog doesn't require semver.
+  it "errors on malformed release version" do
+    expect {
+      parser.parse("spec/fixtures/malformed_release_version.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 14/)
+  end
+
+  # TODO: this maybe be too strict as keep-a-changelog doesn't specify.
+  it "errors on incorrect releaser header delimiter" do
+    expect {
+      parser.parse("spec/fixtures/incorrect_release_header_delimiter.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 18/)
+  end
+
+  it "errors on release header with missing release date" do
+    expect {
+      parser.parse("spec/fixtures/missing_release_date.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 18/)
+  end
+
+  it "errors on malformed release date" do
+    expect {
+      parser.parse("spec/fixtures/malformed_release_date.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 14/)
+  end
+
+  it "errors on malformed change header" do
+    expect {
+      parser.parse("spec/fixtures/malformed_change_header.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 15/)
+  end
+
+  it "errors on unknown change type" do
+    expect {
+      parser.parse("spec/fixtures/unknown_change_type.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 19/)
+  end
+
+  it "errors on incorrect change prefix" do
+    expect {
+      parser.parse("spec/fixtures/incorrect_change_prefix.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 12/)
+  end
+
+  it "errors on missing newline at end of file" do
+    expect {
+      parser.parse("spec/fixtures/missing_newline_at_eof.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 31/)
+  end
+
+  it "errors on missing newline before unreleased section" do
+    expect {
+      parser.parse("spec/fixtures/missing_newline_before_unreleased.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 6/)
+  end
+
+  it "errors on missing newline before releases sections" do
+    expect {
+      parser.parse("spec/fixtures/missing_newline_before_releases.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 13/)
+  end
+
+  it "errors on missing newline between change sections" do
+    expect {
+      parser.parse("spec/fixtures/missing_newline_between_changes.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 10/)
+  end
+
+  it "errors on missing newline before diff sections" do
+    expect {
+      parser.parse("spec/fixtures/missing_newline_before_diffs.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 29/)
+  end
+
+  it "errors on malformed diff version" do
+    expect {
+      parser.parse("spec/fixtures/malformed_diff_version.md")
+    }.to raise_error(ParseAChangelog::ParseError, /line 10/)
+  end
+end

data/test.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+set -eux
+
+echo "==> Starting test.sh"
+
+echo "==> Docker Run"
+
+docker run --rm \
+    --volume $PWD:/work \
+    --workdir /work \
+    cyberark/ubuntu-ruby-builder \
+      bash -c 'git config --global \
+      --add safe.directory /work && \
+      bundle install && bundle exec rspec' 
+
+echo "==> End of test.sh"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse_a_changelog
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - John Tuttle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '3.10'
 description: Uses a grammar describing the keep-a-changelog format to attempt to parse
   a given file.
 email: jtuttle.develops@gmail.com
@@ -74,13 +74,58 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".github/CODEOWNERS"
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
+- CONTRIBUTING.md
+- Contributing_OSS/CyberArk_Open_Source_Contributor_Agreement.pdf
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- Jenkinsfile
 - LICENSE
+- NOTICES.txt
 - README.md
-- VERSION
+- Rakefile
+- SECURITY.md
 - bin/parse
+- build.sh
 - lib/grammar.tt
 - lib/parse_a_changelog.rb
+- parse_a_changelog.gemspec
+- publish.sh
+- spec/fixtures/correct.md
+- spec/fixtures/correct_empty_diff.md
+- spec/fixtures/correct_empty_unreleased.md
+- spec/fixtures/correct_https.md
+- spec/fixtures/correct_initial_tag.md
+- spec/fixtures/correct_no_semver.md
+- spec/fixtures/correct_with_4_digit_version.md
+- spec/fixtures/correct_with_4_digit_version_and_metadata.md
+- spec/fixtures/correct_with_4_digit_version_and_pre_release.md
+- spec/fixtures/correct_with_metadata.md
+- spec/fixtures/correct_with_pre_release.md
+- spec/fixtures/incorrect_change_prefix.md
+- spec/fixtures/incorrect_release_header_delimiter.md
+- spec/fixtures/malformed_change_header.md
+- spec/fixtures/malformed_changelog_header.md
+- spec/fixtures/malformed_diff_version.md
+- spec/fixtures/malformed_release_date.md
+- spec/fixtures/malformed_release_header.md
+- spec/fixtures/malformed_release_version.md
+- spec/fixtures/malformed_unreleased_header.md
+- spec/fixtures/missing_newline_at_eof.md
+- spec/fixtures/missing_newline_before_diffs.md
+- spec/fixtures/missing_newline_before_releases.md
+- spec/fixtures/missing_newline_before_unreleased.md
+- spec/fixtures/missing_newline_between_changes.md
+- spec/fixtures/missing_release_date.md
+- spec/fixtures/no_releases.md
+- spec/fixtures/unknown_change_type.md
+- spec/parser_spec.rb
+- test.sh
 homepage: http://github.com/cyberark/parse-a-changelog
 licenses:
 - Apache-2.0
@@ -100,8 +145,37 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: A validator for the keep-a-changelog format
-test_files: []
+test_files:
+- spec/fixtures/correct.md
+- spec/fixtures/correct_empty_diff.md
+- spec/fixtures/correct_empty_unreleased.md
+- spec/fixtures/correct_https.md
+- spec/fixtures/correct_initial_tag.md
+- spec/fixtures/correct_no_semver.md
+- spec/fixtures/correct_with_4_digit_version.md
+- spec/fixtures/correct_with_4_digit_version_and_metadata.md
+- spec/fixtures/correct_with_4_digit_version_and_pre_release.md
+- spec/fixtures/correct_with_metadata.md
+- spec/fixtures/correct_with_pre_release.md
+- spec/fixtures/incorrect_change_prefix.md
+- spec/fixtures/incorrect_release_header_delimiter.md
+- spec/fixtures/malformed_change_header.md
+- spec/fixtures/malformed_changelog_header.md
+- spec/fixtures/malformed_diff_version.md
+- spec/fixtures/malformed_release_date.md
+- spec/fixtures/malformed_release_header.md
+- spec/fixtures/malformed_release_version.md
+- spec/fixtures/malformed_unreleased_header.md
+- spec/fixtures/missing_newline_at_eof.md
+- spec/fixtures/missing_newline_before_diffs.md
+- spec/fixtures/missing_newline_before_releases.md
+- spec/fixtures/missing_newline_before_unreleased.md
+- spec/fixtures/missing_newline_between_changes.md
+- spec/fixtures/missing_release_date.md
+- spec/fixtures/no_releases.md
+- spec/fixtures/unknown_change_type.md
+- spec/parser_spec.rb

data/VERSION

@@ -1 +0,0 @@
-1.3.0