Merge branch 'master' into abonas-fixComparingPRByMergedAtField

.gitignore

@@ -1,11 +0,0 @@
-bin/
-!bin/git-generate-changelog
-!bin/github_changelog_generator
-pkg/
-coverage/
-.bundle
-spec/*.lock
-doc
-.yardoc
-Gemfile.lock
-gemfiles/Gemfile.2_4_0.lock

.rubocop.yml

@@ -1,12 +1,5 @@
 inherit_from: .rubocop_todo.yml
 
-AllCops:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  Exclude:
-    - 'vendor/**/*'
-    - 'gemfiles/**/*'
-
 Metrics/LineLength:
   Enabled: false
 
@@ -21,49 +14,3 @@ Metrics/ClassLength:
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
     Enabled: false
-
-Style/FileName:
-    Exclude:
-      - 'bin/git-generate-changelog'
-
-#TODOS
-# Offense count: 14
-Metrics/AbcSize:
-  Enabled: false
-
-# Offense count: 1
-Style/AccessorMethodName:
-  Enabled: false
-
-# Offense count: 10
-Style/Documentation:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
-# SupportedStyles: skip_modifier_ifs, always
-Style/Next:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/MutableConstant:
-    Enabled: false
-
-# "Use idx.positive? instead of idx > 0."
-Style/NumericPredicate:
-  Enabled: false
-
-Style/SafeNavigation:
-  Enabled: false

.rubocop_todo.yml

@@ -1,17 +1,11 @@
-# This configuration was generated by
+# This configuration was generated by `rubocop --auto-gen-config`
-# `rubocop --auto-gen-config`
+# on 2015-07-16 14:46:25 +0300 using RuboCop version 0.31.0.
-# on 2016-02-23 17:18:27 +0200 using RuboCop version 0.37.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
+# Offense count: 13
-Lint/ImplicitStringConcatenation:
-  Exclude:
-    - 'lib/github_changelog_generator/parser.rb'
-
-# Offense count: 14
 Metrics/AbcSize:
   Enabled: false
 
@@ -19,11 +13,11 @@ Metrics/AbcSize:
 Metrics/CyclomaticComplexity:
   Max: 7
 
-# Offense count: 2
+# Offense count: 1
 Metrics/PerceivedComplexity:
   Max: 8
 
-# Offense count: 1
+# Offense count: 2
 Style/AccessorMethodName:
   Enabled: false
 
@@ -36,16 +30,13 @@ Style/Documentation:
 Style/GuardClause:
   Enabled: false
 
-# Offense count: 2
+# Offense count: 1
-# Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
-# SupportedStyles: skip_modifier_ifs, always
 Style/Next:
   Enabled: false
 
 # Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
 Style/RegexpLiteral:
   Enabled: false

.ruby-version

@@ -1 +0,0 @@
-2.3.1

.travis.yml

@@ -1,25 +1,10 @@
+sudo: false
+cache: bundler
 language: ruby
-cache:
+rvm:
-  - bundler
+- 2.1.0
-before_install:
+script:
-  - gem update --system
+- bundle exec rake
-  - gem install bundler
-matrix:
-  include:
-    - rvm: 2.2.2
-      install: true # This skips 'bundle install'
-      script: gem build github_changelog_generator && gem install *.gem
-    - rvm: 2.2.2
-      install: true # This skips 'bundle install'
-      script: gem build github_changelog_generator && bundle install
-      gemfile: spec/install-gem-in-bundler.gemfile
-    - rvm: 2.1
-      gemfile: gemfiles/Gemfile.with_rack16
-    - rvm: 2.3.1
-      gemfile: gemfiles/Gemfile.with_rack2
-    - rvm: 2.4.0-preview2
-      gemfile: gemfiles/Gemfile.2_4_0
-
 notifications:
   email:
     recipients:

.yardopts

@@ -1,2 +0,0 @@
---markup=markdown
-

CHANGELOG.md

@@ -1,299 +1,14 @@
 # Change Log
 
-## [1.13.1](https://github.com/skywinder/github-changelog-generator/tree/1.13.1) (2016-07-22)
+## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.13.0...1.13.1)
 
