Linting: formatting code to suit RuboCop (#611 )

Update git-generate-changelog.md (#607 )
Update license date (#610 )
2018-01-01 17:02:25 +01:00 · 2018-01-01 16:20:54 +01:00 · 2018-01-01 16:08:34 +01:00 · 2017-12-29 16:17:02 +01:00 · 2017-12-15 16:23:29 +01:00 · 2017-12-15 16:01:04 +01:00
34 changed files with 1589 additions and 968 deletions
--- a/.github_changelog_generator
+++ b/.github_changelog_generator
@ -0,0 +1,2 @@
 project=github-changelog-generator
 user=skywinder
--- a/.rubocop.yml
+++ b/.rubocop.yml
@ -80,3 +80,10 @@ Metrics/BlockLength:
 Lint/InterpolationCheck:
  Enabled: false
 Style/FormatStringToken:
  Exclude:
    - lib/github_changelog_generator/parser.rb
 Style/MixinUsage:
  Exclude:
    - lib/github_changelog_generator/task.rb
--- a/.travis.yml
+++ b/.travis.yml
@ -4,28 +4,23 @@ cache:
 before_install:
  - gem install bundler
 matrix:
  fast_finish: true
  include:
-    - rvm: 2.2.8
+    - rvm: 2.2.7
      install: true # This skips 'bundle install'
      script: gem build github_changelog_generator && gem install *.gem
-    - rvm: 2.2.8
+      after_success: true # This skips 'codeclimate-test-reporter'
    - rvm: 2.2.7
      install: true # This skips 'bundle install'
      script: gem build github_changelog_generator && bundle install
      gemfile: spec/install-gem-in-bundler.gemfile
-    - rvm: 2.3.5
+      after_success: true # This skips 'codeclimate-test-reporter'
-    - rvm: 2.4.2
+    - rvm: 2.3.4
-    - rvm: jruby-9.1.13.0
+    - rvm: 2.4.1
    - rvm: jruby-9.1.15.0
      jdk: oraclejdk8
      env:
        - JRUBY_OPTS=--debug
    - rvm: jruby-head
      jdk: oraclejdk8
      env:
        - JRUBY_OPTS=--debug
        - DEBUG=1
  allow_failures:
    - rvm: jruby-head
  fast_finish: true
 addons:
  code_climate:
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,4 +1,114 @@
-# Change Log
+# Changelog
 ## [v1.15.0-rc](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0-rc) (2017-10-29)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.15.0.pre.beta...v1.15.0-rc)
 **Implemented enhancements:**
 - Add option --require to load custom Ruby code before starting [\#574](https://github.com/skywinder/github-changelog-generator/pull/574) ([olleolleolle](https://github.com/olleolleolle))
 **Fixed bugs:**
 - issue\_line\_labels and breaking\_labels fail as rake file config params [\#583](https://github.com/skywinder/github-changelog-generator/issues/583)
 **Merged pull requests:**
 - Add Rake options reported missing [\#584](https://github.com/skywinder/github-changelog-generator/pull/584) ([olleolleolle](https://github.com/olleolleolle))
 - Aborting on missing --user and --project prints all of usage [\#578](https://github.com/skywinder/github-changelog-generator/pull/578) ([olleolleolle](https://github.com/olleolleolle))
 - Options\#print\_options + API docs for Options, Parser [\#576](https://github.com/skywinder/github-changelog-generator/pull/576) ([olleolleolle](https://github.com/olleolleolle))
 - \[docs\] Contributing file [\#575](https://github.com/skywinder/github-changelog-generator/pull/575) ([olleolleolle](https://github.com/olleolleolle))
 ## [v1.15.0.pre.beta](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0.pre.beta) (2017-10-13)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.15.0.pre.alpha...v1.15.0.pre.beta)
 **Implemented enhancements:**
 - add breaking-changes section to changelog [\#530](https://github.com/skywinder/github-changelog-generator/pull/530) ([bastelfreak](https://github.com/bastelfreak))
 - Drop Project-and-Username-finding code [\#451](https://github.com/skywinder/github-changelog-generator/pull/451) ([olleolleolle](https://github.com/olleolleolle))
 **Fixed bugs:**
 - since\_tag doesn't work when tag specified is the latest tag [\#555](https://github.com/skywinder/github-changelog-generator/issues/555)
 - since\_tag seems to not be working [\#304](https://github.com/skywinder/github-changelog-generator/issues/304)
 - filter tags correctly when `since\_tag` is set to most recent tag [\#566](https://github.com/skywinder/github-changelog-generator/pull/566) ([Crunch09](https://github.com/Crunch09))
 **Closed issues:**
 - SSL Cert issue on Windows [\#475](https://github.com/skywinder/github-changelog-generator/issues/475)
 **Merged pull requests:**
 - Fix regression w/ enhancements in issues\_to\_log [\#573](https://github.com/skywinder/github-changelog-generator/pull/573) ([ekohl](https://github.com/ekohl))
 - OctoFetcher: Use defaults for request\_options [\#571](https://github.com/skywinder/github-changelog-generator/pull/571) ([olleolleolle](https://github.com/olleolleolle))
 - OctoFetcher: extract methods [\#570](https://github.com/skywinder/github-changelog-generator/pull/570) ([olleolleolle](https://github.com/olleolleolle))
 - OctoFetcher: extract method fail\_with\_message [\#569](https://github.com/skywinder/github-changelog-generator/pull/569) ([olleolleolle](https://github.com/olleolleolle))
 - OctoFetcher: drop unused number\_of\_pages feature [\#568](https://github.com/skywinder/github-changelog-generator/pull/568) ([olleolleolle](https://github.com/olleolleolle))
 - Travis: Do not test on jruby-head [\#567](https://github.com/skywinder/github-changelog-generator/pull/567) ([olleolleolle](https://github.com/olleolleolle))
 - Drop unused Rake task [\#564](https://github.com/skywinder/github-changelog-generator/pull/564) ([olleolleolle](https://github.com/olleolleolle))
 - Update license date [\#553](https://github.com/skywinder/github-changelog-generator/pull/553) ([benhc123](https://github.com/benhc123))
 ## [v1.15.0.pre.alpha](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0.pre.alpha) (2017-10-01)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.3...v1.15.0.pre.alpha)
 **Implemented enhancements:**
 - Add newline after version name and Full Changelog link [\#548](https://github.com/skywinder/github-changelog-generator/pull/548) ([ianroberts131](https://github.com/ianroberts131))
 - Update the token failure example to OctoKit 404 failure [\#525](https://github.com/skywinder/github-changelog-generator/pull/525) ([00xcoffee](https://github.com/00xcoffee))
 - Rescue invalid commands and present the valid options list [\#498](https://github.com/skywinder/github-changelog-generator/pull/498) ([Lucashuang0802](https://github.com/Lucashuang0802))
 - bundled cacert.pem with --ssl-ca-file PATH option [\#480](https://github.com/skywinder/github-changelog-generator/pull/480) ([olleolleolle](https://github.com/olleolleolle))
 - Option parsing: Remove tag1, tag2 cruft [\#479](https://github.com/skywinder/github-changelog-generator/pull/479) ([olleolleolle](https://github.com/olleolleolle))
 **Fixed bugs:**
 - Credit line bug [\#541](https://github.com/skywinder/github-changelog-generator/issues/541)
 - Bug: Credit line about this project added more than once [\#507](https://github.com/skywinder/github-changelog-generator/issues/507)
 - v1.14.0 Fails with missing /tmp/ path on Windows [\#458](https://github.com/skywinder/github-changelog-generator/issues/458)
 - failure when creating changelog from a repo in an orginazation: can't convert Github::ResponseWrapper to Array [\#253](https://github.com/skywinder/github-changelog-generator/issues/253)
 - warn\_if\_nonmatching\_regex should display proper help message when used with exclude-tags-regex [\#551](https://github.com/skywinder/github-changelog-generator/pull/551) ([lacostej](https://github.com/lacostej))
 - Bugfix: require ActiveSupport core\_ext/blank [\#520](https://github.com/skywinder/github-changelog-generator/pull/520) ([olleolleolle](https://github.com/olleolleolle))
 - Create temporary cache files in Dir.tmpdir [\#459](https://github.com/skywinder/github-changelog-generator/pull/459) ([olleolleolle](https://github.com/olleolleolle))
 **Closed issues:**
 - error \(Windows: Command exited with code 1\) [\#536](https://github.com/skywinder/github-changelog-generator/issues/536)
 - Error in generating changelog on Windows [\#521](https://github.com/skywinder/github-changelog-generator/issues/521)
 - Crash on start [\#512](https://github.com/skywinder/github-changelog-generator/issues/512)
 - Error On Running Generation Command [\#511](https://github.com/skywinder/github-changelog-generator/issues/511)
 - Not working [\#510](https://github.com/skywinder/github-changelog-generator/issues/510)
 - PR cited in the wrong TAG [\#503](https://github.com/skywinder/github-changelog-generator/issues/503)
 - 404 Not Found Error [\#484](https://github.com/skywinder/github-changelog-generator/issues/484)
 **Merged pull requests:**
 - Travis: Configure cache: bundler: true [\#563](https://github.com/skywinder/github-changelog-generator/pull/563) ([olleolleolle](https://github.com/olleolleolle))
 - Travis: use JRuby 9.1.13.0; don't redo rvm's job [\#562](https://github.com/skywinder/github-changelog-generator/pull/562) ([olleolleolle](https://github.com/olleolleolle))
 - Travis: update CI matrix [\#561](https://github.com/skywinder/github-changelog-generator/pull/561) ([olleolleolle](https://github.com/olleolleolle))
 - Fix section mapping, hiding untagged PRs, and hiding untagged issues [\#550](https://github.com/skywinder/github-changelog-generator/pull/550) ([hunner](https://github.com/hunner))
 - Update generator\_generation.rb [\#542](https://github.com/skywinder/github-changelog-generator/pull/542) ([Lucashuang0802](https://github.com/Lucashuang0802))
 - AppVeyor: drop init build hook, add .gitattributes instead [\#539](https://github.com/skywinder/github-changelog-generator/pull/539) ([olleolleolle](https://github.com/olleolleolle))
 - AppVeyor: Windows configuration to pass RuboCop [\#538](https://github.com/skywinder/github-changelog-generator/pull/538) ([olleolleolle](https://github.com/olleolleolle))
 - Fix the syntax ambiguity on credit-line-bug [\#537](https://github.com/skywinder/github-changelog-generator/pull/537) ([Lucashuang0802](https://github.com/Lucashuang0802))
 - Credit line bug [\#535](https://github.com/skywinder/github-changelog-generator/pull/535) ([Lucashuang0802](https://github.com/Lucashuang0802))
 - Update README.md [\#534](https://github.com/skywinder/github-changelog-generator/pull/534) ([Lucashuang0802](https://github.com/Lucashuang0802))
 - Delete circle.yml [\#532](https://github.com/skywinder/github-changelog-generator/pull/532) ([Lucashuang0802](https://github.com/Lucashuang0802))
 - Update README.md [\#531](https://github.com/skywinder/github-changelog-generator/pull/531) ([Lucashuang0802](https://github.com/Lucashuang0802))
 - Remove all old credit lines in the output then add a new one [\#526](https://github.com/skywinder/github-changelog-generator/pull/526) ([Enether](https://github.com/Enether))
 - Travis: jruby-9.1.10.0 [\#523](https://github.com/skywinder/github-changelog-generator/pull/523) ([olleolleolle](https://github.com/olleolleolle))
 - Travis CI: Drop 2.1 [\#517](https://github.com/skywinder/github-changelog-generator/pull/517) ([olleolleolle](https://github.com/olleolleolle))
 - Chore: Rubocop 0.49.0 [\#516](https://github.com/skywinder/github-changelog-generator/pull/516) ([olleolleolle](https://github.com/olleolleolle))
 - Travis: use jruby-9.1.9.0 [\#506](https://github.com/skywinder/github-changelog-generator/pull/506) ([olleolleolle](https://github.com/olleolleolle))
 - Use closed\_at and merged\_at when filtering issues/prs [\#504](https://github.com/skywinder/github-changelog-generator/pull/504) ([unicolet](https://github.com/unicolet))
 - Remove --between-tags option [\#501](https://github.com/skywinder/github-changelog-generator/pull/501) ([Lucashuang0802](https://github.com/Lucashuang0802))
 - Fixed headline in README.md [\#496](https://github.com/skywinder/github-changelog-generator/pull/496) ([Dreckiger-Dan](https://github.com/Dreckiger-Dan))
 - Update README.md [\#490](https://github.com/skywinder/github-changelog-generator/pull/490) ([fatData](https://github.com/fatData))
 - Travis: use latest rubies [\#488](https://github.com/skywinder/github-changelog-generator/pull/488) ([olleolleolle](https://github.com/olleolleolle))
 - Use ruby-2.4.1 in CI [\#487](https://github.com/skywinder/github-changelog-generator/pull/487) ([olleolleolle](https://github.com/olleolleolle))
 - Travis: jruby-9.1.8.0 [\#485](https://github.com/skywinder/github-changelog-generator/pull/485) ([olleolleolle](https://github.com/olleolleolle))
 - Update to latest CodeClimate [\#478](https://github.com/skywinder/github-changelog-generator/pull/478) ([olleolleolle](https://github.com/olleolleolle))
 - Gemspec: update retriable to 3.0 [\#477](https://github.com/skywinder/github-changelog-generator/pull/477) ([olleolleolle](https://github.com/olleolleolle))
 - Travis: new JRuby, develop on 2.4.0 [\#476](https://github.com/skywinder/github-changelog-generator/pull/476) ([olleolleolle](https://github.com/olleolleolle))
 - Fix readme typos [\#467](https://github.com/skywinder/github-changelog-generator/pull/467) ([dguo](https://github.com/dguo))
 - Gemspec: demand rainbow 2.2.1+ [\#466](https://github.com/skywinder/github-changelog-generator/pull/466) ([olleolleolle](https://github.com/olleolleolle))
 ## [v1.14.3](https://github.com/skywinder/github-changelog-generator/tree/v1.14.3) (2016-12-31)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.2...v1.14.3)
@ -393,7 +503,7 @@
 **Implemented enhancements:**
- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
+- Generate changelog since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
 - Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
 **Merged pull requests:**
@ -450,7 +560,7 @@
 - Show `Unreleased` section even when there is no tags in repo. [\#228](https://github.com/skywinder/github-changelog-generator/issues/228)
 - Add option `--exclude-tags x,y,z` [\#214](https://github.com/skywinder/github-changelog-generator/issues/214)
- Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
+- Generate changelog between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
 - Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53)
 **Merged pull requests:**
@ -462,7 +572,7 @@
 **Implemented enhancements:**
- Trees/Archives with missing change log notes for the current tag. [\#230](https://github.com/skywinder/github-changelog-generator/issues/230)
+- Trees/Archives with missing changelog notes for the current tag. [\#230](https://github.com/skywinder/github-changelog-generator/issues/230)
 **Fixed bugs:**
@ -481,7 +591,7 @@
 **Implemented enhancements:**
- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
+- Parsing of existing Changelog file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
 - Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
 - Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
@ -745,4 +855,4 @@
 ## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06)
-\* *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)*
--- a/CONTRIBUTING.md
+++ b/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
--- a/16
+++ b/16
@ -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"]
--- a/2
+++ b/2
@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2016 Petr Korolev
+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:
--- a/README.md
+++ b/README.md
@ -1,275 +1,289 @@
-[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
+[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
-[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
+[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
-[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
+[![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
-[![Build status](https://ci.appveyor.com/api/projects/status/xdfnfmdjfo0upm7m?svg=true)](https://ci.appveyor.com/project/olleolleolle/github-changelog-generator)
+[![Build status](https://ci.appveyor.com/api/projects/status/xdfnfmdjfo0upm7m?svg=true)](https://ci.appveyor.com/project/olleolleolle/github-changelog-generator)
-[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/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)
+[![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)
+[![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)
+[![Join the chat at https://gitter.im/github-changelog-generator/chat](https://badges.gitter.im/github-changelog-generator/chat.svg)](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
+
-GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
+GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
-==================
+==================
-
+
-  - [Installation](#installation)
+  - [Installation](#installation)
-  - [Output example](#output-example)
+  - [Output example](#output-example)
-  - [Usage](#usage)
+  - [Usage](#usage)
-    - [Params](#params)
+    - [Params](#params)
-    - [GitHub token](#github-token)
+    - [GitHub token](#github-token)
-  - [Features and advantages of this project](#features-and-advantages-of-this-project)
+  - [Features and advantages of this project](#features-and-advantages-of-this-project)
-    - [Alternatives](#alternatives)
+    - [Alternatives](#alternatives)
-    - [Projects using this library](#projects-using-this-library)
+    - [Projects using this library](#projects-using-this-library)
-  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
+  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
-  - [Contributing](#contributing)
+  - [Contributing](#contributing)
-  - [License](#license)
+  - [License](#license)
-
+
-
+
-### Changelog generation has never been so easy
+### Changelog generation has never been so easy
-
+
-**Fully automated changelog generation** - This gem generates a change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
+**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:
+Since you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:
-
+
-### *What’s the point of a change log?*
+### *What’s the point of a changelog?*
-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?*
+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.
-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.
+
-
+### *Why should I care?*
-:arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
+
-
+Because software tools are for _people_. "Changelogs make it easier for users and
-## Installation
+contributors to see precisely what notable changes have been made between each
-
+release (or version) of the project."
-    gem install github_changelog_generator
+
-
+:arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
-See also Troubleshooting.
+
-
+## Installation
-## Output example
+
-
+    $ [sudo] gem install github_changelog_generator
- 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:
+See also Troubleshooting.
-
+
-      github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
+## Running with Docker
-
+
- In general, it looks like this:
+    $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app skywinder/github-changelog-generator
-
+
-> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
+## Output example
->
+
-> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
+- 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:
-> **Implemented enhancements:**
+
->
+      $ github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
-> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
+
->
+- In general, it looks like this:
-> **Fixed bugs:**
+
->
+> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
-> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
+>
->
+> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
-> **Merged pull requests:**
+>
->
+> **Implemented enhancements:**
-> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
+>
->
+> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
-> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
+>
-
+> **Fixed bugs:**
-
+>
-## Usage
+> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
-**It's really simple!**
+>
-
+> **Merged pull requests:**
- If your **`git remote`** `origin` refers to your GitHub repo, just go to your project folder and run:
+>
-
+> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
-      github_changelog_generator
+>
-
+> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
-  Or, run this from anywhere:
+
-      `github_changelog_generator -u github_username -p github_project`
+
-      `github_changelog_generator  github_username/github_project`
+## Usage
-
+
- If you are running it against a repository on a Github Enterprise install, you must specify *both* `--github-site` and `--github-api` command line options:
+-  Run this:
-
+
-      github_changelog_generator --github-site="https://github.yoursite.com" \
+	   $ github_changelog_generator -u github_username -p github_project
-                                 --github-api="https://github.yoursite.com/api/v3/"
+	   
-
+	or, on the 1.14.x (current stable release)
-This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
+
-
+	   $ github_changelog_generator github_username/github_project
-### Params
+	   
-Type `github_changelog_generator --help` for details.
+
-
+- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
-For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
+
-
+       $ github_changelog_generator --github-site="https://github.yoursite.com" \
-### Params File
+                                  --github-api="https://github.yoursite.com/api/v3/"
-In your project root, you can put a params file named `.github_changelog_generator` to override default params:
+
-
+This generates a `CHANGELOG.md`, with pretty Markdown formatting.
-Example:
+
-```
+### Params
-unreleased=false
+
-future-release=5.0.0
+Print help for all command-line options to learn more details:
-since-tag=1.0.0
+
-```
+    $ github_changelog_generator --help
-
+
-### GitHub token
+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)
-
+
-GitHub only allows 50 unauthenticated requests per hour.
+### Params File
-Therefore, it's recommended to run this script with authentication by using a **token**.
+
-
+In your project root, you can put a params file named `.github_changelog_generator` to override default params:
-Here's how:
+
-
+Example:
- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
+
- Either:
+```
-    - Run the script with `--token <your-40-digit-token>`; **OR**
+unreleased=false
-    - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
+future-release=5.0.0
-
+since-tag=1.0.0
-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`):
+```
-
+
-    export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
+### GitHub token
-
+
-So, if you get a message like this:
+GitHub only allows 50 unauthenticated requests per hour.
-
+
-``` markdown
+Therefore, it's recommended to run this script with authentication by using a **token**.
-API rate limit exceeded for github_username.
+
-See: https://developer.github.com/v3/#rate-limiting
+Here's how:
-```
+
-
+- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
-It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
+- Either:
-
+    - Run the script with `--token <your-40-digit-token>`; **OR**
-## Migrating from a manual changelog
+    - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
-
+
-Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
+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`):
-But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
+
-
+    export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
-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.
+So, if you get a message like this:
-
+
-If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
+``` markdown
-
+API rate limit exceeded for github_username.
-### Rake task
+See: https://developer.github.com/v3/#rate-limiting
-
+```
-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.
+It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
-
+
-Just put something like this in your `Rakefile`:
+## Migrating from a manual changelog
-
+
-```ruby
+Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
-require 'github_changelog_generator/task'
+But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
-
+
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+That's where `--base <your-manual-changelog.md>` comes in handy!
-  config.since_tag = '0.1.14'
+This option lets append your old manual changelog to the end of the generated entries.
-  config.future_release = '0.2.0'
+
-end
+If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
-```
+
-
+### Rake task
-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 love `rake`? We do, too! So, we've made it even easier for you:
-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.
+we've provided a `rake` task library for your changelog generation.
-
+
-## Features and advantages of this project
+Configure the task in your `Rakefile`:
- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
+
- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
+```ruby
- **GitHub Enterprise support** via command line options! :factory:
+require 'github_changelog_generator/task'
- Flexible format **customization**:
+
-    - **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    - **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
+  config.since_tag = '0.1.14'
-    - 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:
+  config.future_release = '0.2.0'
-    - Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
+end
- **Distinguish** issues **by labels**. :mag_right:
+```
-    - Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
+
-    - Bug fixes (issues labeled `bug`) :beetle:
+All command-line options can be passed to the `rake` task as `config`
-    - Enhancements (issues labeled `enhancement`) :star2:
+parameters. And since you're naming the `rake` task yourself, you can create
-    - Issues (closed issues with no labels) :non-potable_water:
+as many as you want.
-
+
- Manually include or exclude issues by labels :wrench:
+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.
- Customize lots more! Tweak the changelog to fit your preferences :tophat:
+
-(*See `github_changelog_generator --help`  for details)*
+## Features and advantages of this project
-
+
-
+- Generate canonical, neat changelog file, followed by [basic changelog guidelines](http://keepachangelog.com) :gem:
-### Alternatives
+- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
-Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
+- **GitHub Enterprise support** via command line options! :factory:
-
+- Flexible format **customization**:
-*If you know other projects, feel free to edit this Wiki page!*
+    - **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
-
+    - **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
-
+    - 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:
-### Projects using this library
+    - Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
-Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
+- **Distinguish** issues **by labels**. :mag_right:
-
+    - Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
-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.
+    - Bug fixes (issues labeled `bug`) :beetle:
-
+    - Enhancements (issues labeled `enhancement`) :star2:
-*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).*
+    - Issues (closed issues with no labels) :non-potable_water:
-
+
-## Am I missing some essential feature?
+- Manually include or exclude issues by labels :wrench:
-
+- Customize lots more! Tweak the changelog to fit your preferences :tophat:
- **Nothing is impossible!**
+(*See `github_changelog_generator --help`  for details)*
-
+
- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
+
-
+### Alternatives
- *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
+
-
+Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
-## FAQ
+
-
+*If you know other projects, feel free to edit this Wiki page!*
- ***I already use GitHub Releases. Why do I need this?***
+
-
+
-GitHub Releases is a very good thing. And it's very good practice to maintain it. (Not a lot of people are using it yet!) :congratulations:
+### Projects using this library
-
+
-*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
+Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
-
+
-I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
+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.
-
+
-An auto-generated changelog really helps, even if you manually fill in the release notes!
+*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).*
-
+
-For example:
+## Am I missing some essential feature?
-
+
-When you find a closed bug, it is very useful to know which release fixed it.
+- **Nothing is impossible!**
-So that you can easily find the issue by \# in `CHANGELOG.md`.
+
-
+- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
- it's not quite as easy to find this in handwritten releases notes
+
- a generated file saves you the trouble of remembering everything;
+- *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
-  sometimes people forget to add things to a handwritten file
+
-
+## FAQ
-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.
+- ***I already use GitHub Releases. Why do I need this?***
-Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
+
-
+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:
- ***I received a warning: "GitHub API rate limit exceed"  What does this mean?***
+
-
+*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
-GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
+
-
+I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
-If you're seeing this warning, please do the following:
+
-
+An auto-generated changelog really helps, even if you manually fill in the release notes!
-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`
+For example:
-
+
- ***My Ruby version is very old, can I use this?***
+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`.
-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.
+- It's not quite as easy to find this in handwritten releases notes.
-
+- A generated file saves you the trouble of remembering everything;
-In a Gemfile, perhaps in a non-deployed `:development` group, add this
+  sometimes people forget to add things to a handwritten file.
-gem:
+
-
+Ultimately, I think GitHub Releases are ideal for end-users.
-```ruby
+Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
-group :development do
+Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
-  gem 'github_changelog_generator', require: false
+
-end
+- ***I got an "API rate limit exceeded" error message. 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).
-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
+If you're seeing this warning, please do the following:
-adding a line like this to the Gemfile:
+
-
+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`
-gem 'rack', '~> 1.6'
+
-```
+- ***My Ruby version is very old, can I use this?***
-
+
-This way, you can keep on using github_changelog_generator, even if you
+When your Ruby is old, and you don't want to upgrade, and you want to
-can't get the latest version of Ruby installed.
+control which libraries you use, you can use Bundler.
-
+
-## Contributing
+In a Gemfile, perhaps in a non-deployed `:development` group, add this
-
+gem:
-1. Create an issue and describe your idea
+
-2. [Fork it](https://github.com/skywinder/github-changelog-generator/fork)
+```ruby
-3. Create your feature branch (`git checkout -b my-new-feature`)
+group :development do
-4. Commit your changes (`git commit -am 'Add some feature'`)
+  gem 'github_changelog_generator', require: false
-5. Publish the branch (`git push origin my-new-feature`)
+end
-6. Create a new Pull Request
+```
-7. Profit! :white_check_mark:
+
-
+Then you can keep back dependencies like rack, which currently is only
-You can test your workflow with changelog generator with [the skywinder/changelog_test repo](https://github.com/skywinder/changelog_test/).
+compatible with Ruby >= 2.2.2. So, use an older version for your app by
-
+adding a line like this to the Gemfile:
-## License
+
-
+```
-Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+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
 We have collected notes on how to contribute to this project in [CONTRIBUTING.md].
 [CONTRIBUTING.md]: CONTRIBUTING.md
 ## License
 Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
--- a/5
+++ b/5
@ -9,12 +9,11 @@ require "fileutils"
 require "overcommit"
 RuboCop::RakeTask.new
-RSpec::Core::RakeTask.new(:rspec)
+RSpec::Core::RakeTask.new
 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 checks: %i[rubocop rspec]
+task default: %i[rubocop spec]
 task default: %i[rubocop rspec]
--- a/appveyor.yml
+++ b/appveyor.yml
@ -39,7 +39,7 @@ install:
 build_script:
  # Install ruby dependencies
  - bundle install --retry 3
-  - bundle exec rake checks
+  - bundle exec rake
 test_script:
  - gem build github_changelog_generator
--- a/github_changelog_generator.gemspec
+++ b/github_changelog_generator.gemspec
@ -9,12 +9,12 @@ Gem::Specification.new do |spec|
  spec.version            = GitHubChangelogGenerator::VERSION
  spec.default_executable = "github_changelog_generator"
-  spec.required_ruby_version = ">= 1.9.3"
+  spec.required_ruby_version = ">= 2.2.2"
  spec.authors = ["Petr Korolev", "Olle Jonsson"]
  spec.email = "sky4winder+github_changelog_generator@gmail.com"
  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.license = "MIT"
@ -24,11 +24,11 @@ Gem::Specification.new do |spec|
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]
  spec.add_runtime_dependency "rake", ">= 10.0"
  spec.add_runtime_dependency "rainbow", ">= 2.2.1"
  spec.add_runtime_dependency("octokit", ["~> 4.6"])
  spec.add_runtime_dependency("faraday-http-cache")
  spec.add_runtime_dependency("activesupport")
-  spec.add_runtime_dependency("retriable", ["~> 3.0"])
+  spec.add_runtime_dependency("faraday-http-cache")
  spec.add_runtime_dependency("multi_json")
  spec.add_runtime_dependency("octokit", ["~> 4.6"])
  spec.add_runtime_dependency "rainbow", ">= 2.2.1"
  spec.add_runtime_dependency "rake", ">= 10.0"
  spec.add_runtime_dependency("retriable", ["~> 3.0"])
 end
--- a/lib/github_changelog_generator.rb
+++ b/lib/github_changelog_generator.rb
@ -22,14 +22,14 @@ require "github_changelog_generator/reader"
 module GitHubChangelogGenerator
  # Main class and entry point for this script.
  class ChangelogGenerator
-    # Class, responsible for whole change log generation cycle
+    # Class, responsible for whole changelog generation cycle
    # @return initialised instance of ChangelogGenerator
    def initialize
      @options = Parser.parse_options
      @generator = Generator.new @options
    end
-    # The entry point of this script to generate change log
+    # The entry point of this script to generate changelog
    # @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
    def run
      log = @generator.compound_changelog
--- a/lib/github_changelog_generator/generator/entry.rb
+++ b/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
--- a/lib/github_changelog_generator/generator/generator.rb
+++ b/lib/github_changelog_generator/generator/generator.rb
@ -1,20 +1,32 @@
 # frozen_string_literal: true
-require_relative "../octo_fetcher"
+require "github_changelog_generator/octo_fetcher"
-require_relative "generator_generation"
+require "github_changelog_generator/generator/generator_fetcher"
-require_relative "generator_fetcher"
+require "github_changelog_generator/generator/generator_processor"
-require_relative "generator_processor"
+require "github_changelog_generator/generator/generator_tags"
-require_relative "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, :github, :tag_section_mapping, :sorted_tags
+    attr_accessor :options, :filtered_tags, :tag_section_mapping, :sorted_tags
-    # A Generator responsible for all logic, related with change log generation from ready-to-parse issues
+    # A Generator responsible for all logic, related with changelog generation from ready-to-parse issues
    #
    # Example:
    #   generator = GitHubChangelogGenerator::Generator.new
@ -23,6 +35,104 @@ module GitHubChangelogGenerator
      @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
@ -35,121 +145,5 @@ module GitHubChangelogGenerator
      fetch_events_for_issues_and_pr
      detect_actual_closed_dates(@issues + @pull_requests)
    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
    # Generates log for section 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 of the newer tag. Could be nil for `Unreleased` section
    # @param [Hash, nil] older_tag Older tag, used for the links. Could be nil for last tag.
    # @return [String] Ready and parsed section
    def create_log_for_tag(pull_requests, issues, newer_tag, older_tag = nil)
      newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
      github_site = options[:github_site] || "https://github.com"
      project_url = "#{github_site}/#{options[:user]}/#{options[:project]}"
      # If the older tag is nil, go back in time from the latest tag and find
      # the SHA for the first commit.
      older_tag_name =
        if older_tag.nil?
          @fetcher.commits_before(newer_tag_time).last["sha"]
        else
          older_tag["name"]
        end
      log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
      if options[:issues]
        # Generate issues:
        log += issues_to_log(issues, pull_requests)
      end
      if options[:pulls] && options[:add_pr_wo_labels]
        # Generate pull requests:
        log += generate_sub_section(pull_requests, options[:merge_prefix])
      end
      log
    end
    # Generate ready-to-paste log from list of issues and pull requests.
    #
    # @param [Array] issues
    # @param [Array] pull_requests
    # @return [String] generated log for issues
    def issues_to_log(issues, pull_requests)
      log = ""
      bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
      log += generate_sub_section(enhancement_a, options[:enhancement_prefix])
      log += generate_sub_section(bugs_a, options[:bug_prefix])
      log += generate_sub_section(issues_a, options[:issue_prefix])
      log
    end
    # This method sort issues by types
    # (bugs, features, or just closed issues) by labels
    #
    # @param [Array] issues
    # @param [Array] pull_requests
    # @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
    def parse_by_sections(issues, pull_requests)
      issues_a = []
      enhancement_a = []
      bugs_a = []
      issues.each do |dict|
        added = false
        dict["labels"].each do |label|
          if options[:bug_labels].include?(label["name"])
            bugs_a.push(dict)
            added = true
            next
          end
          if options[:enhancement_labels].include?(label["name"])
            enhancement_a.push(dict)
            added = true
            next
          end
        end
        issues_a.push(dict) unless added
      end
      added_pull_requests = []
      pull_requests.each do |pr|
        pr["labels"].each do |label|
          if options[:bug_labels].include?(label["name"])
            bugs_a.push(pr)
            added_pull_requests.push(pr)
            next
          end
          if options[:enhancement_labels].include?(label["name"])
            enhancement_a.push(pr)
            added_pull_requests.push(pr)
            next
          end
        end
      end
      added_pull_requests.each { |p| pull_requests.delete(p) }
      [bugs_a, enhancement_a, issues_a]
    end
  end
 end
--- a/lib/github_changelog_generator/generator/generator_generation.rb
+++ b/lib/github_changelog_generator/generator/generator_generation.rb
@ -1,180 +0,0 @@
 # frozen_string_literal: true
 module GitHubChangelogGenerator
  class Generator
    # Main function to start change log generation
    #
    # @return [String] Generated change log file
    def compound_changelog
      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_log_between_tags(filtered_tags[0], nil)
             else
               generate_log_for_all_tags
             end
      log += File.read(options[:base]) if File.file?(options[:base])
      credit_line = "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
      log.gsub!(credit_line, "") # Remove old credit lines
      log += credit_line
      @log = log
    end
    # @param [Array] issues List of issues on sub-section
    # @param [String] prefix Name of sub-section
    # @return [String] Generate ready-to-go sub-section
    def generate_sub_section(issues, prefix)
      log = ""
      if issues.any?
        log += "#{prefix}\n\n" unless options[:simple_list]
        issues.each do |issue|
          merge_string = get_string_for_issue(issue)
          log += "- #{merge_string}\n"
        end
        log += "\n"
      end
      log
    end
    # It generate one header for section 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_link - tag name, used for links.
    # @param [String] project_url - url for current project.
    # @return [String] - Generate one ready-to-add section.
    def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_link, project_url)
      log = ""
      # 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
      log += if newer_tag_name.equal?(options[:unreleased_label])
               "## [#{newer_tag_name}](#{release_url})\n\n"
             else
               "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n\n"
             end
      if options[:compare_link] && older_tag_link
        # Generate compare link
        log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
      end
      log
    end
    # 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_log_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
      create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag)
    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] The complete change log
    def generate_log_for_all_tags
      puts "Generating log..." if options[:verbose]
      log = generate_unreleased_section
      @tag_section_mapping.each_pair do |_tag_section, left_right_tags|
        older_tag, newer_tag = left_right_tags
        log += generate_log_between_tags(older_tag, newer_tag)
      end
      log
    end
    def generate_unreleased_section
      log = ""
      if options[:unreleased]
        start_tag      = filtered_tags[0] || sorted_tags.last
        unreleased_log = generate_log_between_tags(start_tag, nil)
        log           += unreleased_log if unreleased_log
      end
      log
    end
    # 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
    private
    def line_labels_for(issue)
      labels = if options[:issue_line_labels] == ["ALL"]
                 issue["labels"]
               else
                 issue["labels"].select { |label| options[:issue_line_labels].include?(label["name"]) }
               end
      labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
    end
    def issue_line_with_user(line, issue)
      return line if !options[:author] || issue["pull_request"].nil?
      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
  end
 end
--- a/lib/github_changelog_generator/generator/generator_tags.rb
+++ b/lib/github_changelog_generator/generator/generator_tags.rb
@ -129,7 +129,7 @@ module GitHubChangelogGenerator
      if tag
        if all_tags.map { |t| t["name"] }.include? tag
          idx = all_tags.index { |t| t["name"] == tag }
-          filtered_tags = if idx > 0
+          filtered_tags = if idx
                            all_tags[0..idx]
                          else
                            []
--- a/lib/github_changelog_generator/generator/section.rb
+++ b/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
--- a/lib/github_changelog_generator/octo_fetcher.rb
+++ b/lib/github_changelog_generator/octo_fetcher.rb
@ -13,7 +13,7 @@ module GitHubChangelogGenerator
    MAX_THREAD_NUMBER = 25
    MAX_FORBIDDEN_RETRIES = 100
    CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
-    GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
+    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!"
@ -31,21 +31,27 @@ module GitHubChangelogGenerator
      @project      = @options[:project]
      @since        = @options[:since]
      @http_cache   = @options[:http_cache]
-      if @http_cache
+      @cache_file   = nil
-        @cache_file = @options.fetch(:cache_file) { File.join(Dir.tmpdir, "github-changelog-http-cache") }
+      @cache_log    = nil
-        @cache_log  = @options.fetch(:cache_log) { File.join(Dir.tmpdir, "github-changelog-logger.log") }
+      prepare_cache
        init_cache
      end
      @github_token = fetch_github_token
      @request_options               = { per_page: PER_PAGE_NUMBER }
      @github_options                = {}
      @github_options[:access_token] = @github_token unless @github_token.nil?
      @github_options[:api_endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
      configure_octokit_ssl
      @client = Octokit::Client.new(github_options)
    end
-      @client = Octokit::Client.new(@github_options)
+    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
@ -54,21 +60,19 @@ module GitHubChangelogGenerator
    end
    def init_cache
-      middleware_opts = {
+      Octokit.middleware = Faraday::RackBuilder.new do |builder|
-        serializer: Marshal,
+        builder.use(Faraday::HttpCache, serializer: Marshal,
-        store: ActiveSupport::Cache::FileStore.new(@cache_file),
+                                        store: ActiveSupport::Cache::FileStore.new(@cache_file),
-        logger: Logger.new(@cache_log),
+                                        logger: Logger.new(@cache_log),
-        shared_cache: false
+                                        shared_cache: false)
      }
      stack = Faraday::RackBuilder.new do |builder|
        builder.use Faraday::HttpCache, middleware_opts
        builder.use Octokit::Response::RaiseError
        builder.adapter Faraday.default_adapter
        # builder.response :logger
      end
      Octokit.middleware = stack
    end
    DEFAULT_REQUEST_OPTIONS = { per_page: PER_PAGE_NUMBER }
    # Fetch all tags from repo
    #
    # @return [Array <Hash>] array of tags
@ -84,7 +88,7 @@ module GitHubChangelogGenerator
    def calculate_pages(client, method, request_options)
      # Makes the first API call so that we can call last_response
      check_github_response do
-        client.send(method, user_project, @request_options.merge(request_options))
+        client.send(method, user_project, DEFAULT_REQUEST_OPTIONS.merge(request_options))
      end
      last_response = client.last_response
@ -104,7 +108,7 @@ module GitHubChangelogGenerator
      page_i      = 0
      count_pages = calculate_pages(@client, "tags", {})
-      iterate_pages(@client, "tags", {}) do |new_tags|
+      iterate_pages(@client, "tags") do |new_tags|
        page_i += PER_PAGE_NUMBER
        print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
        tags.concat(new_tags)
@ -118,8 +122,13 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
        Helper.log.info "Found #{tags.count} tags"
      end
      # tags are a Sawyer::Resource. Convert to hash
-      tags = tags.map { |h| stringify_keys_deep(h.to_hash) }
+      tags.map { |resource| stringify_keys_deep(resource.to_hash) }
-      tags
+    end
    def closed_pr_options
      @closed_pr_options ||= {
        filter: "all", labels: nil, state: "closed"
      }.tap { |options| options[:since] = @since if @since }
    end
    # This method fetch all closed issues and separate them to pull requests and pure issues
@ -129,17 +138,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
    def fetch_closed_issues_and_pr
      print "Fetching closed issues...\r" if @options[:verbose]
      issues = []
      options = {
        state: "closed",
        filter: "all",
        labels: nil
      }
      options[:since] = @since unless @since.nil?
      page_i      = 0
-      count_pages = calculate_pages(@client, "issues", options)
+      count_pages = calculate_pages(@client, "issues", closed_pr_options)
-      iterate_pages(@client, "issues", options) do |new_issues|
+      iterate_pages(@client, "issues", closed_pr_options) do |new_issues|
        page_i += PER_PAGE_NUMBER
        print_in_same_line("Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
        issues.concat(new_issues)
@ -148,12 +150,9 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
      print_empty_line
      Helper.log.info "Received issues: #{issues.count}"
      issues = issues.map { |h| stringify_keys_deep(h.to_hash) }
      # separate arrays of issues and pull requests:
-      issues.partition do |x|
+      issues.map { |issue| stringify_keys_deep(issue.to_hash) }
-        x["pull_request"].nil?
+            .partition { |issue_or_pr| issue_or_pr["pull_request"].nil? }
      end
    end
    # Fetch all pull requests. We need them to detect :merged_at parameter
@ -179,8 +178,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
      print_empty_line
      Helper.log.info "Pull Request count: #{pull_requests.count}"
-      pull_requests = pull_requests.map { |h| stringify_keys_deep(h.to_hash) }
+      pull_requests.map { |pull_request| stringify_keys_deep(pull_request.to_hash) }
      pull_requests
    end
    # Fetch event for all issues and add them to 'events'
@ -195,10 +193,10 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
        issues_slice.each do |issue|
          threads << Thread.new do
            issue["events"] = []
-            iterate_pages(@client, "issue_events", issue["number"], {}) do |new_event|
+            iterate_pages(@client, "issue_events", issue["number"]) do |new_event|
              issue["events"].concat(new_event)
            end
-            issue["events"] = issue["events"].map { |h| stringify_keys_deep(h.to_hash) }
+            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
@ -256,14 +254,15 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
          stringify_keys_deep(value)
        end
      when Hash
-        indata.each_with_object({}) do |(k, v), output|
+        indata.each_with_object({}) do |(key, value), output|
-          output[k.to_s] = stringify_keys_deep(v)
+          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
@ -274,29 +273,21 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
    #
    # @yield [Sawyer::Resource] An OctoKit-provided response (which can be empty)
    #
-    # @return [Integer] total number of pages
+    # @return [void]
    def iterate_pages(client, method, *args)
-      request_opts = extract_request_args(args)
+      args << DEFAULT_REQUEST_OPTIONS.merge(extract_request_args(args))
      args.push(@request_options.merge(request_opts))
      number_of_pages = 1
      check_github_response { client.send(method, user_project, *args) }
-      last_response = client.last_response
+      last_response = client.last_response.tap do |response|
-      if last_response.status == 301
+        raise(MovedPermanentlyError, response.data[:url]) if response.status == 301
        raise MovedPermanentlyError, last_response.data[:url]
      end
      yield(last_response.data)
      until (next_one = last_response.rels[:next]).nil?
        number_of_pages += 1
        last_response = check_github_response { next_one.get }
        yield(last_response.data)
      end
      number_of_pages
    end
    def extract_request_args(args)
@ -317,14 +308,17 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
        yield
      end
    rescue MovedPermanentlyError => e
-      Helper.log.error("#{e.class}: #{e.message}")
+      fail_with_message(e, "The repository has moved, update your configuration")
      sys_abort("The repository has moved, please update your configuration")
    rescue Octokit::Forbidden => e
-      Helper.log.error("#{e.class}: #{e.message}")
+      fail_with_message(e, "Exceeded retry limit")
      sys_abort("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("Error: wrong GitHub token")
+      sys_abort(message)
    end
    # Exponential backoff
@ -373,7 +367,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
    #
    # @return [String]
    def fetch_github_token
-      env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
+      env_var = @options[:token].presence || ENV["CHANGELOG_GITHUB_TOKEN"]
      Helper.log.warn NO_TOKEN_PROVIDED unless env_var
--- a/lib/github_changelog_generator/options.rb
+++ b/lib/github_changelog_generator/options.rb
@ -1,13 +1,21 @@
 # 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
@ -20,13 +28,15 @@ module GitHubChangelogGenerator
      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
      git_remote
      github_endpoint
      github_site
      header
@ -42,6 +52,7 @@ module GitHubChangelogGenerator
      pulls
      release_branch
      release_url
      require
      simple_list
      since_tag
      ssl_ca_file
@ -54,26 +65,66 @@ module GitHubChangelogGenerator
      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
--- a/lib/github_changelog_generator/parser.rb
+++ b/lib/github_changelog_generator/parser.rb
@ -3,8 +3,9 @@
 require "optparse"
 require "pp"
-require_relative "version"
+require "github_changelog_generator/version"
-require_relative "helper"
+require "github_changelog_generator/helper"
 module GitHubChangelogGenerator
  class Parser
    # parse options with optparse
@ -19,45 +20,34 @@ module GitHubChangelogGenerator
        abort [e, parser].join("\n")
      end
-      fetch_user_and_project(options)
+      unless options[:user] && options[:project]
        warn "Configure which user and project to work on."
        warn "Options --user and --project, or settings to that effect. See --help for more."
        abort(parser.banner)
      end
-      abort(parser.banner) unless options[:user] && options[:project]
+      options.print_options
      print_options(options)
      options
    end
-    # If options set to verbose, print the parsed options.
+    # Setup parsing options
    #
-    # The GitHub `:token` key is censored in the output.
+    # @param options [Options]
-    #
+    # @return [OptionParser]
    # @param options [Hash] The options to display
    # @option options [Boolean] :verbose If false this method does nothing
    def self.print_options(options)
      if options[:verbose]
        Helper.log.info "Performing task with options:"
        options_to_display = options.clone
        options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
        pp options_to_display
        puts ""
      end
    end
    # setup parsing options
    def self.setup_parser(options)
-      parser = OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
+      OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
-        opts.banner = "Usage: github_changelog_generator [options]"
+        opts.banner = "Usage: github_changelog_generator --user USER --project PROJECT [options]"
-        opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
+        opts.on("-u", "--user USER", "Username of the owner of target GitHub repo") do |last|
          options[:user] = last
        end
-        opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last|
+        opts.on("-p", "--project PROJECT", "Name of project on GitHub") do |last|
          options[:project] = last
        end
        opts.on("-t", "--token [TOKEN]", "To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last|
          options[:token] = last
        end
-        opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
+        opts.on("-f", "--date-format FORMAT", "Date format. Default is %Y-%m-%d") do |last|
          options[:date_format] = last
        end
        opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
@ -72,12 +62,21 @@ module GitHubChangelogGenerator
        opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
          options[:enhancement_prefix] = v
        end
        opts.on("--breaking-label [LABEL]", "Setup custom label for the breaking changes section. Default is \"**Breaking changes:**\"") do |v|
          options[:breaking_prefix] = v
        end
        opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
          options[:issue_prefix] = v
        end
-        opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
+        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
@ -120,7 +119,7 @@ module GitHubChangelogGenerator
        opts.on("--include-labels  x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
          options[:include_labels] = list
        end
-        opts.on("--exclude-labels  x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
+        opts.on("--exclude-labels  x,y,z", Array, "Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'") do |list|
          options[:exclude_labels] = list
        end
        opts.on("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
@ -129,19 +128,22 @@ module GitHubChangelogGenerator
        opts.on("--enhancement-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
          options[:enhancement_labels] = list
        end
        opts.on("--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, "Change log will exclude specified tags") do |list|
+        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", "Change log will start after specified tag") do |v|
+        opts.on("--since-tag  x", "Changelog will start after specified tag") do |v|
          options[:since_tag] = v
        end
-        opts.on("--due-tag  x", "Change log will end before specified tag") do |v|
+        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|
@ -177,6 +179,9 @@ module GitHubChangelogGenerator
        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
@ -189,10 +194,9 @@ module GitHubChangelogGenerator
          exit
        end
      end
      parser
    end
-    # @return [Hash] Default options
+    # @return [Options] Default options
    def self.default_options
      Options.new(
        date_format: "%Y-%m-%d",
@ -210,124 +214,23 @@ module GitHubChangelogGenerator
        enhancement_labels: ["enhancement", "Enhancement", "Type: Enhancement"],
        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: "# Change Log",
+        header: "# Changelog",
        merge_prefix: "**Merged pull requests:**",
        issue_prefix: "**Closed issues:**",
        bug_prefix: "**Fixed bugs:**",
        enhancement_prefix: "**Implemented enhancements:**",
-        git_remote: "origin",
+        breaking_prefix: "**Breaking changes:**",
-        http_cache: true
+        http_cache: true,
        require: []
      )
    end
    # If `:user` or `:project` not set in options, try setting them
    # Valid unnamed parameters:
    # 1) in 1 param: repo_name/project
    # 2) in 2 params: repo name project
    def self.fetch_user_and_project(options)
      if options[:user].nil? || options[:project].nil?
        user, project = user_and_project_from_git(options, ARGV[0], ARGV[1])
        options[:user] ||= user
        options[:project] ||= project
      end
    end
    # Sets `:user` and `:project` in `options` from CLI arguments or `git remote`
    # @param [String] arg0 first argument in cli
    # @param [String] arg1 second argument in cli
    # @return [Array<String>] user and project, or nil if unsuccessful
    def self.user_and_project_from_git(options, arg0 = nil, arg1 = nil)
      user, project = user_project_from_option(arg0, arg1, options[:github_site])
      unless user && project
        if ENV["RUBYLIB"] =~ /ruby-debug-ide/
          user = "skywinder"
          project = "changelog_test"
        else
          remote = `git config --get remote.#{options[:git_remote]}.url`
          user, project = user_project_from_remote(remote)
        end
      end
      [user, project]
    end
    # Returns GitHub username and project from CLI arguments
    #
    # @param arg0 [String] This parameter takes two forms: Either a full
    #                      GitHub URL, or a 'username/projectname', or
    #                      simply a GitHub username
    # @param arg1 [String] If arg0 is given as a username,
    #                      then arg1 can given as a projectname
    # @param github_site [String] Domain name of GitHub site
    #
    # @return [Array, nil] user and project, or nil if unsuccessful
    def self.user_project_from_option(arg0, arg1, github_site)
      user = nil
      project = nil
      github_site ||= "github.com"
      if arg0 && !arg1
        # this match should parse  strings such "https://github.com/skywinder/Github-Changelog-Generator" or
        # "skywinder/Github-Changelog-Generator" to user and name
        match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
        begin
          param = match[2].nil?
        rescue StandardError
          puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
          return
        end
        if param
          return
        else
          user = match[1]
          project = match[2]
        end
      end
      [user, project]
    end
    # These patterns match these formats:
    #
    # ```
    # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
    # git@github.com:skywinder/Github-Changelog-Generator.git
    # ```
    #
    # and
    #
    # ```
    # origin	https://github.com/skywinder/ChangelogMerger (fetch)
    # https://github.com/skywinder/ChangelogMerger
    # ```
    GIT_REMOTE_PATTERNS = [
      /.*(?:[:\/])(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*)(?:\.git).*/,
      /.*\/(?<user>(?:-|\w|\.)*)\/(?<project>(?:-|\w|\.)*).*/
    ]
    # Returns GitHub username and project from git remote output
    #
    # @param git_remote_output [String] Output of git remote command
    #
    # @return [Array] user and project
    def self.user_project_from_remote(git_remote_output)
      user = nil
      project = nil
      GIT_REMOTE_PATTERNS.each do |git_remote_pattern|
        git_remote_pattern =~ git_remote_output
        if Regexp.last_match
          user = Regexp.last_match(:user)
          project = Regexp.last_match(:project)
          break
        end
      end
      [user, project]
    end
  end
 end
--- a/lib/github_changelog_generator/parser_file.rb
+++ b/lib/github_changelog_generator/parser_file.rb
@ -67,7 +67,7 @@ module GitHubChangelogGenerator
    end
    KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels bug_labels
-                          enhancement_labels issue_line_labels between_tags exclude_tags]
+                          enhancement_labels breaking_labels issue_line_labels between_tags exclude_tags]
    KNOWN_INTEGER_KEYS = [:max_issues]
    def convert_value(value, option_name)
@ -91,6 +91,7 @@ module GitHubChangelogGenerator
      header_label: :header,
      front_matter: :frontmatter,
      pr_label: :merge_prefix,
      breaking_label: :breaking_prefix,
      issues_wo_labels: :add_issues_wo_labels,
      pr_wo_labels: :add_pr_wo_labels,
      pull_requests: :pulls,
--- a/lib/github_changelog_generator/task.rb
+++ b/lib/github_changelog_generator/task.rb
@ -19,7 +19,7 @@ module GitHubChangelogGenerator
                  between_tags exclude_tags exclude_tags_regex since_tag max_issues
                  github_site github_endpoint simple_list
                  future_release release_branch verbose release_url
-                  base ]
+                  base configure_sections add_sections]
    OPTIONS.each do |o|
      attr_accessor o.to_sym
@ -37,7 +37,7 @@ module GitHubChangelogGenerator
    end
    def define(args, &task_block)
-      desc "Generate a Change log from GitHub"
+      desc "Generate a Changelog from GitHub"
      yield(*[self, args].slice(0, task_block.arity)) if task_block
@ -48,13 +48,11 @@ module GitHubChangelogGenerator
        # mimick parse_options
        options = Parser.default_options
        Parser.fetch_user_and_project(options)
        OPTIONS.each do |o|
          v = instance_variable_get("@#{o}")
          options[o.to_sym] = v unless v.nil?
        end
-
+        abort "user and project are required." unless options[:user] && options[:project]
        generator = Generator.new options
        log = generator.compound_changelog
--- a/lib/github_changelog_generator/version.rb
+++ b/lib/github_changelog_generator/version.rb
@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module GitHubChangelogGenerator
-  VERSION = "1.15.0-alpha"
+  VERSION = "1.15.0-rc"
 end
--- a/man/git-generate-changelog.1
+++ b/man/git-generate-changelog.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2016" "" ""
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2017" "" ""
 .
 .SH "NAME"
 \fBgit\-generate\-changelog\fR \- Generate changelog from github
@ -10,7 +10,7 @@
 \fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
 .
 .SH "DESCRIPTION"
-Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
+Automatically generate changelog from your tags, issues, labels and pull requests on GitHub\.
 .
 .SH "OPTIONS"
 \-u, \-\-user [USER]
@ -70,7 +70,7 @@ Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR
 \-\-header\-label [LABEL]
 .
 .P
-Setup custom header label\. Default is "# Change Log"
+Setup custom header label\. Default is "# Changelog"
 .
 .P
 \-\-front\-matter [JSON]
@ -175,16 +175,10 @@ Issues with the specified labels will be always added to "Fixed bugs" section\.
 Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
 .
 .P
 \-\-between\-tags x,y,z
 .
 .P
 Change log will be filled only between specified tags
 .
 .P
 \-\-exclude\-tags x,y,z
 .
 .P
-Change log will exclude specified tags
+Changelog will exclude specified tags
 .
 .P
 \-\-exclude\-tags\-regex [REGEX]
@ -196,13 +190,13 @@ Apply a regular expression on tag names so that they can be excluded, for exampl
 \-\-since\-tag x
 .
 .P
-Change log will start after specified tag
+Changelog will start after specified tag
 .
 .P
 \-\-due\-tag x
 .
 .P
-Change log will end before specified tag
+Changelog will end before specified tag
 .
 .P
 \-\-max\-issues [NUMBER]
@ -264,6 +258,25 @@ Filename to use for cache\. Default is github\-changelog\-http\-cache in a tempo
 .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
 .
@ -271,6 +284,18 @@ Filename to use for cache log\. Default is github\-changelog\-logger\.log in a t
 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
--- a/man/git-generate-changelog.1.html
+++ b/man/git-generate-changelog.1.html
@ -80,7 +80,7 @@
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
-<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
+<p>Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.</p>
 <h2 id="OPTIONS">OPTIONS</h2>
@ -122,7 +122,7 @@
 <p>   --header-label [LABEL]</p>
-<p>   Setup custom header label. Default is "# Change Log"</p>
+<p>   Setup custom header label. Default is "# Changelog"</p>
 <p>   --front-matter [JSON]</p>
@ -194,7 +194,7 @@
 <p>   --exclude-tags x,y,z</p>
-<p>   Change log will exclude specified tags</p>
+<p>   Changelog will exclude specified tags</p>
 <p>   --exclude-tags-regex [REGEX]</p>
@ -202,11 +202,11 @@
 <p>   --since-tag x</p>
-<p>   Change log will start after specified tag</p>
+<p>   Changelog will start after specified tag</p>
 <p>   --due-tag x</p>
-<p>   Change log will end before specified tag</p>
+<p>   Changelog will end before specified tag</p>
 <p>   --max-issues [NUMBER]</p>
@ -248,17 +248,34 @@
 <p>   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
 <pre><code>--ssl-ca-file [PATH]
 </code></pre>
 <p>   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>
 <p>   --require file1.rb,file2.rb</p>
 <p>   Paths to Ruby file(s) to require before generating changelog.</p>
 <p>   --[no-]verbose</p>
 <p>   Run verbosely. Default is true</p>
-<p>  -v, --version</p>
+<p>   --configure-sections [HASH, STRING]</p>
-<p>  Print version number</p>
+<p>   Define your own set of sections which overrides all default sections") do |v|</p>
-<p>  -h, --help</p>
+<p>   --add-sections [HASH, STRING]</p>
-<p>  Displays Help</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>
@ -277,7 +294,7 @@
  <ol class='man-decor man-foot man foot'>
    <li class='tl'></li>
-    <li class='tc'>December 2016</li>
+    <li class='tc'>December 2017</li>
    <li class='tr'>git-generate-changelog(1)</li>
  </ol>
--- a/man/git-generate-changelog.html
+++ b/man/git-generate-changelog.html
@ -80,7 +80,7 @@
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
-<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
+<p>Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.</p>
 <h2 id="OPTIONS">OPTIONS</h2>
@ -122,7 +122,7 @@
 <p>   --header-label [LABEL]</p>
-<p>   Setup custom header label. Default is "# Change Log"</p>
+<p>   Setup custom header label. Default is "# Changelog"</p>
 <p>   --pr-label [LABEL]</p>
@ -186,15 +186,15 @@
 <p>   --exclude-tags x,y,z</p>
-<p>   Change log will exclude specified tags</p>
+<p>   Changelog will exclude specified tags</p>
 <p>   --since-tag x</p>
-<p>   Change log will start after specified tag</p>
+<p>   Changelog will start after specified tag</p>
 <p>   --due-tag x</p>
-<p>   Change log will end before specified tag</p>
+<p>   Changelog will end before specified tag</p>
 <p>   --max-issues [NUMBER]</p>
@ -220,6 +220,18 @@
 <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>
--- a/man/git-generate-changelog.md
+++ b/man/git-generate-changelog.md
@ -1,4 +1,4 @@
-git-generate-changelog(1) - Generate changelog from github
+git-generate-changelog(1) - Generate changelog from GitHub
 ================================
 ## SYNOPSIS
@ -7,7 +7,7 @@ git-generate-changelog(1) - Generate changelog from github
 ## DESCRIPTION
-Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
+Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.
 ## OPTIONS
@ -49,7 +49,7 @@ Automatically generate change log from your tags, issues, labels and pull reques
   --header-label [LABEL]
-   Setup custom header label. Default is "# Change Log"
+   Setup custom header label. Default is "# Changelog"
   --front-matter [JSON]
@ -121,7 +121,7 @@ Automatically generate change log from your tags, issues, labels and pull reques
   --exclude-tags x,y,z
-   Change log will exclude specified tags
+   Changelog will exclude specified tags
   --exclude-tags-regex [REGEX]
@ -129,11 +129,11 @@ Automatically generate change log from your tags, issues, labels and pull reques
   --since-tag x
-   Change log will start after specified tag
+   Changelog will start after specified tag
   --due-tag x
-   Change log will end before specified tag
+   Changelog will end before specified tag
   --max-issues [NUMBER]
@ -177,19 +177,31 @@ Automatically generate change log from your tags, issues, labels and pull reques
    --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.
+   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
-  -v, --version
+   --configure-sections [HASH, STRING]
-  Print version number
+   Define your own set of sections which overrides all default sections") do |v|
-  -h, --help
+   --add-sections [HASH, STRING]
-  Displays Help
+   Add new sections but keep the default sections"
   -v, --version
   Print version number
   -h, --help
   Displays Help
 ## EXAMPLES
--- a/spec/files/github-changelog-generator.md
+++ b/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)*
--- a/spec/unit/generator/entry_spec.rb
+++ b/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
--- a/spec/unit/generator/generator_generation_spec.rb
+++ b/spec/unit/generator/generator_generation_spec.rb
@ -1,17 +0,0 @@
 # frozen_string_literal: true
 module GitHubChangelogGenerator
  describe Generator do
    describe "#get_string_for_issue" do
      let(:issue) do
        { "title" => "Bug in code" }
      end
      it "formats an issue according to options" do
        expect do
          described_class.new.get_string_for_issue(issue)
        end.not_to raise_error
      end
    end
  end
 end
--- a/spec/unit/generator/generator_tags_spec.rb
+++ b/spec/unit/generator/generator_tags_spec.rb
@ -182,6 +182,11 @@ describe GitHubChangelogGenerator::Generator 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
--- a/spec/unit/options_spec.rb
+++ b/spec/unit/options_spec.rb
@ -12,7 +12,7 @@ RSpec.describe GitHubChangelogGenerator::Options do
      it "raises an error" do
        expect do
          described_class.new(
-            git_remote: "origin",
+            project: "rails",
            strength: "super-strength",
            wisdom: "deep"
          )
@ -22,13 +22,13 @@ RSpec.describe GitHubChangelogGenerator::Options do
  end
  describe "#[]=(key, value)" do
-    let(:options) { described_class.new(git_remote: "origin") }
+    let(:options) { described_class.new(project: "rails") }
    context "with known options" do
      it "sets the option value" do
        expect do
-          options[:git_remote] = "in the cloud"
+          options[:project] = "trails"
-        end.to change { options[:git_remote] }.to "in the cloud"
+        end.to change { options[:project] }.to "trails"
      end
    end
--- a/spec/unit/parser_spec.rb
+++ b/spec/unit/parser_spec.rb
@ -1,83 +1,4 @@
 # frozen_string_literal: true
 describe GitHubChangelogGenerator::Parser do
  describe ".user_project_from_remote" do
    context "when remote is type 1" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin  https://github.com/skywinder/ActionSheetPicker-3.0 (fetch)") }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
    end
    context "when remote is type 2" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
    end
    context "when remote is type 3" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
    end
    context "when remote is type 4" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin git@github.com:skywinder/ActionSheetPicker-3.0.git (fetch)") }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
    end
    context "when remote is invalid" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("some invalid text") }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array([nil, nil]) }
    end
  end
  describe ".user_project_from_option" do
    context "when option is invalid" do
      it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil }
    end
    context "when option is valid" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
    end
    context "when option nil" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array([nil, nil]) }
    end
    context "when site is nil" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
    end
    context "when site is valid" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, "https://codeclimate.com") }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
    end
    context "when second arg is not nil" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", nil) }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array([nil, nil]) }
    end
    context "when all args is not nil" do
      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", "https://codeclimate.com") }
      it { is_expected.to be_a(Array) }
      it { is_expected.to match_array([nil, nil]) }
    end
  end
  describe ".fetch_user_and_project" do
    before do
      stub_const("ARGV", ["https://github.com/skywinder/github-changelog-generator"])
    end
    context do
      let(:valid_user) { "initialized_user" }
      let(:options) { { user: valid_user } }
      let(:options_before_change) { options.dup }
      it "should leave user unchanged" do
        expect { GitHubChangelogGenerator::Parser.fetch_user_and_project(options) }.to change { options }
          .from(options_before_change)
          .to(options_before_change.merge(project: "github-changelog-generator"))
      end
    end
  end
 end
--- a/spec/unit/reader_spec.rb
+++ b/spec/unit/reader_spec.rb
@ -51,7 +51,7 @@ describe GitHubChangelogGenerator::Reader do
      it { is_expected.to be_empty }
    end
    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
Author	SHA1	Message	Date
Olle Jonsson	f977cd1072	Linting: formatting code to suit RuboCop (#611 )	2018-01-01 17:02:25 +01:00
Ben Holden-Crowther	77c7234cf4	Update git-generate-changelog.md (#607 )	2018-01-01 16:20:54 +01:00
Ben Holden-Crowther	bf0b73b1c0	Update license date (#610 )	2018-01-01 16:08:34 +01:00
Olle Jonsson	941a92e96d	RuboCop linting	2017-12-29 16:17:02 +01:00
Olle Jonsson	e2ddb73373	Merge pull request #587 from eputnam/config_sections Add option --configure-sections, --add-sections, --include-merged	2017-12-15 16:23:29 +01:00
Ben Holden-Crowther	8d0bb7d22d	Capitalization and full stops (#605 )	2017-12-15 16:01:04 +01:00
Eric Putnam	587557e1ac	Refactor generation code and allow custom sections There's a lot in this PR. - Added a Section class to more easily make the other changes and hopefully add flexibility for the future - Added an option called `configure_sections` that allows you create your own custom sections. It blows away all other sections and uses only the ones you give it. - Added an option called `add_sections` that allows you to add_sections to the default section set - Added an option called `include_merged` that can be used when configure_sections is defined. Configure sections blows away any and all default sections so to get this one back, you have to set this option. - Added tests for this stuff @HAIL9000 was a co-author. Because of a little git snafu, I accidentally squashed all of our work into one so it looks like it was just me. --- Refactor details: Before this change, the code in generator.rb and generator_generation.rb was conflated and method call flow went back and forth between the two files seemingly randomly. They also both defined the exact same class, which is un-ruby-ish. I tried to separate methods used for the whole changelog generation from methods used for specific parts of the changelog and move them into specific classes. I reasoned that a changelog is a series of "entries" of all tagged releases plus an extra entry for the unreleased entry. Each entry is comprised of a header and a series of "sections" for that entry. Each section is comprized of a list of issues and/or pull requests for that entry. So the log contains entries, entries contain sections, and sections contain issues & prs. I have structured the classes around this idea. - lib/github_changelog_generator/generator/generator.rb is for code related to generating the entire changelog. - lib/github_changelog_generator/generator/entry.rb is for code related to generating entries. - lib/github_changelog_generator/generator/section.rb is for code relating to geneating entry sections. Issues and PRs are already special objects, so it doesn't make sense to break those out into their own class.	2017-12-14 16:13:41 -08:00
Saugat Acharya	d9cf6ffd94	Make 'change log' a single word (#579 )	2017-12-13 22:06:00 +01:00
Ben Holden-Crowther	d5f82c5994	README: Improve readability of GitHub error message explanation (#601 ) - As per #600 - [ci skip]	2017-12-13 21:02:26 +01:00
Olle Jonsson	ab6b38e315	RuboCop 0.52.0 linting (#603 ) * gemspec: Make 2.2.2 the earliest-supported Ruby version * Exclude linting which came out wrong	2017-12-13 21:00:36 +01:00
mueller-ma	9a9e57c9eb	Add $ or # to indicate whether a command needs to be run as root or n… (#602 ) - [ci skip]	2017-12-13 21:00:15 +01:00
Ben Holden-Crowther	ff6a9c0ff3	Minor change (#597 ) Another minor grammar change. [ci skip]	2017-12-10 13:01:28 +01:00
Olle Jonsson	5137c673a7	Merge pull request #596 from benhc123/patch-2 minor cosmetic change	2017-12-09 12:26:59 +01:00
Ben Holden-Crowther	1ded80026f	minor cosmetic change full stop and website vs Web site	2017-12-09 11:07:40 +00:00
Olle Jonsson	11d65548b8	Travis: jruby-9.1.15.0	2017-12-08 09:17:39 +01:00
Marco Ferrari	e87b267b0e	Implemented a Dockerfile (#592 ) * Implemented a Dockerfile. See skywinder/github-changelog-generator#591 * Set Ferrari Marco as a maintainer * Explicitly install the latest released version	2017-11-23 14:08:50 +01:00
Olle Jonsson	72452a1315	CHANGELOG for v1.15.0-rc	2017-10-29 19:03:26 +01:00
Olle Jonsson	9377fe600a	v1.15.0-rc	2017-10-29 18:59:21 +01:00
Olle Jonsson	11a7243de1	README: Markdown typo [ci skip]	2017-10-29 17:54:43 +01:00
Olle Jonsson	307994e11f	Merge pull request #578 from olleolleolle/improve-abort-on-missing-info Aborting on missing --user and --project prints all of usage	2017-10-27 09:48:35 +02:00
Olle Jonsson	4465adf943	Linting	2017-10-27 09:29:17 +02:00
Olle Jonsson	5834fd3766	Update parser.rb	2017-10-27 09:28:52 +02:00
Olle Jonsson	b486425af1	Parser: less wordy output	2017-10-27 09:28:52 +02:00
Olle Jonsson	91ac00c1d3	Abort with friendly message on no user or project	2017-10-27 09:28:52 +02:00
Olle Jonsson	4f640b74ac	Aborting prints all of usage	2017-10-27 09:28:52 +02:00
Olle Jonsson	178ebfb1e7	Travis: in smoke tests, skip codeclimate	2017-10-27 09:00:08 +02:00
Olle Jonsson	eef787d74d	Travis: use pre-installed Rubies - for faster feedback	2017-10-27 08:52:23 +02:00
Olle Jonsson	faf2ddd552	Linting	2017-10-27 08:49:52 +02:00
Olle Jonsson	14c36317f1	Merge pull request #584 from olleolleolle/fix/rake-task-missing-options Add Rake options reported missing	2017-10-26 14:45:02 +02:00
Olle Jonsson	deb902ae13	Add Rake options reported missing	2017-10-26 01:35:51 +02:00
Olle Jonsson	10e6287866	Merge pull request #576 from olleolleolle/fix/docs-for-api Options#print_options + API docs for Options, Parser	2017-10-14 22:13:12 +02:00
Olle Jonsson	5bb4d51b96	Options#print_options: tell don't ask	2017-10-14 21:52:26 +02:00
Olle Jonsson	1fac4efe47	[docs] API docs for Options, Parser - shorten implementation of print_options	2017-10-14 21:28:02 +02:00
Olle Jonsson	ad0d972ed9	Add option --require to load custom Ruby code (#574 )	2017-10-14 21:00:56 +02:00
Olle Jonsson	79518161b8	[docs] Contributing file (#575 ) - [ci skip]	2017-10-14 15:33:34 +02:00
Olle Jonsson	db0e848208	CHANGELOG for v1.15.0.pre.beta	2017-10-13 21:14:22 +02:00
Olle Jonsson	d16bf4cfaa	v1.15.0-beta	2017-10-13 21:08:09 +02:00
Ewoud Kohl van Wijngaarden	fe7c585ed1	Fix regression w/ enhancements in issues_to_log (#573 ) Introduced in 21ec2db39bafc9468c9a9099947cd48b7fe27c0a.	2017-10-13 06:08:59 +02:00
Olle Jonsson	3f8fb60af3	OctoFetcher: Use defaults for request_options (#571 ) * OctoFetcher: rely on default args - in iterate_pages * OctoFetcher: extract options method	2017-10-10 23:48:00 +02:00
Olle Jonsson	23b341f715	OctoFetcher: extract methods (#570 ) * OctoFetcher: extract methods * OctoFetcher: extract github_options smethod * OctoFetcher: Document exception, name parameters - more communicative names * OctoFetcher#fetch_github_token: simplify - using ActiveSupport * OctoFetcher#init_cache: fewer statements * OctoFetcher: inline calls, name parameters * OctoFetcher: name parameters, inline local	2017-10-10 23:05:10 +02:00
Olle Jonsson	630b8cee88	OctoFetcher: extract method fail_with_message (#569 )	2017-10-10 21:42:29 +02:00
Olle Jonsson	74fdc2026a	OctoFetcher: drop unused number_of_pages feature (#568 )	2017-10-10 21:22:17 +02:00
Tim Meusel	21ec2db39b	Add breaking-changes section to changelog (#530 ) * add breaking-changes section to changelog * Clean up parse_by_sections * Thank you bastelfreak and ekohl!	2017-10-10 20:27:23 +02:00
Olle Jonsson	d1e09f6964	Travis: Do not test on jruby-head (#567 )	2017-10-10 20:11:36 +02:00
Olle Jonsson	b36d85eb53	Drop Project-and-Username-finding code (#451 ) * Remove Project-and-Username finding code and usages * Remove "github_remote" option, now unused * Update README: Usage has changed	2017-10-10 19:53:21 +02:00
Ben Holden-Crowther	1658b41dff	Update license date to a range (#553 ) * Update license date to a range containing 2017	2017-10-05 23:38:23 +02:00
Florian Thomas	64f4cd07c9	filter tags correctly when `since_tag` is set to most recent tag (#566 ) * filter tags correctly when `since_tag` is set to most recent tag Before this fix [`filtered_tags`](https://github.com/skywinder/github-changelog-generator/blob/master/lib/github_changelog_generator/generator/generator_generation.rb#L132) was empty which caused a fallback to the last tag in the sorted_tags array (which is the oldest tag). There for no issues and PRs were filtered in that case. fixes #555 fixes #304	2017-10-05 23:15:06 +02:00
Olle Jonsson	7cbe41555a	Drop unused Rake task (#564 )	2017-10-04 09:06:49 +02:00
Olle Jonsson	dd956b7b95	CHANGELOG for v1.15.0.pre.alpha	2017-10-01 15:47:16 +02:00
		`@ -0,0 +1,2 @@`
							`project=github-changelog-generator`
							`user=skywinder`