Merge branch 'release/1.11.6'

Gemspec: Calculate date using Date stdlib

.gitignore

@@ -0,0 +1 @@
+coverage/

.rubocop.yml

@@ -18,3 +18,39 @@ Metrics/MethodLength:
 Style/FileName:
     Exclude:
       - 'bin/git-generate-changelog'
+
+#TODOS
+# Offense count: 14
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 10
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+# SupportedStyles: skip_modifier_ifs, always
+Style/Next:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/MutableConstant:
+    Enabled: false
+    

.rubocop_todo.yml

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

.travis.yml

@@ -1,13 +1,22 @@
+sudo: false
 language: ruby
-before_install: gem update --system
+before_install:
+  - gem update --system
+  - gem install bundler
 rvm:
-- 2.1.0
+  - 2.1.0
-script:
+script: bundle exec rake checks
-- bundle exec rake
+matrix:
+  include:
+    # Test install on clean system
+    - install: true
+      script:
+        - gem build github_changelog_generator
+        - gem install *.gem
 notifications:
   email:
     recipients:
-    - sky4winder+githubchangeloggenerator@gmail.com
+      - sky4winder+githubchangeloggenerator@gmail.com
     on_success: never
     on_failure: change
 addons:

CHANGELOG.md

@@ -1,5 +1,117 @@
 # Change Log
 
