Linting: formatting code to suit RuboCop (#611)

Add option --configure-sections, --add-sections, --include-merged

.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

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

.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

.overcommit.yml

@@ -0,0 +1,36 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/brigade/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    #command: ['bundle', 'exec', 'rubocop'] 
+    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#   quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes
+CommitMsg:
+  CapitalizedSubject:
+      enabled: false

.rubocop.yml

@@ -1,8 +1,89 @@
 inherit_from: .rubocop_todo.yml
 
+AllCops:
+  TargetRubyVersion: 2.2
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - 'vendor/**/*'
+    - 'gemfiles/**/*'
+
 Metrics/LineLength:
   Enabled: false
 
+Performance/RegexpMatch:
+  Enabled: false
+
 #http://viget.com/extend/just-use-double-quoted-ruby-strings
-#Style/StringLiterals:
+Style/StringLiterals:
-#  EnforcedStyle: double_quotes
+  EnforcedStyle: double_quotes
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+    Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+    Enabled: false
+
+Naming/FileName:
+    Exclude:
+      - 'bin/git-generate-changelog'
+
+#TODOS
+# Offense count: 14
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 1
+Naming/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 10
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+# SupportedStyles: skip_modifier_ifs, always
+Style/Next:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/MutableConstant:
+    Enabled: false
+
+# "Use idx.positive? instead of idx > 0."
+Style/NumericPredicate:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+# Re-enable when merged; https://github.com/bbatsov/rubocop/pull/4756
+Lint/InterpolationCheck:
+  Enabled: false
+
+Style/FormatStringToken:
+  Exclude:
+    - lib/github_changelog_generator/parser.rb
+
+Style/MixinUsage:
+  Exclude:
+    - lib/github_changelog_generator/task.rb

.rubocop_todo.yml

@@ -1,81 +1,15 @@
-# This configuration was generated by `rubocop --auto-gen-config`
+# This configuration was generated by
-# on 2015-03-27 03:03:45 +0200 using RuboCop version 0.29.1.
+# `rubocop --auto-gen-config`
+# 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: 20
-Metrics/AbcSize:
-  Max: 114
-
 # Offense count: 1
-Metrics/BlockNesting:
-  Max: 4
-
-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 471
-
-# Offense count: 6
 Metrics/CyclomaticComplexity:
-  Max: 18
+  Max: 7
-
-# Offense count: 27
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 147
-
-# Offense count: 6
-Metrics/PerceivedComplexity:
-  Max: 20
-
-# Offense count: 3
-Style/AccessorMethodName:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/AndOr:
-  Enabled: false
-
-# Offense count: 29
-# Cop supports --auto-correct.
-Style/Blocks:
-  Enabled: false
-
-# Offense count: 7
-# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
-Style/CaseIndentation:
-  Enabled: false
-
-# Offense count: 5
-Style/Documentation:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: AllowedVariables.
-Style/GlobalVars:
-  Enabled: false
-
-# Offense count: 6
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Enabled: false
-
-# Offense count: 17
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Enabled: false
 
 # Offense count: 2
-# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+Metrics/PerceivedComplexity:
-Style/Next:
+  Max: 8
-  Enabled: false
-
-# Offense count: 5
-# Configuration parameters: MaxSlashes.
-Style/RegexpLiteral:
-  Enabled: false

.ruby-version

@@ -0,0 +1 @@
+2.4.0

.travis.yml

@@ -1,17 +1,30 @@
----
-sudo: false
-cache: bundler
 language: ruby
+cache:
+  bundler: true
+before_install:
+  - gem install bundler
+matrix:
+  fast_finish: true
+  include:
+    - rvm: 2.2.7
+      install: true # This skips 'bundle install'
+      script: gem build github_changelog_generator && gem install *.gem
+      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
+      after_success: true # This skips 'codeclimate-test-reporter'
+    - rvm: 2.3.4
+    - rvm: 2.4.1
+    - rvm: jruby-9.1.15.0
+      jdk: oraclejdk8
+      env:
+        - JRUBY_OPTS=--debug
 
-rvm:
+addons:
-  - 2.1.0
+  code_climate:
-
+    repo_token:
-script:
+      secure: iMpV5IAvH+/EVGZrpWnt2BnmNFzSbsRcIumsr4ZyLC8N5nrCSXyjCSy0g48btL3Sj0bSgK9hcrJsmrFd2bkqFleyAcPAzNyUQzBuIRZx47O8yFmbZ+Pj+l3+KOlmcbzJNHfDfxkxuWTmTAcSDfsiyApin721T/ey3SUuwKpZNUc=
-  - bundle exec rake
+after_success:
-
+  - bundle exec codeclimate-test-reporter
-notifications:
-  email:
-    recipients:
-      - sky4winder+githubchangeloggenerator@gmail.com
-    on_success: never # [always|never|change]
-    on_failure: change # [always|never|change]

.yardopts

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

CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# How to contribute
+
+Bug reports and pull requests from users are what keep 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 website][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

Dockerfile

@@ -0,0 +1,16 @@
+FROM ruby:2.4-alpine3.6
+
+LABEL maintainer "ferrari.marco@gmail.com"
+
+ENV GITHUB_CHANGELOG_GENERATOR_VERSION "1.14.3"
+
+RUN gem install github_changelog_generator --version $GITHUB_CHANGELOG_GENERATOR_VERSION
+
+ENV SRC_PATH /usr/local/src/your-app
+RUN mkdir -p $SRC_PATH
+
+VOLUME [ "$SRC_PATH" ]
+WORKDIR $SRC_PATH
+
+CMD ["--help"]
+ENTRYPOINT ["github_changelog_generator"]

Gemfile

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

Gemfile.lock

@@ -1,111 +0,0 @@
-PATH
-  remote: .
-  specs:
-    github_changelog_generator (1.3.11)
-      colorize (~> 0.7)
-      github_api (~> 0.12)
-      thor (~> 0.19)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.7)
-    ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
-    colorize (0.7.5)
-    coveralls (0.7.12)
-      multi_json (~> 1.10)
-      rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.9.1)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    domain_name (0.5.23)
-      unf (>= 0.0.5, < 1.0.0)
-    faraday (0.9.1)
-      multipart-post (>= 1.2, < 3)
-    github_api (0.12.3)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.3)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.3)
-      oauth2
-    hashie (3.4.0)
-    http-cookie (1.0.2)
-      domain_name (~> 0.5)
-    jwt (1.4.1)
-    mime-types (2.4.3)
-    mini_portile (0.6.2)
-    multi_json (1.11.0)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    netrc (0.10.3)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    parser (2.2.0.3)
-      ast (>= 1.1, < 3.0)
-    powerpack (0.1.0)
-    rack (1.6.0)
-    rainbow (2.0.0)
-    rake (10.4.2)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.2)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    rubocop (0.29.1)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.0.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.7.5)
-    simplecov (0.9.2)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.9.0)
-    simplecov-html (0.9.0)
-    term-ansicolor (1.3.0)
-      tins (~> 1.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tins (1.3.5)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.6)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.7)
-  coveralls
-  github_changelog_generator!
-  rake (~> 10.0)
-  rspec
-  rubocop
-  simplecov

LICENSE

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

README.md

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

Rakefile

@@ -1,7 +1,19 @@
-require 'rubocop/rake_task'
+# frozen_string_literal: true
-require 'rspec/core/rake_task'
+
+require "bundler"
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+require "pathname"
+require "fileutils"
+require "overcommit"
 
 RuboCop::RakeTask.new
-RSpec::Core::RakeTask.new(:rspec)
+RSpec::Core::RakeTask.new
 
-task default: [:rubocop, :rspec]
+desc "When releasing the gem, re-fetch latest cacert.pem from curl.haxx.se. Developer task."
+task :update_ssl_ca_file do
+  `pushd lib/github_changelog_generator/ssl_certs && curl --remote-name --time-cond cacert.pem https://curl.haxx.se/ca/cacert.pem && popd`
+end
+
+task default: %i[rubocop spec]

appveyor.yml

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

bin/ghclgen

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby -U
-require 'github_changelog_generator'
-GitHubChangelogGenerator::CLI.start(ARGV)

bin/git-generate-changelog

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

bin/github_changelog_generator

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

bump_gemfile.rb

@@ -1,221 +0,0 @@
-#!/usr/bin/env ruby
-require 'optparse'
-
-SPEC_TYPE = 'gemspec'
-
-:major
-:minor
-:patch
-
-@options = { dry_run: false, bump_number: :patch }
-
-OptionParser.new { |opts|
-  opts.banner = 'Usage: bump.rb [options]'
-
-  opts.on('-d', '--dry-run', 'Dry run') do |v|
-    @options[:dry_run] = v
-  end
-  opts.on('-a', '--major', 'Bump major version') do |_v|
-    @options[:bump_number] = :major
-  end
-  opts.on('-m', '--minor', 'Bump minor version') do |_v|
-    @options[:bump_number] = :minor
-  end
-  opts.on('-p', '--patch', 'Bump patch version') do |_v|
-    @options[:bump_number] = :patch
-  end
-  opts.on('-r', '--revert', 'Revert last bump') do |v|
-    @options[:revert] = v
-  end
-}.parse!
-
-p @options
-
-def check_repo_is_clean_or_dry_run
-  value = `#{'git status --porcelain'}`
-
-  if value.empty?
-    puts 'Repo is clean -> continue'
-  else
-    if @options[:dry_run]
-      puts 'Repo not clean, "Dry run" enabled -> continue'
-    else
-      puts 'Repository not clean -> exit'
-      exit
-    end
-  end
-end
-
-def find_spec_file
-  list_of_specs = execute_line("find . -name '*.#{SPEC_TYPE}'")
-  arr = list_of_specs.split("\n")
-
-  spec_file = ''
-
-  case arr.count
-    when 0
-      puts "No #{SPEC_TYPE} files found. -> Exit."
-      exit
-    when 1
-      spec_file = arr[0]
-    else
-      puts 'Which spec should be used?'
-      arr.each_with_index { |file, index| puts "#{index + 1}. #{file}" }
-      input_index = Integer(gets.chomp)
-      spec_file = arr[input_index - 1]
-  end
-
-  if spec_file.nil?
-    puts "Can't find specified spec file -> exit"
-    exit
-  end
-
-  spec_file.sub('./', '')
-end
-
-def find_current_gem_file
-  list_of_specs = execute_line("find . -name '*.gem'")
-  arr = list_of_specs.split("\n")
-
-  spec_file = ''
-
-  case arr.count
-    when 0
-      puts "No #{SPEC_TYPE} files found. -> Exit."
-      exit
-    when 1
-      spec_file = arr[0]
-    else
-      puts 'Which spec should be used?'
-      arr.each_with_index { |file, index| puts "#{index + 1}. #{file}" }
-      input_index = Integer(gets.chomp)
-      spec_file = arr[input_index - 1]
-  end
-
-  if spec_file.nil?
-    puts "Can't find specified spec file -> exit"
-    exit
-  end
-
-  spec_file.sub('./', '')
-end
-
-def find_version_in_podspec(podspec)
-  readme = File.read(podspec)
-
-  # try to find version in format 1.22.333
-  re = /(\d+)\.(\d+)\.(\d+)/m
-
-  match_result = re.match(readme)
-
-  unless match_result
-    puts 'Not found any versions'
-    exit
-  end
-
-  puts "Found version #{match_result[0]}"
-  [match_result[0], match_result.captures]
-end
-
-def bump_version(versions_array)
-  bumped_result = versions_array.dup
-  bumped_result.map!(&:to_i)
-
-  case @options[:bump_number]
-    when :major
-      bumped_result[0] += 1
-      bumped_result[1] = 0
-      bumped_result[2] = 0
-    when :minor
-      bumped_result[1] += 1
-      bumped_result[2] = 0
-    when :patch
-      bumped_result[2] += 1
-    else
-      fail('unknown bump_number')
-  end
-
-  bumped_version = bumped_result.join('.')
-  puts "Bump version: #{versions_array.join('.')} -> #{bumped_version}"
-  bumped_version
-end
-
-def execute_line(line)
-  output = `#{line}`
-  check_exit_status(output)
-
-  output
-end
-
-def execute_line_if_not_dry_run(line)
-  if @options[:dry_run]
-    puts "Dry run: #{line}"
-    nil
-  else
-    puts line
-    value = `#{line}`
-    puts value
-    check_exit_status(value)
-    value
-  end
-end
-
-def check_exit_status(output)
-  if $CHILD_STATUS.exitstatus != 0
-    puts "Output:\n#{output}\nExit status = #{$CHILD_STATUS.exitstatus} ->Terminate script."
-    exit
-  end
-end
-
-def run_bumping_script
-  check_repo_is_clean_or_dry_run
-  spec_file = find_spec_file
-  result, versions_array = find_version_in_podspec(spec_file)
-  bumped_version = bump_version(versions_array)
-
-  unless @options[:dry_run]
-    puts 'Are you sure? Press Y to continue:'
-    str = gets.chomp
-    if str != 'Y'
-      puts '-> exit'
-      exit
-    end
-  end
-
-  execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" README.md")
-  execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" #{spec_file}")
-  execute_line_if_not_dry_run("git commit --all -m \"Update #{$SPEC_TYPE} to version #{bumped_version}\"")
-  execute_line_if_not_dry_run("git tag #{bumped_version}")
-  execute_line_if_not_dry_run('git push')
-  execute_line_if_not_dry_run('git push --tags')
-  execute_line_if_not_dry_run("gem build #{spec_file}")
-
-  gem = find_current_gem_file
-  execute_line_if_not_dry_run("gem push #{gem}")
-  # execute_line_if_not_dry_run("pod trunk push #{spec_file}")
-end
-
-def revert_last_bump
-  spec_file = find_spec_file
-  result, _ = find_version_in_podspec(spec_file)
-
-  puts "DELETE tag #{result} and HARD reset HEAD~1?\nPress Y to continue:"
-  str = gets.chomp
-  if str != 'Y'
-    puts '-> exit'
-    exit
-  end
-  execute_line_if_not_dry_run("git tag -d #{result}")
-  execute_line_if_not_dry_run('git reset --hard HEAD~1')
-  execute_line_if_not_dry_run("git push --delete origin #{result}")
-end
-
-if __FILE__ == $PROGRAM_NAME
-
-  if @options[:revert]
-    revert_last_bump
-  else
-    run_bumping_script
-  end
-
-end

github_changelog_generator.gemspec

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

lib/CHANGELOG.md

@@ -1,31 +0,0 @@
-# Change Log
-
-## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
-
-[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...HEAD)
-
-**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

@@ -1,627 +1,43 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'github_api'
+require "octokit"
-require 'json'
+require "faraday-http-cache"
-require 'colorize'
+require "logger"
-require 'benchmark'
+require "active_support"
+require "active_support/core_ext/object/blank"
+require "json"
+require "multi_json"
+require "benchmark"
 
-require 'github_changelog_generator/parser'
+require "github_changelog_generator/helper"
-require 'github_changelog_generator/generator'
+require "github_changelog_generator/options"
-require 'github_changelog_generator/version'
+require "github_changelog_generator/parser"
-require 'github_changelog_generator/reader'
+require "github_changelog_generator/parser_file"
-require 'github_changelog_generator/cli'
+require "github_changelog_generator/generator/generator"
+require "github_changelog_generator/version"
+require "github_changelog_generator/reader"
 
+# The main module, where placed all classes (now, at least)
 module GitHubChangelogGenerator
+  # Main class and entry point for this script.
   class ChangelogGenerator
-    attr_accessor :options, :all_tags, :github
+    # Class, responsible for whole changelog generation cycle
-
+    # @return initialised instance of ChangelogGenerator
-    PER_PAGE_NUMBER = 30
-    GH_RATE_LIMIT_EXCEEDED_MSG = 'Warning: GitHub API rate limit (5000 per hour) exceeded, change log may be ' \
-        'missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument.'
-
     def initialize
       @options = Parser.parse_options
-
+      @generator = Generator.new @options
-      fetch_github_token
-
-      github_options = { per_page: PER_PAGE_NUMBER }
-      github_options[:oauth_token] = @github_token unless @github_token.nil?
-      github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
-      github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
-
-      begin
-        @github = Github.new github_options
-      rescue
-        puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-      end
-
-      @generator = Generator.new(@options)
-
-      @all_tags = get_all_tags
-      @issues, @pull_requests = fetch_issues_and_pull_requests
-
-      if @options[:pulls]
-        @pull_requests = get_filtered_pull_requests
-      else
-        @pull_requests = []
-      end
-
-      if @options[:issues]
-        @issues = get_filtered_issues
-      else
-        @issues = []
-      end
-
-      fetch_event_for_issues_and_pr
-      detect_actual_closed_dates
-      @tag_times_hash = {}
     end
 
