keepthechange 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5c4bf13b78872db6e1dd16909a9b2987dc1f4aa
-  data.tar.gz: a4058b6c35f0f5f3a8d6c5b6e6da04d7a4327d09
+  metadata.gz: a3e4fbae1102437bd07a076aa61af0e3e185db57
+  data.tar.gz: ec732ac579541c5518a96468fe19f4c2067bb342
 SHA512:
-  metadata.gz: 1a36c78283dc6bd121c8ec99eafa89da7cc4739cc1bb5dc7c5a2288afd80650bc2935c53f66bfa5b656b87ac804d30d25e1babc9533a5027daae0c40fa29ba80
-  data.tar.gz: 7fa9da2fa58e31efc1aa842c115b93c18b68a50d12fab375d2ec5bd5ca8cd4b2ac07a7456440054b5397ba4de1c76597ec5b62000de11bbe27bc9b313fa503b9
+  metadata.gz: 57c1d313403f0e214baad21b139d02c51251785bea2b600ec6a93c46505f4e3118eb13a5b8dcb2e4b9771c8ff2b6797e4357e686b107a16cfc4bf4b2da61364e
+  data.tar.gz: f9c96f859cc755f55b3b03e2ae404a74c2ecdce1064dca297f2e655dcff032f74865f0539e6664e416ddb8a01a2b46e81f4de77dd9c7ed171d84f3c98f10adf0

data/CHANGELOG.md

@@ -4,6 +4,13 @@ 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.0] - 2017-09-27
+### Added
+- `print_header` parameter for `Parser#combine_changes` method.
+
+### Fixed
+- `Parser#combine_changes` no longer modifies the original `@changelog_hash`.
+
+## [0.1.0] - 2017-08-22
 ### Added
 - Initial release.

data/README.md

@@ -1,5 +1,6 @@
 # KeepTheChange
 
+[![Gem Version](https://badge.fury.io/rb/keepthechange.svg)](https://badge.fury.io/rb/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)
 
@@ -31,22 +32,39 @@ $ gem install keepthechange
 
 ## Usage
 
+### Parsed Changes Hash
+
 ```ruby
-changes_hash = KeepTheChange::Parser.new(changelog: File.read('CHANGELOG.md')).parse
+parser = KeepTheChange::Parser.new(changelog: File.read('CHANGELOG.md'))
+changes_hash = parser.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.
 
+### Combine Multiple Changesets
+
+If you only provide one argument to `combine_changes()`, the resulting output will contain changes since that
+version.
+
+```ruby
+File.write('SINCE_0.1.7.md', parser.combine_changes('0.1.7'))
+```
+
+> `0.1.7` itself won't be included in the resulting file.
+
+Specify both the lower and upper bound (again - lower bound is exclusive) to produce output with changes between the versions.
+
+```ruby
+File.write('0.1.7-1.0.3.md', parser.combine_changes('0.1.7', '1.0.3'))
+```
 
 ## 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.
+run `bin/simple_test` after putting a `TEST_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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/keepthechange/parser.rb

@@ -47,11 +47,11 @@ module KeepTheChange
     #
     # @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)
+    def combine_changes(since_version, to_version = nil, print_header = true)
       parse if @changelog_hash.empty?
 
       combined_changes = {}
-      filtered_changes = @changelog_hash
+      filtered_changes = Marshal.load(Marshal.dump(@changelog_hash))
       if to_version
         filtered_changes.delete_if do |key, _|
           SemVersion.new(key) <= SemVersion.new(since_version) ||
@@ -71,11 +71,16 @@ module KeepTheChange
         end
       end
 
-      output = "## Changes since [#{since_version}]"
-      output << " (and up to [#{to_version}])" if to_version
+      if print_header
+        output = "## Changes since [#{since_version}]"
+        output << " (and up to [#{to_version}])" if to_version
+      else
+        output = ''
+      end
 
       combined_changes.each do |section, changes_list|
-        output << "\n\n### #{section}"
+        output << "\n\n" unless output.empty?
+        output << "### #{section}"
         output << "\n#{changes_list}"
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keepthechange
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eugene Piven
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sem_version
@@ -74,8 +74,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- LICENSE
 - README.md
 - lib/keepthechange.rb
 - lib/keepthechange/parser.rb

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-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.