keepthechange 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5c4bf13b78872db6e1dd16909a9b2987dc1f4aa
+  data.tar.gz: a4058b6c35f0f5f3a8d6c5b6e6da04d7a4327d09
+SHA512:
+  metadata.gz: 1a36c78283dc6bd121c8ec99eafa89da7cc4739cc1bb5dc7c5a2288afd80650bc2935c53f66bfa5b656b87ac804d30d25e1babc9533a5027daae0c40fa29ba80
+  data.tar.gz: 7fa9da2fa58e31efc1aa842c115b93c18b68a50d12fab375d2ec5bd5ca8cd4b2ac07a7456440054b5397ba4de1c76597ec5b62000de11bbe27bc9b313fa503b9

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 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
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at thepegasd@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eugene Piven
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# KeepTheChange
+
+[![Build Status](https://travis-ci.org/pegasd/keepthechange.svg?branch=master)](https://travis-ci.org/pegasd/keepthechange)
+[![Coverage Status](https://coveralls.io/repos/github/pegasd/keepthechange/badge.svg)](https://coveralls.io/github/pegasd/keepthechange)
+
+This gem provides an easy-to-use interface for parsing CHANGELOG files that strictly adhere to
+[keep a changelog format](http://keepachangelog.com/).
+
+The idea is loosely based on [vandamme](https://github.com/tech-angels/vandamme) gem, but is supposed to evolve
+into something more strict (in terms of supported formats), but also more feature-rich.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keepthechange', '~> 0.1'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install keepthechange
+```
+
+## Usage
+
+```ruby
+changes_hash = KeepTheChange::Parser.new(changelog: File.read('CHANGELOG.md')).parse
+```
+
+This will produce a hash where keys are version numbers (e.g. `0.1.0`, `1.0.3`) and values are hashes themselves.
+Those will have headers as keys (e.g. `Added`, `Fixed`) and changesets as corresponding values.
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also 
+run `bin/simple_test` after putting a `CHANGELOG.md` into the repo directory for a basic parsing test.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in 
+`version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push 
+the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports, feature requests and pull requests are welcome at [KeepTheChange official repo](https://github.com/pegasd/keepthechange).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Keepthechange project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the 
+[Code of Conduct](https://github.com/pegasd/keepthechange/blob/master/CODE_OF_CONDUCT.md).

data/lib/keepthechange.rb

@@ -0,0 +1 @@
+require 'keepthechange/parser'

data/lib/keepthechange/parser.rb

@@ -0,0 +1,103 @@
+require 'strscan'
+require 'sem_version'
+
+# Parse Changelogs
+module KeepTheChange
+  # Changelog Parser class. Use a separate instance for each Changelog.
+  class Parser
+    # Version header RE (these are searched for in the Changelog to find actual versions)
+    VERSION_HEADER_RE = /^## \[(\d+\.\d+\.\d+)\] - (\d{4}-\d{2}-\d{2}).*$/
+    # Section header RE (these are searched inside each version changeset to find sections)
+    SECTION_HEADER_RE = /^### (.*)$/
+
+    # @param [String] changelog Markdown contents of Changelog to be parsed.
+    # @param [Regexp] version_header_re Custom header RE.
+    # @param [Regexp] section_header_re Custom section RE.
+    #
+    # @return [KeepTheChange::Parser] Ready to parse!
+    def initialize(changelog: '', version_header_re: VERSION_HEADER_RE, section_header_re: SECTION_HEADER_RE)
+      @changelog         = changelog
+      @version_header_re = version_header_re
+      @section_header_re = section_header_re
+      @changelog_hash    = {}
+    end
+
+    # Parse the Changelog and return a hash of changes.
+    #   @changelog_hash = {
+    #     '1.0.0' => {
+    #       'Added' => "- Change 1\n- Change 2",
+    #       'Fixed' => "- Bugfix"
+    #     }
+    #   }
+    #
+    # @return [Hash] Hash of version numbers, headers, and changesets.
+    def parse
+      @changelog.scan(@version_header_re) do |match|
+        version_changes = Regexp.last_match.post_match
+        scanner         = StringScanner.new(version_changes)
+        scanner.scan_until(@version_header_re)
+        version_changes           = parse_version_changes(scanner.pre_match || version_changes)
+        @changelog_hash[match[0]] = version_changes
+      end
+      @changelog_hash
+    end
+
+    # Combine changes for multiple versions. The `since_version` is your `current` version.
+    # This means that changes will start combining from the next version up.
+    #
+    # @param [String] since_version Version to start parsing from. Changes for this version won't be included.
+    # @param [String] to_version Version to stop parsing at.
+    def combine_changes(since_version, to_version = nil)
+      parse if @changelog_hash.empty?
+
+      combined_changes = {}
+      filtered_changes = @changelog_hash
+      if to_version
+        filtered_changes.delete_if do |key, _|
+          SemVersion.new(key) <= SemVersion.new(since_version) ||
+            SemVersion.new(key) > SemVersion.new(to_version)
+        end
+      else
+        filtered_changes.delete_if { |key, _| SemVersion.new(key) <= SemVersion.new(since_version) }
+      end
+
+      filtered_changes.each do |_, changes|
+        changes.each do |section, changes_list|
+          if combined_changes.key? section
+            combined_changes[section] << "\n" << changes_list
+          else
+            combined_changes[section] = changes_list
+          end
+        end
+      end
+
+      output = "## Changes since [#{since_version}]"
+      output << " (and up to [#{to_version}])" if to_version
+
+      combined_changes.each do |section, changes_list|
+        output << "\n\n### #{section}"
+        output << "\n#{changes_list}"
+      end
+
+      output << "\n"
+    end
+
+    private
+
+    # Parse a changeset for a specific version and return a hash of different kinds of changes.
+    #
+    # @param [String] changes Changeset for one version.
+    #
+    # @return [Hash] Hash with headers (`Added`, `Fixed`, etc) as keys and related changesets as values.
+    def parse_version_changes(changes)
+      changes_hash = {}
+      changes.scan(@section_header_re) do |match|
+        block_changes = Regexp.last_match.post_match
+        scanner       = StringScanner.new(block_changes)
+        scanner.scan_until(@section_header_re)
+        changes_hash[match[0]] = (scanner.pre_match || block_changes).gsub(/(\A\n+|\n+\z)/, '')
+      end
+      changes_hash
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: keepthechange
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eugene Piven
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sem_version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Changelog parser (strictly follows keepachangelog.com format)
+email:
+- thepegasd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- lib/keepthechange.rb
+- lib/keepthechange/parser.rb
+homepage: https://github.com/pegasd/keepthechange
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Changelog parser
+test_files: []