-**Implemented enhancements:**
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...HEAD)
-
-- Don't constrain runtime deps. [\#400](https://github.com/skywinder/github-changelog-generator/pull/400) ([jkeiser](https://github.com/jkeiser))
-
-**Fixed bugs:**
-
-- `--user` flag should not be ignored [\#397](https://github.com/skywinder/github-changelog-generator/issues/397)
-- GHE not working with --github-site set to an enterprise site [\#395](https://github.com/skywinder/github-changelog-generator/issues/395)
-
-**Closed issues:**
-
-- Contributors Section [\#398](https://github.com/skywinder/github-changelog-generator/issues/398)
 
 **Merged pull requests:**
 
-- Ability to implicity set user and project from command line [\#401](https://github.com/skywinder/github-changelog-generator/pull/401) ([skywinder](https://github.com/skywinder))
-- Show how to use it with Rakefile [\#399](https://github.com/skywinder/github-changelog-generator/pull/399) ([edusantana](https://github.com/edusantana))
-- Adds documentation on using a GHE endpoint [\#396](https://github.com/skywinder/github-changelog-generator/pull/396) ([cormacmccarthy](https://github.com/cormacmccarthy))
-- Rake task usage: Added a missing option exclude\_tags\_regex [\#393](https://github.com/skywinder/github-changelog-generator/pull/393) ([perlun](https://github.com/perlun))
-- Parser: YARD docstrings and a rename, and RegExp named capture groups [\#391](https://github.com/skywinder/github-changelog-generator/pull/391) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.13.0](https://github.com/skywinder/github-changelog-generator/tree/1.13.0) (2016-07-04)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.12.1...1.13.0)
-
-**Merged pull requests:**
-
-- Carry PR \#301: usernames\_as\_github\_logins [\#392](https://github.com/skywinder/github-changelog-generator/pull/392) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.12.1](https://github.com/skywinder/github-changelog-generator/tree/1.12.1) (2016-05-09)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.12.0...1.12.1)
-
-**Fixed bugs:**
-
-- github\_changelog\_generator/generator/generator\_tags.rb:61:in `detect\_since\_tag': undefined method `\[\]' for nil:NilClass \(NoMethodError\) [\#351](https://github.com/skywinder/github-changelog-generator/issues/351)
-
-**Closed issues:**
-
-- Add a LICENSE file [\#369](https://github.com/skywinder/github-changelog-generator/issues/369)
-- Error installing on Ubuntu 14.04 [\#364](https://github.com/skywinder/github-changelog-generator/issues/364)
-
-**Merged pull requests:**
-
-- Move dev gems to add\_development\_dependency [\#373](https://github.com/skywinder/github-changelog-generator/pull/373) ([skywinder](https://github.com/skywinder))
-- Add MIT LICENSE file [\#370](https://github.com/skywinder/github-changelog-generator/pull/370) ([olleolleolle](https://github.com/olleolleolle))
-- Avoid nil bug in detect\_since\_tag [\#368](https://github.com/skywinder/github-changelog-generator/pull/368) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.12.0](https://github.com/skywinder/github-changelog-generator/tree/1.12.0) (2016-04-01)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.8...1.12.0)
-
-**Closed issues:**
-
-- .github\_changelog\_generator config file is not consistent with the internal options hash [\#312](https://github.com/skywinder/github-changelog-generator/issues/312)
-- Feature request: YAML front matter [\#276](https://github.com/skywinder/github-changelog-generator/issues/276)
-
-**Merged pull requests:**
-
-- Added tag exclusion with a filter \(string or regex\) [\#320](https://github.com/skywinder/github-changelog-generator/pull/320) ([soundstep](https://github.com/soundstep))
-
-## [1.11.8](https://github.com/skywinder/github-changelog-generator/tree/1.11.8) (2016-03-22)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.7...1.11.8)
-
-**Implemented enhancements:**
-
-- ParserFile: Allow comments in settings file [\#358](https://github.com/skywinder/github-changelog-generator/pull/358) ([olleolleolle](https://github.com/olleolleolle))
-
-**Fixed bugs:**
-
-- Error when specifying exclude\_labels [\#327](https://github.com/skywinder/github-changelog-generator/issues/327)
-- Parse options file options into arrays, integers, flags, and other [\#354](https://github.com/skywinder/github-changelog-generator/pull/354) ([olleolleolle](https://github.com/olleolleolle))
-
-**Closed issues:**
-
-- Installation fails on Ubuntu [\#352](https://github.com/skywinder/github-changelog-generator/issues/352)
-- Test installing on Windows: use AppVeyor [\#348](https://github.com/skywinder/github-changelog-generator/issues/348)
-- Can't run under RubyGems 2.5.1 and Ruby 2.3.0 [\#325](https://github.com/skywinder/github-changelog-generator/issues/325)
-- Ruby 2.3.0 - Deprecation warning: Github::ResponseWrapper\#respond\_to?\(:to\_ary\) is old fashion which takes only one parameter [\#323](https://github.com/skywinder/github-changelog-generator/issues/323)
-- between-tags and exclude-tags do not work in .github\_changelog\_generator [\#317](https://github.com/skywinder/github-changelog-generator/issues/317)
-- Add a "documentation" label [\#284](https://github.com/skywinder/github-changelog-generator/issues/284)
-
-**Merged pull requests:**
-
-- Replace shelling-out-to-Git w/ Dir call [\#360](https://github.com/skywinder/github-changelog-generator/pull/360) ([olleolleolle](https://github.com/olleolleolle))
-- ParserFile: fail parsing with config file line number; use a File instead of a filename [\#357](https://github.com/skywinder/github-changelog-generator/pull/357) ([olleolleolle](https://github.com/olleolleolle))
-- On gem install, do not try to copy manpage files in the "extensions" step [\#356](https://github.com/skywinder/github-changelog-generator/pull/356) ([olleolleolle](https://github.com/olleolleolle))
-- Refactor: call it option\_name, instead of key\_sym [\#355](https://github.com/skywinder/github-changelog-generator/pull/355) ([olleolleolle](https://github.com/olleolleolle))
-- Add a `bundle install` test [\#353](https://github.com/skywinder/github-changelog-generator/pull/353) ([jkeiser](https://github.com/jkeiser))
-- Add an AppVeyor config [\#350](https://github.com/skywinder/github-changelog-generator/pull/350) ([Arcanemagus](https://github.com/Arcanemagus))
-- README: Document GitHub token URI scope [\#345](https://github.com/skywinder/github-changelog-generator/pull/345) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.11.7](https://github.com/skywinder/github-changelog-generator/tree/1.11.7) (2016-03-04)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.6...1.11.7)
-
-**Merged pull requests:**
-
-- Add Olle Jonsson as co-author [\#347](https://github.com/skywinder/github-changelog-generator/pull/347) ([skywinder](https://github.com/skywinder))
-- Gemspec, default date [\#346](https://github.com/skywinder/github-changelog-generator/pull/346) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.11.6](https://github.com/skywinder/github-changelog-generator/tree/1.11.6) (2016-03-01)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.5...1.11.6)
-
-**Fixed bugs:**
-
-- Can't build on Windows [\#340](https://github.com/skywinder/github-changelog-generator/issues/340)
-
-**Closed issues:**
-
-- install error "Not a git repository" [\#339](https://github.com/skywinder/github-changelog-generator/issues/339)
-
-**Merged pull requests:**
-
-- Gemspec: Calculate date using Date stdlib [\#343](https://github.com/skywinder/github-changelog-generator/pull/343) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.11.5](https://github.com/skywinder/github-changelog-generator/tree/1.11.5) (2016-03-01)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.4...1.11.5)
-
-**Merged pull requests:**
-
-- Test clean install in Travis [\#344](https://github.com/skywinder/github-changelog-generator/pull/344) ([jkeiser](https://github.com/jkeiser))
-- Update Rakefile to avoid install-breaking bug [\#341](https://github.com/skywinder/github-changelog-generator/pull/341) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.11.4](https://github.com/skywinder/github-changelog-generator/tree/1.11.4) (2016-02-26)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.3...1.11.4)
-
-**Merged pull requests:**
-
-- Man page copying: only copy .1 [\#338](https://github.com/skywinder/github-changelog-generator/pull/338) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.11.3](https://github.com/skywinder/github-changelog-generator/tree/1.11.3) (2016-02-25)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.2...1.11.3)
-
-**Closed issues:**
-
-- Cannot install gem [\#335](https://github.com/skywinder/github-changelog-generator/issues/335)
-
-## [1.11.2](https://github.com/skywinder/github-changelog-generator/tree/1.11.2) (2016-02-25)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.1...1.11.2)
-
-**Fixed bugs:**
-
-- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
-
-**Merged pull requests:**
-
-- Fix installation by not running the specs - which have dependencies [\#337](https://github.com/skywinder/github-changelog-generator/pull/337) ([skywinder](https://github.com/skywinder))
-
-## [1.11.1](https://github.com/skywinder/github-changelog-generator/tree/1.11.1) (2016-02-25)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.0...1.11.1)
-
-**Merged pull requests:**
-
-- Add rubocop and rspec as runtime dependencies [\#336](https://github.com/skywinder/github-changelog-generator/pull/336) ([jkeiser](https://github.com/jkeiser))
-- \[Refactor\] ParserFile class use Pathname [\#334](https://github.com/skywinder/github-changelog-generator/pull/334) ([olleolleolle](https://github.com/olleolleolle))
-- \[Refactor\] Generator\#exclude\_issues\_by\_labels simpler, tested [\#332](https://github.com/skywinder/github-changelog-generator/pull/332) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.11.0](https://github.com/skywinder/github-changelog-generator/tree/1.11.0) (2016-02-24)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.5...1.11.0)
-
-## [1.10.5](https://github.com/skywinder/github-changelog-generator/tree/1.10.5) (2016-02-24)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.4...1.10.5)
-
-## [1.10.4](https://github.com/skywinder/github-changelog-generator/tree/1.10.4) (2016-02-24)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.3...1.10.4)
-
-**Fixed bugs:**
-
-- Rake and Bundler as runtime deps [\#333](https://github.com/skywinder/github-changelog-generator/pull/333) ([olleolleolle](https://github.com/olleolleolle))
-
-**Merged pull requests:**
-
-- Test case for \#327 [\#331](https://github.com/skywinder/github-changelog-generator/pull/331) ([olleolleolle](https://github.com/olleolleolle))
-- Fix crash installing on systems without overcommit [\#330](https://github.com/skywinder/github-changelog-generator/pull/330) ([jkeiser](https://github.com/jkeiser))
-
-## [1.10.3](https://github.com/skywinder/github-changelog-generator/tree/1.10.3) (2016-02-23)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...1.10.3)
-
-## [1.10.2](https://github.com/skywinder/github-changelog-generator/tree/1.10.2) (2016-02-23)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.11.0...1.10.2)
-
-## [v1.11.0](https://github.com/skywinder/github-changelog-generator/tree/v1.11.0) (2016-02-23)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.1...v1.11.0)
-
-**Implemented enhancements:**
-
-- YAML front matter [\#322](https://github.com/skywinder/github-changelog-generator/pull/322) ([retorquere](https://github.com/retorquere))
-- Git Subcommand [\#288](https://github.com/skywinder/github-changelog-generator/pull/288) ([dlanileonardo](https://github.com/dlanileonardo))
-
-**Fixed bugs:**
-
-- detect\_since\_tag undefined [\#328](https://github.com/skywinder/github-changelog-generator/issues/328)
-
-**Merged pull requests:**
-
-- Update README.md [\#324](https://github.com/skywinder/github-changelog-generator/pull/324) ([Zearin](https://github.com/Zearin))
-
-## [1.10.1](https://github.com/skywinder/github-changelog-generator/tree/1.10.1) (2016-01-06)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.0...1.10.1)
-
-**Fixed bugs:**
-
-- Parser: avoid Ruby exit, to make Rake tasks work [\#315](https://github.com/skywinder/github-changelog-generator/pull/315) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
-
-**Implemented enhancements:**
-
-- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
-- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
-- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
-
-**Closed issues:**
-
-- PRs not closed on master branch show up in changelog [\#280](https://github.com/skywinder/github-changelog-generator/issues/280)
-
-**Merged pull requests:**
-
-- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
-- Fixes \#280 Add release-branch option to filter the Pull Requests [\#305](https://github.com/skywinder/github-changelog-generator/pull/305) ([SteveGilvarry](https://github.com/SteveGilvarry))
-- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
-- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
-- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
-- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
-- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
-
-## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
-
-**Implemented enhancements:**
-
-- Feature: exclude\_tags using regular expression [\#281](https://github.com/skywinder/github-changelog-generator/pull/281) ([olleolleolle](https://github.com/olleolleolle))
-- Auto parse options from file .github\_changelog\_generator [\#278](https://github.com/skywinder/github-changelog-generator/pull/278) ([dlanileonardo](https://github.com/dlanileonardo))
-
-## [1.8.5](https://github.com/skywinder/github-changelog-generator/tree/1.8.5) (2015-09-15)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.4...1.8.5)
-
-**Merged pull requests:**
-
-- Rake task: Be able to set false value in config [\#279](https://github.com/skywinder/github-changelog-generator/pull/279) ([olleolleolle](https://github.com/olleolleolle))
-
-## [1.8.4](https://github.com/skywinder/github-changelog-generator/tree/1.8.4) (2015-09-01)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.3...1.8.4)
-
-**Fixed bugs:**
-
-- Sending OATH through -t fails [\#274](https://github.com/skywinder/github-changelog-generator/issues/274)
-
-## [1.8.3](https://github.com/skywinder/github-changelog-generator/tree/1.8.3) (2015-08-31)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.2...1.8.3)
-
-**Merged pull requests:**
-
-- Do not alter pull\_requests while iterating on it [\#271](https://github.com/skywinder/github-changelog-generator/pull/271) ([raphink](https://github.com/raphink))
-
-## [1.8.2](https://github.com/skywinder/github-changelog-generator/tree/1.8.2) (2015-08-26)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.1...1.8.2)
-
-**Closed issues:**
-
-- Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270)
-
-**Merged pull requests:**
-
-- This PRi will fix \#274. [\#275](https://github.com/skywinder/github-changelog-generator/pull/275) ([skywinder](https://github.com/skywinder))
-
-## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1)
-
-**Implemented enhancements:**
-
-- Honor labels for Pull Requests [\#266](https://github.com/skywinder/github-changelog-generator/pull/266) ([raphink](https://github.com/raphink))
-
-**Merged pull requests:**
-
-- Fix issue with missing events \(in case of events for issue \>30\) [\#268](https://github.com/skywinder/github-changelog-generator/pull/268) ([skywinder](https://github.com/skywinder))
-- Use since\_tag as default for older\_tag [\#267](https://github.com/skywinder/github-changelog-generator/pull/267) ([raphink](https://github.com/raphink))
-
-## [1.8.0](https://github.com/skywinder/github-changelog-generator/tree/1.8.0) (2015-08-24)
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...1.8.0)
-
-**Implemented enhancements:**
-
-- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
-- Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
-
-**Merged pull requests:**
-
-- Add `--due-tag` option [\#265](https://github.com/skywinder/github-changelog-generator/pull/265) ([skywinder](https://github.com/skywinder))
-- Add release\_url to rake task options [\#264](https://github.com/skywinder/github-changelog-generator/pull/264) ([raphink](https://github.com/raphink))
 - Add a rake task [\#260](https://github.com/skywinder/github-changelog-generator/pull/260) ([raphink](https://github.com/raphink))
 - Add release\_url option [\#259](https://github.com/skywinder/github-changelog-generator/pull/259) ([raphink](https://github.com/raphink))
-- Add --since-tag [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
+- Add --since-tag, close  [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
 
 ## [1.7.0](https://github.com/skywinder/github-changelog-generator/tree/1.7.0) (2015-07-16)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.2...1.7.0)
@@ -374,7 +89,6 @@
 
 - Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
 - Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
-- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
 
 **Closed issues:**
 
@@ -384,6 +98,7 @@
 
 - Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
 - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
+- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
 - Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
 - Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
 - Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
@@ -399,7 +114,7 @@
 ## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
 
-**Fixed bugs:**
+**Merged pull requests:**
 
 - Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
 
@@ -410,7 +125,7 @@
 
 - Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
 
-**Fixed bugs:**
+**Merged pull requests:**
 
 - Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
 
@@ -484,7 +199,7 @@
 ## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7)
 
-**Implemented enhancements:**
+**Merged pull requests:**
 
 - Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445))
 
@@ -501,12 +216,15 @@
 **Implemented enhancements:**
 
 - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/github-changelog-generator/issues/22)
-- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
 
 **Fixed bugs:**
 
 - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32)
+
+**Merged pull requests:**
+
 - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
+- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
 
 ## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4)
@@ -540,6 +258,10 @@
 
 - Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/github-changelog-generator/issues/34)
 
+**Merged pull requests:**
+
+- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/github-changelog-generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
+
 ## [1.2.1](https://github.com/skywinder/github-changelog-generator/tree/1.2.1) (2014-11-22)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1)
 
@@ -611,7 +333,6 @@
 
 - Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6)
 - Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4)
-- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
 
 **Fixed bugs:**
 
@@ -619,6 +340,7 @@
 
 **Merged pull requests:**
 
+- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
 - Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder))
 
 ## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07)

Gemfile

@@ -1,27 +1,11 @@
-# frozen_string_literal: true
 source "https://rubygems.org"
 
 gemspec
 
-group :development, :test do
-  gem "rake"
-  gem "bundler"
-  gem "overcommit", ">= 0.31"
-  gem "rubocop", ">= 0.43"
-end
-
-group :development do
-  gem "bump"
-end
-
 group :test do
+  gem "rspec", "~>3.2"
+  gem "rubocop", "~>0.31"
   gem "coveralls", "~>0.8", require: false
   gem "simplecov", "~>0.10", require: false
   gem "codeclimate-test-reporter", "~>0.4"
-  if RUBY_VERSION > "2"
-    gem "json", "~> 2.0", ">= 2.0.2"
-  else
-    gem "json"
-  end
-  gem "rspec", "< 4"
 end

Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    github_changelog_generator (1.7.0)
+      colorize (~> 0.7)
+      github_api (~> 0.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    ast (2.0.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    colorize (0.7.7)
+    coveralls (0.8.2)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.2)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.3)
+    jwt (1.5.1)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    netrc (0.10.3)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.5.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  codeclimate-test-reporter (~> 0.4)
+  coveralls (~> 0.8)
+  github_changelog_generator!
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  rubocop (~> 0.31)
+  simplecov (~> 0.10)

LICENSE

@@ -1,9 +0,0 @@
-The MIT License (MIT)
-Copyright (c) 2016 Petr Korolev
-
-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.
-

README.md

@@ -4,7 +4,6 @@
 [![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
 [![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
 [![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
-[![Join the chat at https://gitter.im/github-changelog-generator/chat](https://badges.gitter.im/github-changelog-generator/chat.svg)](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
 ==================
@@ -22,9 +21,9 @@ GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
   - [License](#license)
 
  
-### Changelog generation has never been so easy
+### Changelog generation has never been so easy:
 
-**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
+**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
 
 Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
 
@@ -33,13 +32,11 @@ To make it easier for users and contributors to see precisely what notable chang
 ### *Why should I care?*
 Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
 
-> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
+> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
 
 ## Installation
 
-	gem install github_changelog_generator
+	[sudo] gem install github_changelog_generator
-
-See also Troubleshooting.
 
 ## Output example
 
@@ -48,7 +45,7 @@ See also Troubleshooting.
 
 		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
 
-- In general, it looks like this:
+- In general it looks like this:
 
 > ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
 > 
@@ -70,199 +67,142 @@ See also Troubleshooting.
 
 
 ## Usage
-**It's really simple!**
+**It's really simple**: 
 
-- If your **`git remote`** `origin` refers to your GitHub repo, just go to your project folder and run:
+- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
 
 		github_changelog_generator
 
--  Or, run this from anywhere:
+-  or from anywhere:
     - `github_changelog_generator -u github_username -p github_project`
     - `github_changelog_generator  github_username/github_project`
      
-- If you are running it against a repository on a Github Enterprise install, you must specify *both* `--github-site` and `--github-api` command line options:
+As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
-
-        github_changelog_generator --github-site="https://github.yoursite.com" \
-                                   --github-api="https://github.yoursite.com/api/v3/"
-
-This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
 
 ### Params
 Type `github_changelog_generator --help` for details.
 
-For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
+More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
-
-### Params File
-In your project root, you can put a params file named `.github_changelog_generator` to override default params:
-
-Example:
-```
-unreleased=false
-future-release=5.0.0
-since-tag=1.0.0
-```
 
 ### GitHub token
 
-GitHub only allows only 50 unauthenticated requests per hour. 
+Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
-Therefore, it's recommended to run this script with authentication by using a **token**.
 
-Here's how:
+**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
 
-- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
+And:
-- Either:
-    - Run the script with `--token <your-40-digit-token>`; **OR**
-    - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
 
-You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
+- Run with key `-t [your-16-digit-token]` 
+- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token. 
  		
-        export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
+	i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
 
-So, if you got an error like this:
+        export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
+
+So, if you got error like this:
 >! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
 
-It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
+It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
 
-## Migrating from a manual changelog
-
-Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
-But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
-
-That's where `--base <your-manual-changelog.md>` comes in handy!
-This option lets append your old manual changelog to the end of the generated entries.
-
-If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
 
 ### Rake task
 
-You love `rake`? We do, too! So, we've made it even easier for you: 
+You love Rake? So do we! And so we've made it easier for you by providing a Rake task library for your Change log generation. In your Rakefile, use:
-we've provided a `rake` task library for your changelog generation.
-
-Just put something like this in your `Rakefile`:
 
 ```ruby
-require 'github_changelog_generator/task'
-
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.since_tag = '0.1.14'
   config.future_release = '0.2.0'
 end
 ```
 
-All command line options can be passed to the `rake` task as `config` parameters. And since you're naming the `rake` task yourself, you can create as many as you want.
+All command line options can be passed to the Rake task as `config` parameters. Since you're naming the Rake task yourself, you can create as many as you want, too.
 
-## Features and advantages of this project
+##Features and advantages of this project
-- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
+- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
-- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
+- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
 - **GitHub Enterprise support** via command line options! :factory:
-- Flexible format **customization**:
+- Flexible format **customisation**:
-    - **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
+    - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
-    - **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
+    - **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
-    - Manually specify the version that fixed an issue (for cases when the issue's Closed date doesn't match) by giving the issue's `milestone` the same name as the tag of version :pushpin:
+    - Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of  required version :pushpin:
-    - Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
+    - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default)  :scissors:
-- **Distinguish** issues **by labels**. :mag_right:
+- **Distinguish** issues **according labels**. :mag_right:
-    - Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
+    - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
-    - Bug fixes (issues labeled `bug`) :beetle:
+    - Bug fixes (by label `bug` in issue) :beetle:
-    - Enhancements (issues labeled `enhancement`) :star2:
+    - Enhancements (by label `enhancement` in issue) :star2:
-    - Issues (closed issues with no labels) :non-potable_water:
+    - 	Issues (closed issues `w/o any labels`) :non-potable_water:    
 
-- Manually include or exclude issues by labels :wrench:
+- You can manually set which labels should be included/excluded. :wrench:
-- Customize lots more! Tweak the changelog to fit your preferences :tophat:
+- Apply a lot of other customisations, to fit changelog for your personal style :tophat: 
-(*See `github_changelog_generator --help`  for details)*
+(*look `github_changelog_generator --help`  for details)*
 
 
 ###Alternatives
-Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
+Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
 
-*If you know other projects, feel free to edit this Wiki page!*
+*If you know other projects - feel free to edit this Wiki page!*
 
 
 ### Projects using this library
-Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
+[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) 
 
 If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
 
-*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).*
+*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
 
 ## Am I missing some essential feature?
 
 - **Nothing is impossible!** 
 
-- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
+- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! 
 
-- *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
+- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
 
 ## FAQ
 
 - ***I already use GitHub Releases. Why do I need this?***
 
-GitHub Releases is a very good thing. And it's very good practice to maintain it. (Not a lot of people are using it yet!) :congratulations:
+GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations:
 
-*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
+*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
 
-I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
+I'm not try to compare quality of auto-generated and manually generated logs.. but:
 
-An auto-generated changelog really helps, even if you manually fill in the release notes!
+The auto generated Changelog really helps even if you manually fill Releases notes!
 
 For example:
 
-When I found a closed bug, it's very useful know which release fixed it. 
+When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
-In this case, you can easily find the issue by \# in `CHANGELOG.md`.
 
-- it's not quite as easy to find this in handwritten releases notes
+- it's not so quite easy to find it in manually filled Releases notes.
-- a generated file saves you the trouble of remembering everything;
+- this file can also help you to build your Release note and not miss features in manually-filled list.
-  sometimes people forget to add things to a handwritten file
 
-Ultimately, I think GitHub Releases is ideal for end-users. 
+In the end:
-Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
-Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
 
-- ***I received a warning: "GitHub API rate limit exceed"  What does this mean?***
+I think, that GitHub Releases is more for end-users.
+But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
+And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
 
-GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
+- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
 
-If you're seeing this warning, please do the following:
+GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
 
-1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
+If you're seeing this warning:
-2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
 
-- ***My Ruby version is very old, can I use this?***
+1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
-
+2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
-When your Ruby is old, and you don't want to upgrade, and your want to
-control which libraries you use, you can use Bundler.
-
-In a Gemfile, perhaps in a non-deployed `:development` group, add this
-gem:
-
-```ruby
-group :development do
-  gem 'github_changelog_generator', require: false
-end
-```
-
-Then you can keep back dependencies like rack, which currently is only
-compatible with Ruby >= 2.2.2. So, use an older version for your app by
-adding a line like this to the Gemfile:
-
-```
-gem 'rack', '~> 1.6'
-```
-
-This way, you can keep on using github_changelog_generator, even if you
-can't get the latest version of Ruby installed.
 
 ## Contributing
 
-1. Create an issue and describe your idea
+1. Create an issue to discuss about your idea
 2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
 3. Create your feature branch (`git checkout -b my-new-feature`)
 4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Publish the branch (`git push origin my-new-feature`)
+5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
 7. Profit! :white_check_mark:
 
-*To test your workflow with changelog generator, you can use [test repo](https://github.com/skywinder/changelog_test/)*
-
 ## License
 
 Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

Rakefile

@@ -1,40 +1,7 @@
-# frozen_string_literal: true
-require "bundler"
-require "bundler/gem_tasks"
 require "rubocop/rake_task"
 require "rspec/core/rake_task"
-require "pathname"
-require "fileutils"
-require "overcommit"
 
 RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:rspec)
 
-task :copy_man_page_to_manpath do |_t|
-  known_manpath_paths = %w(/etc/manpath.config /etc/manpaths)
-  manpath = known_manpath_paths.find do |f|
-    path = Pathname(f)
-    path.file? && path.readable?
-  end
-
-  next unless manpath
-
-  writable_man_path = Pathname(manpath).each_line.find do |line|
-    path = Pathname(line.chomp)
-    path.directory? && path.writable?
-  end
-
-  next unless writable_man_path
-
-  man_prefix = Pathname("#{writable_man_path.chomp}/man1")
-  man_pages = "man/git-*.1"
-
-  Pathname.glob(man_pages) do |path|
-    if path.exist? && man_prefix.exist? && man_prefix.writable?
-      FileUtils.cp(path, man_prefix + path.basename)
-    end
-  end
-end
-
-task checks: [:rubocop, :rspec]
 task default: [:rubocop, :rspec]

appveyor.yml

@@ -1,50 +0,0 @@
-version: "{build}"
-
-platform: x64
-
-branches:
-    only:
-      - master
-
-clone_depth: 10
-
-skip_tags: true
-
-# See here for Ruby versions pre-installed:
-#  http://www.appveyor.com/docs/installed-software#ruby
-environment:
-  matrix:
-    - ruby_version: "21" # Older version, but matches Travis-CI
-    - ruby_version: "21-x64"
-
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-
-  # Print version and location for pre-installed ruby
-  - ruby --version
-  - where ruby
-
-  # Install latest version of RubyGems
-  - gem update --system --no-document --no-post-install-message
-  - gem --version
-  - where gem
-
-  # Print version and location for pre-installed bundler
-  - bundler --version
-  - where bundler
-
-build_script:
-  # Install ruby dependencies
-  - bundle install --retry 3
-  - bundle exec rake checks
-
-test_script:
-  - gem build github_changelog_generator
-  - gem install *.gem
-
-notifications:
-  - provider: Email
-    to:
-      - sky4winder+githubchangeloggenerator@gmail.com
-    on_build_success: false
-    on_build_status_changed: true

bin/git-generate-changelog

@@ -1,5 +0,0 @@
-#! /usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative "../lib/github_changelog_generator"
-GitHubChangelogGenerator::ChangelogGenerator.new.run

bin/github_changelog_generator

@@ -1,5 +1,4 @@
 #! /usr/bin/env ruby
-# frozen_string_literal: true
 
 require_relative "../lib/github_changelog_generator"
 GitHubChangelogGenerator::ChangelogGenerator.new.run

circle.yml

@@ -1,8 +0,0 @@
-notify:
-  webhooks:
-    # A list of hook hashes, containing the url field
-    # gitter hook
-    - url: https://webhooks.gitter.im/e/2d81eb1ae7695fdc82c4
-    - url: https://webhooks.gitter.im/e/3ec6a35fad7e9991058e
-
-

gemfiles/Gemfile.2_4_0

@@ -1,3 +0,0 @@
-eval_gemfile File.expand_path('../../Gemfile', __FILE__)
-gem 'rack', '>= 2'
-

gemfiles/Gemfile.with_rack16

@@ -1,2 +0,0 @@
-eval_gemfile File.expand_path('../../Gemfile', __FILE__)
-gem 'rack', '~> 1.6'

gemfiles/Gemfile.with_rack2

@@ -1,2 +0,0 @@
-eval_gemfile File.expand_path('../../Gemfile', __FILE__)
-gem 'rack', '>= 2'

github_changelog_generator.gemspec

@@ -1,5 +1,5 @@
 # coding: utf-8
-# frozen_string_literal: true
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "github_changelog_generator/version"
@@ -10,21 +10,23 @@ Gem::Specification.new do |spec|
   spec.default_executable = "github_changelog_generator"
 
   spec.required_ruby_version     = ">= 1.9.3"
-  spec.authors = ["Petr Korolev", "Olle Jonsson"]
+  spec.authors = ["Petr Korolev"]
   spec.email = "sky4winder+github_changelog_generator@gmail.com"
-
+  spec.date = `date +"%Y-%m-%d"`.strip!
   spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
   spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
   spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
   spec.license       = "MIT"
 
-  spec.files = Dir["{bin,lib,man,spec}/**/*"] + %w(LICENSE Rakefile README.md)
+  spec.files = `git ls-files -z`.split("\x0")
-
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "rake", ">= 10.0"
+  spec.add_runtime_dependency("github_api", ["~> 0.12"])
-  spec.add_runtime_dependency "github_api", ">= 0.14"
+  spec.add_runtime_dependency("colorize", ["~> 0.7"])
-  spec.add_runtime_dependency "rainbow", ">= 2.1"
+
+  # Development only
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
 end

lib/CHANGELOG.md

@@ -7,7 +7,6 @@
 **Implemented enhancements:**
 
 - Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9)
-- PR with enhancement label [\#16](https://github.com/skywinder/changelog_test/pull/16) ([skywinder](https://github.com/skywinder))
 
 **Fixed bugs:**
 
@@ -22,8 +21,6 @@
 
 **Merged pull requests:**
 
-- Merged br \(should appear in change log also\) [\#21](https://github.com/skywinder/changelog_test/pull/21) ([skywinder](https://github.com/skywinder))
-- This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
 - This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
 - This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))
 

lib/github_changelog_generator.rb

@@ -1,13 +1,12 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
 require "github_api"
 require "json"
+require "colorize"
 require "benchmark"
 
 require_relative "github_changelog_generator/helper"
 require_relative "github_changelog_generator/parser"
-require_relative "github_changelog_generator/parser_file"
 require_relative "github_changelog_generator/generator/generator"
 require_relative "github_changelog_generator/version"
 require_relative "github_changelog_generator/reader"
@@ -28,7 +27,7 @@ module GitHubChangelogGenerator
     def run
       log = @generator.compound_changelog
 
-      output_filename = (@options[:output]).to_s
+      output_filename = "#{@options[:output]}"
       File.open(output_filename, "w") { |file| file.write(log) }
       puts "Done!"
       puts "Generated log placed in #{Dir.pwd}/#{output_filename}"

lib/github_changelog_generator/fetcher.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 module GitHubChangelogGenerator
   # A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
   # (such as filtering, validating, e.t.c)
@@ -8,7 +7,6 @@ module GitHubChangelogGenerator
 
   class Fetcher
     PER_PAGE_NUMBER = 30
-    MAX_SIMULTANEOUS_REQUESTS = 25
     CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
     GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
     "missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
@@ -20,12 +18,12 @@ module GitHubChangelogGenerator
       @user = @options[:user]
       @project = @options[:project]
       @github_token = fetch_github_token
-      @github_options = { per_page: PER_PAGE_NUMBER }
+      github_options = { per_page: PER_PAGE_NUMBER }
-      @github_options[:oauth_token] = @github_token unless @github_token.nil?
+      github_options[:oauth_token] = @github_token unless @github_token.nil?
-      @github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
+      github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
-      @github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
+      github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
 
-      @github = check_github_response { Github.new @github_options }
+      @github = check_github_response { Github.new github_options }
     end
 
     # Returns GitHub token. First try to use variable, provided by --token option,
@@ -35,7 +33,7 @@ module GitHubChangelogGenerator
     def fetch_github_token
       env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
 
-      Helper.log.warn NO_TOKEN_PROVIDED unless env_var
+      Helper.log.warn NO_TOKEN_PROVIDED.yellow unless env_var
 
       env_var
     end
@@ -54,11 +52,11 @@ module GitHubChangelogGenerator
       begin
         value = yield
       rescue Github::Error::Unauthorized => e
-        Helper.log.error e.response_message
+        Helper.log.error e.body.red
         abort "Error: wrong GitHub token"
       rescue Github::Error::Forbidden => e
-        Helper.log.warn e.response_message
+        Helper.log.warn e.body.red
-        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
       end
       value
     end
@@ -73,13 +71,13 @@ module GitHubChangelogGenerator
       response.each_page do |page|
         page_i += PER_PAGE_NUMBER
         print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
-        tags.concat(page) unless page.nil?
+        tags.concat(page)
       end
       print_empty_line
 
-      if tags.empty?
+      if tags.count == 0
         Helper.log.warn "Warning: Can't find any tags in repo.\
-Make sure, that you push tags to remote repo via 'git push --tags'"
+Make sure, that you push tags to remote repo via 'git push --tags'".yellow
       else
         Helper.log.info "Found #{tags.count} tags"
       end
@@ -110,9 +108,8 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
         print_empty_line
         Helper.log.info "Received issues: #{issues.count}"
 
-      rescue Github::Error::Forbidden => e
+      rescue
-        Helper.log.warn e.error_messages.map { |m| m[:message] }.join(", ")
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
       end
 
       # separate arrays of issues and pull requests:
@@ -126,16 +123,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     def fetch_closed_pull_requests
       pull_requests = []
       begin
-        response = if @options[:release_branch].nil?
+        response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
-                     @github.pull_requests.list @options[:user],
-                                                @options[:project],
-                                                state: "closed"
-                   else
-                     @github.pull_requests.list @options[:user],
-                                                @options[:project],
-                                                state: "closed",
-                                                base: @options[:release_branch]
-                   end
         page_i = 0
         count_pages = response.count_pages
         response.each_page do |page|
@@ -145,9 +133,8 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
           pull_requests.concat(page)
         end
         print_empty_line
-      rescue Github::Error::Forbidden => e
+      rescue
-        Helper.log.warn e.error_messages.map { |m| m[:message] }.join(", ")
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
       end
 
       Helper.log.info "Fetching merged dates: #{pull_requests.count}"
@@ -170,21 +157,18 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     # @return [Void]
     def fetch_events_async(issues)
       i = 0
+      max_thread_number = 50
       threads = []
-      issues.each_slice(MAX_SIMULTANEOUS_REQUESTS) do |issues_slice|
+      issues.each_slice(max_thread_number) do |issues_slice|
         issues_slice.each do |issue|
           threads << Thread.new do
             begin
-              response = @github.issues.events.list user: @options[:user],
+              obj = @github.issues.events.list user: @options[:user],
                                                repo: @options[:project],
                                                issue_number: issue["number"]
-              issue[:events] = []
+              issue[:events] = obj.body
-              response.each_page do |page|
+            rescue
-                issue[:events].concat(page)
+              Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-              end
-            rescue Github::Error::Forbidden => e
-              Helper.log.warn e.error_messages.map { |m| m[:message] }.join(", ")
-              Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
             end
             print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
             i += 1
@@ -209,9 +193,8 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
         commit_data = @github.git_data.commits.get @options[:user],
                                                    @options[:project],
                                                    tag["commit"]["sha"]
-      rescue Github::Error::Forbidden => e
+      rescue
-        Helper.log.warn e.error_messages.map { |m| m[:message] }.join(", ")
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
       end
       time_string = commit_data["committer"]["date"]
       Time.parse(time_string)

lib/github_changelog_generator/generator/generator.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 require_relative "../fetcher"
 require_relative "generator_generation"
 require_relative "generator_fetcher"
@@ -67,7 +66,7 @@ module GitHubChangelogGenerator
 
       if @options[:issues]
         # Generate issues:
-        log += issues_to_log(issues, pull_requests)
+        log += issues_to_log(issues)
       end
 
       if @options[:pulls]
@@ -78,14 +77,13 @@ module GitHubChangelogGenerator
       log
     end
 
-    # Generate ready-to-paste log from list of issues and pull requests.
+    # Generate ready-to-paste log from list of issues.
     #
     # @param [Array] issues
-    # @param [Array] pull_requests
     # @return [String] generated log for issues
-    def issues_to_log(issues, pull_requests)
+    def issues_to_log(issues)
       log = ""
-      bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
+      bugs_a, enhancement_a, issues_a = parse_by_sections(issues)
 
       log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
       log += generate_sub_section(bugs_a, @options[:bug_prefix])
@@ -97,9 +95,8 @@ module GitHubChangelogGenerator
     # (bugs, features, or just closed issues) by labels
     #
     # @param [Array] issues
-    # @param [Array] pull_requests
     # @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
-    def parse_by_sections(issues, pull_requests)
+    def parse_by_sections(issues)
       issues_a = []
       enhancement_a = []
       bugs_a = []
@@ -120,24 +117,6 @@ module GitHubChangelogGenerator
         end
         issues_a.push dict unless added
       end
-
-      added_pull_requests = []
-      pull_requests.each do |dict|
-        dict.labels.each do |label|
-          if @options[:bug_labels].include? label.name
-            bugs_a.push dict
-            added_pull_requests.push dict
-            next
-          end
-          if @options[:enhancement_labels].include? label.name
-            enhancement_a.push dict
-            added_pull_requests.push dict
-            next
-          end
-        end
-      end
-      added_pull_requests.each { |p| pull_requests.delete(p) }
-
       [bugs_a, enhancement_a, issues_a]
     end
   end

lib/github_changelog_generator/generator/generator_fetcher.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 module GitHubChangelogGenerator
   class Generator
     # Fetch event for issues and pull requests
@@ -49,11 +48,11 @@ module GitHubChangelogGenerator
     # Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
     # @param [Hash] issue
     def find_closed_date_by_commit(issue)
-      unless issue[:events].nil?
+      unless issue["events"].nil?
         # if it's PR -> then find "merged event", in case of usual issue -> fond closed date
         compare_string = issue[:merged_at].nil? ? "closed" : "merged"
         # reverse! - to find latest closed event. (event goes in date order)
-        issue[:events].reverse!.each do |event|
+        issue["events"].reverse!.each do |event|
           if event[:event].eql? compare_string
             set_date_from_event(event, issue)
             break
@@ -75,7 +74,7 @@ module GitHubChangelogGenerator
           commit = @fetcher.fetch_commit(event)
           issue[:actual_date] = commit[:author][:date]
         rescue
-          puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo."
+          puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo.".yellow
           issue[:actual_date] = issue[:closed_at]
         end
       end

lib/github_changelog_generator/generator/generator_generation.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 module GitHubChangelogGenerator
   class Generator
     # Main function to start change log generation
@@ -9,18 +8,14 @@ module GitHubChangelogGenerator
       sort_tags_by_date(@filtered_tags)
       fetch_issues_and_pr
 
-      log = ""
+      log = "#{@options[:header]}\n\n"
-      log += @options[:frontmatter] if @options[:frontmatter]
-      log += "#{@options[:header]}\n\n"
 
-      log += if @options[:unreleased_only]
+      if @options[:unreleased_only]
-               generate_log_between_tags(filtered_tags[0], nil)
+        log += generate_log_between_tags(filtered_tags[0], nil)
       else
-               generate_log_for_all_tags
+        log += generate_log_for_all_tags
       end
 
-      log += File.read(@options[:base]) if File.file?(@options[:base])
-
       log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
       @log = log
     end
@@ -40,10 +35,10 @@ module GitHubChangelogGenerator
           index2 = hash[tag2]
           log += generate_log_between_tags(all_tags[index1], all_tags[index2])
         else
-          raise ChangelogGeneratorError, "Can't find tag #{tag2} -> exit"
+          fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
         end
       else
-        raise ChangelogGeneratorError, "Can't find tag #{tag1} -> exit"
+        fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
       end
       log
     end
@@ -54,8 +49,9 @@ module GitHubChangelogGenerator
     def generate_sub_section(issues, prefix)
       log = ""
 
+      log += "#{prefix}\n\n" if options[:simple_list] != true && issues.any?
+
       if issues.any?
-        log += "#{prefix}\n\n" unless options[:simple_list]
         issues.each do |issue|
           merge_string = get_string_for_issue(issue)
           log += "- #{merge_string}\n"
@@ -80,15 +76,15 @@ module GitHubChangelogGenerator
       time_string = newer_tag_time.strftime @options[:date_format]
 
       # Generate tag name and link
-      release_url = if @options[:release_url]
+      if @options[:release_url]
-                      format(@options[:release_url], newer_tag_link)
+        release_url = format(@options[:release_url], newer_tag_link)
       else
-                      "#{project_url}/tree/#{newer_tag_link}"
+        release_url = "#{project_url}/tree/#{newer_tag_link}"
       end
-      log += if newer_tag_name.equal? @options[:unreleased_label]
+      if newer_tag_name.equal? @options[:unreleased_label]
-               "## [#{newer_tag_name}](#{release_url})\n\n"
+        log += "## [#{newer_tag_name}](#{release_url})\n\n"
       else
-               "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
+        log += "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
       end
 
       if @options[:compare_link] && older_tag_link
@@ -105,7 +101,7 @@ module GitHubChangelogGenerator
     def generate_log_between_tags(older_tag, newer_tag)
       filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
 
-      older_tag_name = older_tag.nil? ? detect_since_tag : older_tag["name"]
+      older_tag_name = older_tag.nil? ? nil : older_tag["name"]
 
       if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
         # do not generate empty unreleased section
@@ -119,7 +115,7 @@ module GitHubChangelogGenerator
     #
     # @return [Array] filtered issues and pull requests
     def filter_issues_for_tags(newer_tag, older_tag)
-      filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
+      filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, older_tag, newer_tag)
       filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
 
       newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
@@ -142,7 +138,7 @@ module GitHubChangelogGenerator
       (1...filtered_tags.size).each do |index|
         log += generate_log_between_tags(filtered_tags[index], filtered_tags[index - 1])
       end
-      if filtered_tags.any?
+      if @filtered_tags.count != 0
         log += generate_log_between_tags(nil, filtered_tags.last)
       end
 
@@ -161,7 +157,7 @@ module GitHubChangelogGenerator
     # Parse issue and generate single line formatted issue line.
     #
     # Example output:
-    # - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) (@skywinder)
+    # - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
     #
     # @param [Hash] issue Fetched issue from GitHub
     # @return [String] Markdown-formatted single issue
@@ -169,22 +165,17 @@ module GitHubChangelogGenerator
       encapsulated_title = encapsulate_string issue[:title]
 
       title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
-      issue_line_with_user(title_with_number, issue)
-    end
 
-    private
+      unless issue.pull_request.nil?
-
+        if @options[:author]
-    def issue_line_with_user(line, issue)
+          if issue.user.nil?
-      return line if !@options[:author] || issue.pull_request.nil?
+            title_with_number += " ({Null user})"
-
-      user = issue.user
-      return "#{line} ({Null user})" unless user
-
-      if @options[:usernames_as_github_logins]
-        "#{line} (@#{user.login})"
           else
-        "#{line} ([#{user.login}](#{user.html_url}))"
+            title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
           end
         end
       end
+      title_with_number
+    end
+  end
 end

lib/github_changelog_generator/generator/generator_processor.rb

@@ -1,17 +1,17 @@
-# frozen_string_literal: true
 module GitHubChangelogGenerator
   class Generator
     # delete all labels with labels from @options[:exclude_labels] array
     # @param [Array] issues
     # @return [Array] filtered array
     def exclude_issues_by_labels(issues)
-      return issues if !@options[:exclude_labels] || @options[:exclude_labels].empty?
+      unless @options[:exclude_labels].nil?
-
+        issues = issues.select do |issue|
-      issues.reject do |issue|
+          var = issue.labels.map(&:name) & @options[:exclude_labels]
-        labels = issue.labels.map(&:name)
+          !(var).any?
-        (labels & @options[:exclude_labels]).any?
         end
       end
+      issues
+    end
 
     # @return [Array] filtered issues accourding milestone
     def filter_by_milestone(filtered_issues, tag_name, all_issues)
@@ -63,27 +63,27 @@ module GitHubChangelogGenerator
     end
 
     # Method filter issues, that belong only specified tag range
-    # @param [Array] issues issues to filter
+    # @param [Array] array of issues to filter
     # @param [Symbol] hash_key key of date value default is :actual_date
     # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
     # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
     # @return [Array] filtered issues
-    def delete_by_time(issues, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
+    def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
       # in case if not tags specified - return unchanged array
-      return issues if older_tag.nil? && newer_tag.nil?
+      return array if older_tag.nil? && newer_tag.nil?
 
       newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
       older_tag_time = older_tag && get_time_of_tag(older_tag)
 
-      issues.select do |issue|
+      array.select do |req|
-        if issue[hash_key]
+        if req[hash_key]
-          time = Time.parse(issue[hash_key]).utc
+          time = Time.parse(req[hash_key]).utc
 
           tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
 
           tag_in_range_new = tag_older_new_tag?(newer_tag_time, time)
 
-          tag_in_range = tag_in_range_old && tag_in_range_new
+          tag_in_range = (tag_in_range_old) && (tag_in_range_new)
 
           tag_in_range
         else
@@ -93,19 +93,19 @@ module GitHubChangelogGenerator
     end
 
     def tag_older_new_tag?(newer_tag_time, time)
-      tag_in_range_new = if newer_tag_time.nil?
+      if newer_tag_time.nil?
-                           true
+        tag_in_range_new = true
       else
-                           time <= newer_tag_time
+        tag_in_range_new = time <= newer_tag_time
       end
       tag_in_range_new
     end
 
     def tag_newer_old_tag?(older_tag_time, t)
-      tag_in_range_old = if older_tag_time.nil?
+      if older_tag_time.nil?
-                           true
+        tag_in_range_old = true
       else
-                           t > older_tag_time
+        tag_in_range_old = t > older_tag_time
       end
       tag_in_range_old
     end
@@ -131,14 +131,11 @@ module GitHubChangelogGenerator
     end
 
     def filter_by_include_labels(issues)
-      if @options[:include_labels].nil?
+      filtered_issues = @options[:include_labels].nil? ? issues : issues.select do |issue|
-        issues
-      else
-        issues.select do |issue|
         labels = issue.labels.map(&:name) & @options[:include_labels]
-          labels.any?
+        (labels).any?
-        end
       end
+      filtered_issues
     end
 
     # General filtered function
@@ -181,11 +178,9 @@ module GitHubChangelogGenerator
         fetched_pr = closed_pull_requests.find do |fpr|
           fpr.number == pr.number
         end
-        if fetched_pr
         pr[:merged_at] = fetched_pr[:merged_at]
         closed_pull_requests.delete(fetched_pr)
       end
-      end
 
       pull_requests.select! do |pr|
         !pr[:merged_at].nil?

lib/github_changelog_generator/generator/generator_tags.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 module GitHubChangelogGenerator
   class Generator
     # fetch, filter tags, fetch dates and sort them in time order
@@ -20,7 +19,7 @@ module GitHubChangelogGenerator
     # @param [Hash] tag_name name of the tag
     # @return [Time] time of specified tag
     def get_time_of_tag(tag_name)
-      raise ChangelogGeneratorError, "tag_name is nil" if tag_name.nil?
+      fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
 
       name_of_tag = tag_name["name"]
       time_for_name = @tag_times_hash[name_of_tag]
@@ -53,18 +52,6 @@ module GitHubChangelogGenerator
       [newer_tag_link, newer_tag_name, newer_tag_time]
     end
 
-    # @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
-    def detect_since_tag
-      @since_tag ||= @options.fetch(:since_tag) { version_of_first_item }
-    end
-
-    def version_of_first_item
-      return unless File.file?(@options[:base].to_s)
-
-      sections = GitHubChangelogGenerator::Reader.new.read(@options[:base])
-      sections.first["version"] if sections && sections.any?
-    end
-
     # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
     #
     # @return [Array]
@@ -74,18 +61,16 @@ module GitHubChangelogGenerator
       filter_excluded_tags(filtered_tags)
     end
 
-    # @param [Array] all_tags all tags
-    # @return [Array] filtered tags according :since_tag option
     def filter_since_tag(all_tags)
       filtered_tags = all_tags
-      tag = detect_since_tag
+      tag = @options[:since_tag]
       if tag
         if all_tags.map(&:name).include? tag
           idx = all_tags.index { |t| t.name == tag }
-          filtered_tags = if idx > 0
+          if idx > 0
-                            all_tags[0..idx - 1]
+            filtered_tags = all_tags[0..idx - 1]
           else
-                            []
+            filtered_tags = []
           end
         else
           Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
@@ -94,29 +79,6 @@ module GitHubChangelogGenerator
       filtered_tags
     end
 
-    # @param [Array] all_tags all tags
-    # @return [Array] filtered tags according :due_tag option
-    def filter_due_tag(all_tags)
-      filtered_tags = all_tags
-      tag = @options[:due_tag]
-      if tag
-        if all_tags.any? && all_tags.map(&:name).include?(tag)
-          idx = all_tags.index { |t| t.name == tag }
-          last_index = all_tags.count - 1
-          filtered_tags = if idx > 0 && idx < last_index
-                            all_tags[idx + 1..last_index]
-                          else
-                            []
-                          end
-        else
-          Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
-        end
-      end
-      filtered_tags
-    end
-
-    # @param [Array] all_tags all tags
-    # @return [Array] filtered tags according :between_tags option
     def filter_between_tags(all_tags)
       filtered_tags = all_tags
       if @options[:between_tags]
@@ -130,56 +92,17 @@ module GitHubChangelogGenerator
       filtered_tags
     end
 
-    # @param [Array] all_tags all tags
-    # @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option
     def filter_excluded_tags(all_tags)
+      filtered_tags = all_tags
       if @options[:exclude_tags]
-        apply_exclude_tags(all_tags)
-      elsif @options[:exclude_tags_regex]
-        apply_exclude_tags_regex(all_tags)
-      else
-        all_tags
-      end
-    end
-
-    private
-
-    def apply_exclude_tags(all_tags)
-      if @options[:exclude_tags].is_a?(Regexp)
-        filter_tags_with_regex(all_tags, @options[:exclude_tags])
-      else
-        filter_exact_tags(all_tags)
-      end
-    end
-
-    def apply_exclude_tags_regex(all_tags)
-      filter_tags_with_regex(all_tags, Regexp.new(@options[:exclude_tags_regex]))
-    end
-
-    def filter_tags_with_regex(all_tags, regex)
-      warn_if_nonmatching_regex(all_tags)
-      all_tags.reject { |tag| regex =~ tag.name }
-    end
-
-    def filter_exact_tags(all_tags)
         @options[:exclude_tags].each do |tag|
-        warn_if_tag_not_found(all_tags, tag)
-      end
-      all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
-    end
-
-    def warn_if_nonmatching_regex(all_tags)
-      unless all_tags.map(&:name).any? { |t| @options[:exclude_tags] =~ t }
-        Helper.log.warn "Warning: unable to reject any tag, using regex "\
-                        "#{@options[:exclude_tags].inspect} in --exclude-tags "\
-                        "option."
-      end
-    end
-
-    def warn_if_tag_not_found(all_tags, tag)
           unless all_tags.map(&:name).include? tag
             Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
           end
         end
+        filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
+      end
+      filtered_tags
+    end
   end
 end

lib/github_changelog_generator/helper.rb

@@ -1,32 +1,33 @@
-# frozen_string_literal: true
 require "logger"
-require "rainbow"
-
 module GitHubChangelogGenerator
   module Helper
     # @return true if the currently running program is a unit test
     def self.test?
-      defined? SpecHelper
+      defined?SpecHelper
     end
 
-    # :nocov:
+    if test?
-    @log ||= if test?
+      @log ||= Logger.new(nil) # don't show any logs when running tests
-               Logger.new(nil) # don't show any logs when running tests
     else
-               Logger.new(STDOUT)
+      @log ||= Logger.new(STDOUT)
     end
     @log.formatter = proc do |severity, _datetime, _progname, msg|
       string = "#{msg}\n"
-      case severity
+
-      when "DEBUG" then Rainbow(string).magenta
+      if severity == "DEBUG"
-      when "INFO" then Rainbow(string).white
+        string = string.magenta
-      when "WARN" then Rainbow(string).yellow
+      elsif severity == "INFO"
-      when "ERROR" then Rainbow(string).red
+        string = string.white
-      when "FATAL" then Rainbow(string).red.bright
+      elsif severity == "WARN"
-      else string
+        string = string.yellow
+      elsif severity == "ERROR"
+        string = string.red
+      elsif severity == "FATAL"
+        string = string.red.bold
       end
+
+      string
     end
-    # :nocov:
 
     # Logging happens using this method
     class << self

lib/github_changelog_generator/parser.rb

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 require "optparse"
 require "pp"
 require_relative "version"
@@ -8,36 +7,28 @@ module GitHubChangelogGenerator
   class Parser
     # parse options with optparse
     def self.parse_options
-      options = default_options
+      options = get_default_options
-
-      ParserFile.new(options).parse!
 
       parser = setup_parser(options)
+
       parser.parse!
 
-      fetch_user_and_project(options)
+      if options[:user].nil? || options[:project].nil?
-
+        detect_user_and_project(options, ARGV[0], ARGV[1])
-      abort(parser.banner) unless options[:user] && options[:project]
+      end
-
+
-      print_options(options)
+      if !options[:user] || !options[:project]
-
+        puts parser.banner
-      options
+        exit
       end
 
-    # If options set to verbose, print the parsed options.
-    #
-    # The GitHub `:token` key is censored in the output.
-    #
-    # @param options [Hash] The options to display
-    # @option options [Boolean] :verbose If false this method does nothing
-    def self.print_options(options)
       if options[:verbose]
         Helper.log.info "Performing task with options:"
-        options_to_display = options.clone
+        pp options
-        options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
-        pp options_to_display
         puts ""
       end
+
+      options
     end
 
     # setup parsing options
@@ -59,10 +50,7 @@ module GitHubChangelogGenerator
         opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
           options[:output] = last
         end
-        opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
+        opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
-          options[:base] = last
-        end
-        opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**\"") do |v|
           options[:bug_prefix] = v
         end
         opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
@@ -74,9 +62,6 @@ module GitHubChangelogGenerator
         opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
           options[:header] = v
         end
-        opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
-          options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
-        end
         opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
           options[:merge_prefix] = v
         end
@@ -98,9 +83,6 @@ module GitHubChangelogGenerator
         opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
           options[:author] = author
         end
-        opts.on("--usernames-as-github-logins", "Use GitHub tags instead of Markdown links for the author of an issue or pull-request.") do |v|
-          options[:usernames_as_github_logins] = v
-        end
         opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
           options[:unreleased_only] = v
         end
@@ -131,15 +113,9 @@ module GitHubChangelogGenerator
         opts.on("--exclude-tags  x,y,z", Array, "Change log will exclude specified tags") do |list|
           options[:exclude_tags] = list
         end
-        opts.on("--exclude-tags-regex [REGEX]", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\" ") do |last|
-          options[:exclude_tags_regex] = last
-        end
         opts.on("--since-tag  x", "Change log will start after specified tag") do |v|
           options[:since_tag] = v
         end
-        opts.on("--due-tag  x", "Change log will end before specified tag") do |v|
-          options[:due_tag] = v
-        end
         opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
           options[:max_issues] = max
         end
@@ -158,9 +134,6 @@ module GitHubChangelogGenerator
         opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
           options[:future_release] = future_release
         end
-        opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
-          options[:release_branch] = release_branch
-        end
         opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
           options[:verbose] = v
         end
@@ -176,14 +149,13 @@ module GitHubChangelogGenerator
       parser
     end
 
-    # @return [Hash] Default options
+    # just get default options
-    def self.default_options
+    def self.get_default_options
-      {
+      options = {
         tag1: nil,
         tag2: nil,
         date_format: "%Y-%m-%d",
         output: "CHANGELOG.md",
-        base: "HISTORY.md",
         issues: true,
         add_issues_wo_labels: true,
         add_pr_wo_labels: true,
@@ -206,66 +178,45 @@ module GitHubChangelogGenerator
         enhancement_prefix: "**Implemented enhancements:**",
         git_remote: "origin"
       }
+
+      options
     end
 
-    # If `:user` or `:project` not set in options, try setting them
+    # Detects user and project from git
-    # Valid unnamed parameters:
+    def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
-    # 1) in 1 param: repo_name/project
+      options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
-    # 2) in 2 params: repo name project
+      if !options[:user] || !options[:project]
-    def self.fetch_user_and_project(options)
-      if options[:user].nil? || options[:project].nil?
-        user, project = user_and_project_from_git(options, ARGV[0], ARGV[1])
-        options[:user] ||= user
-        options[:project] ||= project
-      end
-    end
-
-    # Sets `:user` and `:project` in `options` from CLI arguments or `git remote`
-    # @param [String] arg0 first argument in cli
-    # @param [String] arg1 second argument in cli
-    # @return [Array<String>] user and project, or nil if unsuccessful
-    def self.user_and_project_from_git(options, arg0 = nil, arg1 = nil)
-      user, project = user_project_from_option(arg0, arg1, options[:github_site])
-      unless user && project
         if ENV["RUBYLIB"] =~ /ruby-debug-ide/
-          user = "skywinder"
+          options[:user] = "skywinder"
-          project = "changelog_test"
+          options[:project] = "changelog_test"
         else
           remote = `git config --get remote.#{options[:git_remote]}.url`
-          user, project = user_project_from_remote(remote)
+          options[:user], options[:project] = user_project_from_remote(remote)
+        end
       end
     end
 
-      [user, project]
+    # Try to find user and project name from git remote output
-    end
-
-    # Returns GitHub username and project from CLI arguments
     #
-    # @param arg0 [String] This parameter takes two forms: Either a full
+    # @param [String] output of git remote command
-    #                      GitHub URL, or a 'username/projectname', or
+    # @return [Array] user and project
-    #                      simply a GitHub username
+    def self.user_project_from_option(arg0, arg1, github_site = nil)
-    # @param arg1 [String] If arg0 is given as a username,
-    #                      then arg1 can given as a projectname
-    # @param github_site [String] Domain name of GitHub site
-    #
-    # @return [Array, nil] user and project, or nil if unsuccessful
-    def self.user_project_from_option(arg0, arg1, github_site)
       user = nil
       project = nil
       github_site ||= "github.com"
       if arg0 && !arg1
-        # this match should parse  strings such "https://github.com/skywinder/Github-Changelog-Generator" or
+        # this match should parse  strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
-        # "skywinder/Github-Changelog-Generator" to user and name
+        puts arg0
         match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
 
         begin
           param = match[2].nil?
         rescue
           puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
-          return
+          exit
         end
         if param
-          return
+          exit
         else
           user = match[1]
           project = match[2]
@@ -274,43 +225,43 @@ module GitHubChangelogGenerator
       [user, project]
     end
 
-    # These patterns match these formats:
+    # Try to find user and project name from git remote output
     #
-    # ```
+    # @param [String] output of git remote command
+    # @return [Array] user and project
+    def self.user_project_from_remote(remote)
+      # try to find repo in format:
       # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
       # git@github.com:skywinder/Github-Changelog-Generator.git
-    # ```
+      regex1 = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/
-    #
+
-    # and
+      # try to find repo in format:
-    #
-    # ```
       # origin	https://github.com/skywinder/ChangelogMerger (fetch)
       # https://github.com/skywinder/ChangelogMerger
-    # ```
+      regex2 = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/
-    GIT_REMOTE_PATTERNS = [
+
-      /.*(?:[:\/])(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*)(?:\.git).*/,
+      remote_structures = [regex1, regex2]
-      /.*\/(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*).*/
-    ]
 
-    # Returns GitHub username and project from git remote output
-    #
-    # @param git_remote_output [String] Output of git remote command
-    #
-    # @return [Array] user and project
-    def self.user_project_from_remote(git_remote_output)
       user = nil
       project = nil
-      GIT_REMOTE_PATTERNS.each do |git_remote_pattern|
+      remote_structures.each do |regex|
-        git_remote_pattern =~ git_remote_output
+        matches = Regexp.new(regex).match(remote)
 
-        if Regexp.last_match
+        if matches && matches[1] && matches[2]
-          user = Regexp.last_match(:user)
+          puts "Detected user:#{matches[1]}, project:#{matches[2]}"
-          project = Regexp.last_match(:project)
+          user = matches[1]
-          break
+          project = matches[2]
         end
+
+        break unless matches.nil?
       end
 
       [user, project]
     end
   end
+
+  if __FILE__ == $PROGRAM_NAME
+    remote = "invalid reference to project"
+    p user_project_from_option(ARGV[0], ARGV[1], remote)
+  end
 end

lib/github_changelog_generator/parser_file.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-require "pathname"
-
-module GitHubChangelogGenerator
-  ParserError = Class.new(StandardError)
-
-  # ParserFile is a configuration file reader which sets options in the
-  # given Hash.
-  #
-  # In your project's root, you can put a file named
-  # <tt>.github_changelog_generator</tt> to override defaults.
-  #
-  # Example:
-  #   header_label=# My Super Changelog
-  #   ; Comments are allowed
-  #   future-release=5.0.0
-  #   # Ruby-style comments, too
-  #   since-tag=1.0.0
-  #
-  # The configuration format is <tt>some-key=value</tt> or <tt>some_key=value</tt>.
-  #
-  class ParserFile
-    # @param options [Hash] options to be configured from file contents
-    # @param file [nil,IO] configuration file handle, defaults to opening `.github_changelog_generator`
-    def initialize(options, file = open_settings_file)
-      @options = options
-      @file = file
-    end
-
-    # Sets options using configuration file content
-    def parse!
-      return unless @file
-      @file.each_with_index { |line, i| parse_line!(line, i + 1) }
-      @file.close
-    end
-
-    private
-
-    FILENAME = ".github_changelog_generator"
-
-    def open_settings_file
-      path = Pathname(File.expand_path(FILENAME))
-      File.open(path) if path.exist?
-    end
-
-    def parse_line!(line, line_number)
-      return if non_configuration_line?(line)
-      option_name, value = extract_pair(line)
-      @options[option_key_for(option_name)] = convert_value(value, option_name)
-    rescue
-      raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
-    end
-
-    # Returns true if the line starts with a pound sign or a semi-colon.
-    def non_configuration_line?(line)
-      line =~ /^[\#;]/ || line =~ /^[\s]+$/
-    end
-
-    # Returns a the option name as a symbol and its string value sans newlines.
-    #
-    # @param line [String] unparsed line from config file
-    # @return [Array<Symbol, String>]
-    def extract_pair(line)
-      key, value = line.split("=", 2)
-      [key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
-    end
-
-    KNOWN_ARRAY_KEYS = [:exclude_labels, :include_labels, :bug_labels,
-                        :enhancement_labels, :between_tags, :exclude_tags]
-    KNOWN_INTEGER_KEYS = [:max_issues]
-
-    def convert_value(value, option_name)
-      if KNOWN_ARRAY_KEYS.include?(option_name)
-        value.split(",")
-      elsif KNOWN_INTEGER_KEYS.include?(option_name)
-        value.to_i
-      elsif value =~ /^(true|t|yes|y|1)$/i
-        true
-      elsif value =~ /^(false|f|no|n|0)$/i
-        false
-      else
-        value
-      end
-    end
-
-    IRREGULAR_OPTIONS = {
-      bugs_label: :bug_prefix,
-      enhancement_label: :enhancement_prefix,
-      issues_label: :issue_prefix,
-      header_label: :header,
-      front_matter: :frontmatter,
-      pr_label: :merge_prefix,
-      issues_wo_labels: :add_issues_wo_labels,
-      pr_wo_labels: :add_pr_wo_labels,
-      pull_requests: :pulls,
-      filter_by_milestone: :filter_issues_by_milestone,
-      github_api: :github_endpoint
-    }
-
-    def option_key_for(option_name)
-      IRREGULAR_OPTIONS.fetch(option_name) { option_name }
-    end
-  end
-end

lib/github_changelog_generator/reader.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 #
 # Author:: Enrico Stahn <mail@enricostahn.com>
 #
@@ -54,28 +53,31 @@ module GitHubChangelogGenerator
 
       @heading_structures.each do |regexp|
         matches = Regexp.new(regexp).match(heading)
-        if matches
+        captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil?
-          captures.merge!(Hash[matches.names.zip(matches.captures)])
+
-          break
+        # Try Regular Expressions until you find one that delivers results
-        end
+        break unless matches.nil?
       end
 
       captures
     end
 
-    # Parse the given ChangeLog data into a list of Hashes
+    # Parse the given ChangeLog data into a Hash
     #
     # @param [String] data File data from the ChangeLog.md
-    # @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
+    # @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
     def parse(data)
       sections = data.split(/^## .+?$/)
       headings = data.scan(/^## .+?$/)
+      changelog = []
 
-      headings.each_with_index.map do |heading, index|
+      headings.each_with_index do |heading, index|
-        section = parse_heading(heading)
+        captures = parse_heading(heading)
-        section["content"] = sections.at(index + 1)
+        captures["content"] = sections.at(index + 1)
-        section
+        changelog.push captures
       end
+
+      changelog
     end
 
     def read(file_path)

lib/github_changelog_generator/task.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 require "rake"
 require "rake/tasklib"
 require "github_changelog_generator"
@@ -15,10 +14,9 @@ module GitHubChangelogGenerator
                   unreleased_only unreleased unreleased_label
                   compare_link include_labels exclude_labels
                   bug_labels enhancement_labels
-                  between_tags exclude_tags exclude_tags_regex since_tag max_issues
+                  between_tags exclude_tags since_tag max_issues
                   github_site github_endpoint simple_list
-                  future_release release_branch verbose release_url
+                  future_release verbose )
-                  base )
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym
@@ -38,27 +36,29 @@ module GitHubChangelogGenerator
     def define(args, &task_block)
       desc "Generate a Change log from GitHub"
 
-      yield(*[self, args].slice(0, task_block.arity)) if task_block
+      task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
 
       # clear any (auto-)pre-existing task
       Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
 
       task @name do
         # mimick parse_options
-        options = Parser.default_options
+        options = Parser.get_default_options
 
-        Parser.fetch_user_and_project(options)
+        if options[:user].nil? || options[:project].nil?
+          Parser.detect_user_and_project(options)
+        end
 
         OPTIONS.each do |o|
           v = instance_variable_get("@#{o}")
-          options[o.to_sym] = v unless v.nil?
+          options[o.to_sym] = v if v
         end
 
         generator = Generator.new options
 
         log = generator.compound_changelog
 
-        output_filename = (options[:output]).to_s
+        output_filename = "#{options[:output]}"
         File.open(output_filename, "w") { |file| file.write(log) }
         puts "Done!"
         puts "Generated log placed in #{Dir.pwd}/#{output_filename}"

lib/github_changelog_generator/version.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 module GitHubChangelogGenerator
-  VERSION = "1.13.2"
+  VERSION = "1.7.0"
 end

man/git-generate-changelog.1

@@ -1,252 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2015" "" ""
-.
-.SH "NAME"
-\fBgit\-generate\-changelog\fR \- Generate changelog from github
-.
-.SH "SYNOPSIS"
-\fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
-.
-.SH "DESCRIPTION"
-Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
-.
-.SH "OPTIONS"
-\-u, \-\-user [USER]
-.
-.P
-Username of the owner of target GitHub repo
-.
-.P
-\-p, \-\-project [PROJECT]
-.
-.P
-Name of project on GitHub
-.
-.P
-\-t, \-\-token [TOKEN]
-.
-.P
-To make more than 50 requests per hour your GitHub token is required\. You can generate it at: https://github\.com/settings/tokens/new
-.
-.P
-\-f, \-\-date\-format [FORMAT]
-.
-.P
-Date format\. Default is %Y\-%m\-%d
-.
-.P
-\-o, \-\-output [NAME]
-.
-.P
-Output file\. Default is CHANGELOG\.md
-.
-.P
-\-b, \-\-base [NAME]
-.
-.P
-Optional base file to append generated changes to\.
-.
-.P
-\-\-bugs\-label [LABEL]
-.
-.P
-Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
-.
-.P
-\-\-enhancement\-label [LABEL]
-.
-.P
-Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
-.
-.P
-\-\-issues\-label [LABEL]
-.
-.P
-Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
-.
-.P
-\-\-header\-label [LABEL]
-.
-.P
-Setup custom header label\. Default is "# Change Log"
-.
-.P
-\-\-pr\-label [LABEL]
-.
-.P
-Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
-.
-.P
-\-\-[no\-]issues
-.
-.P
-Include closed issues in changelog\. Default is true
-.
-.P
-\-\-[no\-]issues\-wo\-labels
-.
-.P
-Include closed issues without labels in changelog\. Default is true
-.
-.P
-\-\-[no\-]pr\-wo\-labels
-.
-.P
-Include pull requests without labels in changelog\. Default is true
-.
-.P
-\-\-[no\-]pull\-requests
-.
-.P
-Include pull\-requests in changelog\. Default is true
-.
-.P
-\-\-[no\-]filter\-by\-milestone
-.
-.P
-Use milestone to detect when issue was resolved\. Default is true
-.
-.P
-\-\-[no\-]author
-.
-.P
-Add author of pull\-request in the end\. Default is true
-.
-.P
-\-\-unreleased\-only
-.
-.P
-Generate log from unreleased closed issues only\.
-.
-.P
-\-\-[no\-]unreleased
-.
-.P
-Add to log unreleased closed issues\. Default is true
-.
-.P
-\-\-unreleased\-label [label]
-.
-.P
-Add to log unreleased closed issues\. Default is true
-.
-.P
-\-\-[no\-]compare\-link
-.
-.P
-Include compare link (Full Changelog) between older version and newer version\. Default is true
-.
-.P
-\-\-include\-labels x,y,z
-.
-.P
-Only issues with the specified labels will be included in the changelog\.
-.
-.P
-\-\-exclude\-labels x,y,z
-.
-.P
-Issues with the specified labels will be always excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'
-.
-.P
-\-\-bug\-labels x,y,z
-.
-.P
-Issues with the specified labels will be always added to "Fixed bugs" section\. Default is \'bug,Bug\'
-.
-.P
-\-\-enhancement\-labels x,y,z
-.
-.P
-Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
-.
-.P
-\-\-between\-tags x,y,z
-.
-.P
-Change log will be filled only between specified tags
-.
-.P
-\-\-exclude\-tags x,y,z
-.
-.P
-Change log will exclude specified tags
-.
-.P
-\-\-since\-tag x
-.
-.P
-Change log will start after specified tag
-.
-.P
-\-\-due\-tag x
-.
-.P
-Change log will end before specified tag
-.
-.P
-\-\-max\-issues [NUMBER]
-.
-.P
-Max number of issues to fetch from GitHub\. Default is unlimited
-.
-.P
-\-\-release\-url [URL]
-.
-.P
-The URL to point to for release links, in printf format (with the tag as variable)\.
-.
-.P
-\-\-github\-site [URL]
-.
-.P
-The Enterprise Github site on which your project is hosted\.
-.
-.P
-\-\-github\-api [URL]
-.
-.P
-The enterprise endpoint to use for your Github API\.
-.
-.P
-\-\-simple\-list
-.
-.P
-Create simple list from issues and pull requests\. Default is false\.
-.
-.P
-\-\-future\-release [RELEASE\-VERSION]
-.
-.P
-Put the unreleased changes in the specified release number\.
-.
-.P
-\-\-[no\-]verbose
-.
-.P
-Run verbosely\. Default is true
-.
-.P
-\-v, \-\-version
-.
-.P
-Print version number
-.
-.P
-\-h, \-\-help
-.
-.P
-Displays Help
-.
-.SH "EXAMPLES"
-.
-.SH "AUTHOR"
-Written by Petr Korolev sky4winder@gmail\.com
-.
-.SH "REPORTING BUGS"
-<\fIhttps://github\.com/skywinder/github\-changelog\-generator/issues\fR>
-.
-.SH "SEE ALSO"
-<\fIhttps://github\.com/skywinder/github\-changelog\-generator/\fR>

man/git-generate-changelog.html

@@ -1,262 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta http-equiv='content-type' value='text/html;charset=utf8'>
-  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
-  <title>git-generate-changelog(1) - Generate changelog from github</title>
-  <style type='text/css' media='all'>
-  /* style: man */
-  body#manpage {margin:0}
-  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
-  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
-  .mp h2 {margin:10px 0 0 0}
-  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
-  .mp h3 {margin:0 0 0 4ex}
-  .mp dt {margin:0;clear:left}
-  .mp dt.flush {float:left;width:8ex}
-  .mp dd {margin:0 0 0 9ex}
-  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
-  .mp pre {margin-bottom:20px}
-  .mp pre+h2,.mp pre+h3 {margin-top:22px}
-  .mp h2+pre,.mp h3+pre {margin-top:5px}
-  .mp img {display:block;margin:auto}
-  .mp h1.man-title {display:none}
-  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
-  .mp h2 {font-size:16px;line-height:1.25}
-  .mp h1 {font-size:20px;line-height:2}
-  .mp {text-align:justify;background:#fff}
-  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
-  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
-  .mp u {text-decoration:underline}
-  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
-  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
-  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
-  .mp b.man-ref {font-weight:normal;color:#434241}
-  .mp pre {padding:0 4ex}
-  .mp pre code {font-weight:normal;color:#434241}
-  .mp h2+pre,h3+pre {padding-left:0}
-  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
-  ol.man-decor {width:100%}
-  ol.man-decor li.tl {text-align:left}
-  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
-  ol.man-decor li.tr {text-align:right;float:right}
-  </style>
-</head>
-<!--
-  The following styles are deprecated and will be removed at some point:
-  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
-
-  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
-  .man-navigation should be used instead.
--->
-<body id='manpage'>
-  <div class='mp' id='man'>
-
-  <div class='man-navigation' style='display:none'>
-    <a href="#NAME">NAME</a>
-    <a href="#SYNOPSIS">SYNOPSIS</a>
-    <a href="#DESCRIPTION">DESCRIPTION</a>
-    <a href="#OPTIONS">OPTIONS</a>
-    <a href="#EXAMPLES">EXAMPLES</a>
-    <a href="#AUTHOR">AUTHOR</a>
-    <a href="#REPORTING-BUGS">REPORTING BUGS</a>
-    <a href="#SEE-ALSO">SEE ALSO</a>
-  </div>
-
-  <ol class='man-decor man-head man head'>
-    <li class='tl'>git-generate-changelog(1)</li>
-    <li class='tc'></li>
-    <li class='tr'>git-generate-changelog(1)</li>
-  </ol>
-
-  <h2 id="NAME">NAME</h2>
-<p class="man-name">
-  <code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
-</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<p><code>git generate-changelog</code> [-h|--help] [-u|--user] [-p|--project]</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
-<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
-
-<h2 id="OPTIONS">OPTIONS</h2>
-
-<p>  -u, --user [USER]</p>
-
-<p>  Username of the owner of target GitHub repo</p>
-
-<p>  -p, --project [PROJECT]</p>
-
-<p>  Name of project on GitHub</p>
-
-<p>  -t, --token [TOKEN]</p>
-
-<p>  To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
-
-<p>  -f, --date-format [FORMAT]</p>
-
-<p>  Date format. Default is %Y-%m-%d</p>
-
-<p>  -o, --output [NAME]</p>
-
-<p>  Output file. Default is CHANGELOG.md</p>
-
-<p>  -b, --base [NAME]</p>
-
-<p>  Optional base file to append generated changes to.</p>
-
-<p>   --bugs-label [LABEL]</p>
-
-<p>   Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
-
-<p>   --enhancement-label [LABEL]</p>
-
-<p>   Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
-
-<p>   --issues-label [LABEL]</p>
-
-<p>   Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
-
-<p>   --header-label [LABEL]</p>
-
-<p>   Setup custom header label. Default is "# Change Log"</p>
-
-<p>   --pr-label [LABEL]</p>
-
-<p>   Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
-
-<p>   --[no-]issues</p>
-
-<p>   Include closed issues in changelog. Default is true</p>
-
-<p>   --[no-]issues-wo-labels</p>
-
-<p>   Include closed issues without labels in changelog. Default is true</p>
-
-<p>   --[no-]pr-wo-labels</p>
-
-<p>   Include pull requests without labels in changelog. Default is true</p>
-
-<p>   --[no-]pull-requests</p>
-
-<p>   Include pull-requests in changelog. Default is true</p>
-
-<p>   --[no-]filter-by-milestone</p>
-
-<p>   Use milestone to detect when issue was resolved. Default is true</p>
-
-<p>   --[no-]author</p>
-
-<p>   Add author of pull-request in the end. Default is true</p>
-
-<p>   --unreleased-only</p>
-
-<p>   Generate log from unreleased closed issues only.</p>
-
-<p>   --[no-]unreleased</p>
-
-<p>   Add to log unreleased closed issues. Default is true</p>
-
-<p>   --unreleased-label [label]</p>
-
-<p>   Add to log unreleased closed issues. Default is true</p>
-
-<p>   --[no-]compare-link</p>
-
-<p>   Include compare link (Full Changelog) between older version and newer version. Default is true</p>
-
-<p>   --include-labels x,y,z</p>
-
-<p>   Only issues with the specified labels will be included in the changelog.</p>
-
-<p>   --exclude-labels x,y,z</p>
-
-<p>   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
-
-<p>   --bug-labels x,y,z</p>
-
-<p>   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
-
-<p>   --enhancement-labels x,y,z</p>
-
-<p>   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
-
-<p>   --between-tags x,y,z</p>
-
-<p>   Change log will be filled only between specified tags</p>
-
-<p>   --exclude-tags x,y,z</p>
-
-<p>   Change log will exclude specified tags</p>
-
-<p>   --since-tag x</p>
-
-<p>   Change log will start after specified tag</p>
-
-<p>   --due-tag x</p>
-
-<p>   Change log will end before specified tag</p>
-
-<p>   --max-issues [NUMBER]</p>
-
-<p>   Max number of issues to fetch from GitHub. Default is unlimited</p>
-
-<p>   --release-url [URL]</p>
-
-<p>   The URL to point to for release links, in printf format (with the tag as variable).</p>
-
-<p>   --github-site [URL]</p>
-
-<p>   The Enterprise Github site on which your project is hosted.</p>
-
-<p>   --github-api [URL]</p>
-
-<p>   The enterprise endpoint to use for your Github API.</p>
-
-<p>   --simple-list</p>
-
-<p>   Create simple list from issues and pull requests. Default is false.</p>
-
-<p>   --future-release [RELEASE-VERSION]</p>
-
-<p>   Put the unreleased changes in the specified release number.</p>
-
-<p>   --[no-]verbose</p>
-
-<p>   Run verbosely. Default is true</p>
-
-<p>  -v, --version</p>
-
-<p>  Print version number</p>
-
-<p>  -h, --help</p>
-
-<p>  Displays Help</p>
-
-<h2 id="EXAMPLES">EXAMPLES</h2>
-
-<h2 id="AUTHOR">AUTHOR</h2>
-
-<p>Written by Petr Korolev sky4winder@gmail.com</p>
-
-<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
-
-<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>&gt;</p>
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>&gt;</p>
-
-
-  <ol class='man-decor man-foot man foot'>
-    <li class='tl'></li>
-    <li class='tc'>October 2015</li>
-    <li class='tr'>git-generate-changelog(1)</li>
-  </ol>
-
-  </div>
-</body>
-</html>

man/git-generate-changelog.md

@@ -1,179 +0,0 @@
-git-generate-changelog(1) - Generate changelog from github
-================================
-
-## SYNOPSIS
-
-`git generate-changelog` [-h|--help] [-u|--user] [-p|--project]
-
-## DESCRIPTION
-
-Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
-
-## OPTIONS
-
-  -u, --user [USER]
-
-  Username of the owner of target GitHub repo
-
-  -p, --project [PROJECT]
-
-  Name of project on GitHub
-
-  -t, --token [TOKEN]
-
-  To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new
-
-  -f, --date-format [FORMAT]
-
-  Date format. Default is %Y-%m-%d
-
-  -o, --output [NAME]
-
-  Output file. Default is CHANGELOG.md
-
-  -b, --base [NAME]
-
-  Optional base file to append generated changes to.
-
-   --bugs-label [LABEL]
-
-   Setup custom label for bug-fixes section. Default is "**Fixed bugs:**
-
-   --enhancement-label [LABEL]
-
-   Setup custom label for enhancements section. Default is "**Implemented enhancements:**"
-
-   --issues-label [LABEL]
-
-   Setup custom label for closed-issues section. Default is "**Closed issues:**"
-
-   --header-label [LABEL]
-
-   Setup custom header label. Default is "# Change Log"
-
-   --pr-label [LABEL]
-
-   Setup custom label for pull requests section. Default is "**Merged pull requests:**"
-
-   --[no-]issues
-
-   Include closed issues in changelog. Default is true
-
-   --[no-]issues-wo-labels
-
-   Include closed issues without labels in changelog. Default is true
-
-   --[no-]pr-wo-labels
-
-   Include pull requests without labels in changelog. Default is true
-
-   --[no-]pull-requests
-
-   Include pull-requests in changelog. Default is true
-
-   --[no-]filter-by-milestone
-
-   Use milestone to detect when issue was resolved. Default is true
-
-   --[no-]author
-
-   Add author of pull-request in the end. Default is true
-
-   --unreleased-only
-
-   Generate log from unreleased closed issues only.
-
-   --[no-]unreleased
-
-   Add to log unreleased closed issues. Default is true
-
-   --unreleased-label [label]
-
-   Add to log unreleased closed issues. Default is true
-
-   --[no-]compare-link
-
-   Include compare link (Full Changelog) between older version and newer version. Default is true
-
-   --include-labels x,y,z
-
-   Only issues with the specified labels will be included in the changelog.
-
-   --exclude-labels x,y,z
-
-   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
-
-   --bug-labels x,y,z
-
-   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'
-
-   --enhancement-labels x,y,z
-
-   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
-
-   --between-tags x,y,z
-
-   Change log will be filled only between specified tags
-
-   --exclude-tags x,y,z
-
-   Change log will exclude specified tags
-
-   --since-tag x
-
-   Change log will start after specified tag
-
-   --due-tag x
-
-   Change log will end before specified tag
-
-   --max-issues [NUMBER]
-
-   Max number of issues to fetch from GitHub. Default is unlimited
-
-   --release-url [URL]
-
-   The URL to point to for release links, in printf format (with the tag as variable).
-
-   --github-site [URL]
-
-   The Enterprise Github site on which your project is hosted.
-
-   --github-api [URL]
-
-   The enterprise endpoint to use for your Github API.
-
-   --simple-list
-
-   Create simple list from issues and pull requests. Default is false.
-
-   --future-release [RELEASE-VERSION]
-
-   Put the unreleased changes in the specified release number.
-
-   --[no-]verbose
-
-   Run verbosely. Default is true
-
-  -v, --version
-
-  Print version number
-
-  -h, --help
-
-  Displays Help
-
-
-## EXAMPLES
-
-## AUTHOR
-
-Written by Petr Korolev sky4winder@gmail.com
-
-## REPORTING BUGS
-
-&lt;<https://github.com/skywinder/github-changelog-generator/issues>&gt;
-
-## SEE ALSO
-
-&lt;<https://github.com/skywinder/github-changelog-generator/>&gt;

spec/install-gem-in-bundler.gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gem "github_changelog_generator", path: Dir.glob("../pkg/github_changelog_generator-*.gem")[0]

spec/spec_helper.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 #
 # Author:: Enrico Stahn <mail@enricostahn.com>
 #
@@ -24,35 +23,99 @@ require "coveralls"
 module SpecHelper
 end
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   Coveralls::SimpleCov::Formatter,
   SimpleCov::Formatter::HTMLFormatter,
   CodeClimate::TestReporter::Formatter
-                                                               ])
+]
-SimpleCov.start do
+SimpleCov.start
-  add_filter "gemfiles/"
-end
 
 require "github_changelog_generator"
-require "github_changelog_generator/task"
 
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
   config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
     mocks.verify_partial_doubles = true
   end
 
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
   config.filter_run :focus
   config.run_all_when_everything_filtered = true
 
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  # config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
   config.warnings = true
 
-  config.default_formatter = "doc" if config.files_to_run.one?
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
 
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
   config.order = :random
 
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
   Kernel.srand config.seed
 end

spec/unit/fetcher_spec.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 VALID_TOKEN = "0123456789abcdef"
 INVALID_TOKEN = "0000000000000000"
 

spec/unit/generator/generator_processor_spec.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-module GitHubChangelogGenerator
-  describe Generator do
-    context "#exclude_issues_by_labels" do
-      let(:label) { double("the-bad-label", name: "BAD") }
-      let(:issue) { double("the-issue-to-be-excluded", labels: [label]) }
-      let(:good_label) { double("a-good-label", name: "GOOD") }
-      let(:good_issue) { double("an-issue-to-be-kept", labels: [good_label]) }
-      let(:issues) { [issue, good_issue] }
-      subject(:generator) { described_class.new(exclude_labels: %w(BAD BOO)) }
-
-      it "removes issues with labels in the exclude_label list" do
-        result = generator.exclude_issues_by_labels(issues)
-
-        expect(result).to include(good_issue)
-        expect(result).not_to include(issue)
-      end
-
-      context "with no option given" do
-        subject(:generator) { described_class.new }
-        it "passes everything through when no option given" do
-          result = generator.exclude_issues_by_labels(issues)
-
-          expect(result).to eq(issues)
-        end
-      end
-    end
-  end
-end

spec/unit/generator/generator_tags_spec.rb

@@ -1,15 +1,19 @@
-# frozen_string_literal: true
+def tag_mash_with_name(tag)
+  mash_tag = Hashie::Mash.new
+  mash_tag.name = tag
+  mash_tag
+end
+
+def tags_mash_from_strings(tags_strings)
+  mash_array = []
+  tags_strings.each do |tag|
+    mash_tag = tag_mash_with_name(tag)
+    mash_array << mash_tag
+  end
+  mash_array
+end
+
 describe GitHubChangelogGenerator::Generator do
-  def tag_mash_with_name(tag)
-    Hashie::Mash.new.tap { |mash_tag| mash_tag.name = tag }
-  end
-
-  def tags_mash_from_strings(tags_strings)
-    tags_strings.map do |tag|
-      tag_mash_with_name(tag)
-    end
-  end
-
   describe "#filter_between_tags" do
     context "when between_tags nil" do
       before do
@@ -72,49 +76,20 @@ describe GitHubChangelogGenerator::Generator do
   describe "#filter_excluded_tags" do
     subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
 
-    context "with matching string" do
+    context "with valid excluded tags" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
       it { is_expected.to be_a Array }
       it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
     end
 
-    context "with non-matching string" do
+    context "with invalid excluded tags" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
       it { is_expected.to be_a Array }
       it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
     end
-
-    context "with matching regex" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
-      it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
-    end
-
-    context "with non-matching regex" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
-      it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
-    end
-  end
-
-  describe "#filter_excluded_tags_regex" do
-    subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
-
-    context "with matching regex" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[23]") }
-      it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
-    end
-
-    context "with non-matching regex" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[45]") }
-      it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
-    end
   end
 
   describe "#filter_since_tag" do
-    context "with filled array" do
     subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
 
     context "with valid since tag" do
@@ -124,63 +99,12 @@ describe GitHubChangelogGenerator::Generator do
     end
 
     context "with invalid since tag" do
-        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
+      let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: %w(invalid tags)) }
       it { is_expected.to be_a Array }
       it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
     end
   end
 
-    context "with empty array" do
-      subject { generator.filter_since_tag(tags_mash_from_strings(%w())) }
-
-      context "with valid since tag" do
-        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
-        it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
-      end
-
-      context "with invalid since tag" do
-        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
-        it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
-      end
-    end
-  end
-
-  describe "#filter_due_tag" do
-    context "with filled array" do
-      subject { generator.filter_due_tag(tags_mash_from_strings(%w(1 2 3))) }
-
-      context "with valid due tag" do
-        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
-        it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_mash_from_strings(%w(3))) }
-      end
-
-      context "with invalid due tag" do
-        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
-        it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
-      end
-    end
-
-    context "with empty array" do
-      subject { generator.filter_due_tag(tags_mash_from_strings(%w())) }
-
-      context "with valid due tag" do
-        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
-        it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
-      end
-
-      context "with invalid due tag" do
-        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
-        it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
-      end
-    end
-  end
-
   describe "#get_time_of_tag" do
     current_time = Time.now
     before(:all) { @generator = GitHubChangelogGenerator::Generator.new }
@@ -202,7 +126,7 @@ describe GitHubChangelogGenerator::Generator do
         @generator.instance_variable_set :@fetcher, mock
       end
       subject do
-        of_tag = @generator.get_time_of_tag(tag_mash_with_name("valid_tag"))
+        of_tag = @generator.get_time_of_tag tag_mash_with_name("valid_tag")
         of_tag
       end
       it { is_expected.to be_a_kind_of(Time) }
@@ -211,32 +135,31 @@ describe GitHubChangelogGenerator::Generator do
   end
 
   describe "#sort_tags_by_date" do
-    let(:time1) { Time.now }
+    time1 = Time.now
-    let(:time2) { Time.now }
+    time2 = Time.now
-    let(:time3) { Time.now }
+    time3 = Time.now
-
     before(:all) do
       @generator = GitHubChangelogGenerator::Generator.new
     end
-
-    before do
-      @generator.instance_variable_set(:@tag_times_hash, "valid_tag1" => time1,
-                                                         "valid_tag2" => time2,
-                                                         "valid_tag3" => time3)
-    end
-
-    subject do
-      @generator.sort_tags_by_date(tags)
-    end
     context "sort unsorted tags" do
-      let(:tags) { tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3) }
+      tags = tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3)
-
+      before do
+        @generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
+      end
+      subject do
+        @generator.sort_tags_by_date tags
+      end
       it { is_expected.to be_a_kind_of(Array) }
       it { is_expected.to match_array(tags.reverse!) }
     end
     context "sort sorted tags" do
-      let(:tags) { tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1) }
+      tags = tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1)
-
+      before do
+        @generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
+      end
+      subject do
+        @generator.sort_tags_by_date tags
+      end
       it { is_expected.to be_a_kind_of(Array) }
       it { is_expected.to match_array(tags) }
     end

spec/unit/parse_file_spec.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-describe GitHubChangelogGenerator::ParserFile do
-  describe ".github_changelog_generator" do
-    let(:options) { {} }
-
-    context "when the well-known default file does not exist" do
-      let(:parser) { GitHubChangelogGenerator::ParserFile.new(options) }
-      subject { parser.parse! }
-      it { is_expected.to be_nil }
-    end
-
-    context "when file is empty" do
-      let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) }
-
-      it "does not change the options" do
-        expect { parser.parse! }.to_not change { options }
-      end
-    end
-
-    context "when file is incorrect" do
-      let(:options_before_change) { options.dup }
-      let(:file) { StringIO.new("unreleased_label=staging\nunreleased: false") }
-      let(:parser) do
-        GitHubChangelogGenerator::ParserFile.new(options, file)
-      end
-      it { expect { parser.parse! }.to raise_error(/line #2/) }
-    end
-
-    context "allows empty lines and comments with semi-colon or pound sign" do
-      let(:file) { StringIO.new("\n   \n# Comment on first line\nunreleased_label=staging\n; Comment on third line\nunreleased=false") }
-      let(:parser) do
-        GitHubChangelogGenerator::ParserFile.new(options, file)
-      end
-      it { expect { parser.parse! }.not_to raise_error }
-    end
-
-    context "when override default values" do
-      let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
-      let(:options) { {}.merge(default_options) }
-      let(:options_before_change) { options.dup }
-      let(:file) { StringIO.new("unreleased_label=staging\nunreleased=false\nheader==== Changelog ===") }
-      let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, file) }
-
-      it "changes the options" do
-        expect { parser.parse! }.to change { options }
-          .from(options_before_change)
-          .to(options_before_change.merge(unreleased_label: "staging",
-                                          unreleased: false,
-                                          header: "=== Changelog ==="))
-      end
-
-      context "turns exclude-labels into an Array", bug: "#327" do
-        let(:file) do
-          StringIO.new(<<EOF
-exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
-header_label=# My changelog
-EOF
-                      )
-        end
-        it "reads exclude_labels into an Array" do
-          expect { parser.parse! }.to change { options[:exclude_labels] }
-            .from(default_options[:exclude_labels])
-            .to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
-        end
-
-        it "translates given header_label into the :header option" do
-          expect { parser.parse! }.to change { options[:header] }
-            .from(default_options[:header])
-            .to("# My changelog")
-        end
-      end
-    end
-  end
-end

spec/unit/parser_spec.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 describe GitHubChangelogGenerator::Parser do
   describe ".user_project_from_remote" do
     context "when remote is type 1" do
@@ -29,16 +28,16 @@ describe GitHubChangelogGenerator::Parser do
   end
   describe ".user_project_from_option" do
     context "when option is invalid" do
-      it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil }
+      it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
     end
 
     context "when option is valid" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
       it { is_expected.to be_a(Array) }
       it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
     end
     context "when option nil" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) }
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil) }
       it { is_expected.to be_a(Array) }
       it { is_expected.to match_array([nil, nil]) }
     end
@@ -57,26 +56,5 @@ describe GitHubChangelogGenerator::Parser do
       it { is_expected.to be_a(Array) }
       it { is_expected.to match_array([nil, nil]) }
     end
-    context "when all args is not nil" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", "https://codeclimate.com") }
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array([nil, nil]) }
-    end
-  end
-  describe ".fetch_user_and_project" do
-    before do
-      stub_const("ARGV", ["https://github.com/skywinder/github-changelog-generator"])
-    end
-
-    context do
-      let(:valid_user) { "initialized_user" }
-      let(:options) { { user: valid_user } }
-      let(:options_before_change) { options.dup }
-      it "should leave user unchanged" do
-        expect { GitHubChangelogGenerator::Parser.fetch_user_and_project(options) }.to change { options }
-          .from(options_before_change)
-          .to(options_before_change.merge(project: "github-changelog-generator"))
-      end
-    end
   end
 end

spec/unit/reader_spec.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 #
 # Author:: Enrico Stahn <mail@enricostahn.com>
 #