parse_a_changelog 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff7a1a2e3159c085fe1539b036fe133d39853aba
-  data.tar.gz: a72e07653087f502dba620b269ac165e5cf94460
+  metadata.gz: 88f22b714176096b7b74215c45ae366fc975bb3b
+  data.tar.gz: 9941e8d79d75ef6978fb7bedc325ff64705f6428
 SHA512:
-  metadata.gz: 5d2050184b2680e52143eec39c4d1ddfbfdacea063866ffd5835c7cc99255ed8f8caa84bb24868a00e3b386c86fc591e4e295f3e4ec69e65f482141f1c13a3aa
-  data.tar.gz: 2b6678c8ec48af82f6f8d5415c240503cc7c53e33f049966cc254dd77699f3c0c04d584449fd28f82cfa7d461a63b5f29e3252582103357d9677611a96fdf19e
+  metadata.gz: 32622036ddf563e60128b569152d5bd727c98eca9123814ed717792761df2a3961f3f67e5fc54a27abb3a95934f569c6ef80b750aeb135ebbd5c22c3c474d8ef
+  data.tar.gz: 33a56a2fe9d808ba445a9e26c97bb22b1988af9061d9fdf365995ea95d4b25aa50300843a0ea3f6bfdbf6068f19025de50e4cdd8383842999e681f1f9be399c0

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+# 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]
+
+## [0.2.1] - 2019-01-30
+### Added
+- Missing gemspec files
+- Gemspec executable metadata
+
+### Changed
+- Move dependencies to gemspec
+
+### Removed
+- Gemfile.lock from source control
+
+## [0.2.0] - 2019-01-25
+### Added
+- Gitlab pipeline configuration
+- Dockerfile (currently for manual usage)
+- CI pipeline validates changelog
+- Binary file to gemspec
+
+## [0.1.2] - 2019-01-23
+### Changed
+- Version bump to replace yanked previous version
+
+## [0.1.1] - 2019-01-23
+### Removed
+- Fixed incorrect Ruby file name in binary
+
+## 0.1.0 - 2019-01-23
+### Added
+- First draft of the Keep A Changelog parser
+- Open source license and contributing information
+- Change log and versioning information
+
+[Unreleased]: https://github.com/cyberark/parse-a-changelog/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/cyberark/parse-a-changelog/compare/v0.1.2...v0.2.0
+[0.1.2]: https://github.com/cyberark/parse-a-changelog/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/cyberark/parse-a-changelog/compare/v0.1.0...v0.1.1

data/LICENSE.md