+## [1.11.5](https://github.com/skywinder/github-changelog-generator/tree/1.11.5) (2016-03-01)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.4...1.11.5)
+
+**Merged pull requests:**
+
+- Test clean install in Travis [\#344](https://github.com/skywinder/github-changelog-generator/pull/344) ([jkeiser](https://github.com/jkeiser))
+- Update Rakefile to avoid install-breaking bug [\#341](https://github.com/skywinder/github-changelog-generator/pull/341) ([olleolleolle](https://github.com/olleolleolle))
+
+## [1.11.4](https://github.com/skywinder/github-changelog-generator/tree/1.11.4) (2016-02-26)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.3...1.11.4)
+
+**Merged pull requests:**
+
+- Man page copying: only copy .1 [\#338](https://github.com/skywinder/github-changelog-generator/pull/338) ([olleolleolle](https://github.com/olleolleolle))
+
+## [1.11.3](https://github.com/skywinder/github-changelog-generator/tree/1.11.3) (2016-02-25)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.2...1.11.3)
+
+**Closed issues:**
+
+- Cannot install gem [\#335](https://github.com/skywinder/github-changelog-generator/issues/335)
+
+## [1.11.2](https://github.com/skywinder/github-changelog-generator/tree/1.11.2) (2016-02-25)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.1...1.11.2)
+
+**Fixed bugs:**
+
+- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
+
+**Merged pull requests:**
+
+- Fix installation by not running the specs - which have dependencies [\#337](https://github.com/skywinder/github-changelog-generator/pull/337) ([skywinder](https://github.com/skywinder))
+
+## [1.11.1](https://github.com/skywinder/github-changelog-generator/tree/1.11.1) (2016-02-25)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.0...1.11.1)
+
+**Merged pull requests:**
+
+- Add rubocop and rspec as runtime dependencies [\#336](https://github.com/skywinder/github-changelog-generator/pull/336) ([jkeiser](https://github.com/jkeiser))
+- \[Refactor\] ParserFile class use Pathname [\#334](https://github.com/skywinder/github-changelog-generator/pull/334) ([olleolleolle](https://github.com/olleolleolle))
+- \[Refactor\] Generator\#exclude\_issues\_by\_labels simpler, tested [\#332](https://github.com/skywinder/github-changelog-generator/pull/332) ([olleolleolle](https://github.com/olleolleolle))
+
+## [1.11.0](https://github.com/skywinder/github-changelog-generator/tree/1.11.0) (2016-02-24)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.5...1.11.0)
+
+## [1.10.5](https://github.com/skywinder/github-changelog-generator/tree/1.10.5) (2016-02-24)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.4...1.10.5)
+
+## [1.10.4](https://github.com/skywinder/github-changelog-generator/tree/1.10.4) (2016-02-24)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.3...1.10.4)
+
+**Fixed bugs:**
+
+- Rake and Bundler as runtime deps [\#333](https://github.com/skywinder/github-changelog-generator/pull/333) ([olleolleolle](https://github.com/olleolleolle))
+
+**Merged pull requests:**
+
+- Test case for \#327 [\#331](https://github.com/skywinder/github-changelog-generator/pull/331) ([olleolleolle](https://github.com/olleolleolle))
+- Fix crash installing on systems without overcommit [\#330](https://github.com/skywinder/github-changelog-generator/pull/330) ([jkeiser](https://github.com/jkeiser))
+
+## [1.10.3](https://github.com/skywinder/github-changelog-generator/tree/1.10.3) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...1.10.3)
+
+## [1.10.2](https://github.com/skywinder/github-changelog-generator/tree/1.10.2) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.11.0...1.10.2)
+
+## [v1.11.0](https://github.com/skywinder/github-changelog-generator/tree/v1.11.0) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.1...v1.11.0)
+
+**Implemented enhancements:**
+
+- YAML front matter [\#322](https://github.com/skywinder/github-changelog-generator/pull/322) ([retorquere](https://github.com/retorquere))
+- Git Subcommand [\#288](https://github.com/skywinder/github-changelog-generator/pull/288) ([dlanileonardo](https://github.com/dlanileonardo))
+
+**Fixed bugs:**
+
+- detect\_since\_tag undefined [\#328](https://github.com/skywinder/github-changelog-generator/issues/328)
+
+**Merged pull requests:**
+
+- Update README.md [\#324](https://github.com/skywinder/github-changelog-generator/pull/324) ([Zearin](https://github.com/Zearin))
+
+## [1.10.1](https://github.com/skywinder/github-changelog-generator/tree/1.10.1) (2016-01-06)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.0...1.10.1)
+
+**Fixed bugs:**
+
+- Parser: avoid Ruby exit, to make Rake tasks work [\#315](https://github.com/skywinder/github-changelog-generator/pull/315) ([olleolleolle](https://github.com/olleolleolle))
+
+## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
+
+**Implemented enhancements:**
+
+- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
+- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
+- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
+
+**Closed issues:**
+
+- PRs not closed on master branch show up in changelog [\#280](https://github.com/skywinder/github-changelog-generator/issues/280)
+
+**Merged pull requests:**
+
+- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
+- Fixes \#280 Add release-branch option to filter the Pull Requests [\#305](https://github.com/skywinder/github-changelog-generator/pull/305) ([SteveGilvarry](https://github.com/SteveGilvarry))
+- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
+- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
+- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
+- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
+- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
+
 ## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
 

Gemfile

@@ -3,8 +3,10 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem "rspec", "~>3.2"
+  gem "rake"
-  gem "rubocop", "~>0.31"
+  gem "bundler"
+  gem "rubocop"
+  gem "overcommit"
   gem "coveralls", "~>0.8", require: false
   gem "simplecov", "~>0.10", require: false
   gem "codeclimate-test-reporter", "~>0.4"

Gemfile.lock

@@ -1,92 +1,88 @@
 PATH
   remote: .
   specs:
-    github_changelog_generator (1.9.0)
+    github_changelog_generator (1.11.5)
+      bundler (>= 1.7)
       colorize (~> 0.7)
       github_api (~> 0.12)
+      overcommit (>= 0.31)
+      rake (>= 10.0)
+      rspec (>= 3.2)
+      rubocop (>= 0.31)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.8)
+    addressable (2.4.0)
-    ast (2.0.0)
+    ast (2.2.0)
-    astrolabe (1.3.1)
+    childprocess (0.5.9)
-      parser (~> 2.2)
+      ffi (~> 1.0, >= 1.0.11)
-    codeclimate-test-reporter (0.4.7)
+    codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
     colorize (0.7.7)
-    coveralls (0.8.2)
+    coveralls (0.8.11)
       json (~> 1.8)
-      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.11.0)
-      simplecov (~> 0.10.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
+      tins (~> 1.6.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    domain_name (0.5.24)
+    faraday (0.9.2)
-      unf (>= 0.0.5, < 1.0.0)
-    faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
-    github_api (0.12.4)
+    ffi (1.9.10)
-      addressable (~> 2.3)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
       hashie (>= 3.4)
       multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.6)
       oauth2
-    hashie (3.4.2)
+    hashie (3.4.3)
-    http-cookie (1.0.2)
+    iniparse (1.4.2)
-      domain_name (~> 0.5)
     json (1.8.3)
     jwt (1.5.1)
-    mime-types (2.6.1)
-    mini_portile (0.6.2)
     multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    netrc (0.10.3)
+    oauth2 (1.1.0)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    oauth2 (1.0.0)
       faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
+      jwt (~> 1.0, < 1.5.2)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
+      rack (>= 1.2, < 3)
-    parser (2.2.2.6)
+    overcommit (0.32.0)
-      ast (>= 1.1, < 3.0)
+      childprocess (~> 0.5.8)
+      iniparse (~> 1.4)
+    parser (2.3.0.6)
+      ast (~> 2.2)
     powerpack (0.1.1)
     rack (1.6.4)
-    rainbow (2.0.0)
+    rainbow (2.1.0)
-    rake (10.4.2)
+    rake (10.5.0)
-    rest-client (1.8.0)
+    rspec (3.4.0)
-      http-cookie (>= 1.0.2, < 2.0)
+      rspec-core (~> 3.4.0)
-      mime-types (>= 1.16, < 3.0)
+      rspec-expectations (~> 3.4.0)
-      netrc (~> 0.7)
+      rspec-mocks (~> 3.4.0)
-    rspec (3.3.0)
+    rspec-core (3.4.3)
-      rspec-core (~> 3.3.0)
+      rspec-support (~> 3.4.0)
-      rspec-expectations (~> 3.3.0)
+    rspec-expectations (3.4.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
+      rspec-support (~> 3.4.0)
-    rspec-mocks (3.3.2)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
+      rspec-support (~> 3.4.0)
-    rspec-support (3.3.0)
+    rspec-support (3.4.1)
-    rubocop (0.32.1)
+    rubocop (0.37.2)
-      astrolabe (~> 1.3)
+      parser (>= 2.3.0.4, < 3.0)
-      parser (>= 2.2.2.5, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
     ruby-progressbar (1.7.5)
-    simplecov (0.10.0)
+    simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
@@ -95,23 +91,21 @@ GEM
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.5)
-    tins (1.5.4)
+    tins (1.6.0)
-    unf (0.1.4)
+    unicode-display_width (0.3.1)
-      unf_ext
-    unf_ext (0.0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.7)
+  bundler
   codeclimate-test-reporter (~> 0.4)
   coveralls (~> 0.8)
   github_changelog_generator!
-  rake (~> 10.0)
+  overcommit
-  rspec (~> 3.2)
+  rake
-  rubocop (~> 0.31)
+  rubocop
   simplecov (~> 0.10)
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

README.md

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

Rakefile

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

ext/mkrf_conf.rb

@@ -1,10 +0,0 @@
-PREFIX = "/usr/local"
-MANPREFIX = "#{PREFIX}/share/man/man1"
-MAN_PAGES = "man/git-*"
-
-require "fileutils"
-
-Dir.glob(MAN_PAGES).each do |f|
-  filename = File.basename(f)
-  FileUtils.cp(f, "#{MANPREFIX}/#{filename}")
-end

github_changelog_generator.gemspec

@@ -1,5 +1,5 @@
 # coding: utf-8
-
+require "date"
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "github_changelog_generator/version"
@@ -9,25 +9,26 @@ 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 = ">= 1.9.3"
   spec.authors = ["Petr Korolev"]
   spec.email = "sky4winder+github_changelog_generator@gmail.com"
-  spec.date = `date +"%Y-%m-%d"`.strip!
+  spec.date = Date.today.iso8601
   spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
   spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
   spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
-  spec.license       = "MIT"
+  spec.license = "MIT"
-  spec.extensions  = "ext/mkrf_conf.rb"
+  spec.extensions = ["Rakefile"]
 
   spec.files = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "rake", ">= 10.0"
+  spec.add_runtime_dependency "bundler", ">= 1.7"
   spec.add_runtime_dependency("github_api", ["~> 0.12"])
   spec.add_runtime_dependency("colorize", ["~> 0.7"])
-
+  spec.add_runtime_dependency("overcommit", ">= 0.31")
-  # Development only
+  spec.add_runtime_dependency("rubocop", ">= 0.31")
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_runtime_dependency("rspec", ">= 3.2")
-  spec.add_development_dependency "rake", "~> 10.0"
 end

lib/CHANGELOG.md

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

lib/github_changelog_generator.rb

@@ -28,7 +28,7 @@ module GitHubChangelogGenerator
     def run
       log = @generator.compound_changelog
 
-      output_filename = "#{@options[:output]}"
+      output_filename = (@options[:output]).to_s
       File.open(output_filename, "w") { |file| file.write(log) }
       puts "Done!"
       puts "Generated log placed in #{Dir.pwd}/#{output_filename}"

lib/github_changelog_generator/fetcher.rb

@@ -18,12 +18,12 @@ module GitHubChangelogGenerator
       @user = @options[:user]
       @project = @options[:project]
       @github_token = fetch_github_token
-      github_options = { per_page: PER_PAGE_NUMBER }
+      @github_options = { per_page: PER_PAGE_NUMBER }
-      github_options[:oauth_token] = @github_token unless @github_token.nil?
+      @github_options[:oauth_token] = @github_token unless @github_token.nil?
-      github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
+      @github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
-      github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
+      @github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
 
-      @github = check_github_response { Github.new github_options }
+      @github = check_github_response { Github.new @github_options }
     end
 
     # Returns GitHub token. First try to use variable, provided by --token option,
@@ -123,7 +123,16 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
     def fetch_closed_pull_requests
       pull_requests = []
       begin
-        response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
+        response = if @options[:release_branch].nil?
+                     @github.pull_requests.list @options[:user],
+                                                @options[:project],
+                                                state: "closed"
+                   else
+                     @github.pull_requests.list @options[:user],
+                                                @options[:project],
+                                                state: "closed",
+                                                base: @options[:release_branch]
+                   end
         page_i = 0
         count_pages = response.count_pages
         response.each_page do |page|

lib/github_changelog_generator/generator/generator_generation.rb

@@ -8,13 +8,15 @@ module GitHubChangelogGenerator
       sort_tags_by_date(@filtered_tags)
       fetch_issues_and_pr
 
-      log = "#{@options[:header]}\n\n"
+      log = ""
+      log += @options[:frontmatter] if @options[:frontmatter]
+      log += "#{@options[:header]}\n\n"
 
-      if @options[:unreleased_only]
+      log += if @options[:unreleased_only]
-        log += generate_log_between_tags(filtered_tags[0], nil)
+               generate_log_between_tags(filtered_tags[0], nil)
-      else
+             else
-        log += generate_log_for_all_tags
+               generate_log_for_all_tags
-      end
+             end
 
       log += File.read(@options[:base]) if File.file?(@options[:base])
 
@@ -37,10 +39,10 @@ module GitHubChangelogGenerator
           index2 = hash[tag2]
           log += generate_log_between_tags(all_tags[index1], all_tags[index2])
         else
-          fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
+          raise ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
         end
       else
-        fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
+        raise ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
       end
       log
     end
@@ -77,16 +79,16 @@ module GitHubChangelogGenerator
       time_string = newer_tag_time.strftime @options[:date_format]
 
       # Generate tag name and link
-      if @options[:release_url]
+      release_url = if @options[:release_url]
-        release_url = format(@options[:release_url], newer_tag_link)
+                      format(@options[:release_url], newer_tag_link)
-      else
+                    else
-        release_url = "#{project_url}/tree/#{newer_tag_link}"
+                      "#{project_url}/tree/#{newer_tag_link}"
-      end
+                    end
-      if newer_tag_name.equal? @options[:unreleased_label]
+      log += if newer_tag_name.equal? @options[:unreleased_label]
-        log += "## [#{newer_tag_name}](#{release_url})\n\n"
+               "## [#{newer_tag_name}](#{release_url})\n\n"
-      else
+             else
-        log += "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
+               "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
-      end
+             end
 
       if @options[:compare_link] && older_tag_link
         # Generate compare link
@@ -169,11 +171,11 @@ module GitHubChangelogGenerator
 
       unless issue.pull_request.nil?
         if @options[:author]
-          if issue.user.nil?
+          title_with_number += if issue.user.nil?
-            title_with_number += " ({Null user})"
+                                 " ({Null user})"
-          else
+                               else
-            title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
+                                 " ([#{issue.user.login}](#{issue.user.html_url}))"
-          end
+                               end
         end
       end
       title_with_number

lib/github_changelog_generator/generator/generator_processor.rb

@@ -4,13 +4,12 @@ module GitHubChangelogGenerator
     # @param [Array] issues
     # @return [Array] filtered array
     def exclude_issues_by_labels(issues)
-      unless @options[:exclude_labels].nil?
+      return issues if !@options[:exclude_labels] || @options[:exclude_labels].empty?
-        issues = issues.select do |issue|
+
-          var = issue.labels.map(&:name) & @options[:exclude_labels]
+      issues.reject do |issue|
-          !(var).any?
+        labels = issue.labels.map(&:name)
-        end
+        (labels & @options[:exclude_labels]).any?
       end
-      issues
     end
 
     # @return [Array] filtered issues accourding milestone
@@ -83,7 +82,7 @@ module GitHubChangelogGenerator
 
           tag_in_range_new = tag_older_new_tag?(newer_tag_time, time)
 
-          tag_in_range = (tag_in_range_old) && (tag_in_range_new)
+          tag_in_range = tag_in_range_old && tag_in_range_new
 
           tag_in_range
         else
@@ -93,20 +92,20 @@ module GitHubChangelogGenerator
     end
 
     def tag_older_new_tag?(newer_tag_time, time)
-      if newer_tag_time.nil?
+      tag_in_range_new = if newer_tag_time.nil?
-        tag_in_range_new = true
+                           true
-      else
+                         else
-        tag_in_range_new = time <= newer_tag_time
+                           time <= newer_tag_time
-      end
+                         end
       tag_in_range_new
     end
 
     def tag_newer_old_tag?(older_tag_time, t)
-      if older_tag_time.nil?
+      tag_in_range_old = if older_tag_time.nil?
-        tag_in_range_old = true
+                           true
-      else
+                         else
-        tag_in_range_old = t > older_tag_time
+                           t > older_tag_time
-      end
+                         end
       tag_in_range_old
     end
 
@@ -133,7 +132,7 @@ module GitHubChangelogGenerator
     def filter_by_include_labels(issues)
       filtered_issues = @options[:include_labels].nil? ? issues : issues.select do |issue|
         labels = issue.labels.map(&:name) & @options[:include_labels]
-        (labels).any?
+        labels.any?
       end
       filtered_issues
     end
@@ -178,8 +177,10 @@ module GitHubChangelogGenerator
         fetched_pr = closed_pull_requests.find do |fpr|
           fpr.number == pr.number
         end
-        pr[:merged_at] = fetched_pr[:merged_at]
+        if fetched_pr
-        closed_pull_requests.delete(fetched_pr)
+          pr[:merged_at] = fetched_pr[:merged_at]
+          closed_pull_requests.delete(fetched_pr)
+        end
       end
 
       pull_requests.select! do |pr|

lib/github_changelog_generator/generator/generator_tags.rb

@@ -19,7 +19,7 @@ module GitHubChangelogGenerator
     # @param [Hash] tag_name name of the tag
     # @return [Time] time of specified tag
     def get_time_of_tag(tag_name)
-      fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
+      raise ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
 
       name_of_tag = tag_name["name"]
       time_for_name = @tag_times_hash[name_of_tag]
@@ -58,7 +58,7 @@ module GitHubChangelogGenerator
       if @since_tag.nil? && @options[:base] && File.file?(@options[:base])
         reader = GitHubChangelogGenerator::Reader.new
         content = reader.read(@options[:base])
-        @since_tag = content[0]["version"] if content
+        @since_tag = content[0]["version"] if content.count && content
       end
       @since_tag
     end
@@ -80,11 +80,11 @@ module GitHubChangelogGenerator
       if tag
         if all_tags.map(&:name).include? tag
           idx = all_tags.index { |t| t.name == tag }
-          if idx > 0
+          filtered_tags = if idx > 0
-            filtered_tags = all_tags[0..idx - 1]
+                            all_tags[0..idx - 1]
-          else
+                          else
-            filtered_tags = []
+                            []
-          end
+                          end
         else
           Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
         end
@@ -101,11 +101,11 @@ module GitHubChangelogGenerator
         if (all_tags.count > 0) && (all_tags.map(&:name).include? tag)
           idx = all_tags.index { |t| t.name == tag }
           last_index = all_tags.count - 1
-          if idx > 0 && idx < last_index
+          filtered_tags = if idx > 0 && idx < last_index
-            filtered_tags = all_tags[idx + 1..last_index]
+                            all_tags[idx + 1..last_index]
-          else
+                          else
-            filtered_tags = []
+                            []
-          end
+                          end
         else
           Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
         end

lib/github_changelog_generator/helper.rb

@@ -3,14 +3,14 @@ module GitHubChangelogGenerator
   module Helper
     # @return true if the currently running program is a unit test
     def self.test?
-      defined?SpecHelper
+      defined? SpecHelper
     end
 
-    if test?
+    @log ||= if test?
-      @log ||= Logger.new(nil) # don't show any logs when running tests
+               Logger.new(nil) # don't show any logs when running tests
-    else
+             else
-      @log ||= Logger.new(STDOUT)
+               Logger.new(STDOUT)
-    end
+             end
     @log.formatter = proc do |severity, _datetime, _progname, msg|
       string = "#{msg}\n"
 

lib/github_changelog_generator/parser.rb

@@ -7,22 +7,16 @@ module GitHubChangelogGenerator
   class Parser
     # parse options with optparse
     def self.parse_options
-      options = get_default_options
+      options = default_options
 
-      parser_file = ParserFile.new options
+      ParserFile.new(options).parse!
-      parser_file.parse!
 
       parser = setup_parser(options)
       parser.parse!
 
-      if options[:user].nil? || options[:project].nil?
+      user_and_project_from_git(options)
-        detect_user_and_project(options, ARGV[0], ARGV[1])
-      end
 
-      if !options[:user] || !options[:project]
+      abort(parser.banner) unless options[:user] && options[:project]
-        puts parser.banner
-        exit
-      end
 
       print_options(options)
 
@@ -74,6 +68,9 @@ module GitHubChangelogGenerator
         opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
           options[:header] = v
         end
+        opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
+          options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
+        end
         opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
           options[:merge_prefix] = v
         end
@@ -149,6 +146,9 @@ module GitHubChangelogGenerator
         opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
           options[:future_release] = future_release
         end
+        opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
+          options[:release_branch] = release_branch
+        end
         opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
           options[:verbose] = v
         end
@@ -165,8 +165,8 @@ module GitHubChangelogGenerator
     end
 
     # just get default options
-    def self.get_default_options
+    def self.default_options
-      options = {
+      {
         tag1: nil,
         tag2: nil,
         date_format: "%Y-%m-%d",
@@ -194,21 +194,25 @@ module GitHubChangelogGenerator
         enhancement_prefix: "**Implemented enhancements:**",
         git_remote: "origin"
       }
+    end
 
-      options
+    def self.user_and_project_from_git(options)
+      if options[:user].nil? || options[:project].nil?
+        detect_user_and_project(options, ARGV[0], ARGV[1])
+      end
     end
 
     # Detects user and project from git
     def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
       options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
-      if !options[:user] || !options[:project]
+      return if options[:user] && options[:project]
-        if ENV["RUBYLIB"] =~ /ruby-debug-ide/
+
-          options[:user] = "skywinder"
+      if ENV["RUBYLIB"] =~ /ruby-debug-ide/
-          options[:project] = "changelog_test"
+        options[:user] = "skywinder"
-        else
+        options[:project] = "changelog_test"
-          remote = `git config --get remote.#{options[:git_remote]}.url`
+      else
-          options[:user], options[:project] = user_project_from_remote(remote)
+        remote = `git config --get remote.#{options[:git_remote]}.url`
-        end
+        options[:user], options[:project] = user_project_from_remote(remote)
       end
     end
 
@@ -216,7 +220,7 @@ module GitHubChangelogGenerator
     #
     # @param [String] output of git remote command
     # @return [Array] user and project
-    def self.user_project_from_option(arg0, arg1, github_site = nil)
+    def self.user_project_from_option(arg0, arg1, github_site)
       user = nil
       project = nil
       github_site ||= "github.com"
@@ -229,10 +233,10 @@ module GitHubChangelogGenerator
           param = match[2].nil?
         rescue
           puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
-          exit
+          return
         end
         if param
-          exit
+          return
         else
           user = match[1]
           project = match[2]
@@ -275,9 +279,4 @@ module GitHubChangelogGenerator
       [user, project]
     end
   end
-
-  if __FILE__ == $PROGRAM_NAME
-    remote = "invalid reference to project"
-    p user_project_from_option(ARGV[0], ARGV[1], remote)
-  end
 end

lib/github_changelog_generator/parser_file.rb

@@ -1,28 +1,33 @@
+require "pathname"
+
 module GitHubChangelogGenerator
+  ParserError = Class.new(StandardError)
+
   class ParserFile
+    FILENAME = ".github_changelog_generator"
+
     def initialize(options)
       @options = options
     end
 
+    # Destructively change @options using data in configured options file.
     def parse!
-      return unless File.exist?(file)
+      file.each_line { |line| parse_line!(line) } if file.exist?
-
-      File.readlines(file).each { |line| parse_line!(line) }
     end
 
     private
 
     def file
-      @file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
+      @file ||= Pathname(File.expand_path(@options[:params_file] || FILENAME))
     end
 
     def parse_line!(line)
       key_sym, value = extract_pair(line)
-      value = true if value =~ (/^(true|t|yes|y|1)$/i)
+      value = true if value =~ /^(true|t|yes|y|1)$/i
-      value = false if value =~ (/^(false|f|no|n|0)$/i)
+      value = false if value =~ /^(false|f|no|n|0)$/i
       @options[key_sym] = value
     rescue
-      raise "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
+      raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
     end
 
     # Returns a the setting as a symbol and its string value sans newlines.

lib/github_changelog_generator/reader.rb

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

lib/github_changelog_generator/task.rb

@@ -16,7 +16,8 @@ module GitHubChangelogGenerator
                   bug_labels enhancement_labels
                   between_tags exclude_tags since_tag max_issues
                   github_site github_endpoint simple_list
-                  future_release verbose release_url base )
+                  future_release release_branch verbose release_url
+                  base )
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym
@@ -36,18 +37,16 @@ module GitHubChangelogGenerator
     def define(args, &task_block)
       desc "Generate a Change log from GitHub"
 
-      task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
+      yield(*[self, args].slice(0, task_block.arity)) if task_block
 
       # clear any (auto-)pre-existing task
       Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
 
       task @name do
         # mimick parse_options
-        options = Parser.get_default_options
+        options = Parser.default_options
 
-        if options[:user].nil? || options[:project].nil?
+        Parser.user_and_project_from_git(options)
-          Parser.detect_user_and_project(options)
-        end
 
         OPTIONS.each do |o|
           v = instance_variable_get("@#{o}")
@@ -58,7 +57,7 @@ module GitHubChangelogGenerator
 
         log = generator.compound_changelog
 
-        output_filename = "#{options[:output]}"
+        output_filename = (options[:output]).to_s
         File.open(output_filename, "w") { |file| file.write(log) }
         puts "Done!"
         puts "Generated log placed in #{Dir.pwd}/#{output_filename}"

lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = "1.9.0"
+  VERSION = "1.11.6"
 end

spec/files/github_changelog_params_327

@@ -0,0 +1 @@
+exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90

spec/spec_helper.rb

@@ -23,11 +23,11 @@ require "coveralls"
 module SpecHelper
 end
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-  Coveralls::SimpleCov::Formatter,
+                                                                 Coveralls::SimpleCov::Formatter,
-  SimpleCov::Formatter::HTMLFormatter,
+                                                                 SimpleCov::Formatter::HTMLFormatter,
-  CodeClimate::TestReporter::Formatter
+                                                                 CodeClimate::TestReporter::Formatter
-]
+                                                               ])
 SimpleCov.start
 
 require "github_changelog_generator"

spec/unit/generator/generator_processor_spec.rb

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

spec/unit/parse_file_spec.rb

@@ -20,11 +20,11 @@ describe GitHubChangelogGenerator::ParserFile do
       let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
       let(:options_before_change) { options.dup }
       let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
-      it { expect { parse.parse! }.to raise_error }
+      it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) }
     end
 
     context "when override default values" do
-      let(:default_options) { GitHubChangelogGenerator::Parser.get_default_options }
+      let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
       let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
       let(:options_before_change) { options.dup }
       let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
@@ -36,6 +36,20 @@ describe GitHubChangelogGenerator::ParserFile do
                                           unreleased: false,
                                           header: "=== Changelog ==="))
       end
+
+      context "turns exclude-labels into an Array", bug: '#327' do
+        let(:options) do
+          {
+            params_file: "spec/files/github_changelog_params_327"
+          }
+        end
+        it "reads exclude_labels into an Array" do
+          pending("Related with Bug #327.")
+          expect { parse.parse! }.to change { options[:exclude_labels] }
+            .from(nil)
+            .to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
+        end
+      end
     end
   end
 end

spec/unit/parser_spec.rb

@@ -28,16 +28,16 @@ describe GitHubChangelogGenerator::Parser do
   end
   describe ".user_project_from_option" do
     context "when option is invalid" do
-      it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
+      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) }
+      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) }
+      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