-    def detect_actual_closed_dates
+    # The entry point of this script to generate changelog
-      if @options[:verbose]
+    # @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
-        print "Fetching closed dates for issues...\r"
+    def run
-      end
+      log = @generator.compound_changelog
 
-      threads = []
+      output_filename = @options[:output].to_s
-
+      File.open(output_filename, "wb") { |file| file.write(log) }
-      @issues.each { |issue|
+      puts "Done!"
-        threads << Thread.new {
+      puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
-          find_closed_date_by_commit(issue)
-        }
-      }
-
-      @pull_requests.each { |pull_request|
-        threads << Thread.new {
-          find_closed_date_by_commit(pull_request)
-        }
-      }
-      threads.each(&:join)
-
-      if @options[:verbose]
-        puts 'Fetching closed dates for issues: Done!'
-      end
     end
-
-    def find_closed_date_by_commit(issue)
-      unless issue['events'].nil?
-        # if it's PR -> then find "merged event", in case of usual issue -> fond closed date
-        compare_string = issue[:merged_at].nil? ? 'closed' : 'merged'
-        # reverse! - to find latest closed event. (event goes in date order)
-        issue['events'].reverse!.each { |event|
-          if event[:event].eql? compare_string
-            if event[:commit_id].nil?
-              issue[:actual_date] = issue[:closed_at]
-            else
-              begin
-                commit = @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
-                issue[:actual_date] = commit[:author][:date]
-              rescue
-                puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo.".yellow
-                issue[:actual_date] = issue[:closed_at]
-              end
-            end
-            break
-          end
-        }
-      end
-      # TODO: assert issues, that remain without 'actual_date' hash for some reason.
-    end
-
-    def print_json(json)
-      puts JSON.pretty_generate(json)
-    end
-
-    def fetch_merged_at_pull_requests
-      if @options[:verbose]
-        print "Fetching merged dates...\r"
-      end
-      pull_requests = []
-      begin
-        response = @github.pull_requests.list @options[:user], @options[:project], state: 'closed'
-        page_i = 0
-        response.each_page do |page|
-          page_i += PER_PAGE_NUMBER
-          count_pages = response.count_pages
-          print "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
-          pull_requests.concat(page)
-        end
-      rescue
-        puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-      end
-
-      print "                                                   \r"
-
-      @pull_requests.each { |pr|
-        fetched_pr = pull_requests.find { |fpr|
-          fpr.number == pr.number
-        }
-        pr[:merged_at] = fetched_pr[:merged_at]
-        pull_requests.delete(fetched_pr)
-      }
-
-      if @options[:verbose]
-        puts 'Fetching merged dates: Done!'
-      end
-    end
-
-    def get_filtered_pull_requests
-      fetch_merged_at_pull_requests
-
-      filtered_pull_requests = @pull_requests.select { |pr| !pr[:merged_at].nil? }
-
-      unless @options[:include_labels].nil?
-        filtered_pull_requests = @pull_requests.select { |issue|
-          # add all labels from @options[:include_labels] array
-          (issue.labels.map(&:name) & @options[:include_labels]).any?
-        }
-      end
-
-      unless @options[:exclude_labels].nil?
-        filtered_pull_requests = filtered_pull_requests.select { |issue|
-          # delete all labels from @options[:exclude_labels] array
-          !(issue.labels.map(&:name) & @options[:exclude_labels]).any?
-        }
-      end
-
-      if @options[:add_issues_wo_labels]
-        issues_wo_labels = @pull_requests.select { |issue|
-          !issue.labels.map(&:name).any?
-        }
-        filtered_pull_requests |= issues_wo_labels
-      end
-
-      if @options[:verbose]
-        puts "Filtered pull requests: #{filtered_pull_requests.count}"
-      end
-
-      filtered_pull_requests
-    end
-
-    def compound_changelog
-      log = "# Change Log\n\n"
-
-      if @options[:unreleased_only]
-        log += generate_log_between_tags(all_tags[0], nil)
-      elsif @options[:tag1] and @options[:tag2]
-        tag1 = @options[:tag1]
-        tag2 = @options[:tag2]
-        tags_strings = []
-        all_tags.each { |x| tags_strings.push(x['name']) }
-
-        if tags_strings.include?(tag1)
-          if tags_strings.include?(tag2)
-            to_a = tags_strings.map.with_index.to_a
-            hash = Hash[to_a]
-            index1 = hash[tag1]
-            index2 = hash[tag2]
-            log += generate_log_between_tags(all_tags[index1], all_tags[index2])
-          else
-            puts "Can't find tag #{tag2} -> exit"
-            exit
-          end
-        else
-          puts "Can't find tag #{tag1} -> exit"
-          exit
-        end
-      else
-        log += generate_log_for_all_tags
-      end
-
-      log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
-
-      output_filename = "#{@options[:output]}"
-      File.open(output_filename, 'w') { |file| file.write(log) }
-      puts 'Done!'
-      puts "Generated log placed in #{`pwd`.strip!}/#{output_filename}"
-    end
-
-    def generate_log_for_all_tags
-      fetch_tags_dates
-
-      if @options[:verbose]
-        puts 'Sorting tags...'
-      end
-
-      @all_tags.sort_by! { |x| get_time_of_tag(x) }.reverse!
-
-      if @options[:verbose]
-        puts 'Generating log...'
-      end
-
-      log = ''
-
-      if @options[:unreleased] && @all_tags.count != 0
-        unreleased_log = generate_log_between_tags(all_tags[0], nil)
-        if unreleased_log
-          log += unreleased_log
-        end
-      end
-
-      (1...all_tags.size).each { |index|
-        log += generate_log_between_tags(all_tags[index], all_tags[index - 1])
-      }
-      if @all_tags.count != 0
-        log += generate_log_between_tags(nil, all_tags.last)
-      end
-
-      log
-    end
-
-    def fetch_tags_dates
-      if @options[:verbose]
-        print "Fetching tag dates...\r"
-      end
-
-      # Async fetching tags:
-      threads = []
-      i = 0
-      all = @all_tags.count
-      @all_tags.each { |tag|
-        # explicit set @tag_times_hash to write data safety.
-        threads << Thread.new {
-          get_time_of_tag(tag, @tag_times_hash)
-          if @options[:verbose]
-            print "Fetching tags dates: #{i + 1}/#{all}\r"
-            i += 1
-          end
-        }
-      }
-
-      print "                                 \r"
-
-      threads.each(&:join)
-
-      if @options[:verbose]
-        puts "Fetching tags dates: #{i} Done!"
-      end
-    end
-
-    def get_all_tags
-      if @options[:verbose]
-        print "Fetching tags...\r"
-      end
-
-      tags = []
-
-      begin
-        response = @github.repos.tags @options[:user], @options[:project]
-        page_i = 0
-        count_pages = response.count_pages
-        response.each_page do |page|
-          page_i += PER_PAGE_NUMBER
-          print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
-          tags.concat(page)
-        end
-        print "                               \r"
-
-        if tags.count == 0
-          puts "Warning: Can't find any tags in repo. Make sure, that you push tags to remote repo via 'git push --tags'".yellow
-        elsif @options[:verbose]
-          puts "Found #{tags.count} tags"
-        end
-
-      rescue
-        puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-      end
-
-      tags
-    end
-
-    def fetch_github_token
-      env_var = @options[:token] ? @options[:token] : (ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil)
-
-      unless env_var
-        puts 'Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.'.yellow
-        puts 'This script can make only 50 requests per hour to GitHub API without a token!'.yellow
-      end
-
-      @github_token ||= env_var
-    end
-
-    def generate_log_between_tags(older_tag, newer_tag)
-      # older_tag nil - means it's first tag, newer_tag nil - means it unreleased section
-      filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
-      filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
-
-      newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
-      older_tag_name = older_tag.nil? ? nil : older_tag['name']
-
-      if @options[:filter_issues_by_milestone]
-        # delete excess irrelevant issues (according milestones)
-        filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
-        filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
-      end
-
-      if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil?
-        # do not generate empty unreleased section
-        return ''
-      end
-
-      create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
-    end
-
-    def filter_by_milestone(filtered_issues, newer_tag_name, src_array)
-      filtered_issues.select! { |issue|
-        # leave issues without milestones
-        if issue.milestone.nil?
-          true
-        else
-          # check, that this milestone in tag list:
-          @all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
-        end
-      }
-      unless newer_tag_name.nil?
-
-        # add missed issues (according milestones)
-        issues_to_add = src_array.select { |issue|
-          if issue.milestone.nil?
-            false
-          else
-            # check, that this milestone in tag list:
-            milestone_is_tag = @all_tags.find { |tag|
-              tag.name == issue.milestone.title
-            }
-
-            if milestone_is_tag.nil?
-              false
-            else
-              issue.milestone.title == newer_tag_name
-            end
-          end
-        }
-
-        filtered_issues |= issues_to_add
-      end
-      filtered_issues
-    end
-
-    def delete_by_time(array, hash_key, older_tag = nil, newer_tag = nil)
-      fail 'At least one of the tags should be not nil!' if older_tag.nil? && newer_tag.nil?
-
-      newer_tag_time = get_time_of_tag(newer_tag)
-      older_tag_time = get_time_of_tag(older_tag)
-
-      array.select { |req|
-        if req[hash_key]
-          t = Time.parse(req[hash_key]).utc
-
-          if older_tag_time.nil?
-            tag_in_range_old = true
-          else
-            tag_in_range_old = t > older_tag_time
-          end
-
-          if newer_tag_time.nil?
-            tag_in_range_new = true
-          else
-            tag_in_range_new = t <= newer_tag_time
-          end
-
-          tag_in_range = (tag_in_range_old) && (tag_in_range_new)
-
-          tag_in_range
-        else
-          false
-        end
-      }
-    end
-
-    # @param [Array] pull_requests
-    # @param [Array] issues
-    # @param [String] older_tag_name
-    # @return [String]
-    def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
-      newer_tag_time = newer_tag.nil? ? Time.new                    : get_time_of_tag(newer_tag)
-      newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag['name']
-      newer_tag_link = newer_tag.nil? ? 'HEAD'                      : newer_tag_name
-
-      github_site = options[:github_site] || 'https://github.com'
-      project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
-
-      log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
-
-      if @options[:issues]
-        # Generate issues:
-        issues_a = []
-        enhancement_a = []
-        bugs_a = []
-
-        issues.each { |dict|
-          added = false
-          dict.labels.each { |label|
-            if label.name == 'bug'
-              bugs_a.push dict
-              added = true
-              next
-            end
-            if label.name == 'enhancement'
-              enhancement_a.push dict
-              added = true
-              next
-            end
-          }
-          unless added
-            issues_a.push dict
-          end
-        }
-
-        log += generate_log_from_array(enhancement_a, @options[:enhancement_prefix])
-        log += generate_log_from_array(bugs_a, @options[:bug_prefix])
-        log += generate_log_from_array(issues_a, @options[:issue_prefix])
-      end
-
-      if @options[:pulls]
-        # Generate pull requests:
-        log += generate_log_from_array(pull_requests, @options[:merge_prefix])
-      end
-
-      log
-    end
-
-    def generate_log_from_array(issues, prefix)
-      log = ''
-      if options[:simple_list].nil? && issues.any?
-        log += "#{prefix}\n\n"
-      end
-
-      if issues.any?
-        issues.each { |issue|
-          merge_string = @generator.get_string_for_issue(issue)
-          log += "- #{merge_string}\n\n"
-        }
-      end
-      log
-    end
-
-    def generate_header(newer_tag_name, newer_tag_name2, newer_tag_time, older_tag_name, project_url)
-      log = ''
-
-      # Generate date string:
-      time_string = newer_tag_time.strftime @options[:dateformat]
-
-      # Generate tag name and link
-      if newer_tag_name.equal? @options[:unreleased_label]
-        log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2})\n\n"
-      else
-        log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2}) (#{time_string})\n\n"
-      end
-
-      if @options[:compare_link] && older_tag_name
-        # Generate compare link
-        log += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_name2})\n\n"
-      end
-
-      log
-    end
-
-    def get_time_of_tag(tag_name, tag_times_hash = @tag_times_hash)
-      if tag_name.nil?
-        return nil
-      end
-
-      if tag_times_hash[tag_name['name']]
-        return @tag_times_hash[tag_name['name']]
-      end
-
-      begin
-        github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name['commit']['sha']
-      rescue
-        puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-      end
-      time_string = github_git_data_commits_get['committer']['date']
-      @tag_times_hash[tag_name['name']] = Time.parse(time_string)
-    end
-
-    def get_filtered_issues
-      issues = @issues
-
-      filtered_issues = issues
-
-      unless @options[:include_labels].nil?
-        filtered_issues = issues.select { |issue|
-          # add all labels from @options[:include_labels] array
-          (issue.labels.map(&:name) & @options[:include_labels]).any?
-        }
-      end
-
-      unless @options[:exclude_labels].nil?
-        filtered_issues = filtered_issues.select { |issue|
-          # delete all labels from @options[:exclude_labels] array
-          !(issue.labels.map(&:name) & @options[:exclude_labels]).any?
-        }
-      end
-
-      if @options[:add_issues_wo_labels]
-        issues_wo_labels = issues.select { |issue|
-          !issue.labels.map(&:name).any?
-        }
-        filtered_issues |= issues_wo_labels
-      end
-
-      if @options[:verbose]
-        puts "Filtered issues: #{filtered_issues.count}"
-      end
-
-      filtered_issues
-    end
-
-    def fetch_issues_and_pull_requests
-      if @options[:verbose]
-        print "Fetching closed issues...\r"
-      end
-      issues = []
-
-      begin
-        response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
-        page_i = 0
-        count_pages = response.count_pages
-        response.each_page do |page|
-          page_i += PER_PAGE_NUMBER
-          print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
-          issues.concat(page)
-          break if @options[:max_issues] && issues.length >= @options[:max_issues]
-        end
-      rescue
-        puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-      end
-
-      print "                               \r"
-
-      if @options[:verbose]
-        puts "Received issues: #{issues.count}"
-      end
-
-      # remove pull request from issues:
-      issues_wo_pr = issues.select { |x|
-        x.pull_request.nil?
-      }
-      pull_requests = issues.select { |x|
-        !x.pull_request.nil?
-      }
-      [issues_wo_pr, pull_requests]
-    end
-
-    def fetch_event_for_issues_and_pr
-      if @options[:verbose]
-        print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
-      end
-
-      # Async fetching events:
-
-      fetch_events_async(@issues + @pull_requests)
-    end
-
-    def fetch_events_async(issues)
-      i = 0
-      max_thread_number = 50
-      threads = []
-      issues.each_slice(max_thread_number) { |issues_slice|
-        issues_slice.each { |issue|
-          threads << Thread.new {
-            begin
-              obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue['number']
-            rescue
-              puts GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-            end
-            issue[:events] = obj.body
-            print "Fetching events for issues and PR: #{i + 1}/#{@issues.count + @pull_requests.count}\r"
-            i += 1
-          }
-        }
-        threads.each(&:join)
-        threads = []
-      }
-
-      # to clear line from prev print
-      print "                                                            \r"
-
-      if @options[:verbose]
-        puts "Fetching events for issues and PR: #{i} Done!"
-      end
-    end
-  end
-
-  if __FILE__ == $PROGRAM_NAME
-    GitHubChangelogGenerator::ChangelogGenerator.new.compound_changelog
   end
 end

lib/github_changelog_generator/cli.rb

@@ -1,62 +0,0 @@
-#
-# Author:: Enrico Stahn <mail@enricostahn.com>
-#
-# Copyright 2014, Zanui, <engineering@zanui.com.au>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require 'thor'
-
-module GitHubChangelogGenerator
-  class CLI < Thor
-    default_task :generate
-
-    desc 'generate', 'Generates the CHANGELOG.md based on the given options'
-    option :user, aliases: '-u', type: :string, desc: 'Username of the owner of target GitHub repo'
-    option :project, aliases: '-p', type: :string, desc: 'Username of the owner of target GitHub repo'
-    option :token, aliases: '-t', type: :string, desc: 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new'
-    option :date_format, aliases: '-f', type: :string, default: '%d/%m/%y', desc: 'Date format.'
-    option :output, aliases: '-o', type: :string, default: 'CHANGELOG.md', desc: 'Output file.'
-    # TODO: Should be "closed_issues"
-    option :issues, type: :boolean, default: true, desc: 'Include closed issues to changelog.'
-    option :issues_wo_labels, type: :boolean, default: true, desc: 'Include closed issues without labels to changelog.'
-    option :pr_wo_labels, type: :boolean, default: true, desc: 'Include pull requests without labels to changelog.'
-    option :pull_requests, type: :boolean, default: true, desc: 'Include pull-requests to changelog.'
-    option :filter_by_milestone, type: :boolean, default: true, desc: 'Use milestone to detect when issue was resolved.'
-    option :author, type: :boolean, default: true, desc: 'Add author of pull-request in the end.'
-    option :unreleased_only, type: :boolean, default: true, desc: 'Generate log from unreleased closed issues only.'
-    option :unreleased, type: :boolean, default: true, desc: 'Add to log unreleased closed issues.'
-    option :unreleased_label, type: :boolean, default: true, desc: 'Add to log unreleased closed issues.'
-    option :compare_link, type: :boolean, default: true, desc: 'Include compare link (Full Changelog) between older version and newer version.'
-    option :include_labels, type: :array, default: %w(bug enhancement), desc: 'Issues only with that labels will be included to changelog.'
-    option :exclude_labels, type: :array, default: %w(duplicate question invalid wontfix), desc: 'Issues with that labels will be always excluded from changelog.'
-    option :max_issues, type: :numeric, desc: 'Max number of issues to fetch from GitHub. Default is unlimited'
-    option :github_site, :banner => 'URL', type: :string, desc: 'The Enterprise Github site on which your project is hosted.'
-    option :github_api, :banner => 'URL', type: :string, desc: 'The enterprise endpoint to use for your Github API.'
-    option :simple_list, type: :boolean, default: false, desc: 'Create simple list from issues and pull requests.'
-    option :verbose, type: :boolean, default: true, desc: 'Run verbosely.'
-
-    long_desc <<-LONGDESC
-Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
-    LONGDESC
-    def generate
-    end
-
-    map %w[--version -v] => :__print_version
-    desc '--version, -v', 'print the version'
-    def __print_version
-      puts "Version: #{GitHubChangelogGenerator::VERSION}"
-    end
-  end
-end

lib/github_changelog_generator/generator.rb

@@ -1,35 +0,0 @@
-module GitHubChangelogGenerator
-  class Generator
-    def initialize(options = nil)
-      @options = options
-    end
-
-    def get_string_for_issue(issue)
-      encapsulated_title = encapsulate_string issue[:title]
-
-      title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
-
-      unless issue.pull_request.nil?
-        if @options[:author]
-          if issue.user.nil?
-            title_with_number += ' ({Null user})'
-          else
-            title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
-          end
-        end
-      end
-      title_with_number
-    end
-
-    def encapsulate_string(string)
-      string.gsub! '\\', '\\\\'
-
-      encpas_chars = %w(> * _ \( \) [ ] #)
-      encpas_chars.each do |char|
-        string.gsub! char, "\\#{char}"
-      end
-
-      string
-    end
-  end
-end

lib/github_changelog_generator/generator/entry.rb

@@ -0,0 +1,237 @@
+require "github_changelog_generator/generator/section"
+
+module GitHubChangelogGenerator
+  # This class generates the content for a single changelog entry. An entry is
+  # generally either for a specific tagged release or the collection of
+  # unreleased changes.
+  #
+  # An entry is comprised of header text followed by a series of sections
+  # relating to the entry.
+  #
+  # @see GitHubChangelogGenerator::Generator
+  # @see GitHubChangelogGenerator::Section
+  class Entry
+    attr_reader :content
+
+    def initialize(options = Options.new({}))
+      @content = ""
+      @options = Options.new(options)
+    end
+
+    # Generates log entry with header and body
+    #
+    # @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 Name of the newer tag. Could be nil for `Unreleased` section.
+    # @param [String] newer_tag_link Name of the newer tag. Could be "HEAD" for `Unreleased` section.
+    # @param [Time] newer_tag_time Time of the newer 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_entry_for_tag(pull_requests, issues, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name) # rubocop:disable Metrics/ParameterLists
+      github_site = @options[:github_site] || "https://github.com"
+      project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
+
+      set_sections_and_maps
+
+      @content = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
+
+      @content += generate_body(pull_requests, issues)
+
+      @content
+    end
+
+    private
+
+    # Creates section objects and the label and section maps needed for
+    # sorting
+    def set_sections_and_maps
+      @sections = if @options.configure_sections?
+                    parse_sections(@options[:configure_sections])
+                  elsif @options.add_sections?
+                    default_sections.concat parse_sections(@options[:add_sections])
+                  else
+                    default_sections
+                  end
+
+      @lmap = label_map
+      @smap = section_map
+    end
+
+    # Turns a string from the commandline into an array of Section objects
+    #
+    # @param [String, Hash] either string or hash describing sections
+    # @return [Array] array of Section objects
+    def parse_sections(sections_desc)
+      require "json"
+
+      sections_desc = sections_desc.to_json if sections_desc.class == Hash
+
+      begin
+        sections_json = JSON.parse(sections_desc)
+      rescue JSON::ParserError => e
+        raise "There was a problem parsing your JSON string for sections: #{e}"
+      end
+
+      sections_json.collect do |name, v|
+        Section.new(name: name.to_s, prefix: v["prefix"], labels: v["labels"], options: @options)
+      end
+    end
+
+    # Creates a hash map of labels => section objects
+    #
+    # @return [Hash] map of labels => section objects
+    def label_map
+      @sections.each_with_object({}) do |section_obj, memo|
+        section_obj.labels.each do |label|
+          memo[label] = section_obj.name
+        end
+      end
+    end
+
+    # Creates a hash map of 'section name' => section object
+    #
+    # @return [Hash] map of 'section name' => section object
+    def section_map
+      @sections.each_with_object({}) do |section, memo|
+        memo[section.name] = section
+      end
+    end
+
+    # It generates header text for an entry with specific parameters.
+    #
+    # @param [String] newer_tag_name - name of newer tag
+    # @param [String] newer_tag_link - used for links. Could be same as #newer_tag_name or some specific value, like HEAD
+    # @param [Time] newer_tag_time - time, when newer tag created
+    # @param [String] older_tag_name - tag name, used for links.
+    # @param [String] project_url - url for current project.
+    # @return [String] - Header text for a changelog entry.
+    def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
+      header = ""
+
+      # Generate date string:
+      time_string = newer_tag_time.strftime(@options[:date_format])
+
+      # Generate tag name and link
+      release_url = if @options[:release_url]
+                      format(@options[:release_url], newer_tag_link)
+                    else
+                      "#{project_url}/tree/#{newer_tag_link}"
+                    end
+      header += if newer_tag_name.equal?(@options[:unreleased_label])
+                  "## [#{newer_tag_name}](#{release_url})\n\n"
+                else
+                  "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n\n"
+                end
+
+      if @options[:compare_link] && older_tag_name
+        # Generate compare link
+        header += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_link})\n\n"
+      end
+
+      header
+    end
+
+    # Generates complete body text for a tag (without a header)
+    #
+    # @param [Array] pull_requests
+    # @param [Array] issues
+    # @returns [String] ready-to-go tag body
+    def generate_body(pull_requests, issues)
+      body = ""
+      body += main_sections_to_log(pull_requests, issues)
+      body += merged_section_to_log(pull_requests) if @options[:pulls] && @options[:add_pr_wo_labels]
+      body
+    end
+
+    # Generates main sections for a tag
+    #
+    # @param [Array] pull_requests
+    # @param [Array] issues
+    # @return [string] ready-to-go sub-sections
+    def main_sections_to_log(pull_requests, issues)
+      if @options[:issues]
+        sections_to_log = parse_by_sections(pull_requests, issues)
+
+        sections_to_log.map(&:generate_content).join
+      end
+    end
+
+    # Generates section for prs with no labels (for a tag)
+    #
+    # @param [Array] pull_requests
+    # @return [string] ready-to-go sub-section
+    def merged_section_to_log(pull_requests)
+      merged = Section.new(name: "merged", prefix: @options[:merge_prefix], labels: [], issues: pull_requests, options: @options)
+      @sections << merged unless @sections.find { |section| section.name == "merged" }
+      merged.generate_content
+    end
+
+    # Set of default sections for backwards-compatibility/defaults
+    #
+    # @return [Array] array of Section objects
+    def default_sections
+      [
+        Section.new(name: "breaking", prefix: @options[:breaking_prefix], labels: @options[:breaking_labels], options: @options),
+        Section.new(name: "enhancements", prefix: @options[:enhancement_prefix], labels: @options[:enhancement_labels], options: @options),
+        Section.new(name: "bugs", prefix: @options[:bug_prefix], labels: @options[:bug_labels], options: @options),
+        Section.new(name: "issues", prefix: @options[:issue_prefix], labels: @options[:issue_labels], options: @options)
+      ]
+    end
+
+    # This method sorts issues by types
+    # (bugs, features, or just closed issues) by labels
+    #
+    # @param [Array] pull_requests
+    # @param [Array] issues
+    # @return [Hash] Mapping of filtered arrays: (Bugs, Enhancements, Breaking stuff, Issues)
+    def parse_by_sections(pull_requests, issues)
+      issues.each do |dict|
+        added = false
+
+        dict["labels"].each do |label|
+          break if @lmap[label["name"]].nil?
+          @smap[@lmap[label["name"]]].issues << dict
+          added = true
+
+          break if added
+        end
+        if @smap["issues"]
+          @sections.find { |sect| sect.name == "issues" }.issues << dict unless added
+        end
+      end
+      sort_pull_requests(pull_requests)
+    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)
+      added_pull_requests = []
+      pull_requests.each do |pr|
+        added = false
+
+        pr["labels"].each do |label|
+          break if @lmap[label["name"]].nil?
+          @smap[@lmap[label["name"]]].issues << pr
+          added_pull_requests << pr
+          added = true
+
+          break if added
+        end
+      end
+      added_pull_requests.each { |req| pull_requests.delete(req) }
+      @sections
+    end
+
+    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
+  end
+end

lib/github_changelog_generator/generator/generator.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require "github_changelog_generator/octo_fetcher"
+require "github_changelog_generator/generator/generator_fetcher"
+require "github_changelog_generator/generator/generator_processor"
+require "github_changelog_generator/generator/generator_tags"
+require "github_changelog_generator/generator/entry"
+require "github_changelog_generator/generator/section"
+
+module GitHubChangelogGenerator
+  # Default error for ChangelogGenerator
+  class ChangelogGeneratorError < StandardError
+  end
+
+  # This class is the high-level code for gathering issues and PRs for a github
+  # repository and generating a CHANGELOG.md file. A changelog is made up of a
+  # series of "entries" of all tagged releases, plus an extra entry for the
+  # unreleased changes. Entries are made up of various organizational
+  # "sections," and sections contain the github issues and PRs.
+  #
+  # So the changelog contains entries, entries contain sections, and sections
+  # contain issues and PRs.
+  #
+  # @see GitHubChangelogGenerator::Entry
+  # @see GitHubChangelogGenerator::Section
+  class Generator
+    attr_accessor :options, :filtered_tags, :tag_section_mapping, :sorted_tags
+
+    # A Generator responsible for all logic, related with changelog generation from ready-to-parse issues
+    #
+    # Example:
+    #   generator = GitHubChangelogGenerator::Generator.new
+    #   content = generator.compound_changelog
+    def initialize(options = {})
+      @options        = options
+      @tag_times_hash = {}
+      @fetcher        = GitHubChangelogGenerator::OctoFetcher.new(options)
+      @sections       = []
+    end
+
+    # Main function to start changelog generation
+    #
+    # @return [String] Generated changelog file
+    def compound_changelog
+      options.load_custom_ruby_files
+      fetch_and_filter_tags
+      fetch_issues_and_pr
+
+      log = ""
+      log += options[:frontmatter] if options[:frontmatter]
+      log += "#{options[:header]}\n\n"
+
+      log += if options[:unreleased_only]
+               generate_entry_between_tags(filtered_tags[0], nil)
+             else
+               generate_entries_for_all_tags
+             end
+
+      log += File.read(options[:base]) if File.file?(options[:base])
+
+      credit_line = "\n\n\\* *This Changelog 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
+
+    private
+
+    # Generate log only between 2 specified tags
+    # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
+    # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
+    def generate_entry_between_tags(older_tag, newer_tag)
+      filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
+
+      if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
+        # do not generate empty unreleased section
+        return ""
+      end
+
+      newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
+
+      # 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
+
+      Entry.new(options).create_entry_for_tag(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name)
+    end
+
+    # 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, "merged_at", 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"]
+
+      if options[:filter_issues_by_milestone]
+        # delete excess irrelevant issues (according milestones). Issue #22.
+        filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
+        filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
+      end
+      [filtered_issues, filtered_pull_requests]
+    end
+
+    # The full cycle of generation for whole project
+    # @return [String] All entries in the changelog
+    def generate_entries_for_all_tags
+      puts "Generating entry..." if options[:verbose]
+
+      entries = generate_unreleased_entry
+
+      @tag_section_mapping.each_pair do |_tag_section, left_right_tags|
+        older_tag, newer_tag = left_right_tags
+        entries += generate_entry_between_tags(older_tag, newer_tag)
+      end
+
+      entries
+    end
+
+    def generate_unreleased_entry
+      entry = ""
+      if options[:unreleased]
+        start_tag        = filtered_tags[0] || sorted_tags.last
+        unreleased_entry = generate_entry_between_tags(start_tag, nil)
+        entry           += unreleased_entry if unreleased_entry
+      end
+      entry
+    end
+
+    def fetch_issues_and_pr
+      issues, pull_requests = @fetcher.fetch_closed_issues_and_pr
+
+      @pull_requests = options[:pulls] ? get_filtered_pull_requests(pull_requests) : []
+
+      @issues = options[:issues] ? get_filtered_issues(issues) : []
+
+      fetch_events_for_issues_and_pr
+      detect_actual_closed_dates(@issues + @pull_requests)
+    end
+  end
+end

lib/github_changelog_generator/generator/generator_fetcher.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module GitHubChangelogGenerator
+  class Generator
+    MAX_THREAD_NUMBER = 25
+
+    # Fetch event for issues and pull requests
+    # @return [Array] array of fetched issues
+    def fetch_events_for_issues_and_pr
+      if options[:verbose]
+        print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
+      end
+
+      # Async fetching events:
+      @fetcher.fetch_events_async(@issues + @pull_requests)
+    end
+
+    # Async fetching of all tags dates
+    def fetch_tags_dates(tags)
+      print "Fetching tag dates...\r" if options[:verbose]
+      # Async fetching tags:
+      threads = []
+      i = 0
+      all = tags.count
+      tags.each do |tag|
+        print "                                 \r"
+        threads << Thread.new do
+          get_time_of_tag(tag)
+          print "Fetching tags dates: #{i + 1}/#{all}\r" if options[:verbose]
+          i += 1
+        end
+      end
+      threads.each(&:join)
+      puts "Fetching tags dates: #{i}" if options[:verbose]
+    end
+
+    # Find correct closed dates, if issues was closed by commits
+    def detect_actual_closed_dates(issues)
+      print "Fetching closed dates for issues...\r" if options[:verbose]
+
+      issues.each_slice(MAX_THREAD_NUMBER) do |issues_slice|
+        threads = []
+        issues_slice.each do |issue|
+          threads << Thread.new { find_closed_date_by_commit(issue) }
+        end
+        threads.each(&:join)
+      end
+      puts "Fetching closed dates for issues: Done!" if options[:verbose]
+    end
+
+    # Fill :actual_date parameter of specified issue by closed date of the commit, if it was closed by commit.
+    # @param [Hash] issue
+    def find_closed_date_by_commit(issue)
+      unless issue["events"].nil?
+        # if it's PR -> then find "merged event", in case of usual issue -> fond closed date
+        compare_string = issue["merged_at"].nil? ? "closed" : "merged"
+        # reverse! - to find latest closed event. (event goes in date order)
+        issue["events"].reverse!.each do |event|
+          if event["event"].eql? compare_string
+            set_date_from_event(event, issue)
+            break
+          end
+        end
+      end
+      # TODO: assert issues, that remain without 'actual_date' hash for some reason.
+    end
+
+    # Set closed date from this issue
+    #
+    # @param [Hash] event
+    # @param [Hash] issue
+    def set_date_from_event(event, issue)
+      if event["commit_id"].nil?
+        issue["actual_date"] = issue["closed_at"]
+      else
+        begin
+          commit = @fetcher.fetch_commit(event)
+          issue["actual_date"] = commit["commit"]["author"]["date"]
+
+          # issue['actual_date'] = commit['author']['date']
+        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
+      end
+    end
+  end
+end

lib/github_changelog_generator/generator/generator_processor.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+module GitHubChangelogGenerator
+  class Generator
+    # delete all labels with labels from options[:exclude_labels] array
+    # @param [Array] issues
+    # @return [Array] filtered array
+    def exclude_issues_by_labels(issues)
+      return issues if !options[:exclude_labels] || options[:exclude_labels].empty?
+
+      issues.reject do |issue|
+        labels = issue["labels"].map { |l| l["name"] }
+        (labels & options[:exclude_labels]).any?
+      end
+    end
+
+    # @return [Array] filtered issues accourding milestone
+    def filter_by_milestone(filtered_issues, tag_name, all_issues)
+      remove_issues_in_milestones(filtered_issues)
+      unless tag_name.nil?
+        # add missed issues (according milestones)
+        issues_to_add = find_issues_to_add(all_issues, tag_name)
+
+        filtered_issues |= issues_to_add
+      end
+      filtered_issues
+    end
+
+    # Add all issues, that should be in that tag, according milestone
+    #
+    # @param [Array] all_issues
+    # @param [String] tag_name
+    # @return [Array] issues with milestone #tag_name
+    def find_issues_to_add(all_issues, tag_name)
+      all_issues.select do |issue|
+        if issue["milestone"].nil?
+          false
+        else
+          # check, that this milestone in tag list:
+          milestone_is_tag = @filtered_tags.find do |tag|
+            tag["name"] == issue["milestone"]["title"]
+          end
+
+          if milestone_is_tag.nil?
+            false
+          else
+            issue["milestone"]["title"] == tag_name
+          end
+        end
+      end
+    end
+
+    # @return [Array] array with removed issues, that contain milestones with same name as a tag
+    def remove_issues_in_milestones(filtered_issues)
+      filtered_issues.select! do |issue|
+        # leave issues without milestones
+        if issue["milestone"].nil?
+          true
+        else
+          # check, that this milestone in tag list:
+          @filtered_tags.find { |tag| tag["name"] == issue["milestone"]["title"] }.nil?
+        end
+      end
+    end
+
+    # Method filter issues, that belong only specified tag range
+    # @param [Array] issues issues to filter
+    # @param [Symbol] hash_key key of date value default is :actual_date
+    # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
+    # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
+    # @return [Array] filtered issues
+    def delete_by_time(issues, hash_key = "actual_date", older_tag = nil, newer_tag = nil)
+      # 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)
+
+      issues.select do |issue|
+        if issue[hash_key]
+          time = Time.parse(issue[hash_key].to_s).utc
+
+          tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
+
+          tag_in_range_new = tag_older_new_tag?(newer_tag_time, time)
+
+          tag_in_range = tag_in_range_old && tag_in_range_new
+
+          tag_in_range
+        else
+          false
+        end
+      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
+                         else
+                           time <= newer_tag_time
+                         end
+      tag_in_range_new
+    end
+
+    def tag_newer_old_tag?(older_tag_time, t)
+      tag_in_range_old = if older_tag_time.nil?
+                           true
+                         else
+                           t > older_tag_time
+                         end
+      tag_in_range_old
+    end
+
+    # Include issues with labels, specified in :include_labels
+    # @param [Array] issues to filter
+    # @return [Array] filtered array of issues
+    def include_issues_by_labels(issues)
+      filtered_issues = filter_by_include_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
+      else
+        issues.select { |issue| issue["labels"].map { |l| l["name"] }.any? }
+      end
+    end
+
+    def filter_by_include_labels(issues)
+      if options[:include_labels].nil?
+        issues
+      else
+        issues.select do |issue|
+          labels = issue["labels"].map { |l| l["name"] } & options[:include_labels]
+          labels.any?
+        end
+      end
+    end
+
+    # General filtered function
+    #
+    # @param [Array] all_issues
+    # @return [Array] filtered issues
+    def filter_array_by_labels(all_issues)
+      filtered_issues = include_issues_by_labels(all_issues)
+      exclude_issues_by_labels(filtered_issues)
+    end
+
+    # Filter issues according labels
+    # @return [Array] Filtered issues
+    def get_filtered_issues(issues)
+      issues = filter_array_by_labels(issues)
+      puts "Filtered issues: #{issues.count}" if options[:verbose]
+      issues
+    end
+
+    # This method fetches missing params for PR and filter them by specified options
+    # It include add all PR's with labels from options[:include_labels] array
+    # And exclude all from :exclude_labels array.
+    # @return [Array] filtered PR's
+    def get_filtered_pull_requests(pull_requests)
+      pull_requests = filter_array_by_labels(pull_requests)
+      pull_requests = filter_merged_pull_requests(pull_requests)
+      puts "Filtered pull requests: #{pull_requests.count}" if options[:verbose]
+      pull_requests
+    end
+
+    # This method filter only merged PR and
+    # fetch missing required attributes for pull requests
+    # :merged_at - is a date, when issue PR was merged.
+    # More correct to use merged date, rather than closed date.
+    def filter_merged_pull_requests(pull_requests)
+      print "Fetching merged dates...\r" if options[:verbose]
+      closed_pull_requests = @fetcher.fetch_closed_pull_requests
+
+      pull_requests.each do |pr|
+        fetched_pr = closed_pull_requests.find do |fpr|
+          fpr["number"] == pr["number"]
+        end
+        if fetched_pr
+          pr["merged_at"] = fetched_pr["merged_at"]
+          closed_pull_requests.delete(fetched_pr)
+        end
+      end
+
+      pull_requests.reject! do |pr|
+        pr["merged_at"].nil?
+      end
+
+      pull_requests
+    end
+  end
+end

lib/github_changelog_generator/generator/generator_tags.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+module GitHubChangelogGenerator
+  class Generator
+    # fetch, filter tags, fetch dates and sort them in time order
+    def fetch_and_filter_tags
+      detect_since_tag
+      detect_due_tag
+
+      all_tags = @fetcher.get_all_tags
+      fetch_tags_dates(all_tags) # Creates a Hash @tag_times_hash
+      all_sorted_tags = sort_tags_by_date(all_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] section_tags are the tags that need a subsection output
+    # @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]
+    # rubocop:disable Style/For - for allows us to be more concise
+    def build_tag_section_mapping(section_tags, filtered_tags)
+      tag_mapping = {}
+      for i in 0..(section_tags.length - 1)
+        tag = section_tags[i]
+
+        # 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)
+      puts "Sorting tags..." if options[:verbose]
+      tags.sort_by! do |x|
+        get_time_of_tag(x)
+      end.reverse!
+    end
+
+    # Returns date for given GitHub Tag hash
+    #
+    # Memoize the date by tag name.
+    #
+    # @param [Hash] tag_name
+    #
+    # @return [Time] time of specified tag
+    def get_time_of_tag(tag_name)
+      raise ChangelogGeneratorError, "tag_name is nil" if tag_name.nil?
+
+      name_of_tag = tag_name.fetch("name")
+      time_for_tag_name = @tag_times_hash[name_of_tag]
+      return time_for_tag_name if time_for_tag_name
+
+      @fetcher.fetch_date_of_tag(tag_name).tap do |time_string|
+        @tag_times_hash[name_of_tag] = time_string
+      end
+    end
+
+    # Detect link, name and time for specified tag.
+    #
+    # @param [Hash] newer_tag newer tag. Can be nil, if it's Unreleased section.
+    # @return [Array] link, name and time of the tag
+    def detect_link_tag_time(newer_tag)
+      # if tag is nil - set current time
+      newer_tag_time = newer_tag.nil? ? Time.new : get_time_of_tag(newer_tag)
+
+      # if it's future release tag - set this value
+      if newer_tag.nil? && options[:future_release]
+        newer_tag_name = options[:future_release]
+        newer_tag_link = options[:future_release]
+      else
+        # put unreleased label if there is no name for the tag
+        newer_tag_name = newer_tag.nil? ? options[:unreleased_label] : newer_tag["name"]
+        newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
+      end
+      [newer_tag_link, newer_tag_name, newer_tag_time]
+    end
+
+    # @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
+    def detect_since_tag
+      @since_tag ||= options.fetch(:since_tag) { version_of_first_item }
+    end
+
+    def detect_due_tag
+      @due_tag ||= options.fetch(:due_tag, nil)
+    end
+
+    def version_of_first_item
+      return unless File.file?(options[:base].to_s)
+
+      sections = GitHubChangelogGenerator::Reader.new.read(options[:base])
+      sections.first["version"] if sections && sections.any?
+    end
+
+    # Return tags after filtering tags in lists provided by option: --exclude-tags
+    #
+    # @return [Array]
+    def get_filtered_tags(all_tags)
+      filtered_tags = filter_since_tag(all_tags)
+      filter_due_tag(filtered_tags)
+    end
+
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :since_tag option
+    def filter_since_tag(all_tags)
+      filtered_tags = all_tags
+      tag = detect_since_tag
+      if tag
+        if all_tags.map { |t| t["name"] }.include? tag
+          idx = all_tags.index { |t| t["name"] == tag }
+          filtered_tags = if idx
+                            all_tags[0..idx]
+                          else
+                            []
+                          end
+        else
+          Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
+        end
+      end
+      filtered_tags
+    end
+
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :due_tag option
+    def filter_due_tag(all_tags)
+      filtered_tags = all_tags
+      tag           = detect_due_tag
+      if tag
+        if all_tags.any? && all_tags.map { |t| t["name"] }.include?(tag)
+          idx = all_tags.index { |t| t["name"] == tag }
+          filtered_tags = if idx > 0
+                            all_tags[(idx + 1)..-1]
+                          else
+                            []
+                          end
+        else
+          Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
+        end
+      end
+      filtered_tags
+    end
+
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option
+    def filter_excluded_tags(all_tags)
+      if options[:exclude_tags]
+        apply_exclude_tags(all_tags)
+      elsif options[:exclude_tags_regex]
+        apply_exclude_tags_regex(all_tags)
+      else
+        all_tags
+      end
+    end
+
+    private
+
+    def apply_exclude_tags(all_tags)
+      if options[:exclude_tags].is_a?(Regexp)
+        filter_tags_with_regex(all_tags, options[:exclude_tags], "--exclude-tags")
+      else
+        filter_exact_tags(all_tags)
+      end
+    end
+
+    def apply_exclude_tags_regex(all_tags)
+      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, regex_option_name)
+      warn_if_nonmatching_regex(all_tags, regex, regex_option_name)
+      all_tags.reject { |tag| regex =~ tag["name"] }
+    end
+
+    def filter_exact_tags(all_tags)
+      options[:exclude_tags].each do |tag|
+        warn_if_tag_not_found(all_tags, tag)
+      end
+      all_tags.reject { |tag| options[:exclude_tags].include?(tag["name"]) }
+    end
+
+    def warn_if_nonmatching_regex(all_tags, regex, regex_option_name)
+      unless all_tags.map { |t| t["name"] }.any? { |t| regex =~ t }
+        Helper.log.warn "Warning: unable to reject any tag, using regex "\
+                        "#{regex.inspect} in #{regex_option_name} option."
+      end
+    end
+
+    def warn_if_tag_not_found(all_tags, tag)
+      unless all_tags.map { |t| t["name"] }.include?(tag)
+        Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
+      end
+    end
+  end
+end

lib/github_changelog_generator/generator/section.rb

@@ -0,0 +1,83 @@
+module GitHubChangelogGenerator
+  # This class generates the content for a single section of a changelog entry.
+  # It turns the tagged issues and PRs into a well-formatted list of changes to
+  # be later incorporated into a changelog entry.
+  #
+  # @see GitHubChangelogGenerator::Entry
+  class Section
+    attr_accessor :name, :prefix, :issues, :labels
+
+    def initialize(opts = {})
+      @name = opts[:name]
+      @prefix = opts[:prefix]
+      @labels = opts[:labels] || []
+      @issues = opts[:issues] || []
+      @options = opts[:options] || Options.new({})
+    end
+
+    # @param [Array] issues List of issues on sub-section
+    # @param [String] prefix Name of sub-section
+    # @return [String] Generate section content
+    def generate_content
+      content = ""
+
+      if @issues.any?
+        content += "#{@prefix}\n\n" unless @options[:simple_list]
+        @issues.each do |issue|
+          merge_string = get_string_for_issue(issue)
+          content += "- #{merge_string}\n"
+        end
+        content += "\n"
+      end
+      content
+    end
+
+    private
+
+    # Parse issue and generate single line formatted issue line.
+    #
+    # Example output:
+    # - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) (@skywinder)
+    #
+    # @param [Hash] issue Fetched issue from GitHub
+    # @return [String] Markdown-formatted single issue
+    def get_string_for_issue(issue)
+      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
+
+    def issue_line_with_user(line, issue)
+      return line if !@options[:author] || issue["pull_request"].nil?
+
+      user = issue["user"]
+      return "#{line} ({Null user})" unless user
+
+      if @options[:usernames_as_github_logins]
+        "#{line} (@#{user['login']})"
+      else
+        "#{line} ([#{user['login']}](#{user['html_url']}))"
+      end
+    end
+
+    ENCAPSULATED_CHARACTERS = %w(< > * _ \( \) [ ] #)
+
+    # Encapsulate characters to make Markdown look as expected.
+    #
+    # @param [String] string
+    # @return [String] encapsulated input string
+    def encapsulate_string(string)
+      string = string.gsub('\\', '\\\\')
+
+      ENCAPSULATED_CHARACTERS.each do |char|
+        string = string.gsub(char, "\\#{char}")
+      end
+
+      string
+    end
+  end
+end

lib/github_changelog_generator/helper.rb

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

lib/github_changelog_generator/octo_fetcher.rb

@@ -0,0 +1,390 @@
+# 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)
+  #
+  # Example:
+  # fetcher = GitHubChangelogGenerator::OctoFetcher.new(options)
+  class OctoFetcher
+    PER_PAGE_NUMBER   = 100
+    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, changelog may be " \
+    "missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
+    NO_TOKEN_PROVIDED = "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found. " \
+    "This script can make only 50 requests to GitHub API per hour without token!"
+
+    # @param options [Hash] Options passed in
+    # @option options [String] :user GitHub username
+    # @option options [String] :project GitHub project
+    # @option options [String] :since Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. eg. Time.parse("2016-01-01 10:00:00").iso8601
+    # @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 = {})
+      @options      = options || {}
+      @user         = @options[:user]
+      @project      = @options[:project]
+      @since        = @options[:since]
+      @http_cache   = @options[:http_cache]
+      @cache_file   = nil
+      @cache_log    = nil
+      prepare_cache
+      configure_octokit_ssl
+      @client = Octokit::Client.new(github_options)
+    end
+
+    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
+
+    def github_options
+      result = {}
+      github_token = fetch_github_token
+      result[:access_token] = github_token if github_token
+      endpoint = @options[:github_endpoint]
+      result[:api_endpoint] = endpoint if endpoint
+      result
+    end
+
+    def configure_octokit_ssl
+      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
+      Octokit.middleware = Faraday::RackBuilder.new do |builder|
+        builder.use(Faraday::HttpCache, serializer: Marshal,
+                                        store: ActiveSupport::Cache::FileStore.new(@cache_file),
+                                        logger: Logger.new(@cache_log),
+                                        shared_cache: false)
+        builder.use Octokit::Response::RaiseError
+        builder.adapter Faraday.default_adapter
+        # builder.response :logger
+      end
+    end
+
+    DEFAULT_REQUEST_OPTIONS = { per_page: PER_PAGE_NUMBER }
+
+    # Fetch all tags from repo
+    #
+    # @return [Array <Hash>] array of tags
+    def get_all_tags
+      print "Fetching tags...\r" if @options[:verbose]
+
+      check_github_response { github_fetch_tags }
+    end
+
+    # Returns the number of pages for a API call
+    #
+    # @return [Integer] number of pages for this API call in total
+    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, DEFAULT_REQUEST_OPTIONS.merge(request_options))
+      end
+
+      last_response = client.last_response
+
+      if (last_pg = last_response.rels[:last])
+        querystring_as_hash(last_pg.href)["page"].to_i
+      else
+        1
+      end
+    end
+
+    # Fill input array with tags
+    #
+    # @return [Array <Hash>] array of tags in repo
+    def github_fetch_tags
+      tags        = []
+      page_i      = 0
+      count_pages = calculate_pages(@client, "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)
+      end
+      print_empty_line
+
+      if tags.count == 0
+        Helper.log.warn "Warning: Can't find any tags in repo. \
+Make sure, that you push tags to remote repo via 'git push --tags'"
+      else
+        Helper.log.info "Found #{tags.count} tags"
+      end
+      # tags are a Sawyer::Resource. Convert to hash
+      tags.map { |resource| stringify_keys_deep(resource.to_hash) }
+    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
+    # (pull request is kind of issue in term of GitHub)
+    #
+    # @return [Tuple] with (issues [Array <Hash>], pull-requests [Array <Hash>])
+    def fetch_closed_issues_and_pr
+      print "Fetching closed issues...\r" if @options[:verbose]
+      issues = []
+      page_i      = 0
+      count_pages = calculate_pages(@client, "issues", closed_pr_options)
+
+      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)
+        break if @options[:max_issues] && issues.length >= @options[:max_issues]
+      end
+      print_empty_line
+      Helper.log.info "Received issues: #{issues.count}"
+
+      # separate arrays of issues and pull requests:
+      issues.map { |issue| stringify_keys_deep(issue.to_hash) }
+            .partition { |issue_or_pr| issue_or_pr["pull_request"].nil? }
+    end
+
+    # Fetch all pull requests. We need them to detect :merged_at parameter
+    #
+    # @return [Array <Hash>] all pull requests
+    def fetch_closed_pull_requests
+      pull_requests = []
+      options = { state: "closed" }
+
+      unless @options[:release_branch].nil?
+        options[:base] = @options[:release_branch]
+      end
+
+      page_i      = 0
+      count_pages = calculate_pages(@client, "pull_requests", options)
+
+      iterate_pages(@client, "pull_requests", options) do |new_pr|
+        page_i += PER_PAGE_NUMBER
+        log_string = "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}"
+        print_in_same_line(log_string)
+        pull_requests.concat(new_pr)
+      end
+      print_empty_line
+
+      Helper.log.info "Pull Request count: #{pull_requests.count}"
+      pull_requests.map { |pull_request| stringify_keys_deep(pull_request.to_hash) }
+    end
+
+    # Fetch event for all issues and add them to 'events'
+    #
+    # @param [Array] issues
+    # @return [Void]
+    def fetch_events_async(issues)
+      i       = 0
+      threads = []
+
+      issues.each_slice(MAX_THREAD_NUMBER) do |issues_slice|
+        issues_slice.each do |issue|
+          threads << Thread.new do
+            issue["events"] = []
+            iterate_pages(@client, "issue_events", issue["number"]) do |new_event|
+              issue["events"].concat(new_event)
+            end
+            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
+        end
+        threads.each(&:join)
+        threads = []
+      end
+
+      # to clear line from prev print
+      print_empty_line
+
+      Helper.log.info "Fetching events for issues and PR: #{i}"
+    end
+
+    # Fetch tag time from repo
+    #
+    # @param [Hash] tag GitHub data item about a Tag
+    #
+    # @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 = stringify_keys_deep(commit_data.to_hash)
+
+      commit_data["commit"]["committer"]["date"]
+    end
+
+    # Fetch commit for specified event
+    #
+    # @return [Hash]
+    def fetch_commit(event)
+      check_github_response do
+        commit = @client.commit(user_project, event["commit_id"])
+        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')
+    #
+    # @yield [Sawyer::Resource] An OctoKit-provided response (which can be empty)
+    #
+    # @return [void]
+    def iterate_pages(client, method, *args)
+      args << DEFAULT_REQUEST_OPTIONS.merge(extract_request_args(args))
+
+      check_github_response { client.send(method, user_project, *args) }
+      last_response = client.last_response.tap do |response|
+        raise(MovedPermanentlyError, response.data[:url]) if response.status == 301
+      end
+
+      yield(last_response.data)
+
+      until (next_one = last_response.rels[:next]).nil?
+        last_response = check_github_response { next_one.get }
+        yield(last_response.data)
+      end
+    end
+
+    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
+      Retriable.retriable(retry_options) do
+        yield
+      end
+    rescue MovedPermanentlyError => e
+      fail_with_message(e, "The repository has moved, update your configuration")
+    rescue Octokit::Forbidden => e
+      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
+    end
+
+    def sys_abort(msg)
+      abort(msg)
+    end
+
+    # Print specified line on the same string
+    #
+    # @param [String] log_string
+    def print_in_same_line(log_string)
+      print log_string + "\r"
+    end
+
+    # Print long line with spaces on same line to clear prev message
+    def print_empty_line
+      print_in_same_line("                                                                       ")
+    end
+
+    # Returns GitHub token. First try to use variable, provided by --token option,
+    # otherwise try to fetch it from CHANGELOG_GITHUB_TOKEN env variable.
+    #
+    # @return [String]
+    def fetch_github_token
+      env_var = @options[:token].presence || ENV["CHANGELOG_GITHUB_TOKEN"]
+
+      Helper.log.warn NO_TOKEN_PROVIDED unless env_var
+
+      env_var
+    end
+
+    # @return [String] helper to return Github "user/project"
+    def user_project
+      "#{@options[:user]}/#{@options[:project]}"
+    end
+
+    # 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 querystring_as_hash(uri)
+      Hash[URI.decode_www_form(URI(uri).query || "")]
+    end
+  end
+end

lib/github_changelog_generator/options.rb

@@ -0,0 +1,136 @@
+# 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
+      add_sections
+      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
+      configure_sections
+      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
+
+    # Boolean method for whether the user is using configure_sections
+    def configure_sections?
+      !self[:configure_sections].nil? && !self[:configure_sections].empty?
+    end
+
+    # Boolean method for whether the user is using add_sections
+    def add_sections?
+      !self[:add_sections].nil? && !self[:add_sections].empty?
+    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,16 +1,207 @@
 #!/usr/bin/env ruby
-require 'optparse'
+# frozen_string_literal: true
-require 'pp'
+
-require_relative 'version'
+require "optparse"
+require "pp"
+require "github_changelog_generator/version"
+require "github_changelog_generator/helper"
 
 module GitHubChangelogGenerator
   class Parser
+    # parse options with optparse
     def self.parse_options
-      options = {
+      options = default_options
-        tag1: nil,
+
-        tag2: nil,
+      ParserFile.new(options).parse!
-        dateformat: '%Y-%m-%d',
+
-        output: 'CHANGELOG.md',
+      parser = setup_parser(options)
+      begin parser.parse!
+      rescue OptionParser::InvalidOption => e
+        abort [e, parser].join("\n")
+      end
+
+      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
+
+      options.print_options
+
+      options
+    end
+
+    # Setup parsing options
+    #
+    # @param options [Options]
+    # @return [OptionParser]
+    def self.setup_parser(options)
+      OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
+        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|
+          options[:user] = last
+        end
+        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|
+          options[:date_format] = last
+        end
+        opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
+          options[:output] = last
+        end
+        opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
+          options[:base] = last
+        end
+        opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**\"") do |v|
+          options[:bug_prefix] = v
+        end
+        opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
+          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
+        opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Changelog\"") do |v|
+          options[:header] = v
+        end
+        opts.on("--configure-sections [Hash, String]", "Define your own set of sections which overrides all default sections") do |v|
+          options[:configure_sections] = v
+        end
+        opts.on("--add-sections [Hash, String]", "Add new sections but keep the default sections") do |v|
+          options[:add_sections] = v
+        end
+        opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
+          options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
+        end
+        opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
+          options[:merge_prefix] = v
+        end
+        opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
+          options[:issues] = v
+        end
+        opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true") do |v|
+          options[:add_issues_wo_labels] = v
+        end
+        opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true") do |v|
+          options[:add_pr_wo_labels] = v
+        end
+        opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true") do |v|
+          options[:pulls] = v
+        end
+        opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true") do |last|
+          options[:filter_issues_by_milestone] = last
+        end
+        opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
+          options[:author] = author
+        end
+        opts.on("--usernames-as-github-logins", "Use GitHub tags instead of Markdown links for the author of an issue or pull-request.") do |v|
+          options[:usernames_as_github_logins] = v
+        end
+        opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
+          options[:unreleased_only] = v
+        end
+        opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
+          options[:unreleased] = v
+        end
+        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|
+          options[:compare_link] = v
+        end
+        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|
+          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|
+          options[:bug_labels] = list
+        end
+        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("--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[: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, "Changelog will exclude specified tags") do |list|
+          options[:exclude_tags] = list
+        end
+        opts.on("--exclude-tags-regex [REGEX]", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\" ") do |last|
+          options[:exclude_tags_regex] = last
+        end
+        opts.on("--since-tag  x", "Changelog will start after specified tag") do |v|
+          options[:since_tag] = v
+        end
+        opts.on("--due-tag  x", "Changelog will end before specified tag") do |v|
+          options[:due_tag] = v
+        end
+        opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
+          options[:max_issues] = max
+        end
+        opts.on("--release-url [URL]", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
+          options[:release_url] = url
+        end
+        opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
+          options[:github_site] = last
+        end
+        opts.on("--github-api [URL]", "The enterprise endpoint to use for your Github API.") do |last|
+          options[:github_endpoint] = last
+        end
+        opts.on("--simple-list", "Create simple list from issues and pull requests. Default is false.") do |v|
+          options[:simple_list] = v
+        end
+        opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
+          options[:future_release] = future_release
+        end
+        opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
+          options[:release_branch] = release_branch
+        end
+        opts.on("--[no-]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 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 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
+        opts.on("-v", "--version", "Print version number") do |_v|
+          puts "Version: #{GitHubChangelogGenerator::VERSION}"
+          exit
+        end
+        opts.on("-h", "--help", "Displays Help") do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    # @return [Options] Default options
+    def self.default_options
+      Options.new(
+        date_format: "%Y-%m-%d",
+        output: "CHANGELOG.md",
+        base: "HISTORY.md",
         issues: true,
         add_issues_wo_labels: true,
         add_pr_wo_labels: true,
@@ -18,160 +209,28 @@ module GitHubChangelogGenerator
         filter_issues_by_milestone: true,
         author: true,
         unreleased: true,
-        unreleased_label: 'Unreleased',
+        unreleased_label: "Unreleased",
         compare_link: true,
-        include_labels: %w(bug enhancement),
+        enhancement_labels: ["enhancement", "Enhancement", "Type: Enhancement"],
-        exclude_labels: %w(duplicate question invalid wontfix),
+        bug_labels: ["bug", "Bug", "Type: Bug"],
+        exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"],
+        breaking_labels: %w[backwards-incompatible breaking],
+        configure_sections: {},
+        add_sections: {},
+        issue_line_labels: [],
         max_issues: nil,
         simple_list: false,
+        ssl_ca_file: nil,
         verbose: true,
-
+        header: "# Changelog",
-        merge_prefix: '**Merged pull requests:**',
+        merge_prefix: "**Merged pull requests:**",
-        issue_prefix: '**Closed issues:**',
+        issue_prefix: "**Closed issues:**",
-        bug_prefix: '**Fixed bugs:**',
+        bug_prefix: "**Fixed bugs:**",
-        enhancement_prefix: '**Implemented enhancements:**',
+        enhancement_prefix: "**Implemented enhancements:**",
-        branch: 'origin'
+        breaking_prefix: "**Breaking changes:**",
-      }
+        http_cache: true,
-
+        require: []
-      parser = OptionParser.new do |opts|
+      )
-        opts.banner = 'Usage: github_changelog_generator [options]'
-        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|
-          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|
-          options[:dateformat] = last
-        end
-        opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
-          options[:output] = last
-        end
-        opts.on('--[no-]issues', 'Include closed issues in changelog. Default is true') do |v|
-          options[:issues] = v
-        end
-        opts.on('--[no-]issues-wo-labels', 'Include closed issues without labels in changelog. Default is true') do |v|
-          options[:add_issues_wo_labels] = v
-        end
-        opts.on('--[no-]pr-wo-labels', 'Include pull requests without labels in changelog. Default is true') do |v|
-          options[:add_pr_wo_labels] = v
-        end
-        opts.on('--[no-]pull-requests', 'Include pull-requests in changelog. Default is true') do |v|
-          options[:pulls] = v
-        end
-        opts.on('--[no-]filter-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
-          options[:filter_issues_by_milestone] = last
-        end
-        opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
-          options[:author] = author
-        end
-        opts.on('--unreleased-only', 'Generate log from unreleased closed issues only.') do |v|
-          options[:unreleased_only] = v
-        end
-        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|
-          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|
-          options[:compare_link] = v
-        end
-        opts.on('--include-labels  x,y,z', Array, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') 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|
-          options[:exclude_labels] = list
-        end
-        opts.on('--max-issues [NUMBER]', Integer, 'Max number of issues to fetch from GitHub. Default is unlimited') do |max|
-          options[:max_issues] = max
-        end
-        opts.on('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
-          options[:github_site] = last
-        end
-        opts.on('--github-api [URL]', 'The enterprise endpoint to use for your Github API.') do |last|
-          options[:github_endpoint] = last
-        end
-        opts.on('--simple-list', 'Create simple list from issues and pull requests. Default is false.') do |v|
-          options[:simple_list] = v
-        end
-        opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
-          options[:verbose] = v
-        end
-        opts.on('-v', '--version', 'Print version number') do |_v|
-          puts "Version: #{GitHubChangelogGenerator::VERSION}"
-          exit
-        end
-        opts.on('-h', '--help', 'Displays Help') do
-          puts opts
-          exit
-        end
-      end
-
-      parser.parse!
-
-      if ARGV[0] && !ARGV[1]
-        github_site = options[:github_site] ? options[:github_site] : 'github.com'
-        # 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(ARGV[0])
-
-        begin
-          param = match[2].nil?
-        rescue
-          puts "Can't detect user and name from first parameter: '#{ARGV[0]}' -> exit'"
-          exit
-        end
-        if param
-          exit
-        else
-          options[:user] = match[1]
-          options[:project] = match[2]
-        end
-
-      end
-
-      if !options[:user] && !options[:project]
-        remote = `git config --get remote.#{options[:branch]}.url`
-        # try to find repo in format:
-        # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
-        # git@github.com:skywinder/Github-Changelog-Generator.git
-        match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/.match(remote)
-
-        if match && match[1] && match[2]
-          puts "Detected user:#{match[1]}, project:#{match[2]}"
-          options[:user], options[:project] = match[1], match[2]
-        else
-          # try to find repo in format:
-          # origin	https://github.com/skywinder/ChangelogMerger (fetch)
-          # https://github.com/skywinder/ChangelogMerger
-          match = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/.match(remote)
-          if match && match[1] && match[2]
-            puts "Detected user:#{match[1]}, project:#{match[2]}"
-            options[:user], options[:project] = match[1], match[2]
-          end
-        end
-      end
-
-      if !options[:user] || !options[:project]
-        puts parser.banner
-        exit
-      end
-
-      if ARGV[1]
-        options[:tag1] = ARGV[0]
-        options[:tag2] = ARGV[1]
-      end
-
-      if options[:verbose]
-        puts 'Performing task with options:'
-        pp options
-        puts ''
-      end
-
-      options
     end
   end
 end

lib/github_changelog_generator/parser_file.rb

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

lib/github_changelog_generator/reader.rb

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

lib/github_changelog_generator/task.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/tasklib"
+require "github_changelog_generator"
+
+module GitHubChangelogGenerator
+  class RakeTask < ::Rake::TaskLib
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    OPTIONS = %w[ user project token date_format output
+                  bug_prefix enhancement_prefix issue_prefix
+                  header merge_prefix issues
+                  add_issues_wo_labels add_pr_wo_labels
+                  pulls filter_issues_by_milestone author
+                  unreleased_only unreleased unreleased_label
+                  compare_link include_labels exclude_labels
+                  bug_labels enhancement_labels
+                  between_tags exclude_tags exclude_tags_regex since_tag max_issues
+                  github_site github_endpoint simple_list
+                  future_release release_branch verbose release_url
+                  base configure_sections add_sections]
+
+    OPTIONS.each do |o|
+      attr_accessor o.to_sym
+    end
+
+    # Public: Initialise a new GitHubChangelogGenerator::RakeTask.
+    #
+    # Example
+    #
+    #   GitHubChangelogGenerator::RakeTask.new
+    def initialize(*args, &task_block)
+      @name = args.shift || :changelog
+
+      define(args, &task_block)
+    end
+
+    def define(args, &task_block)
+      desc "Generate a Changelog from GitHub"
+
+      yield(*[self, args].slice(0, task_block.arity)) if task_block
+
+      # clear any (auto-)pre-existing task
+      Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
+
+      task @name do
+        # mimick parse_options
+        options = Parser.default_options
+
+        OPTIONS.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
+
+        output_filename = (options[:output]).to_s
+        File.open(output_filename, "w") { |file| file.write(log) }
+        puts "Done!"
+        puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
+      end
+    end
+  end
+end

lib/github_changelog_generator/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHubChangelogGenerator
-  VERSION = '1.3.11'
+  VERSION = "1.15.0-rc"
 end

man/git-generate-changelog.1

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

man/git-generate-changelog.1.html

@@ -0,0 +1,303 @@
+<!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 changelog 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 "# Changelog"</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>   Changelog 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>   Changelog will start after specified tag</p>
+
+<p>   --due-tag x</p>
+
+<p>   Changelog 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>   --configure-sections [HASH, STRING]</p>
+
+<p>   Define your own set of sections which overrides all default sections") do |v|</p>
+
+<p>   --add-sections [HASH, STRING]</p>
+
+<p>   Add new sections but keep the default sections"</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'>December 2017</li>
+    <li class='tr'>git-generate-changelog(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

man/git-generate-changelog.html

@@ -0,0 +1,270 @@
+<!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 changelog 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 "# Changelog"</p>
+
+<p>   --pr-label [LABEL]</p>
+
+<p>   Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
+
+<p>   --[no-]issues</p>
+
+<p>   Include closed issues in changelog. Default is true</p>
+
+<p>   --[no-]issues-wo-labels</p>
+
+<p>   Include closed issues without labels in changelog. Default is true</p>
+
+<p>   --[no-]pr-wo-labels</p>
+
+<p>   Include pull requests without labels in changelog. Default is true</p>
+
+<p>   --[no-]pull-requests</p>
+
+<p>   Include pull-requests in changelog. Default is true</p>
+
+<p>   --[no-]filter-by-milestone</p>
+
+<p>   Use milestone to detect when issue was resolved. Default is true</p>
+
+<p>   --[no-]author</p>
+
+<p>   Add author of pull-request in the end. Default is true</p>
+
+<p>   --unreleased-only</p>
+
+<p>   Generate log from unreleased closed issues only.</p>
+
+<p>   --[no-]unreleased</p>
+
+<p>   Add to log unreleased closed issues. Default is true</p>
+
+<p>   --unreleased-label [label]</p>
+
+<p>   Add to log unreleased closed issues. Default is true</p>
+
+<p>   --[no-]compare-link</p>
+
+<p>   Include compare link (Full Changelog) between older version and newer version. Default is true</p>
+
+<p>   --include-labels x,y,z</p>
+
+<p>   Only issues with the specified labels will be included in the changelog.</p>
+
+<p>   --exclude-labels x,y,z</p>
+
+<p>   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
+
+<p>   --bug-labels x,y,z</p>
+
+<p>   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
+
+<p>   --enhancement-labels x,y,z</p>
+
+<p>   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
+
+<p>   --exclude-tags x,y,z</p>
+
+<p>   Changelog will exclude specified tags</p>
+
+<p>   --since-tag x</p>
+
+<p>   Changelog will start after specified tag</p>
+
+<p>   --due-tag x</p>
+
+<p>   Changelog 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>   --configure-sections [HASH, STRING]</p>
+
+<p>   Define your own set of sections which overrides all default sections") do |v|</p>
+
+<p>   --add-sections [HASH, STRING]</p>
+
+<p>   Add new sections but keep the default sections"</p>
+
+<p>   --include-merged</p>
+
+<p>   If configure_sections is set, use this to restore the merged pull requests sections</p>
+
+<p>   --[no-]verbose</p>
+
+<p>   Run verbosely. Default is true</p>
+
+<p>  -v, --version</p>
+
+<p>  Print version number</p>
+
+<p>  -h, --help</p>
+
+<p>  Displays Help</p>
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<h2 id="AUTHOR">AUTHOR</h2>
+
+<p>Written by Petr Korolev sky4winder@gmail.com</p>
+
+<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
+
+<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>&gt;</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>&gt;</p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>October 2015</li>
+    <li class='tr'>git-generate-changelog(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

man/git-generate-changelog.md

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

spec/files/github-changelog-generator.md

@@ -1,4 +1,4 @@
-# Change Log
+# Changelog
 
 ## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)
 
@@ -302,4 +302,4 @@
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

spec/install-gem-in-bundler.gemfile

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

spec/spec_helper.rb

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

spec/unit/generator/entry_spec.rb

@@ -0,0 +1,362 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ModuleLength
+module GitHubChangelogGenerator
+  RSpec.describe Entry do
+    def label(name)
+      { "name" => name }
+    end
+
+    def issue(title, labels, number = "1", user = { "login" => "user" })
+      {
+        "title" => "issue #{title}",
+        "labels" => labels.map { |l| label(l) },
+        "number" => number,
+        "html_url" => "https://github.com/owner/repo/issue/#{number}",
+        "user" => user
+      }
+    end
+
+    def pr(title, labels, number = "1", user = { "login" => "user" })
+      {
+        "pull_request" => true,
+        "title" => "pr #{title}",
+        "labels" => labels.map { |l| label(l) },
+        "number" => number,
+        "html_url" => "https://github.com/owner/repo/pull/#{number}",
+        "user" => user.merge("html_url" => "https://github.com/#{user['login']}")
+      }
+    end
+
+    def titles_for(issues)
+      issues.map { |issue| issue["title"] }
+    end
+
+    def default_sections
+      %w[enhancements bugs breaking issues]
+    end
+
+    describe "#create_entry_for_tag" do
+      let(:options) do
+        Parser.default_options.merge(
+          user: "owner",
+          project: "repo",
+          bug_labels: ["bug"],
+          enhancement_labels: ["enhancement"],
+          breaking_labels: ["breaking"]
+        )
+      end
+
+      let(:issues) do
+        [
+          issue("no labels", [], "5", "login" => "user1"),
+          issue("enhancement", ["enhancement"], "6", "login" => "user2"),
+          issue("bug", ["bug"], "7", "login" => "user1"),
+          issue("breaking", ["breaking"], "8", "login" => "user5"),
+          issue("all the labels", %w[enhancement bug breaking], "9", "login" => "user9")
+        ]
+      end
+
+      let(:pull_requests) do
+        [
+          pr("no labels", [], "10", "login" => "user1"),
+          pr("enhancement", ["enhancement"], "11", "login" => "user5"),
+          pr("bug", ["bug"], "12", "login" => "user5"),
+          pr("breaking", ["breaking"], "13", "login" => "user5"),
+          pr("all the labels", %w[enhancement bug breaking], "14", "login" => "user5")
+        ]
+      end
+
+      subject { described_class.new(options) }
+      it "generates a header and body" do
+        changelog = <<-CHANGELOG.gsub(/^ {8}/, "")
+        ## [1.0.1](https://github.com/owner/repo/tree/1.0.1) (2017-12-04)
+
+        [Full Changelog](https://github.com/owner/repo/compare/1.0.0...1.0.1)
+
+        **Breaking changes:**
+
+        - issue breaking [\\#8](https://github.com/owner/repo/issue/8)
+        - pr breaking [\\#13](https://github.com/owner/repo/pull/13) ([user5](https://github.com/user5))
+
+        **Implemented enhancements:**
+
+        - issue enhancement [\\#6](https://github.com/owner/repo/issue/6)
+        - issue all the labels [\\#9](https://github.com/owner/repo/issue/9)
+        - pr enhancement [\\#11](https://github.com/owner/repo/pull/11) ([user5](https://github.com/user5))
+        - pr all the labels [\\#14](https://github.com/owner/repo/pull/14) ([user5](https://github.com/user5))
+
+        **Fixed bugs:**
+
+        - issue bug [\\#7](https://github.com/owner/repo/issue/7)
+        - pr bug [\\#12](https://github.com/owner/repo/pull/12) ([user5](https://github.com/user5))
+
+        **Closed issues:**
+
+        - issue no labels [\\#5](https://github.com/owner/repo/issue/5)
+
+        **Merged pull requests:**
+
+        - pr no labels [\\#10](https://github.com/owner/repo/pull/10) ([user1](https://github.com/user1))
+
+        CHANGELOG
+        expect(subject.create_entry_for_tag(pull_requests, issues, "1.0.1", "1.0.1", Time.new(2017, 12, 4), "1.0.0")).to eq(changelog)
+      end
+    end
+    describe "#parse_sections" do
+      before do
+        subject { described_class.new }
+      end
+      context "valid json" do
+        let(:sections_string) { "{ \"foo\": { \"prefix\": \"foofix\", \"labels\": [\"test1\", \"test2\"]}, \"bar\": { \"prefix\": \"barfix\", \"labels\": [\"test3\", \"test4\"]}}" }
+
+        let(:sections_array) do
+          [
+            Section.new(name: "foo", prefix: "foofix", labels: %w[test1 test2]),
+            Section.new(name: "bar", prefix: "barfix", labels: %w[test3 test4])
+          ]
+        end
+
+        it "returns an array with 2 objects" do
+          arr = subject.send(:parse_sections, sections_string)
+          expect(arr.size).to eq 2
+          arr.each { |section| expect(section).to be_an_instance_of Section }
+        end
+
+        it "returns correctly constructed sections" do
+          require "json"
+
+          sections_json = JSON.parse(sections_string)
+          sections_array.each_index do |i|
+            aggregate_failures "checks each component" do
+              expect(sections_array[i].name).to eq sections_json.first[0]
+              expect(sections_array[i].prefix).to eq sections_json.first[1]["prefix"]
+              expect(sections_array[i].labels).to eq sections_json.first[1]["labels"]
+              expect(sections_array[i].issues).to eq []
+            end
+            sections_json.shift
+          end
+        end
+      end
+      context "hash" do
+        let(:sections_hash) do
+          {
+            enhancements: {
+              prefix: "**Enhancements**",
+              labels: %w[feature enhancement]
+            },
+            breaking: {
+              prefix: "**Breaking**",
+              labels: ["breaking"]
+            },
+            bugs: {
+              prefix: "**Bugs**",
+              labels: ["bug"]
+            }
+          }
+        end
+
+        let(:sections_array) do
+          [
+            Section.new(name: "enhancements", prefix: "**Enhancements**", labels: %w[feature enhancement]),
+            Section.new(name: "breaking", prefix: "**Breaking**", labels: ["breaking"]),
+            Section.new(name: "bugs", prefix: "**Bugs**", labels: ["bug"])
+          ]
+        end
+
+        it "returns an array with 3 objects" do
+          arr = subject.send(:parse_sections, sections_hash)
+          expect(arr.size).to eq 3
+          arr.each { |section| expect(section).to be_an_instance_of Section }
+        end
+
+        it "returns correctly constructed sections" do
+          sections_array.each_index do |i|
+            aggregate_failures "checks each component" do
+              expect(sections_array[i].name).to eq sections_hash.first[0].to_s
+              expect(sections_array[i].prefix).to eq sections_hash.first[1][:prefix]
+              expect(sections_array[i].labels).to eq sections_hash.first[1][:labels]
+              expect(sections_array[i].issues).to eq []
+            end
+            sections_hash.shift
+          end
+        end
+      end
+    end
+
+    describe "#parse_by_sections" do
+      context "default sections" do
+        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
+
+        subject { described_class.new(options) }
+
+        before do
+          subject.send(:set_sections_and_maps)
+          @arr = subject.send(:parse_by_sections, pull_requests, issues)
+        end
+
+        it "returns 4 sections" do
+          expect(@arr.size).to eq 4
+        end
+
+        it "returns default sections" do
+          default_sections.each { |default_section| expect(@arr.select { |section| section.name == default_section }.size).to eq 1 }
+        end
+
+        it "assigns issues to the correct sections" do
+          breaking_section = @arr.select { |section| section.name == "breaking" }[0]
+          enhancement_section = @arr.select { |section| section.name == "enhancements" }[0]
+          issue_section = @arr.select { |section| section.name == "issues" }[0]
+          bug_section = @arr.select { |section| section.name == "bugs" }[0]
+
+          expect(titles_for(breaking_section.issues)).to eq(["issue breaking", "pr breaking"])
+          expect(titles_for(enhancement_section.issues)).to eq(["issue enhancement", "issue all the labels", "pr enhancement", "pr all the labels"])
+          expect(titles_for(issue_section.issues)).to eq(["issue no labels"])
+          expect(titles_for(bug_section.issues)).to eq(["issue bug", "pr bug"])
+          expect(titles_for(pull_requests)).to eq(["pr no labels"])
+        end
+      end
+      context "configure sections" do
+        let(:options) do
+          {
+            configure_sections: "{ \"foo\": { \"prefix\": \"foofix\", \"labels\": [\"test1\", \"test2\"]}, \"bar\": { \"prefix\": \"barfix\", \"labels\": [\"test3\", \"test4\"]}}"
+          }
+        end
+
+        let(:issues) do
+          [
+            issue("no labels", []),
+            issue("test1", ["test1"]),
+            issue("test3", ["test3"]),
+            issue("test4", ["test4"]),
+            issue("all the labels", %w[test1 test2 test3 test4])
+          ]
+        end
+
+        let(:pull_requests) do
+          [
+            pr("no labels", []),
+            pr("test1", ["test1"]),
+            pr("test3", ["test3"]),
+            pr("test4", ["test4"]),
+            pr("all the labels", %w[test1 test2 test3 test4])
+          ]
+        end
+
+        subject { described_class.new(options) }
+
+        before do
+          subject.send(:set_sections_and_maps)
+          @arr = subject.send(:parse_by_sections, pull_requests, issues)
+        end
+
+        it "returns 2 sections" do
+          expect(@arr.size).to eq 2
+        end
+
+        it "returns only configured sections" do
+          expect(@arr.select { |section| section.name == "foo" }.size).to eq 1
+          expect(@arr.select { |section| section.name == "bar" }.size).to eq 1
+        end
+
+        it "assigns issues to the correct sections" do
+          foo_section = @arr.select { |section| section.name == "foo" }[0]
+          bar_section = @arr.select { |section| section.name == "bar" }[0]
+
+          aggregate_failures "checks all sections" do
+            expect(titles_for(foo_section.issues)).to eq(["issue test1", "issue all the labels", "pr test1", "pr all the labels"])
+            expect(titles_for(bar_section.issues)).to eq(["issue test3", "issue test4", "pr test3", "pr test4"])
+            expect(titles_for(pull_requests)).to eq(["pr no labels"])
+          end
+        end
+      end
+      context "add sections" do
+        let(:options) do
+          {
+            bug_labels: ["bug"],
+            enhancement_labels: ["enhancement"],
+            breaking_labels: ["breaking"],
+            add_sections: "{ \"foo\": { \"prefix\": \"foofix\", \"labels\": [\"test1\", \"test2\"]}}"
+          }
+        end
+
+        let(:issues) do
+          [
+            issue("no labels", []),
+            issue("test1", ["test1"]),
+            issue("bugaboo", ["bug"]),
+            issue("all the labels", %w[test1 test2 enhancement bug])
+          ]
+        end
+
+        let(:pull_requests) do
+          [
+            pr("no labels", []),
+            pr("test1", ["test1"]),
+            pr("enhance", ["enhancement"]),
+            pr("all the labels", %w[test1 test2 enhancement bug])
+          ]
+        end
+
+        subject { described_class.new(options) }
+
+        before do
+          subject.send(:set_sections_and_maps)
+          @arr = subject.send(:parse_by_sections, pull_requests, issues)
+        end
+
+        it "returns 5 sections" do
+          expect(@arr.size).to eq 5
+        end
+
+        it "returns default sections" do
+          default_sections.each { |default_section| expect(@arr.select { |section| section.name == default_section }.size).to eq 1 }
+        end
+
+        it "returns added section" do
+          expect(@arr.select { |section| section.name == "foo" }.size).to eq 1
+        end
+
+        it "assigns issues to the correct sections" do
+          foo_section = @arr.select { |section| section.name == "foo" }[0]
+          enhancement_section = @arr.select { |section| section.name == "enhancements" }[0]
+          bug_section = @arr.select { |section| section.name == "bugs" }[0]
+
+          aggregate_failures "checks all sections" do
+            expect(titles_for(foo_section.issues)).to eq(["issue test1", "issue all the labels", "pr test1", "pr all the labels"])
+            expect(titles_for(enhancement_section.issues)).to eq(["pr enhance"])
+            expect(titles_for(bug_section.issues)).to eq(["issue bugaboo"])
+            expect(titles_for(pull_requests)).to eq(["pr no labels"])
+          end
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ModuleLength

spec/unit/generator/generator_processor_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module GitHubChangelogGenerator
+  describe Generator do
+    let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
+    let(:options) { {} }
+    let(:generator) { described_class.new(default_options.merge(options)) }
+
+    let(:bad_label) { { "name" => "BAD" } }
+    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] }
+
+    describe "#exclude_issues_by_labels" do
+      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
+        subject(:generator) { described_class.new }
+        it "passes everything through when no option given" do
+          result = generator.exclude_issues_by_labels(issues)
+
+          expect(result).to eq(issues)
+        end
+      end
+    end
+
+    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

@@ -0,0 +1,310 @@
+# frozen_string_literal: true
+
+describe GitHubChangelogGenerator::Generator do
+  def tag_with_name(tag)
+    {
+      "name" => tag
+    }
+  end
+
+  def tags_from_strings(tags_strings)
+    tags_strings.map do |tag|
+      tag_with_name(tag)
+    end
+  end
+
+  describe "#tag_section_mapping" do
+    let(:all_tags) { tags_from_strings(%w[8 7 6 5 4 3 2 1]) }
+    let(:sorted_tags) { all_tags }
+
+    let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
+    let(:options) { {} }
+    let(:generator) { described_class.new(default_options.merge(options)) }
+
+    before do
+      allow_any_instance_of(GitHubChangelogGenerator::OctoFetcher).to receive(:get_all_tags).and_return(all_tags)
+      allow(generator).to receive(:fetch_tags_dates).with(all_tags)
+      allow(generator).to receive(:sort_tags_by_date).with(all_tags).and_return(sorted_tags)
+      generator.fetch_and_filter_tags
+    end
+
+    subject do
+      generator.tag_section_mapping
+    end
+
+    shared_examples_for "a section mapping" do
+      it { is_expected.to be_a(Hash) }
+      it { is_expected.to eq(expected_mapping) }
+    end
+
+    shared_examples_for "a full changelog" do
+      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])) }
+
+    context "with matching string" do
+      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])) }
+    end
+
+    context "with non-matching string" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w[invalid tags]) }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(tags_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])) }
+    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])) }
+    end
+  end
+
+  describe "#filter_excluded_tags_regex" do
+    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])) }
+    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])) }
+    end
+  end
+
+  describe "#filter_since_tag" do
+    context "with filled array" do
+      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 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])) }
+      end
+    end
+
+    context "with empty array" do
+      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[])) }
+      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[])) }
+      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])) }
+
+      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])) }
+      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])) }
+      end
+    end
+
+    context "with empty array" do
+      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[])) }
+      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[])) }
+      end
+    end
+  end
+
+  describe "#get_time_of_tag" do
+    current_time = Time.now
+    before(:all) { @generator = GitHubChangelogGenerator::Generator.new }
+    context "run with nil parameter" do
+      it "should raise ChangelogGeneratorError" do
+        expect { @generator.get_time_of_tag nil }.to raise_error(GitHubChangelogGenerator::ChangelogGeneratorError)
+      end
+    end
+    context "fetch already filled tag" do
+      before { @generator.instance_variable_set :@tag_times_hash, "valid_tag" => current_time }
+      subject { @generator.get_time_of_tag tag_with_name("valid_tag") }
+      it { is_expected.to be_a_kind_of(Time) }
+      it { is_expected.to eq(current_time) }
+    end
+    context "fetch not filled tag" do
+      before do
+        mock = double("fake fetcher")
+        allow(mock).to receive_messages(fetch_date_of_tag: current_time)
+        @generator.instance_variable_set :@fetcher, mock
+      end
+      subject do
+        of_tag = @generator.get_time_of_tag(tag_with_name("valid_tag"))
+        of_tag
+      end
+      it { is_expected.to be_a_kind_of(Time) }
+      it { is_expected.to eq(current_time) }
+    end
+  end
+
+  describe "#sort_tags_by_date" do
+    let(:time1) { Time.now }
+    let(:time2) { Time.now }
+    let(:time3) { Time.now }
+
+    before(:all) do
+      @generator = GitHubChangelogGenerator::Generator.new
+    end
+
+    before do
+      @generator.instance_variable_set(:@tag_times_hash, "valid_tag1" => time1,
+                                                         "valid_tag2" => time2,
+                                                         "valid_tag3" => time3)
+    end
+
+    subject do
+      @generator.sort_tags_by_date(tags)
+    end
+    context "sort unsorted tags" do
+      let(:tags) { tags_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] }
+
+      it { is_expected.to be_a_kind_of(Array) }
+      it { is_expected.to match_array(tags) }
+    end
+  end
+end