@@ -0,0 +1,163 @@
+GNU Lesser General Public License
+=================================
+
+_Version 3, 29 June 2007_  
+_Copyright © 2007 Free Software Foundation, Inc. &lt;<http://fsf.org/>&gt;_
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+
+This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+### 0. Additional Definitions
+
+As used herein, “this License” refers to version 3 of the GNU Lesser
+General Public License, and the “GNU GPL” refers to version 3 of the GNU
+General Public License.
+
+“The Library” refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the “Linked
+Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+### 1. Exception to Section 3 of the GNU GPL
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+### 2. Conveying Modified Versions
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+* **a)** under this License, provided that you make a good faith effort to
+ensure that, in the event an Application does not supply the
+function or data, the facility still operates, and performs
+whatever part of its purpose remains meaningful, or
+
+* **b)** under the GNU GPL, with none of the additional permissions of
+this License applicable to that copy.
+
+### 3. Object Code Incorporating Material from Library Header Files
+
+The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+* **a)** Give prominent notice with each copy of the object code that the
+Library is used in it and that the Library and its use are
+covered by this License.
+* **b)** Accompany the object code with a copy of the GNU GPL and this license
+document.
+
+### 4. Combined Works
+
+You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+* **a)** Give prominent notice with each copy of the Combined Work that
+the Library is used in it and that the Library and its use are
+covered by this License.
+
+* **b)** Accompany the Combined Work with a copy of the GNU GPL and this license
+document.
+
+* **c)** For a Combined Work that displays copyright notices during
+execution, include the copyright notice for the Library among
+these notices, as well as a reference directing the user to the
+copies of the GNU GPL and this license document.
+
+* **d)** Do one of the following:
+    - **0)** Convey the Minimal Corresponding Source under the terms of this
+License, and the Corresponding Application Code in a form
+suitable for, and under terms that permit, the user to
+recombine or relink the Application with a modified version of
+the Linked Version to produce a modified Combined Work, in the
+manner specified by section 6 of the GNU GPL for conveying
+Corresponding Source.
+    - **1)** Use a suitable shared library mechanism for linking with the
+Library.  A suitable mechanism is one that **(a)** uses at run time
+a copy of the Library already present on the user's computer
+system, and **(b)** will operate properly with a modified version
+of the Library that is interface-compatible with the Linked
+Version.
+
+* **e)** Provide Installation Information, but only if you would otherwise
+be required to provide such information under section 6 of the
+GNU GPL, and only to the extent that such information is
+necessary to install and execute a modified version of the
+Combined Work produced by recombining or relinking the
+Application with a modified version of the Linked Version. (If
+you use option **4d0**, the Installation Information must accompany
+the Minimal Corresponding Source and Corresponding Application
+Code. If you use option **4d1**, you must provide the Installation
+Information in the manner specified by section 6 of the GNU GPL
+for conveying Corresponding Source.)
+
+### 5. Combined Libraries
+
+You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+* **a)** Accompany the combined library with a copy of the same work based
+on the Library, uncombined with any other library facilities,
+conveyed under the terms of this License.
+* **b)** Give prominent notice with the combined library that part of it
+is a work based on the Library, and explaining where to find the
+accompanying uncombined form of the same work.
+
+### 6. Revised Versions of the GNU Lesser General Public License
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License “or any later version”
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,45 @@
+# parse-a-changelog
+
+This gem validates that a file conforms to the [Keep a Changelog](https://keepachangelog.com) standard.
+
+It does so by defining the Keep a Changelog grammar and using the [treetop parsing DSL](https://github.com/cjheath/treetop) to parse your changelog file according to that grammar.
+
+## Usage
+
+Add `parse-a-changelog` to your Gemfile and `bundle install` or install directly with:
+
+```
+gem install parse-a-changelog
+```
+
+The gem can then be used via CLI:
+
+```
+parse path/to/changelog
+```
+
+Or it can be used directly in your Ruby code:
+
+```
+result = ParseAChangelog::parse("path/to/changelog")
+```
+
+# Development
+
+We welcome contributions of all kinds to `parse-a-changelog`. See our [contributing guide](CONTRIBUTING.md).
+
+# Testing
+
+Make sure you have the `rspec` gem installed in your current gem set then run the tests like so:
+
+```
+$ rspec
+..................
+
+Finished in 0.02494 seconds (files took 0.21634 seconds to load)
+18 examples, 0 failures
+```
+
+# License
+
+The parse-a-changelog gem is licensed under Apache License 2.0 - see [`LICENSE.md`](LICENSE.md) for more details.

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/lib/grammar.tt

@@ -0,0 +1,74 @@
+grammar KeepAChangelog
+  rule changelog
+    changelog_header unreleased_section releases_section diff_section?
+  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://keepachangelog.com/en/1.0.0/)' "\n"
+    'and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).' "\n"
+    "\n"
+  end
+
+  rule unreleased_section
+    unreleased_header change_section? ("\n" change_section)*
+  end
+
+  rule unreleased_header
+    '## ' '['? 'Unreleased' ']'? "\n"
+  end
+
+  rule change_section
+    change_header change+
+  end
+
+  rule change_header
+    '### ' ('Added' / 'Changed' / 'Deprecated' / 'Removed' / 'Fixed' / 'Security') "\n"
+  end
+
+  rule change
+    ('- ' / '  ') (!"\n" .)+ "\n"?
+  end
+
+  rule releases_section
+    release*
+  end
+  
+  rule release
+    "\n" release_header change_section? ("\n" change_section)*
+  end
+
+  rule release_header
+    '## ' '['? release_version ']'? ' - ' release_date "\n"
+  end
+
+  rule release_version
+    [0-9]+ '.' [0-9]+ '.' [0-9]+
+  end
+
+  rule release_date
+    [0-9] [0-9] [0-9] [0-9] '-' [0-9] [0-9] '-' [0-9] [0-9]
+  end
+
+  rule diff_section
+    "\n" unreleased_diff release_diff*
+  end
+
+  rule unreleased_diff
+    '[Unreleased]: ' release_url "\n"
+  end
+
+  rule release_diff
+    '[' release_version ']: ' release_url "\n"
+  end
+
+  rule release_url
+    'https://github.com/' (!'/' .)+ '/' (!'/' .)+ '/compare/' diff_version '...' diff_version
+  end
+
+  rule diff_version
+    ('HEAD' / 'v' release_version)
+  end
+end

metadata

@@ -1,22 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: parse_a_changelog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - John Tuttle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
-dependencies: []
-description: A validator for the keep-a-changelog format
+date: 2019-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Uses a grammar describing the keep-a-changelog format to attempt to parse
+  a given file.
 email: jtuttle.develops@gmail.com
-executables: []
+executables:
+- parse
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- VERSION
 - bin/parse
+- lib/grammar.tt
 - lib/parse_a_changelog.rb
 homepage: http://github.com/cyberark/parse-a-changelog
 licenses: