CHANGELOG for v1.15.0-rc

Aborting on missing --user and --project prints all of usage

.codeclimate.yml

@@ -0,0 +1,12 @@
+engines:
+ duplication:
+   enabled: true
+   config:
+     languages:
+     - ruby
+ rubocop:
+   enabled: true
+ratings:
+ paths:
+ - "**.rb"
+exclude_paths:

.github_changelog_generator

@@ -0,0 +1,2 @@
+project=github-changelog-generator
+user=skywinder

.gitignore

@@ -9,3 +9,4 @@ doc
 .yardoc
 Gemfile.lock
 gemfiles/Gemfile.2_4_0.lock
+gemfiles/Gemfile.jruby-9.1.5.0.lock

.rubocop.yml

@@ -1,6 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
+  TargetRubyVersion: 2.2
   DisplayCopNames: true
   DisplayStyleGuide: true
   Exclude:
@@ -10,6 +11,9 @@ AllCops:
 Metrics/LineLength:
   Enabled: false
 
+Performance/RegexpMatch:
+  Enabled: false
+
 #http://viget.com/extend/just-use-double-quoted-ruby-strings
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -22,7 +26,7 @@ Metrics/ClassLength:
 Metrics/MethodLength:
     Enabled: false
 
-Style/FileName:
+Naming/FileName:
     Exclude:
       - 'bin/git-generate-changelog'
 
@@ -32,7 +36,7 @@ Metrics/AbcSize:
   Enabled: false
 
 # Offense count: 1
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Enabled: false
 
 # Offense count: 10
@@ -66,4 +70,13 @@ Style/NumericPredicate:
   Enabled: false
 
 Style/SafeNavigation:
-  Enabled: false
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+# Re-enable when merged; https://github.com/bbatsov/rubocop/pull/4756
+Lint/InterpolationCheck:
+  Enabled: false
+

.rubocop_todo.yml

@@ -1,20 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-02-23 17:18:27 +0200 using RuboCop version 0.37.2.
+# on 2016-09-30 23:56:15 +0200 using RuboCop version 0.43.0.
 # 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
-Lint/ImplicitStringConcatenation:
-  Exclude:
-    - 'lib/github_changelog_generator/parser.rb'
-
-# Offense count: 14
-Metrics/AbcSize:
-  Enabled: false
-
 # Offense count: 1
 Metrics/CyclomaticComplexity:
   Max: 7
@@ -22,30 +13,3 @@ Metrics/CyclomaticComplexity:
 # Offense count: 2
 Metrics/PerceivedComplexity:
   Max: 8
-
-# 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

.ruby-version

@@ -1 +1 @@
-2.3.1
+2.4.0

.travis.yml

@@ -1,32 +1,30 @@
 language: ruby
 cache:
-  - bundler
+  bundler: true
 before_install:
-  - gem update --system
   - gem install bundler
 matrix:
+  fast_finish: true
   include:
-    - rvm: 2.2.2
+    - rvm: 2.2.7
       install: true # This skips 'bundle install'
       script: gem build github_changelog_generator && gem install *.gem
-    - rvm: 2.2.2
+      after_success: true # This skips 'codeclimate-test-reporter'
+    - rvm: 2.2.7
       install: true # This skips 'bundle install'
       script: gem build github_changelog_generator && bundle install
       gemfile: spec/install-gem-in-bundler.gemfile
-    - rvm: 2.1
+      after_success: true # This skips 'codeclimate-test-reporter'
-      gemfile: gemfiles/Gemfile.2_1
+    - rvm: 2.3.4
-    - rvm: 2.3.1
+    - rvm: 2.4.1
-      gemfile: gemfiles/Gemfile.2_3_1
+    - rvm: jruby-9.1.13.0
-    - rvm: 2.4.0-preview2
+      jdk: oraclejdk8
-      gemfile: gemfiles/Gemfile.2_4_0
+      env:
+        - JRUBY_OPTS=--debug
 
-notifications:
-  email:
-    recipients:
-      - sky4winder+githubchangeloggenerator@gmail.com
-    on_success: never
-    on_failure: change
 addons:
   code_climate:
     repo_token:
       secure: iMpV5IAvH+/EVGZrpWnt2BnmNFzSbsRcIumsr4ZyLC8N5nrCSXyjCSy0g48btL3Sj0bSgK9hcrJsmrFd2bkqFleyAcPAzNyUQzBuIRZx47O8yFmbZ+Pj+l3+KOlmcbzJNHfDfxkxuWTmTAcSDfsiyApin721T/ey3SUuwKpZNUc=
+after_success:
+  - bundle exec codeclimate-test-reporter

CHANGELOG.md

@@ -1,5 +1,223 @@
 # Change Log
 
+## [v1.15.0-rc](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0-rc) (2017-10-29)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.15.0.pre.beta...v1.15.0-rc)
+
+**Implemented enhancements:**
+
+- Add option --require to load custom Ruby code before starting [\#574](https://github.com/skywinder/github-changelog-generator/pull/574) ([olleolleolle](https://github.com/olleolleolle))
+
+**Fixed bugs:**
+
+- issue\_line\_labels and breaking\_labels fail as rake file config params [\#583](https://github.com/skywinder/github-changelog-generator/issues/583)
+
+**Merged pull requests:**
+
+- Add Rake options reported missing [\#584](https://github.com/skywinder/github-changelog-generator/pull/584) ([olleolleolle](https://github.com/olleolleolle))
+- Aborting on missing --user and --project prints all of usage [\#578](https://github.com/skywinder/github-changelog-generator/pull/578) ([olleolleolle](https://github.com/olleolleolle))
+- Options\#print\_options + API docs for Options, Parser [\#576](https://github.com/skywinder/github-changelog-generator/pull/576) ([olleolleolle](https://github.com/olleolleolle))
+- \[docs\] Contributing file [\#575](https://github.com/skywinder/github-changelog-generator/pull/575) ([olleolleolle](https://github.com/olleolleolle))
+
+## [v1.15.0.pre.beta](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0.pre.beta) (2017-10-13)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.15.0.pre.alpha...v1.15.0.pre.beta)
+
+**Implemented enhancements:**
+
+- add breaking-changes section to changelog [\#530](https://github.com/skywinder/github-changelog-generator/pull/530) ([bastelfreak](https://github.com/bastelfreak))
+- Drop Project-and-Username-finding code [\#451](https://github.com/skywinder/github-changelog-generator/pull/451) ([olleolleolle](https://github.com/olleolleolle))
+
+**Fixed bugs:**
+
+- since\_tag doesn't work when tag specified is the latest tag [\#555](https://github.com/skywinder/github-changelog-generator/issues/555)
+- since\_tag seems to not be working [\#304](https://github.com/skywinder/github-changelog-generator/issues/304)
+- filter tags correctly when `since\_tag` is set to most recent tag [\#566](https://github.com/skywinder/github-changelog-generator/pull/566) ([Crunch09](https://github.com/Crunch09))
+
+**Closed issues:**
+
+- SSL Cert issue on Windows [\#475](https://github.com/skywinder/github-changelog-generator/issues/475)
+
+**Merged pull requests:**
+
+- Fix regression w/ enhancements in issues\_to\_log [\#573](https://github.com/skywinder/github-changelog-generator/pull/573) ([ekohl](https://github.com/ekohl))
+- OctoFetcher: Use defaults for request\_options [\#571](https://github.com/skywinder/github-changelog-generator/pull/571) ([olleolleolle](https://github.com/olleolleolle))
+- OctoFetcher: extract methods [\#570](https://github.com/skywinder/github-changelog-generator/pull/570) ([olleolleolle](https://github.com/olleolleolle))
+- OctoFetcher: extract method fail\_with\_message [\#569](https://github.com/skywinder/github-changelog-generator/pull/569) ([olleolleolle](https://github.com/olleolleolle))
+- OctoFetcher: drop unused number\_of\_pages feature [\#568](https://github.com/skywinder/github-changelog-generator/pull/568) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: Do not test on jruby-head [\#567](https://github.com/skywinder/github-changelog-generator/pull/567) ([olleolleolle](https://github.com/olleolleolle))
+- Drop unused Rake task [\#564](https://github.com/skywinder/github-changelog-generator/pull/564) ([olleolleolle](https://github.com/olleolleolle))
+- Update license date [\#553](https://github.com/skywinder/github-changelog-generator/pull/553) ([benhc123](https://github.com/benhc123))
+
+## [v1.15.0.pre.alpha](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0.pre.alpha) (2017-10-01)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.3...v1.15.0.pre.alpha)
+
+**Implemented enhancements:**
+
+- Add newline after version name and Full Changelog link [\#548](https://github.com/skywinder/github-changelog-generator/pull/548) ([ianroberts131](https://github.com/ianroberts131))
+- Update the token failure example to OctoKit 404 failure [\#525](https://github.com/skywinder/github-changelog-generator/pull/525) ([00xcoffee](https://github.com/00xcoffee))
+- Rescue invalid commands and present the valid options list [\#498](https://github.com/skywinder/github-changelog-generator/pull/498) ([Lucashuang0802](https://github.com/Lucashuang0802))
+- bundled cacert.pem with --ssl-ca-file PATH option [\#480](https://github.com/skywinder/github-changelog-generator/pull/480) ([olleolleolle](https://github.com/olleolleolle))
+- Option parsing: Remove tag1, tag2 cruft [\#479](https://github.com/skywinder/github-changelog-generator/pull/479) ([olleolleolle](https://github.com/olleolleolle))
+
+**Fixed bugs:**
+
+- Credit line bug [\#541](https://github.com/skywinder/github-changelog-generator/issues/541)
+- Bug: Credit line about this project added more than once [\#507](https://github.com/skywinder/github-changelog-generator/issues/507)
+- v1.14.0 Fails with missing /tmp/ path on Windows [\#458](https://github.com/skywinder/github-changelog-generator/issues/458)
+- failure when creating changelog from a repo in an orginazation: can't convert Github::ResponseWrapper to Array [\#253](https://github.com/skywinder/github-changelog-generator/issues/253)
+- warn\_if\_nonmatching\_regex should display proper help message when used with exclude-tags-regex [\#551](https://github.com/skywinder/github-changelog-generator/pull/551) ([lacostej](https://github.com/lacostej))
+- Bugfix: require ActiveSupport core\_ext/blank [\#520](https://github.com/skywinder/github-changelog-generator/pull/520) ([olleolleolle](https://github.com/olleolleolle))
+- Create temporary cache files in Dir.tmpdir [\#459](https://github.com/skywinder/github-changelog-generator/pull/459) ([olleolleolle](https://github.com/olleolleolle))
+
+**Closed issues:**
+
+- error \(Windows: Command exited with code 1\) [\#536](https://github.com/skywinder/github-changelog-generator/issues/536)
+- Error in generating changelog on Windows [\#521](https://github.com/skywinder/github-changelog-generator/issues/521)
+- Crash on start [\#512](https://github.com/skywinder/github-changelog-generator/issues/512)
+- Error On Running Generation Command [\#511](https://github.com/skywinder/github-changelog-generator/issues/511)
+- Not working [\#510](https://github.com/skywinder/github-changelog-generator/issues/510)
+- PR cited in the wrong TAG [\#503](https://github.com/skywinder/github-changelog-generator/issues/503)
+- 404 Not Found Error [\#484](https://github.com/skywinder/github-changelog-generator/issues/484)
+
+**Merged pull requests:**
+
+- Travis: Configure cache: bundler: true [\#563](https://github.com/skywinder/github-changelog-generator/pull/563) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: use JRuby 9.1.13.0; don't redo rvm's job [\#562](https://github.com/skywinder/github-changelog-generator/pull/562) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: update CI matrix [\#561](https://github.com/skywinder/github-changelog-generator/pull/561) ([olleolleolle](https://github.com/olleolleolle))
+- Fix section mapping, hiding untagged PRs, and hiding untagged issues [\#550](https://github.com/skywinder/github-changelog-generator/pull/550) ([hunner](https://github.com/hunner))
+- Update generator\_generation.rb [\#542](https://github.com/skywinder/github-changelog-generator/pull/542) ([Lucashuang0802](https://github.com/Lucashuang0802))
+- AppVeyor: drop init build hook, add .gitattributes instead [\#539](https://github.com/skywinder/github-changelog-generator/pull/539) ([olleolleolle](https://github.com/olleolleolle))
+- AppVeyor: Windows configuration to pass RuboCop [\#538](https://github.com/skywinder/github-changelog-generator/pull/538) ([olleolleolle](https://github.com/olleolleolle))
+- Fix the syntax ambiguity on credit-line-bug [\#537](https://github.com/skywinder/github-changelog-generator/pull/537) ([Lucashuang0802](https://github.com/Lucashuang0802))
+- Credit line bug [\#535](https://github.com/skywinder/github-changelog-generator/pull/535) ([Lucashuang0802](https://github.com/Lucashuang0802))
+- Update README.md [\#534](https://github.com/skywinder/github-changelog-generator/pull/534) ([Lucashuang0802](https://github.com/Lucashuang0802))
+- Delete circle.yml [\#532](https://github.com/skywinder/github-changelog-generator/pull/532) ([Lucashuang0802](https://github.com/Lucashuang0802))
+- Update README.md [\#531](https://github.com/skywinder/github-changelog-generator/pull/531) ([Lucashuang0802](https://github.com/Lucashuang0802))
+- Remove all old credit lines in the output then add a new one [\#526](https://github.com/skywinder/github-changelog-generator/pull/526) ([Enether](https://github.com/Enether))
+- Travis: jruby-9.1.10.0 [\#523](https://github.com/skywinder/github-changelog-generator/pull/523) ([olleolleolle](https://github.com/olleolleolle))
+- Travis CI: Drop 2.1 [\#517](https://github.com/skywinder/github-changelog-generator/pull/517) ([olleolleolle](https://github.com/olleolleolle))
+- Chore: Rubocop 0.49.0 [\#516](https://github.com/skywinder/github-changelog-generator/pull/516) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: use jruby-9.1.9.0 [\#506](https://github.com/skywinder/github-changelog-generator/pull/506) ([olleolleolle](https://github.com/olleolleolle))
+- Use closed\_at and merged\_at when filtering issues/prs [\#504](https://github.com/skywinder/github-changelog-generator/pull/504) ([unicolet](https://github.com/unicolet))
+- Remove --between-tags option [\#501](https://github.com/skywinder/github-changelog-generator/pull/501) ([Lucashuang0802](https://github.com/Lucashuang0802))
+- Fixed headline in README.md [\#496](https://github.com/skywinder/github-changelog-generator/pull/496) ([Dreckiger-Dan](https://github.com/Dreckiger-Dan))
+- Update README.md [\#490](https://github.com/skywinder/github-changelog-generator/pull/490) ([fatData](https://github.com/fatData))
+- Travis: use latest rubies [\#488](https://github.com/skywinder/github-changelog-generator/pull/488) ([olleolleolle](https://github.com/olleolleolle))
+- Use ruby-2.4.1 in CI [\#487](https://github.com/skywinder/github-changelog-generator/pull/487) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: jruby-9.1.8.0 [\#485](https://github.com/skywinder/github-changelog-generator/pull/485) ([olleolleolle](https://github.com/olleolleolle))
+- Update to latest CodeClimate [\#478](https://github.com/skywinder/github-changelog-generator/pull/478) ([olleolleolle](https://github.com/olleolleolle))
+- Gemspec: update retriable to 3.0 [\#477](https://github.com/skywinder/github-changelog-generator/pull/477) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: new JRuby, develop on 2.4.0 [\#476](https://github.com/skywinder/github-changelog-generator/pull/476) ([olleolleolle](https://github.com/olleolleolle))
+- Fix readme typos [\#467](https://github.com/skywinder/github-changelog-generator/pull/467) ([dguo](https://github.com/dguo))
+- Gemspec: demand rainbow 2.2.1+ [\#466](https://github.com/skywinder/github-changelog-generator/pull/466) ([olleolleolle](https://github.com/olleolleolle))
+
+## [v1.14.3](https://github.com/skywinder/github-changelog-generator/tree/v1.14.3) (2016-12-31)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.2...v1.14.3)
+
+**Fixed bugs:**
+
+- Use Octokit::Client for both .com and Enterprise [\#455](https://github.com/skywinder/github-changelog-generator/pull/455) ([eliperkins](https://github.com/eliperkins))
+
+**Closed issues:**
+
+- Last tag contains too many PRs [\#291](https://github.com/skywinder/github-changelog-generator/issues/291)
+
+**Merged pull requests:**
+
+- CodeClimate configuration file [\#465](https://github.com/skywinder/github-changelog-generator/pull/465) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: Build against 2.4.0 [\#464](https://github.com/skywinder/github-changelog-generator/pull/464) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: add jruby-head, 2.4.0-rc1 [\#463](https://github.com/skywinder/github-changelog-generator/pull/463) ([olleolleolle](https://github.com/olleolleolle))
+- Gemfiles for building versions separately dropped [\#461](https://github.com/skywinder/github-changelog-generator/pull/461) ([olleolleolle](https://github.com/olleolleolle))
+- Order Gemfile gems A-Z; add ruby version marker [\#460](https://github.com/skywinder/github-changelog-generator/pull/460) ([olleolleolle](https://github.com/olleolleolle))
+- README: Documentation update about RakeTask params and how to translate labels [\#454](https://github.com/skywinder/github-changelog-generator/pull/454) ([edusantana](https://github.com/edusantana))
+- Travis: Use ruby 2.3.3 and 2.2.6 [\#452](https://github.com/skywinder/github-changelog-generator/pull/452) ([olleolleolle](https://github.com/olleolleolle))
+
+## [v1.14.2](https://github.com/skywinder/github-changelog-generator/tree/v1.14.2) (2016-11-12)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.1...v1.14.2)
+
+**Implemented enhancements:**
+
+- OctoFetcher: Moved repositories fail explicitly [\#449](https://github.com/skywinder/github-changelog-generator/pull/449) ([olleolleolle](https://github.com/olleolleolle))
+
+**Closed issues:**
+
+- Error: can't convert Sawyer::Resource to Array when iterating over a 301 Moved Permanently [\#448](https://github.com/skywinder/github-changelog-generator/issues/448)
+
+## [v1.14.1](https://github.com/skywinder/github-changelog-generator/tree/v1.14.1) (2016-11-06)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.0...v1.14.1)
+
+**Closed issues:**
+
+- multi\_json is required but is listed as a test dependency [\#444](https://github.com/skywinder/github-changelog-generator/issues/444)
+
+**Merged pull requests:**
+
+- Add multi\_json as a runtime dependency [\#445](https://github.com/skywinder/github-changelog-generator/pull/445) ([rnelson0](https://github.com/rnelson0))
+
+## [v1.14.0](https://github.com/skywinder/github-changelog-generator/tree/v1.14.0) (2016-11-05)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.13.2...v1.14.0)
+
+**Implemented enhancements:**
+
+- On OctoKit::Forbidden error: retry with exponential backoff [\#434](https://github.com/skywinder/github-changelog-generator/pull/434) ([awaage](https://github.com/awaage))
+- Use octokit, carrying awaage commits [\#422](https://github.com/skywinder/github-changelog-generator/pull/422) ([olleolleolle](https://github.com/olleolleolle))
+- Add option to show selected labels in the issue line [\#418](https://github.com/skywinder/github-changelog-generator/pull/418) ([aih](https://github.com/aih))
+
+**Fixed bugs:**
+
+- unreleased and unreleased-label [\#374](https://github.com/skywinder/github-changelog-generator/issues/374)
+- Problems installing 1.11.7 on Windows when git absent [\#349](https://github.com/skywinder/github-changelog-generator/issues/349)
+
+**Closed issues:**
+
+- broken issue-line-labels in log [\#442](https://github.com/skywinder/github-changelog-generator/issues/442)
+- Broken multi hyphen options in param file [\#440](https://github.com/skywinder/github-changelog-generator/issues/440)
+- Install error on Mac: "rack requires Ruby version \>= 2.2.2" [\#425](https://github.com/skywinder/github-changelog-generator/issues/425)
+- Changelog includes issues going back months too far [\#394](https://github.com/skywinder/github-changelog-generator/issues/394)
+
+**Merged pull requests:**
+
+- Fixed issue \#442 - broken issue-line-labels in log. [\#443](https://github.com/skywinder/github-changelog-generator/pull/443) ([thorsteneckel](https://github.com/thorsteneckel))
+- Fixed issue \#440 - broken multi hyphen options in param file. [\#441](https://github.com/skywinder/github-changelog-generator/pull/441) ([thorsteneckel](https://github.com/thorsteneckel))
+- Option --unreleased-label explained [\#439](https://github.com/skywinder/github-changelog-generator/pull/439) ([olleolleolle](https://github.com/olleolleolle))
+- Fixed issue \#304 - entries of previous tags are included. [\#438](https://github.com/skywinder/github-changelog-generator/pull/438) ([thorsteneckel](https://github.com/thorsteneckel))
+- man page: Add undescribed options [\#437](https://github.com/skywinder/github-changelog-generator/pull/437) ([olleolleolle](https://github.com/olleolleolle))
+- On GitHub MAX\_THREAD\_NUMBER is 25 [\#433](https://github.com/skywinder/github-changelog-generator/pull/433) ([olleolleolle](https://github.com/olleolleolle))
+- OctoFetcher, Options: Refactoring [\#432](https://github.com/skywinder/github-changelog-generator/pull/432) ([olleolleolle](https://github.com/olleolleolle))
+- Fix typo in Readme [\#431](https://github.com/skywinder/github-changelog-generator/pull/431) ([rmtheis](https://github.com/rmtheis))
+- Fix: Turn Sawyer method into String-keyed hash access [\#429](https://github.com/skywinder/github-changelog-generator/pull/429) ([olleolleolle](https://github.com/olleolleolle))
+- Spec: Test a url helper function [\#428](https://github.com/skywinder/github-changelog-generator/pull/428) ([olleolleolle](https://github.com/olleolleolle))
+- Rubocop TODO file regenerated [\#427](https://github.com/skywinder/github-changelog-generator/pull/427) ([olleolleolle](https://github.com/olleolleolle))
+- Drop a stray Markdown file [\#426](https://github.com/skywinder/github-changelog-generator/pull/426) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: Add JRuby 9.1.5.0 to matrix [\#424](https://github.com/skywinder/github-changelog-generator/pull/424) ([olleolleolle](https://github.com/olleolleolle))
+
+## [v1.13.2](https://github.com/skywinder/github-changelog-generator/tree/v1.13.2) (2016-09-29)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.13.2...v1.13.2)
+
+## [1.13.2](https://github.com/skywinder/github-changelog-generator/tree/1.13.2) (2016-09-29)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.13.1...1.13.2)
+
+**Implemented enhancements:**
+
+- Replace GPL'd colorize gem with MIT-licensed rainbow [\#408](https://github.com/skywinder/github-changelog-generator/pull/408) ([jamesc](https://github.com/jamesc))
+- Limit number of simultaneous requests to 25 [\#407](https://github.com/skywinder/github-changelog-generator/pull/407) ([jkeiser](https://github.com/jkeiser))
+- Report actual github error when rate limit exceeded [\#405](https://github.com/skywinder/github-changelog-generator/pull/405) ([jkeiser](https://github.com/jkeiser))
+- Make error messages print on error [\#404](https://github.com/skywinder/github-changelog-generator/pull/404) ([jkeiser](https://github.com/jkeiser))
+
+**Fixed bugs:**
+
+- Fetching events for issues and PRs triggers abuse rate limits [\#406](https://github.com/skywinder/github-changelog-generator/issues/406)
+
+**Merged pull requests:**
+
+- Add bump gem to development deps [\#423](https://github.com/skywinder/github-changelog-generator/pull/423) ([olleolleolle](https://github.com/olleolleolle))
+- Skip logger helper in coverage [\#421](https://github.com/skywinder/github-changelog-generator/pull/421) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: Test on 2.4.0-preview2 [\#420](https://github.com/skywinder/github-changelog-generator/pull/420) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: Collecting the config, gemspec: extract development deps to Gemfile [\#417](https://github.com/skywinder/github-changelog-generator/pull/417) ([olleolleolle](https://github.com/olleolleolle))
+- Update README.md [\#415](https://github.com/skywinder/github-changelog-generator/pull/415) ([dijonkitchen](https://github.com/dijonkitchen))
+- README: Add Gitter badge [\#413](https://github.com/skywinder/github-changelog-generator/pull/413) ([olleolleolle](https://github.com/olleolleolle))
+- CircleCI hook for Gitter notification [\#411](https://github.com/skywinder/github-changelog-generator/pull/411) ([olleolleolle](https://github.com/olleolleolle))
+- Spec: avoid Ruby warning about already-defined constant [\#409](https://github.com/skywinder/github-changelog-generator/pull/409) ([olleolleolle](https://github.com/olleolleolle))
+
 ## [1.13.1](https://github.com/skywinder/github-changelog-generator/tree/1.13.1) (2016-07-22)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.13.0...1.13.1)
 
@@ -186,6 +404,7 @@
 
 **Implemented enhancements:**
 
+- We should add a git-generate-changelog command. [\#255](https://github.com/skywinder/github-changelog-generator/issues/255)
 - 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))
 

CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# How to contribute
+
+Bug reports and pull requests from users is what keeps this project working.
+
+## Basics
+
+1. Create an issue and describe 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`)
+6. Create a new Pull Request
+
+## Checking your work
+
+You can test your workflow with changelog generator with
+[the skywinder/changelog_test repo].
+
+You can run the test suite.
+
+You can run [RuboCop] to check code style.
+
+The default Rake task, runnable using `rake`, calls `rubocop`, then `spec`.
+
+[the skywinder/changelog_test repo]: https://github.com/skywinder/changelog_test/
+[RuboCop]: http://rubocop.readthedocs.io/en/latest/
+
+## Write documentation
+
+This project has documentation in a few places:
+
+### Introduction and usage
+
+A friendly `README.md` written for many audiences.
+
+### Examples and advanced usage
+
+The [wiki].
+
+###  API documentation 
+
+API documentation is written as [YARD] docblocks in the Ruby code.
+
+This is rendered as Web pages on [Rubydoc.info][github-changelog-generator on Rubydoc.info].
+
+The completeness of the API documentation is measured on [our page on the Inch CI Web site][github-changelog-generator on Inch CI]
+
+### man page
+
+`man/git-generate-changelog.md`
+
+The man page is for the `git generate-changelog` Git sub-command, which is a wrapper for `github_changelog_generator`. That file is a Markdown file.
+
+Use the [ronn] gem to generate `.1` and `.html` artifacts like this: `cd man; ronn git-generate-changelog.md`
+
+[wiki]: https://github.com/skywinder/github-changelog-generator/wiki
+[YARD]: https://yardoc.org/
+[github-changelog-generator on Rubydoc.info]: http://www.rubydoc.info/gems/github_changelog_generator
+[ronn]: https://github.com/rtomayko/ronn
+[github-changelog-generator on Inch CI]: https://inch-ci.org/github/skywinder/github-changelog-generator

Gemfile

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

LICENSE

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2016 Petr Korolev
+Copyright (c) 2016-2017 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:
 

README.md

@@ -1,268 +1,279 @@
-[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
+[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
-[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
+[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
-[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
+[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
-[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
+[![Build status](https://ci.appveyor.com/api/projects/status/xdfnfmdjfo0upm7m?svg=true)](https://ci.appveyor.com/project/olleolleolle/github-changelog-generator)
-[![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
+[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/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)
+[![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.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)
+[![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)
+
-==================
+GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
-
+==================
-  - [Installation](#installation)
+
-  - [Output example](#output-example)
+  - [Installation](#installation)
-  - [Usage](#usage)
+  - [Output example](#output-example)
-    - [Params](#params)
+  - [Usage](#usage)
-    - [GitHub token](#github-token)
+    - [Params](#params)
-  - [Features and advantages of this project](#features-and-advantages-of-this-project)
+    - [GitHub token](#github-token)
-    - [Alternatives](#alternatives)
+  - [Features and advantages of this project](#features-and-advantages-of-this-project)
-    - [Projects using this library](#projects-using-this-library)
+    - [Alternatives](#alternatives)
-  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
+    - [Projects using this library](#projects-using-this-library)
-  - [Contributing](#contributing)
+  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
-  - [License](#license)
+  - [Contributing](#contributing)
-
+  - [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 automated changelog generation** - This gem generates a 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.
-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:
+
-
+Since you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:
->### *What’s the point of a change log?*
+
-To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
+### *What’s the point of a change log?*
-### *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.
+To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
-
+
-> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
+### *Why should I care?*
-
+
-## Installation
+Because software tools are for _people_. "Changelogs make it easier for users and
-
+contributors to see precisely what notable changes have been made between each
-	gem install github_changelog_generator
+release (or version) of the project."
-
+
-See also Troubleshooting.
+:arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
-
+
-## Output example
+## Installation
-
+
-- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
+    gem install github_changelog_generator
-- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
+
-
+See also Troubleshooting.
-		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
+
-
+## Output example
-- In general, it looks like this:
+
-
+- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
-> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
+- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
->
+
-> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
+      github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
->
+
-> **Implemented enhancements:**
+- In general, it looks like this:
->
+
-> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
+> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
->
+>
-> **Fixed bugs:**
+> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
->
+>
-> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
+> **Implemented enhancements:**
->
+>
-> **Merged pull requests:**
+> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
->
+>
-> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
+> **Fixed bugs:**
->
+>
-> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
+> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
-
+>
-
+> **Merged pull requests:**
-## Usage
+>
-**It's really simple!**
+> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
-
+>
-- If your **`git remote`** `origin` refers to your GitHub repo, just go to your project folder and run:
+> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
-
+
-		github_changelog_generator
+
-
+## Usage
--  Or, run this from anywhere:
+
-    - `github_changelog_generator -u github_username -p github_project`
+-  Run this:
-    - `github_changelog_generator  github_username/github_project`
+
-
+      `github_changelog_generator -u github_username -p 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:
+      `github_changelog_generator  github_username/github_project`
-
+
-        github_changelog_generator --github-site="https://github.yoursite.com" \
+- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
-                                   --github-api="https://github.yoursite.com/api/v3/"
+
-
+      github_changelog_generator --github-site="https://github.yoursite.com" \
-This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
+                                 --github-api="https://github.yoursite.com/api/v3/"
-
+
-### Params
+This generates a `CHANGELOG.md`, with pretty Markdown formatting.
-Type `github_changelog_generator --help` for details.
+
-
+### Params
-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)
+
-
+Type `github_changelog_generator --help` for details.
-### Params File
+
-In your project root, you can put a params file named `.github_changelog_generator` to override default params:
+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)
-
+
-Example:
+### Params File
-```
+
-unreleased=false
+In your project root, you can put a params file named `.github_changelog_generator` to override default params:
-future-release=5.0.0
+
-since-tag=1.0.0
+Example:
-```
+
-
+```
-### GitHub token
+unreleased=false
-
+future-release=5.0.0
-GitHub only allows only 50 unauthenticated requests per hour. 
+since-tag=1.0.0
-Therefore, it's recommended to run this script with authentication by using a **token**.
+```
-
+
-Here's how:
+### GitHub token
-
+
-- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
+GitHub only allows 50 unauthenticated requests per hour.
-- Either:
+
-    - Run the script with `--token <your-40-digit-token>`; **OR**
+Therefore, it's recommended to run this script with authentication by using a **token**.
-    - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
+
-
+Here's how:
-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`):
+
-
+- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
-        export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
+- Either:
-
+    - Run the script with `--token <your-40-digit-token>`; **OR**
-So, if you got an error like this:
+    - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
->! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
+
-
+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`):
-It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
+
-
+    export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
-## Migrating from a manual changelog
+
-
+So, if you get a message like this:
-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.
+``` markdown
-
+API rate limit exceeded for github_username.
-That's where `--base <your-manual-changelog.md>` comes in handy!
+See: https://developer.github.com/v3/#rate-limiting
-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.
+It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
-
+
-### Rake task
+## Migrating from a manual changelog
-
+
-You love `rake`? We do, too! So, we've made it even easier for you: 
+Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
-we've provided a `rake` task library for your changelog generation.
+But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
-
+
-Just put something like this in your `Rakefile`:
+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.
-```ruby
+
-require 'github_changelog_generator/task'
+If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
-
+
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+### Rake task
-  config.since_tag = '0.1.14'
+
-  config.future_release = '0.2.0'
+You love `rake`? We do, too! So, we've made it even easier for you:
-end
+we've provided a `rake` task library for your changelog generation.
-```
+
-
+Configure the task in your `Rakefile`:
-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.
+
-
+```ruby
-## Features and advantages of this project
+require 'github_changelog_generator/task'
-- 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:
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-- **GitHub Enterprise support** via command line options! :factory:
+  config.since_tag = '0.1.14'
-- Flexible format **customization**:
+  config.future_release = '0.2.0'
-    - **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
+end
-    - **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :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:
+
-    - Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
+All command-line options can be passed to the `rake` task as `config`
-- **Distinguish** issues **by labels**. :mag_right:
+parameters. And since you're naming the `rake` task yourself, you can create
-    - Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
+as many as you want.
-    - Bug fixes (issues labeled `bug`) :beetle:
+
-    - Enhancements (issues labeled `enhancement`) :star2:
+You can look for params names from the [parser source code (#setup_parser)](https://github.com/skywinder/github-changelog-generator/blob/master/lib/github_changelog_generator/parser.rb). For example, to translate the bugs label to Portuguese, instead of setting `config.bugs_label`, you have to set `config.bug_prefix`, and so on.
-    - Issues (closed issues with no labels) :non-potable_water:
+
-
+## Features and advantages of this project
-- Manually include or exclude issues by labels :wrench:
+
-- Customize lots more! Tweak the changelog to fit your preferences :tophat:
+- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
-(*See `github_changelog_generator --help`  for details)*
+- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
-
+- **GitHub Enterprise support** via command line options! :factory:
-
+- Flexible format **customization**:
-###Alternatives
+    - **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
-Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
+    - **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :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:
-*If you know other projects, feel free to edit this Wiki page!*
+    - Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
-
+- **Distinguish** issues **by labels**. :mag_right:
-
+    - Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
-### Projects using this library
+    - Bug fixes (issues labeled `bug`) :beetle:
-Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
+    - Enhancements (issues labeled `enhancement`) :star2:
-
+    - Issues (closed issues with no labels) :non-potable_water:
-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.
+
-
+- Manually include or exclude issues by labels :wrench:
-*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).*
+- Customize lots more! Tweak the changelog to fit your preferences :tophat:
-
+(*See `github_changelog_generator --help`  for details)*
-## Am I missing some essential feature?
+
-
+
-- **Nothing is impossible!**
+### Alternatives
-
+
-- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
+Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
-
+
-- *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
+*If you know other projects, feel free to edit this Wiki page!*
-
+
-## FAQ
+
-
+### Projects using this library
-- ***I already use GitHub Releases. Why do I need this?***
+
-
+Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
-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:
+
-
+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.
-*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
+
-
+*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).*
-I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
+
-
+## Am I missing some essential feature?
-An auto-generated changelog really helps, even if you manually fill in the release notes!
+
-
+- **Nothing is impossible!**
-For example:
+
-
+- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
-When I found a closed bug, it's very useful know which release fixed it. 
+
-In this case, you can easily find the issue by \# in `CHANGELOG.md`.
+- *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
-
+
-- it's not quite as easy to find this in handwritten releases notes
+## FAQ
-- a generated file saves you the trouble of remembering everything;
+
-  sometimes people forget to add things to a handwritten file
+- ***I already use GitHub Releases. Why do I need this?***
-
+
-Ultimately, I think GitHub Releases is ideal for end-users. 
+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:
-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.
+*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
-
+
-- ***I received a warning: "GitHub API rate limit exceed"  What does this mean?***
+I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
-
+
-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).
+An auto-generated changelog really helps, even if you manually fill in the release notes!
-
+
-If you're seeing this warning, please do the following:
+For example:
-
+
-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.
+When you find a closed bug, it is very useful to know which release fixed it.
-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`
+So that you can easily find the issue by \# in `CHANGELOG.md`.
-
+
-- ***My Ruby version is very old, can I use this?***
+- it's not quite as easy to find this in handwritten releases notes
-
+- a generated file saves you the trouble of remembering everything;
-When your Ruby is old, and you don't want to upgrade, and your want to
+  sometimes people forget to add things to a handwritten file
-control which libraries you use, you can use Bundler.
+
-
+Ultimately, I think GitHub Releases are ideal for end-users.
-In a Gemfile, perhaps in a non-deployed `:development` group, add this
+Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
-gem:
+Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
-
+
-```ruby
+- ***I received a warning: "GitHub API rate limit exceed"  What does this mean?***
-group :development do
+
-  gem 'github_changelog_generator', require: false
+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).
-end
+
-```
+If you're seeing this warning, please do the following:
-
+
-Then you can keep back dependencies like rack, which currently is only
+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.
-compatible with Ruby >= 2.2.2. So, use an older version for your app by
+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`
-adding a line like this to the Gemfile:
+
-
+- ***My Ruby version is very old, can I use this?***
-```
+
-gem 'rack', '~> 1.6'
+When your Ruby is old, and you don't want to upgrade, and you want to
-```
+control which libraries you use, you can use Bundler.
-
+
-This way, you can keep on using github_changelog_generator, even if you
+In a Gemfile, perhaps in a non-deployed `:development` group, add this
-can't get the latest version of Ruby installed.
+gem:
-
+
-## Contributing
+```ruby
-
+group :development do
-1. Create an issue and describe your idea
+  gem 'github_changelog_generator', require: false
-2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
+end
-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`)
+Then you can keep back dependencies like rack, which currently is only
-6. Create a new Pull Request
+compatible with Ruby >= 2.2.2. So, use an older version for your app by
-7. Profit! :white_check_mark:
+adding a line like this to the Gemfile:
-
+
-*To test your workflow with changelog generator, you can use [test repo](https://github.com/skywinder/changelog_test/)*
+```
-
+gem 'rack', '~> 1.6'
-## License
+```
-
+
-Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+This way, you can keep on using github_changelog_generator, even if you
+can't get the latest version of Ruby installed.
+
+## Contributing
+
+We have collected notes on how to contribute to this project in [CONTRIBUTING.md].
+
+[CONTRIBUTING.md]: CONTRIBUTING.md
+
+## License
+
+Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "bundler"
 require "bundler/gem_tasks"
 require "rubocop/rake_task"
@@ -8,33 +9,11 @@ require "fileutils"
 require "overcommit"
 
 RuboCop::RakeTask.new
-RSpec::Core::RakeTask.new(:rspec)
+RSpec::Core::RakeTask.new
 
-task :copy_man_page_to_manpath do |_t|
+desc "When releasing the gem, re-fetch latest cacert.pem from curl.haxx.se. Developer task."
-  known_manpath_paths = %w(/etc/manpath.config /etc/manpaths)
+task :update_ssl_ca_file do
-  manpath = known_manpath_paths.find do |f|
+  `pushd lib/github_changelog_generator/ssl_certs && curl --remote-name --time-cond cacert.pem https://curl.haxx.se/ca/cacert.pem && popd`
-    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: %i[rubocop spec]
-task default: [:rubocop, :rspec]

appveyor.yml

@@ -17,6 +17,9 @@ environment:
     - ruby_version: "21" # Older version, but matches Travis-CI
     - ruby_version: "21-x64"
 
+init:
+  - git config --global core.autocrlf true
+
 install:
   - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
 
@@ -36,7 +39,7 @@ install:
 build_script:
   # Install ruby dependencies
   - bundle install --retry 3
-  - bundle exec rake checks
+  - bundle exec rake
 
 test_script:
   - gem build github_changelog_generator
@@ -48,3 +51,8 @@ notifications:
       - sky4winder+githubchangeloggenerator@gmail.com
     on_build_success: false
     on_build_status_changed: true
+  - provider: GitHubPullRequest
+    on_build_success: true
+    on_build_failure: true
+    on_build_status_changed: true
+

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_1

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

gemfiles/Gemfile.2_3_1

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

gemfiles/Gemfile.2_4_0

@@ -1,3 +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"
@@ -18,15 +18,17 @@ Gem::Specification.new do |spec|
   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 = Dir["{bin,lib,man,spec}/**/*"] + %w[LICENSE Rakefile README.md]
 
   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 "rainbow", ">= 2.1"
-  spec.add_runtime_dependency("octokit", ["~> 4.0"])
-  spec.add_runtime_dependency("faraday-http-cache")
   spec.add_runtime_dependency("activesupport")
+  spec.add_runtime_dependency("faraday-http-cache")
+  spec.add_runtime_dependency("multi_json")
+  spec.add_runtime_dependency("octokit", ["~> 4.6"])
+  spec.add_runtime_dependency "rainbow", ">= 2.2.1"
+  spec.add_runtime_dependency "rake", ">= 10.0"
+  spec.add_runtime_dependency("retriable", ["~> 3.0"])
 end

lib/CHANGELOG.md

@@ -1,58 +0,0 @@
-# Change Log
-
-## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
-
-[Full Changelog](https://github.com/skywinder/changelog_test/compare/0.0.4...HEAD)
-
-**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:**
-
-- BugFix [\#11](https://github.com/skywinder/changelog_test/issues/11)
-
-**Closed issues:**
-
-- Issue closed from commit from PR [\#14](https://github.com/skywinder/changelog_test/issues/14)
-- Issue, closed by PR [\#12](https://github.com/skywinder/changelog_test/issues/12)
-- Issue [\#10](https://github.com/skywinder/changelog_test/issues/10)
-- Issue with some other label - Should be in closed issues [\#8](https://github.com/skywinder/changelog_test/issues/8)
-
-**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))
-
-## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
-[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...0.0.4)
-
-**Closed issues:**
-
-- Test issue, that should appear in 0.0.4 [\#3](https://github.com/skywinder/changelog_test/issues/3)
-
-**Merged pull requests:**
-
-- Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
-
-## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)
-[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
-
-**Merged pull requests:**
-
-- fix \#3. hotfix. Should appear in v0.0.3 [\#4](https://github.com/skywinder/changelog_test/pull/4) ([skywinder](https://github.com/skywinder))
-
-## [v0.0.2](https://github.com/skywinder/changelog_test/tree/v0.0.2) (2015-03-04)
-[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
-
-**Merged pull requests:**
-
-- Here is a test hotfix should appear in v.0.0.2 [\#2](https://github.com/skywinder/changelog_test/pull/2) ([skywinder](https://github.com/skywinder))
-
-## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)
-
-
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

lib/github_changelog_generator.rb

@@ -5,18 +5,18 @@ require "octokit"
 require "faraday-http-cache"
 require "logger"
 require "active_support"
+require "active_support/core_ext/object/blank"
 require "json"
 require "multi_json"
 require "benchmark"
 
-require_relative "github_changelog_generator/helper"
+require "github_changelog_generator/helper"
-require_relative "github_changelog_generator/parser"
+require "github_changelog_generator/options"
-require_relative "github_changelog_generator/parser_file"
+require "github_changelog_generator/parser"
-require_relative "github_changelog_generator/generator/generator"
+require "github_changelog_generator/parser_file"
-require_relative "github_changelog_generator/version"
+require "github_changelog_generator/generator/generator"
-require_relative "github_changelog_generator/reader"
+require "github_changelog_generator/version"
-require_relative "github_changelog_generator/hash"
+require "github_changelog_generator/reader"
-require_relative "github_changelog_generator/array"
 
 # The main module, where placed all classes (now, at least)
 module GitHubChangelogGenerator
@@ -34,14 +34,10 @@ module GitHubChangelogGenerator
     def run
       log = @generator.compound_changelog
 
-      output_filename = (@options[:output]).to_s
+      output_filename = @options[:output].to_s
-      File.open(output_filename, "w") { |file| file.write(log) }
+      File.open(output_filename, "wb") { |file| file.write(log) }
       puts "Done!"
       puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
     end
   end
-
-  if __FILE__ == $PROGRAM_NAME
-    GitHubChangelogGenerator::ChangelogGenerator.new.run
-  end
 end

lib/github_changelog_generator/array.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-class Array
-  def stringify_keys_deep!
-    new_ar = []
-    each do |value|
-      new_value = value
-      if value.is_a?(Hash) || value.is_a?(Array)
-        new_value = value.stringify_keys_deep!
-      end
-      new_ar << new_value
-    end
-    new_ar
-  end
-end

lib/github_changelog_generator/generator/generator.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
-require_relative "../octo_fetcher"
+
-require_relative "generator_generation"
+require "github_changelog_generator/octo_fetcher"
-require_relative "generator_fetcher"
+require "github_changelog_generator/generator/generator_generation"
-require_relative "generator_processor"
+require "github_changelog_generator/generator/generator_fetcher"
-require_relative "generator_tags"
+require "github_changelog_generator/generator/generator_processor"
+require "github_changelog_generator/generator/generator_tags"
 
 module GitHubChangelogGenerator
   # Default error for ChangelogGenerator
@@ -11,7 +12,7 @@ module GitHubChangelogGenerator
   end
 
   class Generator
-    attr_accessor :options, :filtered_tags, :github, :tag_section_mapping
+    attr_accessor :options, :filtered_tags, :github, :tag_section_mapping, :sorted_tags
 
     # A Generator responsible for all logic, related with change log generation from ready-to-parse issues
     #
@@ -35,16 +36,17 @@ module GitHubChangelogGenerator
       detect_actual_closed_dates(@issues + @pull_requests)
     end
 
-    # Encapsulate characters to make markdown look as expected.
+    ENCAPSULATED_CHARACTERS = %w(< > * _ \( \) [ ] #)
+
+    # Encapsulate characters to make Markdown look as expected.
     #
     # @param [String] string
     # @return [String] encapsulated input string
     def encapsulate_string(string)
-      string.gsub! '\\', '\\\\'
+      string = string.gsub('\\', '\\\\')
 
-      encpas_chars = %w(< > * _ \( \) [ ] #)
+      ENCAPSULATED_CHARACTERS.each do |char|
-      encpas_chars.each do |char|
+        string = string.gsub(char, "\\#{char}")
-        string.gsub! char, "\\#{char}"
       end
 
       string
@@ -55,14 +57,23 @@ module GitHubChangelogGenerator
     # @param [Array] pull_requests List or PR's in new section
     # @param [Array] issues List of issues in new section
     # @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
-    # @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
+    # @param [Hash, nil] older_tag Older tag, used for the links. Could be nil for last tag.
     # @return [String] Ready and parsed section
-    def create_log_for_tag(pull_requests, issues, newer_tag, older_tag_name = nil)
+    def create_log_for_tag(pull_requests, issues, newer_tag, older_tag = nil)
       newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
 
       github_site = options[:github_site] || "https://github.com"
       project_url = "#{github_site}/#{options[:user]}/#{options[:project]}"
 
+      # If the older tag is nil, go back in time from the latest tag and find
+      # the SHA for the first commit.
+      older_tag_name =
+        if older_tag.nil?
+          @fetcher.commits_before(newer_tag_time).last["sha"]
+        else
+          older_tag["name"]
+        end
+
       log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
 
       if options[:issues]
@@ -70,7 +81,7 @@ module GitHubChangelogGenerator
         log += issues_to_log(issues, pull_requests)
       end
 
-      if options[:pulls]
+      if options[:pulls] && options[:add_pr_wo_labels]
         # Generate pull requests:
         log += generate_sub_section(pull_requests, options[:merge_prefix])
       end
@@ -84,12 +95,13 @@ module GitHubChangelogGenerator
     # @param [Array] pull_requests
     # @return [String] generated log for issues
     def issues_to_log(issues, pull_requests)
-      log = ""
+      sections = parse_by_sections(issues, pull_requests)
-      bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
 
-      log += generate_sub_section(enhancement_a, options[:enhancement_prefix])
+      log = ""
-      log += generate_sub_section(bugs_a, options[:bug_prefix])
+      log += generate_sub_section(sections[:breaking], options[:breaking_prefix])
-      log += generate_sub_section(issues_a, options[:issue_prefix])
+      log += generate_sub_section(sections[:enhancements], options[:enhancement_prefix])
+      log += generate_sub_section(sections[:bugs], options[:bug_prefix])
+      log += generate_sub_section(sections[:issues], options[:issue_prefix])
       log
     end
 
@@ -98,47 +110,69 @@ module GitHubChangelogGenerator
     #
     # @param [Array] issues
     # @param [Array] pull_requests
-    # @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
+    # @return [Hash] Mapping of filtered arrays: (Bugs, Enhancements, Breaking stuff, Issues)
     def parse_by_sections(issues, pull_requests)
-      issues_a = []
+      sections = {
-      enhancement_a = []
+        issues: [],
-      bugs_a = []
+        enhancements: [],
+        bugs: [],
+        breaking: []
+      }
 
       issues.each do |dict|
         added = false
+
         dict["labels"].each do |label|
           if options[:bug_labels].include?(label["name"])
-            bugs_a.push(dict)
+            sections[:bugs] << dict
             added = true
-            next
+          elsif options[:enhancement_labels].include?(label["name"])
-          end
+            sections[:enhancements] << dict
-          if options[:enhancement_labels].include?(label["name"])
+            added = true
-            enhancement_a.push(dict)
+          elsif options[:breaking_labels].include?(label["name"])
+            sections[:breaking] << dict
             added = true
-            next
           end
+
+          break if added
         end
-        issues_a.push(dict) unless added
+
+        sections[:issues] << dict unless added
       end
 
+      sort_pull_requests(pull_requests, sections)
+    end
+
+    # This method iterates through PRs and sorts them into sections
+    #
+    # @param [Array] pull_requests
+    # @param [Hash] sections
+    # @return [Hash] sections
+    def sort_pull_requests(pull_requests, sections)
       added_pull_requests = []
       pull_requests.each do |pr|
+        added = false
+
         pr["labels"].each do |label|
           if options[:bug_labels].include?(label["name"])
-            bugs_a.push(pr)
+            sections[:bugs] << pr
-            added_pull_requests.push(pr)
+            added_pull_requests << pr
-            next
+            added = true
-          end
+          elsif options[:enhancement_labels].include?(label["name"])
-          if options[:enhancement_labels].include?(label["name"])
+            sections[:enhancements] << pr
-            enhancement_a.push(pr)
+            added_pull_requests << pr
-            added_pull_requests.push(pr)
+            added = true
-            next
+          elsif options[:breaking_labels].include?(label["name"])
+            sections[:breaking] << pr
+            added_pull_requests << pr
+            added = true
           end
+
+          break if added
         end
       end
       added_pull_requests.each { |p| pull_requests.delete(p) }
-
+      sections
-      [bugs_a, enhancement_a, issues_a]
     end
   end
 end

lib/github_changelog_generator/generator/generator_fetcher.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module GitHubChangelogGenerator
   class Generator
-    MAX_THREAD_NUMBER = 1
+    MAX_THREAD_NUMBER = 25
 
     # Fetch event for issues and pull requests
     # @return [Array] array of fetched issues
@@ -77,7 +78,7 @@ module GitHubChangelogGenerator
           issue["actual_date"] = commit["commit"]["author"]["date"]
 
           # issue['actual_date'] = commit['author']['date']
-        rescue
+        rescue StandardError
           puts "Warning: Can't fetch commit #{event['commit_id']}. It is probably referenced from another repo."
           issue["actual_date"] = issue["closed_at"]
         end

lib/github_changelog_generator/generator/generator_generation.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+
 module GitHubChangelogGenerator
   class Generator
     # Main function to start change log generation
     #
     # @return [String] Generated change log file
     def compound_changelog
+      options.load_custom_ruby_files
       fetch_and_filter_tags
       fetch_issues_and_pr
 
@@ -20,12 +22,15 @@ module GitHubChangelogGenerator
 
       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)*"
+      credit_line = "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
+      log.gsub!(credit_line, "") # Remove old credit lines
+      log += credit_line
+
       @log = log
     end
 
     # @param [Array] issues List of issues on sub-section
-    # @param [String] prefix Nae of sub-section
+    # @param [String] prefix Name of sub-section
     # @return [String] Generate ready-to-go sub-section
     def generate_sub_section(issues, prefix)
       log = ""
@@ -64,7 +69,7 @@ module GitHubChangelogGenerator
       log += if newer_tag_name.equal?(options[:unreleased_label])
                "## [#{newer_tag_name}](#{release_url})\n\n"
              else
-               "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
+               "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n\n"
              end
 
       if options[:compare_link] && older_tag_link
@@ -81,22 +86,21 @@ 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"]
-
       if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
         # do not generate empty unreleased section
         return ""
       end
 
-      create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
+      create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag)
     end
 
-    # Apply all filters to issues and pull requests
+    # Filters issues and pull requests based on, respectively, `closed_at` and `merged_at`
+    #  timestamp fields.
     #
     # @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)
+      filtered_issues        = delete_by_time(@issues, "closed_at", older_tag, newer_tag)
 
       newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
 
@@ -126,8 +130,9 @@ module GitHubChangelogGenerator
     def generate_unreleased_section
       log = ""
       if options[:unreleased]
-        unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
+        start_tag      = filtered_tags[0] || sorted_tags.last
-        log += unreleased_log if unreleased_log
+        unreleased_log = generate_log_between_tags(start_tag, nil)
+        log           += unreleased_log if unreleased_log
       end
       log
     end
@@ -143,13 +148,25 @@ module GitHubChangelogGenerator
       encapsulated_title = encapsulate_string issue["title"]
 
       title_with_number = "#{encapsulated_title} [\\##{issue['number']}](#{issue['html_url']})"
+      if options[:issue_line_labels].present?
+        title_with_number = "#{title_with_number}#{line_labels_for(issue)}"
+      end
       issue_line_with_user(title_with_number, issue)
     end
 
     private
 
+    def line_labels_for(issue)
+      labels = if options[:issue_line_labels] == ["ALL"]
+                 issue["labels"]
+               else
+                 issue["labels"].select { |label| options[:issue_line_labels].include?(label["name"]) }
+               end
+      labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
+    end
+
     def issue_line_with_user(line, issue)
-      return line if !options[:author] || issue.pull_request.nil?
+      return line if !options[:author] || issue["pull_request"].nil?
 
       user = issue["user"]
       return "#{line} ({Null user})" unless user

lib/github_changelog_generator/generator/generator_processor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GitHubChangelogGenerator
   class Generator
     # delete all labels with labels from options[:exclude_labels] array
@@ -72,6 +73,8 @@ module GitHubChangelogGenerator
       # in case if not tags specified - return unchanged array
       return issues if older_tag.nil? && newer_tag.nil?
 
+      older_tag = ensure_older_tag(older_tag, newer_tag)
+
       newer_tag_time = newer_tag && get_time_of_tag(newer_tag)
       older_tag_time = older_tag && get_time_of_tag(older_tag)
 
@@ -92,6 +95,14 @@ module GitHubChangelogGenerator
       end
     end
 
+    def ensure_older_tag(older_tag, newer_tag)
+      return older_tag if older_tag
+      idx = sorted_tags.index { |t| t["name"] == newer_tag["name"] }
+      # skip if we are already at the oldest element
+      return if idx == sorted_tags.size - 1
+      sorted_tags[idx - 1]
+    end
+
     def tag_older_new_tag?(newer_tag_time, time)
       tag_in_range_new = if newer_tag_time.nil?
                            true
@@ -115,19 +126,17 @@ module GitHubChangelogGenerator
     # @return [Array] filtered array of issues
     def include_issues_by_labels(issues)
       filtered_issues = filter_by_include_labels(issues)
-      filtered_issues |= filter_wo_labels(issues)
+      filtered_issues = filter_wo_labels(filtered_issues)
       filtered_issues
     end
 
     # @return [Array] issues without labels or empty array if add_issues_wo_labels is false
     def filter_wo_labels(issues)
       if options[:add_issues_wo_labels]
-        issues_wo_labels = issues.select do |issue|
+        issues
-          !issue["labels"].map { |l| l["name"] }.any?
+      else
-        end
+        issues.select { |issue| issue["labels"].map { |l| l["name"] }.any? }
-        return issues_wo_labels
       end
-      []
     end
 
     def filter_by_include_labels(issues)
@@ -187,8 +196,8 @@ module GitHubChangelogGenerator
         end
       end
 
-      pull_requests.select! do |pr|
+      pull_requests.reject! do |pr|
-        !pr["merged_at"].nil?
+        pr["merged_at"].nil?
       end
 
       pull_requests

lib/github_changelog_generator/generator/generator_tags.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GitHubChangelogGenerator
   class Generator
     # fetch, filter tags, fetch dates and sort them in time order
@@ -6,31 +7,48 @@ module GitHubChangelogGenerator
       detect_since_tag
       detect_due_tag
 
-      all_tags      = @fetcher.get_all_tags
+      all_tags = @fetcher.get_all_tags
-      included_tags = filter_excluded_tags(all_tags)
-
       fetch_tags_dates(all_tags) # Creates a Hash @tag_times_hash
-      sorted_tags          = sort_tags_by_date(included_tags)
+      all_sorted_tags = sort_tags_by_date(all_tags)
-      @filtered_tags       = get_filtered_tags(included_tags)
 
-      @tag_section_mapping = build_tag_section_mapping(@filtered_tags, sorted_tags)
+      @sorted_tags   = filter_excluded_tags(all_sorted_tags)
+      @filtered_tags = get_filtered_tags(@sorted_tags)
+
+      # Because we need to properly create compare links, we need a sorted list
+      # of all filtered tags (including the excluded ones). We'll exclude those
+      # tags from section headers inside the mapping function.
+      section_tags = get_filtered_tags(all_sorted_tags)
+
+      @tag_section_mapping = build_tag_section_mapping(section_tags, @filtered_tags)
 
       @filtered_tags
     end
 
-    # @param [Array] filtered_tags are the tags that need a subsection output
+    # @param [Array] section_tags are the tags that need a subsection output
-    # @param [Array] all_tags is the list of all tags ordered from newest -> oldest
+    # @param [Array] filtered_tags is the list of filtered tags ordered from newest -> oldest
     # @return [Hash] key is the tag to output, value is an array of [Left Tag, Right Tag]
     # PRs to include in this section will be >= [Left Tag Date] and <= [Right Tag Date]
-    def build_tag_section_mapping(filtered_tags, all_tags)
+    # rubocop:disable Style/For - for allows us to be more concise
+    def build_tag_section_mapping(section_tags, filtered_tags)
       tag_mapping = {}
-      filtered_tags.each do |tag|
+      for i in 0..(section_tags.length - 1)
-        older_tag_idx = all_tags.index(tag) + 1
+        tag = section_tags[i]
-        older_tag = all_tags[older_tag_idx]
+
+        # Don't create section header for the "since" tag
+        next if @since_tag && tag["name"] == @since_tag
+
+        # Don't create a section header for the first tag in between_tags
+        next if options[:between_tags] && tag == section_tags.last
+
+        # Don't create a section header for excluded tags
+        next unless filtered_tags.include?(tag)
+
+        older_tag = section_tags[i + 1]
         tag_mapping[tag] = [older_tag, tag]
       end
       tag_mapping
     end
+    # rubocop:enable Style/For
 
     # Sort all tags by date, newest to oldest
     def sort_tags_by_date(tags)
@@ -95,13 +113,12 @@ module GitHubChangelogGenerator
       sections.first["version"] if sections && sections.any?
     end
 
-    # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
+    # Return tags after filtering tags in lists provided by option: --exclude-tags
     #
     # @return [Array]
     def get_filtered_tags(all_tags)
       filtered_tags = filter_since_tag(all_tags)
-      filtered_tags = filter_due_tag(filtered_tags)
+      filter_due_tag(filtered_tags)
-      filter_between_tags(filtered_tags)
     end
 
     # @param [Array] all_tags all tags
@@ -112,8 +129,8 @@ module GitHubChangelogGenerator
       if tag
         if all_tags.map { |t| t["name"] }.include? tag
           idx = all_tags.index { |t| t["name"] == tag }
-          filtered_tags = if idx > 0
+          filtered_tags = if idx
-                            all_tags[0..idx - 1]
+                            all_tags[0..idx]
                           else
                             []
                           end
@@ -144,23 +161,6 @@ module GitHubChangelogGenerator
       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
-      tag_names     = filtered_tags.map { |ft| ft["name"] }
-
-      if options[:between_tags]
-        options[:between_tags].each do |tag|
-          unless tag_names.include?(tag)
-            Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option."
-          end
-        end
-        filtered_tags = all_tags.select { |tag| options[:between_tags].include?(tag["name"]) }
-      end
-      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)
@@ -177,18 +177,19 @@ module GitHubChangelogGenerator
 
     def apply_exclude_tags(all_tags)
       if options[:exclude_tags].is_a?(Regexp)
-        filter_tags_with_regex(all_tags, options[:exclude_tags])
+        filter_tags_with_regex(all_tags, options[:exclude_tags], "--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]))
+      regex = Regexp.new(options[:exclude_tags_regex])
+      filter_tags_with_regex(all_tags, regex, "--exclude-tags-regex")
     end
 
-    def filter_tags_with_regex(all_tags, regex)
+    def filter_tags_with_regex(all_tags, regex, regex_option_name)
-      warn_if_nonmatching_regex(all_tags)
+      warn_if_nonmatching_regex(all_tags, regex, regex_option_name)
       all_tags.reject { |tag| regex =~ tag["name"] }
     end
 
@@ -199,11 +200,10 @@ module GitHubChangelogGenerator
       all_tags.reject { |tag| options[:exclude_tags].include?(tag["name"]) }
     end
 
-    def warn_if_nonmatching_regex(all_tags)
+    def warn_if_nonmatching_regex(all_tags, regex, regex_option_name)
-      unless all_tags.map { |t| t["name"] }.any? { |t| options[:exclude_tags] =~ t }
+      unless all_tags.map { |t| t["name"] }.any? { |t| regex =~ t }
         Helper.log.warn "Warning: unable to reject any tag, using regex "\
-                        "#{options[:exclude_tags].inspect} in --exclude-tags "\
+                        "#{regex.inspect} in #{regex_option_name} option."
-                        "option."
       end
     end
 

lib/github_changelog_generator/hash.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-class Hash
-  def stringify_keys_deep!
-    new_hash = {}
-    keys.each do |k|
-      ks = k.respond_to?(:to_s) ? k.to_s : k
-      new_hash[ks] = if values_at(k).first.is_a?(Hash) || values_at(k).first.is_a?(Array)
-                       values_at(k).first.send(:stringify_keys_deep!)
-                     else
-                       values_at(k).first
-                     end
-    end
-
-    new_hash
-  end
-end

lib/github_changelog_generator/helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "logger"
 require "rainbow"
 

lib/github_changelog_generator/octo_fetcher.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+
+require "tmpdir"
+require "retriable"
 module GitHubChangelogGenerator
   # A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
   # (such as filtering, validating, e.t.c)
@@ -7,7 +10,8 @@ module GitHubChangelogGenerator
   # fetcher = GitHubChangelogGenerator::OctoFetcher.new(options)
   class OctoFetcher
     PER_PAGE_NUMBER   = 100
-    MAX_THREAD_NUMBER = 1
+    MAX_THREAD_NUMBER = 25
+    MAX_FORBIDDEN_RETRIES = 100
     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."
@@ -21,43 +25,54 @@ module GitHubChangelogGenerator
     # @option options [Boolean] :http_cache Use ActiveSupport::Cache::FileStore to cache http requests
     # @option options [Boolean] :cache_file If using http_cache, this is the cache file path
     # @option options [Boolean] :cache_log If using http_cache, this is the cache log file path
-    def initialize(options = {}) # rubocop:disable Metrics/CyclomaticComplexity
+    def initialize(options = {})
       @options      = options || {}
       @user         = @options[:user]
       @project      = @options[:project]
       @since        = @options[:since]
       @http_cache   = @options[:http_cache]
-      @cache_file   = @options.fetch(:cache_file, "/tmp/github-changelog-http-cache") if @http_cache
+      @cache_file   = nil
-      @cache_log    = @options.fetch(:cache_log, "/tmp/github-changelog-logger.log") if @http_cache
+      @cache_log    = nil
-      init_cache if @http_cache
+      prepare_cache
+      configure_octokit_ssl
+      @client = Octokit::Client.new(github_options)
+    end
 
-      @github_token = fetch_github_token
+    def prepare_cache
+      return unless @http_cache
+      @cache_file = @options.fetch(:cache_file) { File.join(Dir.tmpdir, "github-changelog-http-cache") }
+      @cache_log  = @options.fetch(:cache_log) { File.join(Dir.tmpdir, "github-changelog-logger.log") }
+      init_cache
+    end
 
-      @request_options               = { per_page: PER_PAGE_NUMBER }
+    def github_options
-      @github_options                = {}
+      result = {}
-      @github_options[:access_token] = @github_token unless @github_token.nil?
+      github_token = fetch_github_token
-      @github_options[:api_endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
+      result[:access_token] = github_token if github_token
+      endpoint = @options[:github_endpoint]
+      result[:api_endpoint] = endpoint if endpoint
+      result
+    end
 
-      client_type = @options[:github_endpoint].nil? ? Octokit::Client : Octokit::EnterpriseAdminClient
+    def configure_octokit_ssl
-      @client     = client_type.new(@github_options)
+      ca_file = @options[:ssl_ca_file] || ENV["SSL_CA_FILE"] || File.expand_path("../ssl_certs/cacert.pem", __FILE__)
+      Octokit.connection_options = { ssl: { ca_file: ca_file } }
     end
 
     def init_cache
-      middleware_opts = {
+      Octokit.middleware = Faraday::RackBuilder.new do |builder|
-        serializer: Marshal,
+        builder.use(Faraday::HttpCache, serializer: Marshal,
-        store: ActiveSupport::Cache::FileStore.new(@cache_file),
+                                        store: ActiveSupport::Cache::FileStore.new(@cache_file),
-        logger: Logger.new(@cache_log),
+                                        logger: Logger.new(@cache_log),
-        shared_cache: false
+                                        shared_cache: false)
-      }
-      stack = Faraday::RackBuilder.new do |builder|
-        builder.use Faraday::HttpCache, middleware_opts
         builder.use Octokit::Response::RaiseError
         builder.adapter Faraday.default_adapter
         # builder.response :logger
       end
-      Octokit.middleware = stack
     end
 
+    DEFAULT_REQUEST_OPTIONS = { per_page: PER_PAGE_NUMBER }
+
     # Fetch all tags from repo
     #
     # @return [Array <Hash>] array of tags
@@ -73,13 +88,13 @@ module GitHubChangelogGenerator
     def calculate_pages(client, method, request_options)
       # Makes the first API call so that we can call last_response
       check_github_response do
-        client.send(method, user_project, @request_options.merge(request_options))
+        client.send(method, user_project, DEFAULT_REQUEST_OPTIONS.merge(request_options))
       end
 
       last_response = client.last_response
 
       if (last_pg = last_response.rels[:last])
-        parse_url_for_vars(last_pg.href)["page"].to_i
+        querystring_as_hash(last_pg.href)["page"].to_i
       else
         1
       end
@@ -93,7 +108,7 @@ module GitHubChangelogGenerator
       page_i      = 0
       count_pages = calculate_pages(@client, "tags", {})
 
-      iterate_pages(@client, "tags", {}) do |new_tags|
+      iterate_pages(@client, "tags") do |new_tags|
         page_i += PER_PAGE_NUMBER
         print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
         tags.concat(new_tags)
@@ -101,14 +116,19 @@ module GitHubChangelogGenerator
       print_empty_line
 
       if tags.count == 0
-        Helper.log.warn "Warning: Can't find any tags in repo.\
+        Helper.log.warn "Warning: Can't find any tags in repo. \
 Make sure, that you push tags to remote repo via 'git push --tags'"
       else
         Helper.log.info "Found #{tags.count} tags"
       end
       # tags are a Sawyer::Resource. Convert to hash
-      tags = tags.map { |h| h.to_hash.stringify_keys_deep! }
+      tags.map { |resource| stringify_keys_deep(resource.to_hash) }
-      tags
+    end
+
+    def closed_pr_options
+      @closed_pr_options ||= {
+        filter: "all", labels: nil, state: "closed"
+      }.tap { |options| options[:since] = @since if @since }
     end
 
     # This method fetch all closed issues and separate them to pull requests and pure issues
@@ -118,17 +138,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     def fetch_closed_issues_and_pr
       print "Fetching closed issues...\r" if @options[:verbose]
       issues = []
-      options = {
-        state: "closed",
-        filter: "all",
-        labels: nil
-      }
-      options[:since] = @since unless @since.nil?
-
       page_i      = 0
-      count_pages = calculate_pages(@client, "issues", options)
+      count_pages = calculate_pages(@client, "issues", closed_pr_options)
 
-      iterate_pages(@client, "issues", options) do |new_issues|
+      iterate_pages(@client, "issues", closed_pr_options) do |new_issues|
         page_i += PER_PAGE_NUMBER
         print_in_same_line("Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
         issues.concat(new_issues)
@@ -137,12 +150,9 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
       print_empty_line
       Helper.log.info "Received issues: #{issues.count}"
 
-      issues = issues.map { |h| h.to_hash.stringify_keys_deep! }
-
       # separate arrays of issues and pull requests:
-      issues.partition do |x|
+      issues.map { |issue| stringify_keys_deep(issue.to_hash) }
-        x["pull_request"].nil?
+            .partition { |issue_or_pr| issue_or_pr["pull_request"].nil? }
-      end
     end
 
     # Fetch all pull requests. We need them to detect :merged_at parameter
@@ -168,8 +178,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
       print_empty_line
 
       Helper.log.info "Pull Request count: #{pull_requests.count}"
-      pull_requests = pull_requests.map { |h| h.to_hash.stringify_keys_deep! }
+      pull_requests.map { |pull_request| stringify_keys_deep(pull_request.to_hash) }
-      pull_requests
     end
 
     # Fetch event for all issues and add them to 'events'
@@ -184,10 +193,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
         issues_slice.each do |issue|
           threads << Thread.new do
             issue["events"] = []
-            iterate_pages(@client, "issue_events", issue["number"], {}) do |new_event|
+            iterate_pages(@client, "issue_events", issue["number"]) do |new_event|
               issue["events"].concat(new_event)
             end
-            issue["events"] = issue["events"].map { |h| h.to_hash.stringify_keys_deep! }
+            issue["events"] = issue["events"].map { |event| stringify_keys_deep(event.to_hash) }
             print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
             i += 1
           end
@@ -209,7 +218,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     # @return [Time] time of specified tag
     def fetch_date_of_tag(tag)
       commit_data = check_github_response { @client.commit(user_project, tag["commit"]["sha"]) }
-      commit_data = commit_data.to_hash.stringify_keys_deep!
+      commit_data = stringify_keys_deep(commit_data.to_hash)
 
       commit_data["commit"]["committer"]["date"]
     end
@@ -220,62 +229,125 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     def fetch_commit(event)
       check_github_response do
         commit = @client.commit(user_project, event["commit_id"])
-        commit = commit.to_hash.stringify_keys_deep!
+        commit = stringify_keys_deep(commit.to_hash)
         commit
       end
     end
 
+    # Fetch all commits before certain point
+    #
+    # @return [String]
+    def commits_before(start_time)
+      commits = []
+      iterate_pages(@client, "commits_before", start_time.to_datetime.to_s) do |new_commits|
+        commits.concat(new_commits)
+      end
+      commits
+    end
+
     private
 
+    def stringify_keys_deep(indata)
+      case indata
+      when Array
+        indata.map do |value|
+          stringify_keys_deep(value)
+        end
+      when Hash
+        indata.each_with_object({}) do |(key, value), output|
+          output[key.to_s] = stringify_keys_deep(value)
+        end
+      else
+        indata
+      end
+    end
+
+    # Exception raised to warn about moved repositories.
+    MovedPermanentlyError = Class.new(RuntimeError)
+
     # Iterates through all pages until there are no more :next pages to follow
     # yields the result per page
     #
     # @param [Octokit::Client] client
     # @param [String] method (eg. 'tags')
-    # @return [Integer] total number of pages
+    #
+    # @yield [Sawyer::Resource] An OctoKit-provided response (which can be empty)
+    #
+    # @return [void]
     def iterate_pages(client, method, *args)
-      if args.size == 1 && args.first.is_a?(Hash)
+      args << DEFAULT_REQUEST_OPTIONS.merge(extract_request_args(args))
-        request_options = args.delete_at(0)
+
-      elsif args.size > 1 && args.last.is_a?(Hash)
+      check_github_response { client.send(method, user_project, *args) }
-        request_options = args.delete_at(args.length - 1)
+      last_response = client.last_response.tap do |response|
+        raise(MovedPermanentlyError, response.data[:url]) if response.status == 301
       end
 
-      args.push(@request_options.merge(request_options))
+      yield(last_response.data)
-
-      pages = 1
-
-      check_github_response do
-        client.send(method, user_project, *args)
-      end
-      last_response = client.last_response
-
-      yield last_response.data
 
       until (next_one = last_response.rels[:next]).nil?
-        pages += 1
-
         last_response = check_github_response { next_one.get }
-        yield last_response.data
+        yield(last_response.data)
       end
+    end
 
-      pages
+    def extract_request_args(args)
+      if args.size == 1 && args.first.is_a?(Hash)
+        args.delete_at(0)
+      elsif args.size > 1 && args.last.is_a?(Hash)
+        args.delete_at(args.length - 1)
+      else
+        {}
+      end
     end
 
     # This is wrapper with rescue block
     #
     # @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block
     def check_github_response
-      begin
+      Retriable.retriable(retry_options) do
-        value = yield
+        yield
-      rescue Octokit::Unauthorized => e
+      end
-        Helper.log.error e.message
+    rescue MovedPermanentlyError => e
-        abort "Error: wrong GitHub token"
+      fail_with_message(e, "The repository has moved, update your configuration")
-      rescue Octokit::Forbidden => e
+    rescue Octokit::Forbidden => e
-        Helper.log.warn e.message
+      fail_with_message(e, "Exceeded retry limit")
+    rescue Octokit::Unauthorized => e
+      fail_with_message(e, "Error: wrong GitHub token")
+    end
+
+    # Presents the exception, and the aborts with the message.
+    def fail_with_message(e, message)
+      Helper.log.error("#{e.class}: #{e.message}")
+      sys_abort(message)
+    end
+
+    # Exponential backoff
+    def retry_options
+      {
+        on: [Octokit::Forbidden],
+        tries: MAX_FORBIDDEN_RETRIES,
+        base_interval: sleep_base_interval,
+        multiplier: 1.0,
+        rand_factor: 0.0,
+        on_retry: retry_callback
+      }
+    end
+
+    def sleep_base_interval
+      1.0
+    end
+
+    def retry_callback
+      proc do |exception, try, elapsed_time, next_interval|
+        Helper.log.warn("RETRY - #{exception.class}: '#{exception.message}'")
+        Helper.log.warn("#{try} tries in #{elapsed_time} seconds and #{next_interval} seconds until the next try")
         Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
         Helper.log.warn @client.rate_limit
       end
-      value
+    end
+
+    def sys_abort(msg)
+      abort(msg)
     end
 
     # Print specified line on the same string
@@ -295,7 +367,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     #
     # @return [String]
     def fetch_github_token
-      env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
+      env_var = @options[:token].presence || ENV["CHANGELOG_GITHUB_TOKEN"]
 
       Helper.log.warn NO_TOKEN_PROVIDED unless env_var
 
@@ -307,16 +379,12 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
       "#{@options[:user]}/#{@options[:project]}"
     end
 
-    # Parses a URI and returns a hash of all GET variables
+    # Returns Hash of all querystring variables in given URI.
     #
     # @param [String] uri eg. https://api.github.com/repositories/43914960/tags?page=37&foo=1
     # @return [Hash] of all GET variables. eg. { 'page' => 37, 'foo' => 1 }
-    def parse_url_for_vars(uri)
+    def querystring_as_hash(uri)
-      URI(uri).query.split("&").each_with_object({}) do |get_var, params|
+      Hash[URI.decode_www_form(URI(uri).query || "")]
-        k, v = get_var.split("=")
-        params[k] = v
-        params
-      end
     end
   end
 end

lib/github_changelog_generator/options.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require "delegate"
+require "github_changelog_generator/helper"
+
+module GitHubChangelogGenerator
+  # This class wraps Options, and knows a list of known options. Others options
+  # will raise exceptions.
+  class Options < SimpleDelegator
+    # Raised on intializing with unknown keys in the values hash,
+    # and when trying to store a value on an unknown key.
+    UnsupportedOptionError = Class.new(ArgumentError)
+
+    # List of valid option names
+    KNOWN_OPTIONS = %i[
+      add_issues_wo_labels
+      add_pr_wo_labels
+      author
+      base
+      between_tags
+      bug_labels
+      bug_prefix
+      cache_file
+      cache_log
+      compare_link
+      date_format
+      due_tag
+      enhancement_labels
+      enhancement_prefix
+      breaking_labels
+      breaking_prefix
+      exclude_labels
+      exclude_tags
+      exclude_tags_regex
+      filter_issues_by_milestone
+      frontmatter
+      future_release
+      github_endpoint
+      github_site
+      header
+      http_cache
+      include_labels
+      issue_prefix
+      issue_line_labels
+      issues
+      max_issues
+      merge_prefix
+      output
+      project
+      pulls
+      release_branch
+      release_url
+      require
+      simple_list
+      since_tag
+      ssl_ca_file
+      token
+      unreleased
+      unreleased_label
+      unreleased_only
+      user
+      usernames_as_github_logins
+      verbose
+    ]
+
+    # @param values [Hash]
+    #
+    # @raise [UnsupportedOptionError] if given values contain unknown options
+    def initialize(values)
+      super(values)
+      unsupported_options.any? && raise(UnsupportedOptionError, unsupported_options.inspect)
+    end
+
+    # Set option key to val.
+    #
+    # @param key [Symbol]
+    # @param val [Object]
+    #
+    # @raise [UnsupportedOptionError] when trying to set an unknown option
+    def []=(key, val)
+      supported_option?(key) || raise(UnsupportedOptionError, key.inspect)
+      values[key] = val
+    end
+
+    # @return [Hash]
+    def to_hash
+      values
+    end
+
+    # Loads the configured Ruby files from the --require option.
+    def load_custom_ruby_files
+      self[:require].each { |f| require f }
+    end
+
+    # Pretty-prints a censored options hash, if :verbose.
+    def print_options
+      return unless self[:verbose]
+      Helper.log.info "Using these options:"
+      pp(censored_values)
+      puts ""
+    end
+
+    private
+
+    def values
+      __getobj__
+    end
+
+    # Returns a censored options hash.
+    #
+    # @return [Hash] The GitHub `:token` key is censored in the output.
+    def censored_values
+      values.clone.tap { |opts| opts[:token] = opts[:token].nil? ? "No token used" : "hidden value" }
+    end
+
+    def unsupported_options
+      values.keys - KNOWN_OPTIONS
+    end
+
+    def supported_option?(key)
+      KNOWN_OPTIONS.include?(key)
+    end
+  end
+end

lib/github_changelog_generator/parser.rb

@@ -1,9 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 require "optparse"
 require "pp"
-require_relative "version"
+require "github_changelog_generator/version"
-require_relative "helper"
+require "github_changelog_generator/helper"
+
 module GitHubChangelogGenerator
   class Parser
     # parse options with optparse
@@ -13,47 +15,39 @@ module GitHubChangelogGenerator
       ParserFile.new(options).parse!
 
       parser = setup_parser(options)
-      parser.parse!
+      begin parser.parse!
+      rescue OptionParser::InvalidOption => e
+        abort [e, parser].join("\n")
+      end
 
-      fetch_user_and_project(options)
+      unless options[:user] && options[:project]
+        warn "Configure which user and project to work on."
+        warn "Options --user and --project, or settings to that effect. See --help for more."
+        abort(parser.banner)
+      end
 
-      abort(parser.banner) unless options[:user] && options[:project]
+      options.print_options
-
-      print_options(options)
 
       options
     end
 
-    # If options set to verbose, print the parsed options.
+    # Setup parsing options
     #
-    # The GitHub `:token` key is censored in the output.
+    # @param options [Options]
-    #
+    # @return [OptionParser]
-    # @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
-        options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
-        pp options_to_display
-        puts ""
-      end
-    end
-
-    # setup parsing options
     def self.setup_parser(options)
-      parser = OptionParser.new do |opts|
+      OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
-        opts.banner = "Usage: github_changelog_generator [options]"
+        opts.banner = "Usage: github_changelog_generator --user USER --project PROJECT [options]"
-        opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
+        opts.on("-u", "--user USER", "Username of the owner of target GitHub repo") do |last|
           options[:user] = last
         end
-        opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last|
+        opts.on("-p", "--project PROJECT", "Name of project on GitHub") do |last|
           options[:project] = last
         end
         opts.on("-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") do |last|
           options[:token] = last
         end
-        opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
+        opts.on("-f", "--date-format FORMAT", "Date format. Default is %Y-%m-%d") do |last|
           options[:date_format] = last
         end
         opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
@@ -68,6 +62,9 @@ module GitHubChangelogGenerator
         opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
           options[:enhancement_prefix] = v
         end
+        opts.on("--breaking-label [LABEL]", "Setup custom label for the breaking changes section. Default is \"**Breaking changes:**\"") do |v|
+          options[:breaking_prefix] = v
+        end
         opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
           options[:issue_prefix] = v
         end
@@ -107,7 +104,7 @@ module GitHubChangelogGenerator
         opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
           options[:unreleased] = v
         end
-        opts.on("--unreleased-label [label]", "Add to log unreleased closed issues. Default is true") do |v|
+        opts.on("--unreleased-label [label]", "Setup custom label for unreleased closed issues section. Default is \"**Unreleased:**\"") do |v|
           options[:unreleased_label] = v
         end
         opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
@@ -116,7 +113,7 @@ module GitHubChangelogGenerator
         opts.on("--include-labels  x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
           options[:include_labels] = list
         end
-        opts.on("--exclude-labels  x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
+        opts.on("--exclude-labels  x,y,z", Array, "Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'") do |list|
           options[:exclude_labels] = list
         end
         opts.on("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
@@ -125,8 +122,11 @@ module GitHubChangelogGenerator
         opts.on("--enhancement-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
           options[:enhancement_labels] = list
         end
-        opts.on("--between-tags  x,y,z", Array, "Change log will be filled only between specified tags") do |list|
+        opts.on("--breaking-labels x,y,z", Array, 'Issues with these labels will be added to a new section, called "Breaking Changes". Default is \'backwards-incompatible\'') do |list|
-          options[:between_tags] = list
+          options[:breaking_labels] = list
+        end
+        opts.on("--issue-line-labels x,y,z", Array, 'The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].') do |list|
+          options[:issue_line_labels] = list
         end
         opts.on("--exclude-tags  x,y,z", Array, "Change log will exclude specified tags") do |list|
           options[:exclude_tags] = list
@@ -164,12 +164,18 @@ module GitHubChangelogGenerator
         opts.on("--[no-]http-cache", "Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.") do |http_cache|
           options[:http_cache] = http_cache
         end
-        opts.on("--cache-file [CACHE-FILE]", "Filename to use for cache. Default is /tmp/github-changelog-http-cache") do |cache_file|
+        opts.on("--cache-file [CACHE-FILE]", "Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.") do |cache_file|
           options[:cache_file] = cache_file
         end
-        opts.on("--cache-log [CACHE-LOG]", "Filename to use for cache log. Default is /tmp/github-changelog-logger.log") do |cache_log|
+        opts.on("--cache-log [CACHE-LOG]", "Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.") do |cache_log|
           options[:cache_log] = cache_log
         end
+        opts.on("--ssl-ca-file [PATH]", "Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.") do |ssl_ca_file|
+          options[:ssl_ca_file] = ssl_ca_file
+        end
+        opts.on("--require x,y,z", Array, "Path to Ruby file(s) to require.") do |paths|
+          options[:require] = paths
+        end
         opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
           options[:verbose] = v
         end
@@ -182,14 +188,11 @@ module GitHubChangelogGenerator
           exit
         end
       end
-      parser
     end
 
-    # @return [Hash] Default options
+    # @return [Options] Default options
     def self.default_options
-      {
+      Options.new(
-        tag1: nil,
-        tag2: nil,
         date_format: "%Y-%m-%d",
         output: "CHANGELOG.md",
         base: "HISTORY.md",
@@ -202,127 +205,24 @@ module GitHubChangelogGenerator
         unreleased: true,
         unreleased_label: "Unreleased",
         compare_link: true,
-        enhancement_labels: %w(enhancement Enhancement),
+        enhancement_labels: ["enhancement", "Enhancement", "Type: Enhancement"],
-        bug_labels: %w(bug Bug),
+        bug_labels: ["bug", "Bug", "Type: Bug"],
-        exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix),
+        exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"],
+        breaking_labels: %w[backwards-incompatible breaking],
+        issue_line_labels: [],
         max_issues: nil,
         simple_list: false,
+        ssl_ca_file: nil,
         verbose: true,
         header: "# Change Log",
         merge_prefix: "**Merged pull requests:**",
         issue_prefix: "**Closed issues:**",
         bug_prefix: "**Fixed bugs:**",
         enhancement_prefix: "**Implemented enhancements:**",
-        git_remote: "origin",
+        breaking_prefix: "**Breaking changes:**",
         http_cache: true,
-        cache_file: "/tmp/github-changelog-http-cache",
+        require: []
-        cache_log: "/tmp/github-changelog-logger.log"
+      )
-      }
-    end
-
-    # If `:user` or `:project` not set in options, try setting them
-    # Valid unnamed parameters:
-    # 1) in 1 param: repo_name/project
-    # 2) in 2 params: repo name 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"
-          project = "changelog_test"
-        else
-          remote = `git config --get remote.#{options[:git_remote]}.url`
-          user, project = user_project_from_remote(remote)
-        end
-      end
-
-      [user, project]
-    end
-
-    # Returns GitHub username and project from CLI arguments
-    #
-    # @param arg0 [String] This parameter takes two forms: Either a full
-    #                      GitHub URL, or a 'username/projectname', or
-    #                      simply a GitHub username
-    # @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
-        # "skywinder/Github-Changelog-Generator" to user and name
-        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
-        end
-        if param
-          return
-        else
-          user = match[1]
-          project = match[2]
-        end
-      end
-      [user, project]
-    end
-
-    # These patterns match these formats:
-    #
-    # ```
-    # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
-    # git@github.com:skywinder/Github-Changelog-Generator.git
-    # ```
-    #
-    # and
-    #
-    # ```
-    # origin	https://github.com/skywinder/ChangelogMerger (fetch)
-    # https://github.com/skywinder/ChangelogMerger
-    # ```
-    GIT_REMOTE_PATTERNS = [
-      /.*(?:[:\/])(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*)(?:\.git).*/,
-      /.*\/(?<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|
-        git_remote_pattern =~ git_remote_output
-
-        if Regexp.last_match
-          user = Regexp.last_match(:user)
-          project = Regexp.last_match(:project)
-          break
-        end
-      end
-
-      [user, project]
     end
   end
 end

lib/github_changelog_generator/parser_file.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "pathname"
 
 module GitHubChangelogGenerator
@@ -47,7 +48,7 @@ module GitHubChangelogGenerator
       return if non_configuration_line?(line)
       option_name, value = extract_pair(line)
       @options[option_key_for(option_name)] = convert_value(value, option_name)
-    rescue
+    rescue StandardError
       raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
     end
 
@@ -62,11 +63,11 @@ module GitHubChangelogGenerator
     # @return [Array<Symbol, String>]
     def extract_pair(line)
       key, value = line.split("=", 2)
-      [key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
+      [key.tr("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
     end
 
-    KNOWN_ARRAY_KEYS = [:exclude_labels, :include_labels, :bug_labels,
+    KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels bug_labels
-                        :enhancement_labels, :between_tags, :exclude_tags]
+                          enhancement_labels breaking_labels issue_line_labels between_tags exclude_tags]
     KNOWN_INTEGER_KEYS = [:max_issues]
 
     def convert_value(value, option_name)
@@ -90,6 +91,7 @@ module GitHubChangelogGenerator
       header_label: :header,
       front_matter: :frontmatter,
       pr_label: :merge_prefix,
+      breaking_label: :breaking_prefix,
       issues_wo_labels: :add_issues_wo_labels,
       pr_wo_labels: :add_pr_wo_labels,
       pull_requests: :pulls,

lib/github_changelog_generator/reader.rb

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

lib/github_changelog_generator/task.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "rake"
 require "rake/tasklib"
 require "github_changelog_generator"
@@ -7,8 +8,9 @@ module GitHubChangelogGenerator
   class RakeTask < ::Rake::TaskLib
     include ::Rake::DSL if defined?(::Rake::DSL)
 
-    OPTIONS = %w( user project token date_format output
+    OPTIONS = %w[ user project token date_format output
                   bug_prefix enhancement_prefix issue_prefix
+                  breaking_labels issue_line_labels
                   header merge_prefix issues
                   add_issues_wo_labels add_pr_wo_labels
                   pulls filter_issues_by_milestone author
@@ -18,7 +20,7 @@ module GitHubChangelogGenerator
                   between_tags exclude_tags exclude_tags_regex since_tag max_issues
                   github_site github_endpoint simple_list
                   future_release release_branch verbose release_url
-                  base )
+                  base ]
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym
@@ -47,13 +49,11 @@ module GitHubChangelogGenerator
         # mimick parse_options
         options = Parser.default_options
 
-        Parser.fetch_user_and_project(options)
-
         OPTIONS.each do |o|
           v = instance_variable_get("@#{o}")
           options[o.to_sym] = v unless v.nil?
         end
-
+        abort "user and project are required." unless options[:user] && options[:project]
         generator = Generator.new options
 
         log = generator.compound_changelog

lib/github_changelog_generator/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GitHubChangelogGenerator
-  VERSION = "1.13.1"
+  VERSION = "1.15.0-rc"
 end

man/git-generate-changelog.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2015" "" ""
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2017" "" ""
 .
 .SH "NAME"
 \fBgit\-generate\-changelog\fR \- Generate changelog from github
@@ -73,6 +73,12 @@ Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR
 Setup custom header label\. Default is "# Change Log"
 .
 .P
+\-\-front\-matter [JSON]
+.
+.P
+Add YAML front matter\. Formatted as JSON because it\'s easier to add on the command line
+.
+.P
 \-\-pr\-label [LABEL]
 .
 .P
@@ -115,6 +121,12 @@ Use milestone to detect when issue was resolved\. Default is true
 Add author of pull\-request in the end\. Default is true
 .
 .P
+\-\-usernames\-as\-github\-logins
+.
+.P
+Use GitHub tags instead of Markdown links for the author of an issue or pull\-request\.
+.
+.P
 \-\-unreleased\-only
 .
 .P
@@ -130,7 +142,7 @@ Add to log unreleased closed issues\. Default is true
 \-\-unreleased\-label [label]
 .
 .P
-Add to log unreleased closed issues\. Default is true
+Setup custom label for unreleased closed issues section\. Default is "\fBUnreleased:\fR"
 .
 .P
 \-\-[no\-]compare\-link
@@ -163,18 +175,18 @@ Issues with the specified labels will be always added to "Fixed bugs" section\.
 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
+\-\-exclude\-tags\-regex [REGEX]
+.
+.P
+Apply a regular expression on tag names so that they can be excluded, for example: \-\-exclude\-tags\-regex "\.*+\ed{1,}"
+.
+.P
 \-\-since\-tag x
 .
 .P
@@ -223,6 +235,49 @@ Create simple list from issues and pull requests\. Default is false\.
 Put the unreleased changes in the specified release number\.
 .
 .P
+\-\-release\-branch [RELEASE\-BRANCH]
+.
+.P
+Limit pull requests to the release branch, such as master or release
+.
+.P
+\-\-http\-cache
+.
+.P
+Use HTTP Cache to cache Github API requests (useful for large repos) Default is true\.
+.
+.P
+\-\-[no\-]cache\-file [CACHE\-FILE]
+.
+.P
+Filename to use for cache\. Default is github\-changelog\-http\-cache in a temporary directory\.
+.
+.P
+\-\-cache\-log [CACHE\-LOG]
+.
+.P
+Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
+.
+.IP "" 4
+.
+.nf
+
+\-\-ssl\-ca\-file [PATH]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Path to cacert\.pem file\. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert\.pem\. Respects SSL_CA_PATH\.
+.
+.P
+\-\-require file1\.rb,file2\.rb
+.
+.P
+Paths to Ruby file(s) to require before generating changelog\.
+.
+.P
 \-\-[no\-]verbose
 .
 .P

man/git-generate-changelog.1.html

@@ -0,0 +1,295 @@
+<!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>   --front-matter [JSON]</p>
+
+<p>   Add YAML front matter. Formatted as JSON because it's easier to add on the command line</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>   --usernames-as-github-logins</p>
+
+<p>   Use GitHub tags instead of Markdown links for the author of an issue or pull-request.</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>   Setup custom label for unreleased closed issues section. Default is "<strong>Unreleased:</strong>"</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>   --exclude-tags x,y,z</p>
+
+<p>   Change log will exclude specified tags</p>
+
+<p>   --exclude-tags-regex [REGEX]</p>
+
+<p>   Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*+\d{1,}"</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>   --release-branch [RELEASE-BRANCH]</p>
+
+<p>   Limit pull requests to the release branch, such as master or release</p>
+
+<p>   --http-cache</p>
+
+<p>   Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.</p>
+
+<p>   --[no-]cache-file [CACHE-FILE]</p>
+
+<p>   Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.</p>
+
+<p>   --cache-log [CACHE-LOG]</p>
+
+<p>   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
+
+<pre><code>--ssl-ca-file [PATH]
+</code></pre>
+
+<p>   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>
+
+<p>   --require file1.rb,file2.rb</p>
+
+<p>   Paths to Ruby file(s) to require before generating changelog.</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 2017</li>
+    <li class='tr'>git-generate-changelog(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

man/git-generate-changelog.html

@@ -184,10 +184,6 @@
 
 <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>

man/git-generate-changelog.md

@@ -51,6 +51,10 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    Setup custom header label. Default is "# Change Log"
 
+   --front-matter [JSON]
+
+   Add YAML front matter. Formatted as JSON because it's easier to add on the command line
+
    --pr-label [LABEL]
 
    Setup custom label for pull requests section. Default is "**Merged pull requests:**"
@@ -79,6 +83,10 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    Add author of pull-request in the end. Default is true
 
+   --usernames-as-github-logins
+
+   Use GitHub tags instead of Markdown links for the author of an issue or pull-request.
+
    --unreleased-only
 
    Generate log from unreleased closed issues only.
@@ -89,7 +97,7 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    --unreleased-label [label]
 
-   Add to log unreleased closed issues. Default is true
+   Setup custom label for unreleased closed issues section. Default is "**Unreleased:**"
 
    --[no-]compare-link
 
@@ -111,14 +119,14 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    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
 
+   --exclude-tags-regex [REGEX]
+
+   Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*\+\d{1,}"
+
    --since-tag x
 
    Change log will start after specified tag
@@ -151,6 +159,30 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    Put the unreleased changes in the specified release number.
 
+   --release-branch [RELEASE-BRANCH]
+
+   Limit pull requests to the release branch, such as master or release
+
+   --http-cache
+
+   Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.
+
+   --[no-]cache-file [CACHE-FILE]
+
+   Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.
+
+   --cache-log [CACHE-LOG]
+
+   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
+
+    --ssl-ca-file [PATH]
+
+   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.
+
+   --require file1.rb,file2.rb
+
+   Paths to Ruby file(s) to require before generating changelog.
+
    --[no-]verbose
 
    Run verbosely. Default is true

spec/spec_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # Author:: Enrico Stahn <mail@enricostahn.com>
 #
@@ -16,7 +17,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "codeclimate-test-reporter"
 require "simplecov"
 require "coveralls"
 require "vcr"
@@ -28,8 +28,7 @@ end
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
                                                                  Coveralls::SimpleCov::Formatter,
-                                                                 SimpleCov::Formatter::HTMLFormatter,
+                                                                 SimpleCov::Formatter::HTMLFormatter
-                                                                 CodeClimate::TestReporter::Formatter
                                                                ])
 SimpleCov.start do
   add_filter "gemfiles/"

spec/unit/generator/generator_generation_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module GitHubChangelogGenerator
+  describe Generator do
+    describe "#get_string_for_issue" do
+      let(:issue) do
+        { "title" => "Bug in code" }
+      end
+
+      it "formats an issue according to options" do
+        expect do
+          described_class.new.get_string_for_issue(issue)
+        end.not_to raise_error
+      end
+    end
+
+    describe "#parse_by_sections" do
+      def label(name)
+        { "name" => name }
+      end
+
+      def issue(title, labels)
+        { "title" => "issue #{title}", "labels" => labels.map { |l| label(l) } }
+      end
+
+      def pr(title, labels)
+        { "title" => "pr #{title}", "labels" => labels.map { |l| label(l) } }
+      end
+
+      def get_titles(issues)
+        issues.map { |issue| issue["title"] }
+      end
+
+      let(:options) do
+        {
+          bug_labels: ["bug"],
+          enhancement_labels: ["enhancement"],
+          breaking_labels: ["breaking"]
+        }
+      end
+
+      let(:issues) do
+        [
+          issue("no labels", []),
+          issue("enhancement", ["enhancement"]),
+          issue("bug", ["bug"]),
+          issue("breaking", ["breaking"]),
+          issue("all the labels", %w[enhancement bug breaking])
+        ]
+      end
+
+      let(:pull_requests) do
+        [
+          pr("no labels", []),
+          pr("enhancement", ["enhancement"]),
+          pr("bug", ["bug"]),
+          pr("breaking", ["breaking"]),
+          pr("all the labels", %w[enhancement bug breaking])
+        ]
+      end
+
+      it "works" do
+        sections = described_class.new(options).parse_by_sections(issues, pull_requests)
+
+        expect(get_titles(sections[:issues])).to eq(["issue no labels"])
+        expect(get_titles(sections[:enhancements])).to eq(["issue enhancement", "issue all the labels", "pr enhancement", "pr all the labels"])
+        expect(get_titles(sections[:bugs])).to eq(["issue bug", "pr bug"])
+        expect(get_titles(sections[:breaking])).to eq(["issue breaking", "pr breaking"])
+        expect(get_titles(pull_requests)).to eq(["pr no labels"])
+      end
+    end
+  end
+end

spec/unit/generator/generator_processor_spec.rb

@@ -1,19 +1,32 @@
 # frozen_string_literal: true
+
 module GitHubChangelogGenerator
   describe Generator do
-    context "#exclude_issues_by_labels" do
+    let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
-      let(:label) { { "name" => "BAD" } }
+    let(:options) { {} }
-      let(:issue) { { "labels" => [label] } }
+    let(:generator) { described_class.new(default_options.merge(options)) }
-      let(:good_label) { { "name" => "GOOD" } }
-      let(:good_issue) { { "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
+    let(:bad_label) { { "name" => "BAD" } }
-        result = generator.exclude_issues_by_labels(issues)
+    let(:bad_issue) { { "labels" => [bad_label] } }
+    let(:good_label) { { "name" => "GOOD" } }
+    let(:good_issue) { { "labels" => [good_label] } }
+    let(:unlabeled_issue) { { "labels" => [] } }
+    let(:issues) { [bad_issue, good_issue, unlabeled_issue] }
 
-        expect(result).to include(good_issue)
+    describe "#exclude_issues_by_labels" do
-        expect(result).not_to include(issue)
+      subject do
+        generator.exclude_issues_by_labels(issues)
+      end
+
+      let(:expected_issues) { issues }
+
+      it { is_expected.to eq(expected_issues) }
+
+      context "when 'exclude_lables' is provided" do
+        let(:options) { { exclude_labels: %w[BAD BOO] } }
+        let(:expected_issues) { [good_issue, unlabeled_issue] }
+
+        it { is_expected.to eq(expected_issues) }
       end
 
       context "with no option given" do
@@ -25,5 +38,43 @@ module GitHubChangelogGenerator
         end
       end
     end
+
+    describe "#get_filtered_issues" do
+      subject do
+        generator.get_filtered_issues(issues)
+      end
+
+      let(:expected_issues) { issues }
+
+      it { is_expected.to eq(expected_issues) }
+
+      context "when 'exclude_labels' is provided" do
+        let(:options) { { exclude_labels: %w[BAD BOO] } }
+        let(:expected_issues) { [good_issue, unlabeled_issue] }
+
+        it { is_expected.to eq(expected_issues) }
+      end
+
+      context "when 'add_issues_wo_labels' is false" do
+        let(:options) { { add_issues_wo_labels: false } }
+        let(:expected_issues) { [bad_issue, good_issue] }
+
+        it { is_expected.to eq(expected_issues) }
+
+        context "with 'exclude_labels'" do
+          let(:options) { { add_issues_wo_labels: false, exclude_labels: %w[GOOD] } }
+          let(:expected_issues) { [bad_issue] }
+
+          it { is_expected.to eq(expected_issues) }
+        end
+      end
+
+      context "when 'include_labels' is specified" do
+        let(:options) { { include_labels: %w[GOOD] } }
+        let(:expected_issues) { [good_issue] }
+
+        it { is_expected.to eq(expected_issues) }
+      end
+    end
   end
 end

spec/unit/generator/generator_tags_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 describe GitHubChangelogGenerator::Generator do
   def tag_with_name(tag)
     {
@@ -12,174 +13,236 @@ describe GitHubChangelogGenerator::Generator do
     end
   end
 
-  describe "#filter_between_tags" do
+  describe "#tag_section_mapping" do
-    context "when between_tags nil" do
+    let(:all_tags) { tags_from_strings(%w[8 7 6 5 4 3 2 1]) }
-      before do
+    let(:sorted_tags) { all_tags }
-        @generator = GitHubChangelogGenerator::Generator.new(between_tags: nil)
-      end
 
-      subject do
+    let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
-        @generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
+    let(:options) { {} }
-      end
+    let(:generator) { described_class.new(default_options.merge(options)) }
-      it { is_expected.to be_a(Array) }
+
-      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
+    before do
-    end
+      allow_any_instance_of(GitHubChangelogGenerator::OctoFetcher).to receive(:get_all_tags).and_return(all_tags)
-    context "when between_tags same as input array" do
+      allow(generator).to receive(:fetch_tags_dates).with(all_tags)
-      before do
+      allow(generator).to receive(:sort_tags_by_date).with(all_tags).and_return(sorted_tags)
-        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3))
+      generator.fetch_and_filter_tags
-      end
-      subject do
-        @generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
-      end
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
     end
 
-    context "when between_tags filled with correct values" do
-      before do
-        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
-      end
-      subject do
-        @generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
-      end
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
-    end
-
-    context "when between_tags filled with invalid values" do
-      before do
-        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 q w))
-      end
-
-      subject do
-        @generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
-      end
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(tags_from_strings(%w(1))) }
-    end
-  end
-
-  describe "#get_filtered_tags" do
     subject do
-      generator.get_filtered_tags(tags_from_strings(%w(1 2 3 4 5)))
+      generator.tag_section_mapping
     end
 
-    context "respects between tags" do
+    shared_examples_for "a section mapping" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3)) }
+      it { is_expected.to be_a(Hash) }
+      it { is_expected.to eq(expected_mapping) }
+    end
 
-      it { is_expected.to be_a Array }
+    shared_examples_for "a full changelog" do
-      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
+      let(:expected_mapping) do
+        {
+          tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
+          tag_with_name("7") => [tag_with_name("6"), tag_with_name("7")],
+          tag_with_name("6") => [tag_with_name("5"), tag_with_name("6")],
+          tag_with_name("5") => [tag_with_name("4"), tag_with_name("5")],
+          tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
+          tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
+          tag_with_name("2") => [tag_with_name("1"), tag_with_name("2")],
+          tag_with_name("1") => [nil, tag_with_name("1")]
+        }
+      end
+
+      it_behaves_like "a section mapping"
+    end
+
+    shared_examples_for "a changelog with some exclusions" do
+      let(:expected_mapping) do
+        {
+          tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
+          tag_with_name("6") => [tag_with_name("5"), tag_with_name("6")],
+          tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
+          tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
+          tag_with_name("1") => [nil, tag_with_name("1")]
+        }
+      end
+
+      it_behaves_like "a section mapping"
+    end
+
+    context "with no constraints" do
+      it_behaves_like "a full changelog"
+    end
+
+    context "with since only" do
+      let(:options) { { since_tag: "6" } }
+      let(:expected_mapping) do
+        {
+          tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
+          tag_with_name("7") => [tag_with_name("6"), tag_with_name("7")]
+        }
+      end
+
+      it_behaves_like "a section mapping"
+    end
+
+    context "with due only" do
+      let(:options) { { due_tag: "4" } }
+      let(:expected_mapping) do
+        {
+          tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
+          tag_with_name("2") => [tag_with_name("1"), tag_with_name("2")],
+          tag_with_name("1") => [nil, tag_with_name("1")]
+        }
+      end
+
+      it_behaves_like "a section mapping"
+    end
+
+    context "with since and due" do
+      let(:options) { { since_tag: "2", due_tag: "5" } }
+      let(:expected_mapping) do
+        {
+          tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
+          tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")]
+        }
+      end
+
+      it_behaves_like "a section mapping"
+    end
+
+    context "with excluded tags" do
+      context "as a list of strings" do
+        let(:options) { { exclude_tags: %w[2 5 7] } }
+
+        it_behaves_like "a changelog with some exclusions"
+      end
+
+      context "as a regex" do
+        let(:options) { { exclude_tags: /[257]/ } }
+
+        it_behaves_like "a changelog with some exclusions"
+      end
+
+      context "as a regex string" do
+        let(:options) { { exclude_tags_regex: "[257]" } }
+
+        it_behaves_like "a changelog with some exclusions"
+      end
     end
   end
 
   describe "#filter_excluded_tags" do
-    subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
+    subject { generator.filter_excluded_tags(tags_from_strings(%w[1 2 3])) }
 
     context "with matching string" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w[3]) }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
+      it { is_expected.to match_array(tags_from_strings(%w[1 2])) }
     end
 
     context "with non-matching string" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w[invalid tags]) }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
+      it { is_expected.to match_array(tags_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_from_strings(%w(1))) }
+      it { is_expected.to match_array(tags_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_from_strings(%w(1 2 3))) }
+      it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
     end
   end
 
   describe "#filter_excluded_tags_regex" do
-    subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
+    subject { generator.filter_excluded_tags(tags_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_from_strings(%w(1))) }
+      it { is_expected.to match_array(tags_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_from_strings(%w(1 2 3))) }
+      it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
     end
   end
 
   describe "#filter_since_tag" do
     context "with filled array" do
-      subject { generator.filter_since_tag(tags_from_strings(%w(1 2 3))) }
+      subject { generator.filter_since_tag(tags_from_strings(%w[1 2 3])) }
 
       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_from_strings(%w(1))) }
+        it { is_expected.to match_array(tags_from_strings(%w[1 2])) }
+
+        context "with since tag set to the most recent tag" do
+          let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "1") }
+          it { is_expected.to match_array(tags_from_strings(%w[1])) }
+        end
       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_from_strings(%w(1 2 3))) }
+        it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
       end
     end
 
     context "with empty array" do
-      subject { generator.filter_since_tag(tags_from_strings(%w())) }
+      subject { generator.filter_since_tag(tags_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_from_strings(%w())) }
+        it { is_expected.to match_array(tags_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_from_strings(%w())) }
+        it { is_expected.to match_array(tags_from_strings(%w[])) }
       end
     end
   end
 
   describe "#filter_due_tag" do
     context "with filled array" do
-      subject { generator.filter_due_tag(tags_from_strings(%w(1 2 3))) }
+      subject { generator.filter_due_tag(tags_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_from_strings(%w(3))) }
+        it { is_expected.to match_array(tags_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_from_strings(%w(1 2 3))) }
+        it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
       end
     end
 
     context "with empty array" do
-      subject { generator.filter_due_tag(tags_from_strings(%w())) }
+      subject { generator.filter_due_tag(tags_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_from_strings(%w())) }
+        it { is_expected.to match_array(tags_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_from_strings(%w())) }
+        it { is_expected.to match_array(tags_from_strings(%w[])) }
       end
     end
   end
@@ -232,13 +295,13 @@ describe GitHubChangelogGenerator::Generator do
       @generator.sort_tags_by_date(tags)
     end
     context "sort unsorted tags" do
-      let(:tags) { tags_from_strings %w(valid_tag1 valid_tag2 valid_tag3) }
+      let(:tags) { tags_from_strings %w[valid_tag1 valid_tag2 valid_tag3] }
 
       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_from_strings %w(valid_tag3 valid_tag2 valid_tag1) }
+      let(:tags) { tags_from_strings %w[valid_tag3 valid_tag2 valid_tag1] }
 
       it { is_expected.to be_a_kind_of(Array) }
       it { is_expected.to match_array(tags) }

spec/unit/octo_fetcher_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 VALID_TOKEN = "0123456789abcdef"
 INVALID_TOKEN = "0000000000000000"
 
@@ -12,6 +13,31 @@ describe GitHubChangelogGenerator::OctoFetcher do
 
   let(:fetcher) { GitHubChangelogGenerator::OctoFetcher.new(options) }
 
+  describe "#check_github_response" do
+    context "when returns successfully" do
+      it "returns block value" do
+        expect(fetcher.send(:check_github_response) { 1 + 1 }).to eq(2)
+      end
+    end
+
+    context "when raises Octokit::Unauthorized" do
+      it "aborts" do
+        expect(fetcher).to receive(:sys_abort).with("Error: wrong GitHub token")
+        fetcher.send(:check_github_response) { raise(Octokit::Unauthorized) }
+      end
+    end
+
+    context "when raises Octokit::Forbidden" do
+      it "sleeps and retries and then aborts" do
+        retry_limit = GitHubChangelogGenerator::OctoFetcher::MAX_FORBIDDEN_RETRIES - 1
+        allow(fetcher).to receive(:sleep_base_interval).exactly(retry_limit).times.and_return(0)
+
+        expect(fetcher).to receive(:sys_abort).with("Exceeded retry limit")
+        fetcher.send(:check_github_response) { raise(Octokit::Forbidden) }
+      end
+    end
+  end
+
   describe "#fetch_github_token" do
     token = GitHubChangelogGenerator::OctoFetcher::CHANGELOG_GITHUB_TOKEN
     context "when token in ENV exist" do
@@ -274,7 +300,7 @@ describe GitHubChangelogGenerator::OctoFetcher do
         pull_requests = fetcher.fetch_closed_pull_requests
 
         pr = pull_requests.first
-        expect(pr.keys).to eq(%w(url id html_url diff_url patch_url issue_url number state locked title user body created_at updated_at closed_at merged_at merge_commit_sha assignee assignees milestone commits_url review_comments_url review_comment_url comments_url statuses_url head base _links))
+        expect(pr.keys).to eq(%w[url id html_url diff_url patch_url issue_url number state locked title user body created_at updated_at closed_at merged_at merge_commit_sha assignee assignees milestone commits_url review_comments_url review_comment_url comments_url statuses_url head base _links])
       end
     end
   end
@@ -426,6 +452,20 @@ describe GitHubChangelogGenerator::OctoFetcher do
     end
   end
 
+  describe "#querystring_as_hash" do
+    it "works on the blank URL" do
+      expect { fetcher.send(:querystring_as_hash, "") }.not_to raise_error
+    end
+
+    it "where there are no querystring params" do
+      expect { fetcher.send(:querystring_as_hash, "http://example.com") }.not_to raise_error
+    end
+
+    it "returns a String-keyed Hash of querystring params" do
+      expect(fetcher.send(:querystring_as_hash, "http://example.com/o.html?str=18&wis=12")).to include("wis" => "12", "str" => "18")
+    end
+  end
+
   describe "#fetch_commit" do
     context "when API call is valid", :vcr do
       it "returns commit" do
@@ -461,7 +501,7 @@ describe GitHubChangelogGenerator::OctoFetcher do
         commit = fetcher.fetch_commit(event)
 
         expectations = [
-          %w(sha decfe840d1a1b86e0c28700de5362d3365a29555),
+          %w[sha decfe840d1a1b86e0c28700de5362d3365a29555],
           ["url",
            "https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
           # OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
@@ -486,4 +526,18 @@ describe GitHubChangelogGenerator::OctoFetcher do
       end
     end
   end
+
+  describe "#commits_before" do
+    context "when API is valid", :vcr do
+      let(:start_time) { Time.parse("Wed Mar 4 18:47:17 2015 +0200") }
+
+      subject do
+        fetcher.commits_before(start_time)
+      end
+
+      it "returns commits" do
+        expect(subject.last["sha"]).to eq("4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d")
+      end
+    end
+  end
 end

spec/unit/options_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+RSpec.describe GitHubChangelogGenerator::Options do
+  describe "#initialize" do
+    context "with known options" do
+      it "instantiates successfully" do
+        expect(described_class.new(user: "olle")[:user]).to eq("olle")
+      end
+    end
+
+    context "with unknown options" do
+      it "raises an error" do
+        expect do
+          described_class.new(
+            project: "rails",
+            strength: "super-strength",
+            wisdom: "deep"
+          )
+        end.to raise_error("[:strength, :wisdom]")
+      end
+    end
+  end
+
+  describe "#[]=(key, value)" do
+    let(:options) { described_class.new(project: "rails") }
+
+    context "with known options" do
+      it "sets the option value" do
+        expect do
+          options[:project] = "trails"
+        end.to change { options[:project] }.to "trails"
+      end
+    end
+
+    context "with unknown options" do
+      it "raises an error" do
+        expect do
+          options[:charisma] = 8
+        end.to raise_error(":charisma")
+      end
+    end
+  end
+end

spec/unit/parse_file_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 describe GitHubChangelogGenerator::ParserFile do
   describe ".github_changelog_generator" do
     let(:options) { {} }
@@ -13,7 +14,7 @@ describe GitHubChangelogGenerator::ParserFile do
       let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) }
 
       it "does not change the options" do
-        expect { parser.parse! }.to_not change { options }
+        expect { parser.parse! }.to_not(change { options })
       end
     end
 
@@ -51,12 +52,11 @@ describe GitHubChangelogGenerator::ParserFile do
 
       context "turns exclude-labels into an Array", bug: "#327" do
         let(:file) do
-          StringIO.new(<<EOF
+          line1 = "exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90\n"
-exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
+          line2 = "header_label=# My changelog\n"
-header_label=# My changelog
+          StringIO.new(line1 + line2)
-EOF
-                      )
         end
+
         it "reads exclude_labels into an Array" do
           expect { parser.parse! }.to change { options[:exclude_labels] }
             .from(default_options[:exclude_labels])

spec/unit/parser_spec.rb

@@ -1,82 +1,4 @@
 # frozen_string_literal: true
+
 describe GitHubChangelogGenerator::Parser do
-  describe ".user_project_from_remote" do
-    context "when remote is type 1" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin  https://github.com/skywinder/ActionSheetPicker-3.0 (fetch)") }
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
-    end
-    context "when remote is type 2" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
-    end
-    context "when remote is type 3" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
-    end
-    context "when remote is type 4" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin git@github.com:skywinder/ActionSheetPicker-3.0.git (fetch)") }
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
-    end
-    context "when remote is invalid" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("some invalid text") }
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array([nil, nil]) }
-    end
-  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 }
-    end
-
-    context "when option is valid" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, 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) }
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array([nil, nil]) }
-    end
-    context "when site is nil" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
-    end
-    context "when site is valid" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, "https://codeclimate.com") }
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
-    end
-    context "when second arg is not nil" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", nil) }
-      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,5 @@
 # frozen_string_literal: true
+
 #
 # Author:: Enrico Stahn <mail@enricostahn.com>
 #
@@ -85,10 +86,6 @@ describe GitHubChangelogGenerator::Reader do
     context "angular.js.md" do
       it { is_expected.to be_an(Array) }
       it { is_expected.not_to be_empty }
-      it do
-        pending("Implement heading_level for parser.")
-        expect(subject.count).to eq(134)
-      end
       # it do
       #   pending('Implement heading_level for parser.')
       #   expect(subject.first).to include('version' => '1.4.0-beta.6 cookie-liberation')