spec/unit/octo_fetcher_spec.rb

@@ -0,0 +1,543 @@
+# frozen_string_literal: true
+
+VALID_TOKEN = "0123456789abcdef"
+INVALID_TOKEN = "0000000000000000"
+
+describe GitHubChangelogGenerator::OctoFetcher do
+  let(:options) do
+    {
+      user: "skywinder",
+      project: "changelog_test"
+    }
+  end
+
+  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
+      before { stub_const("ENV", ENV.to_hash.merge(token => VALID_TOKEN)) }
+      subject { fetcher.send(:fetch_github_token) }
+      it { is_expected.to eq(VALID_TOKEN) }
+    end
+
+    context "when token in ENV is nil" do
+      before { stub_const("ENV", ENV.to_hash.merge(token => nil)) }
+      subject { fetcher.send(:fetch_github_token) }
+      it { is_expected.to be_nil }
+    end
+
+    context "when token in options and ENV is nil" do
+      let(:options) { { token: VALID_TOKEN } }
+
+      before do
+        stub_const("ENV", ENV.to_hash.merge(token => nil))
+      end
+
+      subject { fetcher.send(:fetch_github_token) }
+      it { is_expected.to eq(VALID_TOKEN) }
+    end
+
+    context "when token in options and ENV specified" do
+      let(:options) { { token: VALID_TOKEN } }
+
+      before do
+        stub_const("ENV", ENV.to_hash.merge(token => "no_matter_what"))
+      end
+
+      subject { fetcher.send(:fetch_github_token) }
+      it { is_expected.to eq(VALID_TOKEN) }
+    end
+  end
+
+  describe "#get_all_tags" do
+    context "when github_fetch_tags returns tags" do
+      it "returns tags" do
+        mock_tags = ["tag"]
+        allow(fetcher).to receive(:github_fetch_tags).and_return(mock_tags)
+        expect(fetcher.get_all_tags).to eq(mock_tags)
+      end
+    end
+  end
+
+  describe "#github_fetch_tags" do
+    context "when wrong token provided", :vcr do
+      let(:options) do
+        {
+          user: "skywinder",
+          project: "changelog_test",
+          token: INVALID_TOKEN
+        }
+      end
+
+      it "should raise Unauthorized error" do
+        expect { fetcher.github_fetch_tags }.to raise_error SystemExit, "Error: wrong GitHub token"
+      end
+    end
+
+    context "when API call is valid", :vcr do
+      it "should return tags" do
+        expected_tags = [{ "name"        => "v0.0.3",
+                           "zipball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.3",
+                           "tarball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.3",
+                           "commit"      =>
+                             { "sha" => "a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90",
+                               "url" =>
+                                 "https://api.github.com/repos/skywinder/changelog_test/commits/a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90" } },
+                         { "name"        => "v0.0.2",
+                           "zipball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.2",
+                           "tarball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.2",
+                           "commit"      =>
+                             { "sha" => "9b35bb13dcd15b68e7bcbf10cde5eb937a54f710",
+                               "url" =>
+                                 "https://api.github.com/repos/skywinder/changelog_test/commits/9b35bb13dcd15b68e7bcbf10cde5eb937a54f710" } },
+                         { "name"        => "v0.0.1",
+                           "zipball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.1",
+                           "tarball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.1",
+                           "commit"      =>
+                             { "sha" => "4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d",
+                               "url" =>
+                                 "https://api.github.com/repos/skywinder/changelog_test/commits/4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d" } },
+                         { "name"        => "0.0.4",
+                           "zipball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/zipball/0.0.4",
+                           "tarball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/tarball/0.0.4",
+                           "commit"      =>
+                             { "sha" => "ece0c3ab7142b21064b885061c55ede00ef6ce94",
+                               "url" =>
+                                 "https://api.github.com/repos/skywinder/changelog_test/commits/ece0c3ab7142b21064b885061c55ede00ef6ce94" } }]
+
+        expect(fetcher.github_fetch_tags).to eq(expected_tags)
+      end
+
+      it "should return tags count" do
+        tags = fetcher.github_fetch_tags
+        expect(tags.size).to eq(4)
+      end
+    end
+  end
+
+  describe "#fetch_closed_issues_and_pr" do
+    context "when API call is valid", :vcr do
+      it "returns issues" do
+        issues, pull_requests = fetcher.fetch_closed_issues_and_pr
+        expect(issues.size).to eq(7)
+        expect(pull_requests.size).to eq(14)
+      end
+
+      it "returns issue with proper key/values" do
+        issues, _pull_requests = fetcher.fetch_closed_issues_and_pr
+
+        expected_issue = { "url"            => "https://api.github.com/repos/skywinder/changelog_test/issues/14",
+                           "repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
+                           "labels_url"     =>
+                             "https://api.github.com/repos/skywinder/changelog_test/issues/14/labels{/name}",
+                           "comments_url"   =>
+                             "https://api.github.com/repos/skywinder/changelog_test/issues/14/comments",
+                           "events_url"     =>
+                             "https://api.github.com/repos/skywinder/changelog_test/issues/14/events",
+                           "html_url"       => "https://github.com/skywinder/changelog_test/issues/14",
+                           "id"             => 95_419_412,
+                           "number"         => 14,
+                           "title"          => "Issue closed from commit from PR",
+                           "user"           =>
+                             { "login"               => "skywinder",
+                               "id"                  => 3_356_474,
+                               "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                               "gravatar_id"         => "",
+                               "url"                 => "https://api.github.com/users/skywinder",
+                               "html_url"            => "https://github.com/skywinder",
+                               "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                               "following_url"       =>
+                                 "https://api.github.com/users/skywinder/following{/other_user}",
+                               "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                               "starred_url"         =>
+                                 "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                               "subscriptions_url"   => "https://api.github.com/users/skywinder/subscriptions",
+                               "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                               "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                               "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                               "received_events_url" =>
+                                 "https://api.github.com/users/skywinder/received_events",
+                               "type"                => "User",
+                               "site_admin"          => false },
+                           "labels"         => [],
+                           "state"          => "closed",
+                           "locked"         => false,
+                           "assignee"       => nil,
+                           "assignees" => [],
+                           "milestone"      => nil,
+                           "comments"       => 0,
+                           "created_at"     => "2015-07-16T12:06:08Z",
+                           "updated_at"     => "2015-07-16T12:21:42Z",
+                           "closed_at"      => "2015-07-16T12:21:42Z",
+                           "body"           => "" }
+
+        # Convert times to Time
+        expected_issue.each_pair do |k, v|
+          expected_issue[k] = Time.parse(v) if v =~ /^2015-/
+        end
+
+        expect(issues.first).to eq(expected_issue)
+      end
+
+      it "returns pull request with proper key/values" do
+        _issues, pull_requests = fetcher.fetch_closed_issues_and_pr
+
+        expected_pr = { "url"            => "https://api.github.com/repos/skywinder/changelog_test/issues/21",
+                        "repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
+                        "labels_url"     =>
+                          "https://api.github.com/repos/skywinder/changelog_test/issues/21/labels{/name}",
+                        "comments_url"   =>
+                          "https://api.github.com/repos/skywinder/changelog_test/issues/21/comments",
+                        "events_url"     =>
+                          "https://api.github.com/repos/skywinder/changelog_test/issues/21/events",
+                        "html_url"       => "https://github.com/skywinder/changelog_test/pull/21",
+                        "id"             => 124_925_759,
+                        "number"         => 21,
+                        "title"          => "Merged br (should appear in change log with  #20)",
+                        "user"           =>
+                          { "login"               => "skywinder",
+                            "id"                  => 3_356_474,
+                            "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                            "gravatar_id"         => "",
+                            "url"                 => "https://api.github.com/users/skywinder",
+                            "html_url"            => "https://github.com/skywinder",
+                            "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                            "following_url"       =>
+                              "https://api.github.com/users/skywinder/following{/other_user}",
+                            "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                            "starred_url"         =>
+                              "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                            "subscriptions_url"   => "https://api.github.com/users/skywinder/subscriptions",
+                            "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                            "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                            "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                            "received_events_url" =>
+                              "https://api.github.com/users/skywinder/received_events",
+                            "type"                => "User",
+                            "site_admin"          => false },
+                        "labels"         => [],
+                        "state"          => "closed",
+                        "locked"         => false,
+                        "assignee"       => nil,
+                        "assignees" => [],
+                        "milestone"      => nil,
+                        "comments"       => 0,
+                        "created_at"     => "2016-01-05T09:24:08Z",
+                        "updated_at"     => "2016-01-05T09:26:53Z",
+                        "closed_at"      => "2016-01-05T09:24:27Z",
+                        "pull_request"   =>
+                          { "url"       => "https://api.github.com/repos/skywinder/changelog_test/pulls/21",
+                            "html_url"  => "https://github.com/skywinder/changelog_test/pull/21",
+                            "diff_url"  => "https://github.com/skywinder/changelog_test/pull/21.diff",
+                            "patch_url" => "https://github.com/skywinder/changelog_test/pull/21.patch" },
+                        "body"           =>
+                          "to test https://github.com/skywinder/github-changelog-generator/pull/305\r\nshould appear in change log with #20" }
+
+        # Convert times to Time
+        expected_pr.each_pair do |k, v|
+          expected_pr[k] = Time.parse(v) if v =~ /^2016-01/
+        end
+
+        expect(pull_requests.first).to eq(expected_pr)
+      end
+
+      it "returns issues with labels" do
+        issues, _pull_requests = fetcher.fetch_closed_issues_and_pr
+        expected = [[], [], ["Bug"], [], ["enhancement"], ["some label"], []]
+        expect(issues.map { |i| i["labels"].map { |l| l["name"] } }).to eq(expected)
+      end
+
+      it "returns pull_requests with labels" do
+        _issues, pull_requests = fetcher.fetch_closed_issues_and_pr
+        expected = [[], [], [], [], [], ["enhancement"], [], [], ["invalid"], [], [], [], [], ["invalid"]]
+        expect(pull_requests.map { |i| i["labels"].map { |l| l["name"] } }).to eq(expected)
+      end
+    end
+  end
+
+  describe "#fetch_closed_pull_requests" do
+    context "when API call is valid", :vcr do
+      it "returns pull requests" do
+        pull_requests = fetcher.fetch_closed_pull_requests
+        expect(pull_requests.size).to eq(14)
+      end
+
+      it "returns correct pull request keys" 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])
+      end
+    end
+  end
+
+  describe "#fetch_events_async" do
+    context "when API call is valid", :vcr do
+      it "populates issues" do
+        issues = [{ "url"            => "https://api.github.com/repos/skywinder/changelog_test/issues/14",
+                    "repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
+                    "labels_url"     =>
+                      "https://api.github.com/repos/skywinder/changelog_test/issues/14/labels{/name}",
+                    "comments_url"   =>
+                      "https://api.github.com/repos/skywinder/changelog_test/issues/14/comments",
+                    "events_url"     =>
+                      "https://api.github.com/repos/skywinder/changelog_test/issues/14/events",
+                    "html_url"       => "https://github.com/skywinder/changelog_test/issues/14",
+                    "id"             => 95_419_412,
+                    "number"         => 14,
+                    "title"          => "Issue closed from commit from PR",
+                    "user"           =>
+                      { "login"               => "skywinder",
+                        "id"                  => 3_356_474,
+                        "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                        "gravatar_id"         => "",
+                        "url"                 => "https://api.github.com/users/skywinder",
+                        "html_url"            => "https://github.com/skywinder",
+                        "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                        "following_url"       =>
+                          "https://api.github.com/users/skywinder/following{/other_user}",
+                        "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                        "starred_url"         =>
+                          "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                        "subscriptions_url"   =>
+                          "https://api.github.com/users/skywinder/subscriptions",
+                        "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                        "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                        "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                        "received_events_url" =>
+                          "https://api.github.com/users/skywinder/received_events",
+                        "type"                => "User",
+                        "site_admin"          => false },
+                    "labels"         => [],
+                    "state"          => "closed",
+                    "locked"         => false,
+                    "assignee"       => nil,
+                    "assignees" => [],
+                    "milestone"      => nil,
+                    "comments"       => 0,
+                    "created_at"     => "2015-07-16T12:06:08Z",
+                    "updated_at"     => "2015-07-16T12:21:42Z",
+                    "closed_at"      => "2015-07-16T12:21:42Z",
+                    "body"           => "" }]
+
+        # Check that they are blank to begin with
+        expect(issues.first["events"]).to be_nil
+
+        fetcher.fetch_events_async(issues)
+        issue_events = issues.first["events"]
+
+        expected_events = [{ "id"         => 357_462_189,
+                             "url"        =>
+                               "https://api.github.com/repos/skywinder/changelog_test/issues/events/357462189",
+                             "actor"      =>
+                               { "login"               => "skywinder",
+                                 "id"                  => 3_356_474,
+                                 "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                                 "gravatar_id"         => "",
+                                 "url"                 => "https://api.github.com/users/skywinder",
+                                 "html_url"            => "https://github.com/skywinder",
+                                 "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                                 "following_url"       =>
+                                   "https://api.github.com/users/skywinder/following{/other_user}",
+                                 "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                                 "starred_url"         =>
+                                   "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                                 "subscriptions_url"   =>
+                                   "https://api.github.com/users/skywinder/subscriptions",
+                                 "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                                 "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                                 "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                                 "received_events_url" =>
+                                   "https://api.github.com/users/skywinder/received_events",
+                                 "type"                => "User",
+                                 "site_admin"          => false },
+                             "event"      => "referenced",
+                             "commit_id"  => "decfe840d1a1b86e0c28700de5362d3365a29555",
+                             "commit_url" =>
+                               "https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
+                             "created_at" => "2015-07-16T12:21:16Z" },
+                           { "id"         => 357_462_542,
+                             "url"        =>
+                               "https://api.github.com/repos/skywinder/changelog_test/issues/events/357462542",
+                             "actor"      =>
+                               { "login"               => "skywinder",
+                                 "id"                  => 3_356_474,
+                                 "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                                 "gravatar_id"         => "",
+                                 "url"                 => "https://api.github.com/users/skywinder",
+                                 "html_url"            => "https://github.com/skywinder",
+                                 "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                                 "following_url"       =>
+                                   "https://api.github.com/users/skywinder/following{/other_user}",
+                                 "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                                 "starred_url"         =>
+                                   "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                                 "subscriptions_url"   =>
+                                   "https://api.github.com/users/skywinder/subscriptions",
+                                 "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                                 "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                                 "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                                 "received_events_url" =>
+                                   "https://api.github.com/users/skywinder/received_events",
+                                 "type"                => "User",
+                                 "site_admin"          => false },
+                             "event"      => "closed",
+                             "commit_id"  => "decfe840d1a1b86e0c28700de5362d3365a29555",
+                             "commit_url" =>
+                               "https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
+                             "created_at" => "2015-07-16T12:21:42Z" }]
+
+        # Convert times to Time
+        expected_events.map! do |event|
+          event.each_pair do |k, v|
+            event[k] = Time.parse(v) if v =~ /^201[56]-/
+          end
+        end
+
+        expect(issue_events).to eq(expected_events)
+      end
+    end
+  end
+
+  describe "#fetch_date_of_tag" do
+    context "when API call is valid", :vcr do
+      it "returns date" do
+        tag = { "name"        => "v0.0.3",
+                "zipball_url" =>
+                  "https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.3",
+                "tarball_url" =>
+                  "https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.3",
+                "commit"      =>
+                  { "sha" => "a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90",
+                    "url" =>
+                      "https://api.github.com/repos/skywinder/changelog_test/commits/a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90" } }
+
+        dt = fetcher.fetch_date_of_tag(tag)
+        expect(dt).to eq(Time.parse("2015-03-04 19:01:48 UTC"))
+      end
+    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
+        event = { "id"         => 357_462_189,
+                  "url"        =>
+                    "https://api.github.com/repos/skywinder/changelog_test/issues/events/357462189",
+                  "actor"      =>
+                    { "login"               => "skywinder",
+                      "id"                  => 3_356_474,
+                      "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                      "gravatar_id"         => "",
+                      "url"                 => "https://api.github.com/users/skywinder",
+                      "html_url"            => "https://github.com/skywinder",
+                      "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                      "following_url"       =>
+                        "https://api.github.com/users/skywinder/following{/other_user}",
+                      "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                      "starred_url"         =>
+                        "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                      "subscriptions_url"   => "https://api.github.com/users/skywinder/subscriptions",
+                      "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                      "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                      "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                      "received_events_url" =>
+                        "https://api.github.com/users/skywinder/received_events",
+                      "type"                => "User",
+                      "site_admin"          => false },
+                  "event"      => "referenced",
+                  "commit_id"  => "decfe840d1a1b86e0c28700de5362d3365a29555",
+                  "commit_url" =>
+                    "https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
+                  "created_at" => "2015-07-16T12:21:16Z" }
+        commit = fetcher.fetch_commit(event)
+
+        expectations = [
+          %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"],
+          ["html_url",
+           "https://github.com/skywinder/changelog_test/commit/decfe840d1a1b86e0c28700de5362d3365a29555"],
+          ["author",
+           { "login" => "skywinder", "id" => 3_356_474, "avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
+          ["committer",
+           { "login" => "skywinder", "id" => 3_356_474, "avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
+          ["parents",
+           [{ "sha" => "7ec095e5e3caceacedabf44d0b9b10da17c92e51",
+              "url" =>
+               "https://api.github.com/repos/skywinder/changelog_test/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
+              # OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
+              "html_url" =>
+               "https://github.com/skywinder/changelog_test/commit/7ec095e5e3caceacedabf44d0b9b10da17c92e51" }]]
+        ]
+
+        expectations.each do |property, val|
+          expect(commit[property]).to eq(val)
+        end
+      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

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

spec/unit/parser_spec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+describe GitHubChangelogGenerator::Parser do
+end

spec/unit/reader_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Author:: Enrico Stahn <mail@enricostahn.com>
 #
@@ -21,73 +23,69 @@ describe GitHubChangelogGenerator::Reader do
     @reader = GitHubChangelogGenerator::Reader.new
   end
 
-  describe '#parse_heading' do
+  describe "#parse_heading" do
-    context 'when heading is empty' do
+    context "when heading is empty" do
-      subject { @reader.parse_heading('## ') }
+      subject { @reader.parse_heading("## ") }
       it { is_expected.to be_a(Hash) }
-      it { is_expected.to include('version', 'url', 'date') }
+      it { is_expected.to include("version", "url", "date") }
-      it { is_expected.to include('version' => nil, 'url' => nil, 'date' => nil) }
+      it { is_expected.to include("version" => nil, "url" => nil, "date" => nil) }
       # TODO: Doesn't work?
       # it { is_expected.to have_all_string_keys }
     end
-    context 'when given version, url and date' do
+    context "when given version, url and date" do
-      subject { @reader.parse_heading('## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)') }
+      subject { @reader.parse_heading("## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)") }
-      it { is_expected.to include('version' => '1.3.10') }
+      it { is_expected.to include("version" => "1.3.10") }
-      it { is_expected.to include('url' => 'https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10') }
+      it { is_expected.to include("url" => "https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10") }
-      it { is_expected.to include('date' => '2015-03-18') }
+      it { is_expected.to include("date" => "2015-03-18") }
     end
-    context 'when no url and date is provided' do
+    context "when no url and date is provided" do
-      subject { @reader.parse_heading('## foobar') }
+      subject { @reader.parse_heading("## foobar") }
-      it { is_expected.to include('version' => 'foobar', 'url' => nil, 'date' => nil) }
+      it { is_expected.to include("version" => "foobar", "url" => nil, "date" => nil) }
     end
   end
 
-  describe '#parse' do
+  describe "#parse" do
-    context 'when file is empty' do
+    context "when file is empty" do
-      subject { @reader.parse('') }
+      subject { @reader.parse("") }
       it { is_expected.to be_an(Array) }
       it { is_expected.to be_empty }
     end
-    context 'when file has only the header' do
+    context "when file has only the header" do
-      subject { @reader.parse('# Change Log') }
+      subject { @reader.parse("# Changelog") }
       it { is_expected.to be_an(Array) }
       it { is_expected.to be_empty }
     end
   end
 
-  describe 'example CHANGELOG files' do
+  describe "example CHANGELOG files" do
-    subject { @reader.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'files', self.class.description))) }
+    subject { @reader.read(File.expand_path(File.join(File.dirname(__FILE__), "..", "files", self.class.description))) }
-    context 'github-changelog-generator.md' do
+    context "github-changelog-generator.md" do
       it { is_expected.to be_an(Array) }
       it { is_expected.not_to be_empty }
       it { expect(subject.count).to eq(28) }
-      it { expect(subject.first).to include('version' => '1.3.10') }
+      it { expect(subject.first).to include("version" => "1.3.10") }
-      it { expect(subject.first).to include('url' => 'https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10') }
+      it { expect(subject.first).to include("url" => "https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10") }
-      it { expect(subject.first).to include('date' => '2015-03-18') }
+      it { expect(subject.first).to include("date" => "2015-03-18") }
-      it { expect(subject.first).to include('content') }
+      it { expect(subject.first).to include("content") }
-      it 'content should not be empty' do
+      it "content should not be empty" do
-        expect(subject.first['content']).not_to be_empty
+        expect(subject.first["content"]).not_to be_empty
       end
     end
-    context 'bundler.md' do
+    context "bundler.md" do
       it { is_expected.to be_an(Array) }
       it { is_expected.not_to be_empty }
       it { expect(subject.count).to eq(151) }
-      it { expect(subject.first).to include('version' => '1.9.1') }
+      it { expect(subject.first).to include("version" => "1.9.1") }
-      it { expect(subject.first).to include('url' => nil) }
+      it { expect(subject.first).to include("url" => nil) }
-      it { expect(subject.first).to include('date' => '2015-03-21') }
+      it { expect(subject.first).to include("date" => "2015-03-21") }
-      it { expect(subject.first).to include('content') }
+      it { expect(subject.first).to include("content") }
-      it 'content should not be empty' do
+      it "content should not be empty" do
-        expect(subject.first['content']).not_to be_empty
+        expect(subject.first["content"]).not_to be_empty
       end
     end
-    context 'angular.js.md' 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')

spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_events_async/when_API_call_is_valid.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/issues/14/events?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Server":["GitHub.com"],"Date":["Fri, 20 May 2016 06:13:06 GMT"],"Content-Type":["application/json; charset=utf-8"],"Transfer-Encoding":["chunked"],"Status":["200 OK"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["37"],"X-Ratelimit-Reset":["1463724861"],"Cache-Control":["public, max-age=60, s-maxage=60"],"Vary":["Accept","Accept-Encoding"],"Etag":["W/\"4d408c4e8053c706d7255563141ccb80\""],"X-Github-Media-Type":["github.v3; format=json"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Served-By":["2d7a5e35115884240089368322196939"],"X-Github-Request-Id":["6C2F0F69:7F8B:2084B01:573EAAF2"]},"body":{"encoding":"ASCII-8BIT","base64_string":"W3siaWQiOjM1NzQ2MjE4OSwidXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNv\nbS9yZXBvcy9za3l3aW5kZXIvY2hhbmdlbG9nX3Rlc3QvaXNzdWVzL2V2ZW50\ncy8zNTc0NjIxODkiLCJhY3RvciI6eyJsb2dpbiI6InNreXdpbmRlciIsImlk\nIjozMzU2NDc0LCJhdmF0YXJfdXJsIjoiaHR0cHM6Ly9hdmF0YXJzLmdpdGh1\nYnVzZXJjb250ZW50LmNvbS91LzMzNTY0NzQ/dj0zIiwiZ3JhdmF0YXJfaWQi\nOiIiLCJ1cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdp\nbmRlciIsImh0bWxfdXJsIjoiaHR0cHM6Ly9naXRodWIuY29tL3NreXdpbmRl\nciIsImZvbGxvd2Vyc191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3Vz\nZXJzL3NreXdpbmRlci9mb2xsb3dlcnMiLCJmb2xsb3dpbmdfdXJsIjoiaHR0\ncHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvZm9sbG93aW5n\ney9vdGhlcl91c2VyfSIsImdpc3RzX3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1\nYi5jb20vdXNlcnMvc2t5d2luZGVyL2dpc3Rzey9naXN0X2lkfSIsInN0YXJy\nZWRfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5k\nZXIvc3RhcnJlZHsvb3duZXJ9ey9yZXBvfSIsInN1YnNjcmlwdGlvbnNfdXJs\nIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvc3Vi\nc2NyaXB0aW9ucyIsIm9yZ2FuaXphdGlvbnNfdXJsIjoiaHR0cHM6Ly9hcGku\nZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvb3JncyIsInJlcG9zX3VybCI6\nImh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMvc2t5d2luZGVyL3JlcG9z\nIiwiZXZlbnRzX3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMv\nc2t5d2luZGVyL2V2ZW50c3svcHJpdmFjeX0iLCJyZWNlaXZlZF9ldmVudHNf\ndXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIv\ncmVjZWl2ZWRfZXZlbnRzIiwidHlwZSI6IlVzZXIiLCJzaXRlX2FkbWluIjpm\nYWxzZX0sImV2ZW50IjoicmVmZXJlbmNlZCIsImNvbW1pdF9pZCI6ImRlY2Zl\nODQwZDFhMWI4NmUwYzI4NzAwZGU1MzYyZDMzNjVhMjk1NTUiLCJjb21taXRf\ndXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS9yZXBvcy9za3l3aW5kZXIv\nY2hhbmdlbG9nX3Rlc3QvY29tbWl0cy9kZWNmZTg0MGQxYTFiODZlMGMyODcw\nMGRlNTM2MmQzMzY1YTI5NTU1IiwiY3JlYXRlZF9hdCI6IjIwMTUtMDctMTZU\nMTI6MjE6MTZaIn0seyJpZCI6MzU3NDYyNTQyLCJ1cmwiOiJodHRwczovL2Fw\naS5naXRodWIuY29tL3JlcG9zL3NreXdpbmRlci9jaGFuZ2Vsb2dfdGVzdC9p\nc3N1ZXMvZXZlbnRzLzM1NzQ2MjU0MiIsImFjdG9yIjp7ImxvZ2luIjoic2t5\nd2luZGVyIiwiaWQiOjMzNTY0NzQsImF2YXRhcl91cmwiOiJodHRwczovL2F2\nYXRhcnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tL3UvMzM1NjQ3ND92PTMiLCJn\ncmF2YXRhcl9pZCI6IiIsInVybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20v\ndXNlcnMvc2t5d2luZGVyIiwiaHRtbF91cmwiOiJodHRwczovL2dpdGh1Yi5j\nb20vc2t5d2luZGVyIiwiZm9sbG93ZXJzX3VybCI6Imh0dHBzOi8vYXBpLmdp\ndGh1Yi5jb20vdXNlcnMvc2t5d2luZGVyL2ZvbGxvd2VycyIsImZvbGxvd2lu\nZ191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdpbmRl\nci9mb2xsb3dpbmd7L290aGVyX3VzZXJ9IiwiZ2lzdHNfdXJsIjoiaHR0cHM6\nLy9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvZ2lzdHN7L2dpc3Rf\naWR9Iiwic3RhcnJlZF91cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3Vz\nZXJzL3NreXdpbmRlci9zdGFycmVkey9vd25lcn17L3JlcG99Iiwic3Vic2Ny\naXB0aW9uc191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3Nr\neXdpbmRlci9zdWJzY3JpcHRpb25zIiwib3JnYW5pemF0aW9uc191cmwiOiJo\ndHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdpbmRlci9vcmdzIiwi\ncmVwb3NfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3\naW5kZXIvcmVwb3MiLCJldmVudHNfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHVi\nLmNvbS91c2Vycy9za3l3aW5kZXIvZXZlbnRzey9wcml2YWN5fSIsInJlY2Vp\ndmVkX2V2ZW50c191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJz\nL3NreXdpbmRlci9yZWNlaXZlZF9ldmVudHMiLCJ0eXBlIjoiVXNlciIsInNp\ndGVfYWRtaW4iOmZhbHNlfSwiZXZlbnQiOiJjbG9zZWQiLCJjb21taXRfaWQi\nOiJkZWNmZTg0MGQxYTFiODZlMGMyODcwMGRlNTM2MmQzMzY1YTI5NTU1Iiwi\nY29tbWl0X3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vcmVwb3Mvc2t5\nd2luZGVyL2NoYW5nZWxvZ190ZXN0L2NvbW1pdHMvZGVjZmU4NDBkMWExYjg2\nZTBjMjg3MDBkZTUzNjJkMzM2NWEyOTU1NSIsImNyZWF0ZWRfYXQiOiIyMDE1\nLTA3LTE2VDEyOjIxOjQyWiJ9XQ==\n"},"http_version":null},"recorded_at":"Fri, 20 May 2016 06:13:10 GMT"}],"recorded_with":"VCR 3.0.1"}

spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_wrong_token_provided.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/tags?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Authorization":["token 0000000000000000"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":401,"message":"Unauthorized"},"headers":{"Server":["GitHub.com"],"Date":["Fri, 20 May 2016 05:47:03 GMT"],"Content-Type":["application/json; charset=utf-8"],"Content-Length":["83"],"Status":["401 Unauthorized"],"X-Github-Media-Type":["github.v3; format=json"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["42"],"X-Ratelimit-Reset":["1463724861"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Github-Request-Id":["6C2F0F69:1271A:B8980B7:573EA4D6"]},"body":{"encoding":"UTF-8","base64_string":"eyJtZXNzYWdlIjoiQmFkIGNyZWRlbnRpYWxzIiwiZG9jdW1lbnRhdGlvbl91\ncmwiOiJodHRwczovL2RldmVsb3Blci5naXRodWIuY29tL3YzIn0=\n"},"http_version":null},"recorded_at":"Fri, 20 May 2016 05:47:07 GMT"}],"recorded_with":"VCR 3.0.1"}

spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_wrong_token_provided/should_raise_Unauthorized_error.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/tags?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Authorization":["token 0000000000000000"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":401,"message":"Unauthorized"},"headers":{"Server":["GitHub.com"],"Date":["Sat, 02 Jul 2016 14:13:57 GMT"],"Content-Type":["application/json; charset=utf-8"],"Content-Length":["83"],"Status":["401 Unauthorized"],"X-Github-Media-Type":["github.v3; format=json"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["59"],"X-Ratelimit-Reset":["1467472437"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Github-Request-Id":["54DBAB83:300E:76DBC85:5777CC25"]},"body":{"encoding":"UTF-8","base64_string":"eyJtZXNzYWdlIjoiQmFkIGNyZWRlbnRpYWxzIiwiZG9jdW1lbnRhdGlvbl91\ncmwiOiJodHRwczovL2RldmVsb3Blci5naXRodWIuY29tL3YzIn0=\n"},"http_version":null},"recorded_at":"Sat, 02 Jul 2016 14:13:58 GMT"}],"recorded_with":"VCR 3.0.1"}