Merge branch 'release/1.4.1'

Add future release option

.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

.hound.yml

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

.overcommit.yml

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

.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Enabled: false
+
+#http://viget.com/extend/just-use-double-quoted-ruby-strings
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

.rubocop_todo.yml

@@ -0,0 +1,74 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-05-14 16:51:06 +0300 using RuboCop version 0.31.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 15
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 2
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 337
+
+# Offense count: 5
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Offense count: 22
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Enabled: false
+
+# Offense count: 5
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Offense count: 4
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AndOr:
+  Enabled: false
+
+# Offense count: 19
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
+  Enabled: false
+
+# Offense count: 4
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 5
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 15
+# Cop supports --auto-correct.
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+Style/Next:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+Style/RegexpLiteral:
+  Enabled: false

.travis.yml

@@ -1,15 +1,17 @@
+sudo: false
+cache: bundler
 language: ruby
-before_install:
-  - gem update --system
-  - gem --version
 rvm:
-  - 2.1.0
+- 2.1.0
-gemfile:
+script:
-  - Gemfile
+- bundle exec rake
-
 notifications:
   email:
     recipients:
-      - sky4winder+githubchangeloggenerator@gmail.com
+    - sky4winder+githubchangeloggenerator@gmail.com
-    on_success: never # [always|never|change]
+    on_success: never
-    on_failure: change # [always|never|change]
+    on_failure: change
+addons:
+  code_climate:
+    repo_token:
+      secure: iMpV5IAvH+/EVGZrpWnt2BnmNFzSbsRcIumsr4ZyLC8N5nrCSXyjCSy0g48btL3Sj0bSgK9hcrJsmrFd2bkqFleyAcPAzNyUQzBuIRZx47O8yFmbZ+Pj+l3+KOlmcbzJNHfDfxkxuWTmTAcSDfsiyApin721T/ey3SUuwKpZNUc=

CHANGELOG.md

@@ -1,267 +1,338 @@
 # Change Log
 
-## [1.3.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.0) (2015-02-26)
+## [1.4.0](https://github.com/skywinder/github-changelog-generator/tree/1.4.0) (2015-05-07)
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.8...1.3.0)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...1.4.0)
 
-#### Implemented enhancements:
+**Implemented enhancements:**
 
-- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/Github-Changelog-Generator/issues/55)
+- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
 
-- Separate list exclude and include labels [\#52](https://github.com/skywinder/Github-Changelog-Generator/issues/52)
+- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
 
-- Unreleased issues in separate section [\#47](https://github.com/skywinder/Github-Changelog-Generator/issues/47)
+**Closed issues:**
 
-- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/Github-Changelog-Generator/issues/31)
+- Add CodeClimate and Inch CI [\#219](https://github.com/skywinder/github-changelog-generator/issues/219)
 
+**Merged pull requests:**
 
-#### Fixed bugs:
+- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
 
-- Test pull request with invalid label \(#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44)
+- Implement fetcher class [\#227](https://github.com/skywinder/github-changelog-generator/pull/227) ([skywinder](https://github.com/skywinder))
 
+- Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
 
-#### Merged pull requests:
+- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([skywinder](https://github.com/skywinder))
 
-- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder))
+- Implement Reader class to parse ChangeLog.md [\#216](https://github.com/skywinder/github-changelog-generator/pull/216) ([estahn](https://github.com/estahn))
 
+- Relatively require github\_changelog\_generator library [\#207](https://github.com/skywinder/github-changelog-generator/pull/207) ([sneal](https://github.com/sneal))
 
-## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17)
+- Add --max-issues argument to limit requests [\#76](https://github.com/skywinder/github-changelog-generator/pull/76) ([sneal](https://github.com/sneal))
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8)
+## [1.3.11](https://github.com/skywinder/github-changelog-generator/tree/1.3.11) (2015-03-21)
 
-#### Closed issues:
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.10...1.3.11)
 
-- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/Github-Changelog-Generator/issues/37)
+**Merged pull requests:**
 
+- Add  fallback with warning message to prevent crash in case of exceed API Rate Limit \(temporary workaround for \#71\) [\#75](https://github.com/skywinder/github-changelog-generator/pull/75) ([skywinder](https://github.com/skywinder))
 
-#### Merged pull requests:
+## [1.3.10](https://github.com/skywinder/github-changelog-generator/tree/1.3.10) (2015-03-18)
 
-- Feature/fix 37 [\#49](https://github.com/skywinder/Github-Changelog-Generator/pull/49) ([skywinder](https://github.com/skywinder))
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.9...1.3.10)
 
-- Prettify output [\#48](https://github.com/skywinder/Github-Changelog-Generator/pull/48) ([skywinder](https://github.com/skywinder))
+**Merged pull requests:**
 
+- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/github-changelog-generator/pull/70) ([skywinder](https://github.com/skywinder))
 
-## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7) (2015-01-26)
+## [1.3.9](https://github.com/skywinder/github-changelog-generator/tree/1.3.9) (2015-03-06)
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.8...1.3.9)
 
-#### Merged pull requests:
+**Implemented enhancements:**
 
-- Add compare link between older version and newer version [\#46](https://github.com/skywinder/Github-Changelog-Generator/pull/46) ([sue445](https://github.com/sue445))
+- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/github-changelog-generator/issues/63)
 
+**Merged pull requests:**
 
-## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6) (2015-01-21)
+- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/github-changelog-generator/pull/65) ([skywinder](https://github.com/skywinder))
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
+## [1.3.8](https://github.com/skywinder/github-changelog-generator/tree/1.3.8) (2015-03-05)
 
-#### Merged pull requests:
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.6...1.3.8)
 
-- fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao))
+**Merged pull requests:**
 
+- Fix `git remote` parsing in case, when script running without parameters inside destination directory [\#61](https://github.com/skywinder/github-changelog-generator/pull/61) ([skywinder](https://github.com/skywinder))
 
-## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
+## [1.3.6](https://github.com/skywinder/github-changelog-generator/tree/1.3.6) (2015-03-05)
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.5...1.3.6)
 
-#### Implemented enhancements:
+## [1.3.5](https://github.com/skywinder/github-changelog-generator/tree/1.3.5) (2015-03-04)
 
-- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.4...1.3.5)
 
+**Fixed bugs:**
 
-#### Fixed bugs:
+- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/github-changelog-generator/issues/60)
 
-- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
+## [1.3.4](https://github.com/skywinder/github-changelog-generator/tree/1.3.4) (2015-03-03)
 
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.3...1.3.4)
 
-#### Merged pull requests:
+**Fixed bugs:**
 
-- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
+- --no-issues appears to break PRs [\#59](https://github.com/skywinder/github-changelog-generator/issues/59)
 
-- support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
+## [1.3.3](https://github.com/skywinder/github-changelog-generator/tree/1.3.3) (2015-03-03)
 
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.2...1.3.3)
 
-## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4) (2014-12-16)
+**Closed issues:**
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
+- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/github-changelog-generator/issues/58)
 
-#### Fixed bugs:
+## [1.3.2](https://github.com/skywinder/github-changelog-generator/tree/1.3.2) (2015-03-03)
 
-- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/Github-Changelog-Generator/issues/41)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.1...1.3.2)
 
-- Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35)
+**Fixed bugs:**
 
+- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/github-changelog-generator/issues/57)
 
-#### Merged pull requests:
+## [1.3.1](https://github.com/skywinder/github-changelog-generator/tree/1.3.1) (2015-02-27)
 
-- Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.0...1.3.1)
 
+## [1.3.0](https://github.com/skywinder/github-changelog-generator/tree/1.3.0) (2015-02-26)
 
-## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3) (2014-12-16)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.8...1.3.0)
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
+**Implemented enhancements:**
 
-#### Implemented enhancements:
+- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/github-changelog-generator/issues/55)
 
-- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
+- Separate list exclude and include labels [\#52](https://github.com/skywinder/github-changelog-generator/issues/52)
 
-- Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
+- Unreleased issues in separate section [\#47](https://github.com/skywinder/github-changelog-generator/issues/47)
 
+- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/github-changelog-generator/issues/31)
 
-#### Fixed bugs:
+**Fixed bugs:**
 
-- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
+- Pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/github-changelog-generator/issues/44)
 
+**Merged pull requests:**
 
-#### Merged pull requests:
+- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/github-changelog-generator/pull/50) ([skywinder](https://github.com/skywinder))
 
-- Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
+## [1.2.8](https://github.com/skywinder/github-changelog-generator/tree/1.2.8) (2015-02-17)
 
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.7...1.2.8)
 
-## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2) (2014-12-10)
+**Closed issues:**
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...1.2.2)
+- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/github-changelog-generator/issues/37)
 
-#### Fixed bugs:
+**Merged pull requests:**
 
-- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
+- Feature/fix 37 [\#49](https://github.com/skywinder/github-changelog-generator/pull/49) ([skywinder](https://github.com/skywinder))
 
+- Prettify output [\#48](https://github.com/skywinder/github-changelog-generator/pull/48) ([skywinder](https://github.com/skywinder))
 
-#### Merged pull requests:
+## [1.2.7](https://github.com/skywinder/github-changelog-generator/tree/1.2.7) (2015-01-26)
 
-- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.6...1.2.7)
 
+**Merged pull requests:**
 
-## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1) (2014-11-22)
+- Add compare link between older version and newer version [\#46](https://github.com/skywinder/github-changelog-generator/pull/46) ([sue445](https://github.com/sue445))
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...1.2.1)
+## [1.2.6](https://github.com/skywinder/github-changelog-generator/tree/1.2.6) (2015-01-21)
 
-#### Fixed bugs:
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.5...1.2.6)
 
-- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
+**Merged pull requests:**
 
+- fix link tag format [\#45](https://github.com/skywinder/github-changelog-generator/pull/45) ([sugamasao](https://github.com/sugamasao))
 
-#### Merged pull requests:
+## [1.2.5](https://github.com/skywinder/github-changelog-generator/tree/1.2.5) (2015-01-15)
 
-- Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.4...1.2.5)
 
-- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
+**Implemented enhancements:**
 
+- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/github-changelog-generator/issues/22)
 
-## [1.2.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0) (2014-11-19)
+**Fixed bugs:**
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0)
+- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32)
 
-#### Merged pull requests:
+**Merged pull requests:**
 
-- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder))
+- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
 
-- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder))
+- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
 
-- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder))
+## [1.2.4](https://github.com/skywinder/github-changelog-generator/tree/1.2.4) (2014-12-16)
 
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.3...1.2.4)
 
-## [1.1.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4) (2014-11-18)
+**Fixed bugs:**
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4)
+- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/github-changelog-generator/issues/41)
 
-#### Implemented enhancements:
+- Crash when try generate log for rails [\#35](https://github.com/skywinder/github-changelog-generator/issues/35)
 
-- Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
+## [1.2.3](https://github.com/skywinder/github-changelog-generator/tree/1.2.3) (2014-12-16)
 
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.2...1.2.3)
 
-#### Merged pull requests:
+**Implemented enhancements:**
 
-- Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
+- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/github-changelog-generator/issues/38)
 
+- Detailed output [\#33](https://github.com/skywinder/github-changelog-generator/issues/33)
 
-## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2) (2014-11-12)
+**Fixed bugs:**
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2)
+- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/github-changelog-generator/issues/30)
 
-#### Merged pull requests:
+**Merged pull requests:**
 
-- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder))
+- Implement async fetching [\#39](https://github.com/skywinder/github-changelog-generator/pull/39) ([skywinder](https://github.com/skywinder))
 
-- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder))
+- Fix crash when user is NULL [\#40](https://github.com/skywinder/github-changelog-generator/pull/40) ([skywinder](https://github.com/skywinder))
 
+## [1.2.2](https://github.com/skywinder/github-changelog-generator/tree/1.2.2) (2014-12-10)
 
-## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1) (2014-11-10)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.1...1.2.2)
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1)
+**Fixed bugs:**
 
-#### Merged pull requests:
+- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/github-changelog-generator/issues/34)
 
-- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15) ([skywinder](https://github.com/skywinder))
+**Merged pull requests:**
 
-- Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
+- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/github-changelog-generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
 
-- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder))
+## [1.2.1](https://github.com/skywinder/github-changelog-generator/tree/1.2.1) (2014-11-22)
 
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.2.0...1.2.1)
 
-## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0) (2014-11-10)
+**Fixed bugs:**
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...1.1.0)
+- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/github-changelog-generator/issues/20)
 
-#### Implemented enhancements:
+**Merged pull requests:**
 
-- Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
+- Issues for last tag not in list [\#29](https://github.com/skywinder/github-changelog-generator/pull/29) ([skywinder](https://github.com/skywinder))
 
+- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/github-changelog-generator/pull/28) ([skywinder](https://github.com/skywinder))
 
-#### Fixed bugs:
+## [1.2.0](https://github.com/skywinder/github-changelog-generator/tree/1.2.0) (2014-11-19)
 
-- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.4...1.2.0)
 
-- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
+**Merged pull requests:**
 
+- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/github-changelog-generator/pull/27) ([skywinder](https://github.com/skywinder))
 
-## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1) (2014-11-10)
+- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/github-changelog-generator/pull/25) ([skywinder](https://github.com/skywinder))
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1)
+- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/github-changelog-generator/pull/24) ([skywinder](https://github.com/skywinder))
 
-#### Merged pull requests:
+## [1.1.4](https://github.com/skywinder/github-changelog-generator/tree/1.1.4) (2014-11-18)
 
-- Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.2...1.1.4)
 
+**Implemented enhancements:**
 
-## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0) (2014-11-07)
+- Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/github-changelog-generator/issues/19)
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...1.0.0)
+**Merged pull requests:**
 
-#### Implemented enhancements:
+- Sort tags by date [\#23](https://github.com/skywinder/github-changelog-generator/pull/23) ([skywinder](https://github.com/skywinder))
 
-- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
+## [1.1.2](https://github.com/skywinder/github-changelog-generator/tree/1.1.2) (2014-11-12)
 
-- Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.1...1.1.2)
 
+**Merged pull requests:**
 
-#### Fixed bugs:
+- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/github-changelog-generator/pull/18) ([skywinder](https://github.com/skywinder))
 
-- Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
+- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/github-changelog-generator/pull/17) ([skywinder](https://github.com/skywinder))
 
+## [1.1.1](https://github.com/skywinder/github-changelog-generator/tree/1.1.1) (2014-11-10)
 
-#### Merged pull requests:
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.1.0...1.1.1)
 
-- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
+**Merged pull requests:**
 
-- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
+- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/github-changelog-generator/pull/15) ([skywinder](https://github.com/skywinder))
 
+- Sort issues by tags [\#14](https://github.com/skywinder/github-changelog-generator/pull/14) ([skywinder](https://github.com/skywinder))
 
-## [0.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0) (2014-11-07)
+- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/github-changelog-generator/pull/13) ([skywinder](https://github.com/skywinder))
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...0.1.0)
+## [1.1.0](https://github.com/skywinder/github-changelog-generator/tree/1.1.0) (2014-11-10)
 
-#### Merged pull requests:
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.1...1.1.0)
 
-- Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder))
+**Implemented enhancements:**
 
-- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) ([skywinder](https://github.com/skywinder))
+- Detect username and project form origin [\#11](https://github.com/skywinder/github-changelog-generator/issues/11)
 
+**Fixed bugs:**
 
-## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2) (2014-11-06)
+- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/github-changelog-generator/issues/12)
 
-[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2)
+- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/github-changelog-generator/issues/9)
 
-## [0.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1) (2014-11-06)
+## [1.0.1](https://github.com/skywinder/github-changelog-generator/tree/1.0.1) (2014-11-10)
+
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.0.0...1.0.1)
+
+## [1.0.0](https://github.com/skywinder/github-changelog-generator/tree/1.0.0) (2014-11-07)
+
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.1.0...1.0.0)
+
+**Implemented enhancements:**
+
+- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/github-changelog-generator/issues/6)
+
+- Implement option to specify output filename [\#4](https://github.com/skywinder/github-changelog-generator/issues/4)
+
+**Fixed bugs:**
+
+- Last tag not appeared in changelog [\#5](https://github.com/skywinder/github-changelog-generator/issues/5)
+
+**Merged pull requests:**
+
+- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
+
+- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/github-changelog-generator/pull/7) ([skywinder](https://github.com/skywinder))
+
+## [0.1.0](https://github.com/skywinder/github-changelog-generator/tree/0.1.0) (2014-11-07)
+
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.2...0.1.0)
+
+**Merged pull requests:**
+
+- Fix parsing date of pull request [\#3](https://github.com/skywinder/github-changelog-generator/pull/3) ([skywinder](https://github.com/skywinder))
+
+- Add changelog generation for last tag [\#2](https://github.com/skywinder/github-changelog-generator/pull/2) ([skywinder](https://github.com/skywinder))
+
+- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/github-changelog-generator/pull/1) ([skywinder](https://github.com/skywinder))
+
+## [0.0.2](https://github.com/skywinder/github-changelog-generator/tree/0.0.2) (2014-11-06)
+
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/0.0.1...0.0.2)
+
+## [0.0.1](https://github.com/skywinder/github-changelog-generator/tree/0.0.1) (2014-11-06)
 
 
 

Gemfile

@@ -1,4 +1,14 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
-gem 'github_api'
+
-gem 'colorize'
+gem "rake", ">=10.4.2"
-gem 'rake'
+
+gem "github_api", ">=0.12.3"
+gem "colorize", ">=0.7.7"
+
+group :test do
+  gem "rspec"
+  gem "rubocop"
+  gem "coveralls", require: false
+  gem "simplecov", require: false
+  gem "codeclimate-test-reporter"
+end

Gemfile.lock

@@ -1,13 +1,28 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.6)
+    addressable (2.3.8)
-    colorize (0.7.4)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    colorize (0.7.7)
+    coveralls (0.8.1)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    faraday (0.9.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
-    github_api (0.12.2)
+    github_api (0.12.3)
       addressable (~> 2.3)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
@@ -15,13 +30,18 @@ GEM
       multi_json (>= 1.7.5, < 2.0)
       nokogiri (~> 1.6.3)
       oauth2
-    hashie (3.3.2)
+    hashie (3.4.1)
-    jwt (1.2.0)
+    http-cookie (1.0.2)
-    mini_portile (0.6.1)
+      domain_name (~> 0.5)
-    multi_json (1.10.1)
+    json (1.8.2)
+    jwt (1.5.0)
+    mime-types (2.5)
+    mini_portile (0.6.2)
+    multi_json (1.11.0)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.5)
+    netrc (0.10.3)
+    nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
     oauth2 (1.0.0)
       faraday (>= 0.8, < 0.10)
@@ -29,14 +49,59 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    rack (1.5.2)
+    parser (2.2.2.2)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rack (1.6.1)
+    rainbow (2.0.0)
     rake (10.4.2)
-    thread_safe (0.3.4)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    rubocop (0.31.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.5.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  colorize
+  codeclimate-test-reporter
-  github_api
+  colorize (>= 0.7.7)
-  rake
+  coveralls
+  github_api (>= 0.12.3)
+  rake (>= 10.4.2)
+  rspec
+  rubocop
+  simplecov

README.md

@@ -1,8 +1,11 @@
-
 [![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
-[![Build Status](https://travis-ci.org/skywinder/Github-Changelog-Generator.svg?branch=master)](https://travis-ci.org/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)
+[![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
 
-GitHub Changelog Generator
+GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
 ==================
 
   - [Installation](#installation)
@@ -13,14 +16,23 @@ GitHub Changelog Generator
   - [Features and advantages of this project](#features-and-advantages-of-this-project)
     - [Alternatives](#alternatives)
     - [Projects using this library](#projects-using-this-library)
-  - [Am I missed some essential feature?](#am-i-missed-some-essential-feature)
+  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
   - [Contributing](#contributing)
   - [License](#license)
 
  
-Changelog generation has never been so easy.
+### 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**. This generator complies all [change log format guidelines](http://keepachangelog.com/).
+**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
+
+Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
+
+>### *What’s the point of a change log?*
+To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
+### *Why should I care?*
+Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
+
+> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
 
 ## Installation
 
@@ -39,15 +51,15 @@ Changelog generation has never been so easy.
 > 
 > [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
 > 
-> #### Implemented enhancements:
+> **Implemented enhancements:**
 > 
 > - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
 > 
-> #### Fixed bugs:
+> **Fixed bugs:**
 > 
 > - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
 > 
-> #### Merged pull requests:
+> **Merged pull requests:**
 > 
 > - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
 > 
@@ -57,13 +69,13 @@ Changelog generation has never been so easy.
 ## Usage
 **It's really simple**: 
 
-- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run:
+- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
 
 		github_changelog_generator
 
 -  or from anywhere:
-
+    - `github_changelog_generator -u github_username -p github_project`
-		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.
 
@@ -71,34 +83,36 @@ As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* chan
 Type `github_changelog_generator --help` for detailed usage.
 
     Usage: changelog_generator [options]
-    -u, --user [USER]                Username of the owner of target GitHub repo
+    -u, --user [USER]                         Username of the owner of target GitHub repo
-    -p, --project [PROJECT]          Name of project on GitHub
+    -p, --project [PROJECT]                   Name of project on GitHub
-    -t, --token [TOKEN]              To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new
+    -t, --token [TOKEN]                       To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new
-    -f, --date-format [FORMAT]       Date format. Default is %d/%m/%y
+    -f, --date-format [FORMAT]                Date format. Default is %d/%m/%y
-    -o, --output [NAME]              Output file. Default is CHANGELOG.md
+    -o, --output [NAME]                       Output file. Default is CHANGELOG.md
-        --[no-]verbose               Run verbosely. Default is true
+        --[no-]verbose                        Run verbosely. Default is true
-        --[no-]issues                Include closed issues to changelog. Default is true
+        --[no-]issues                         Include closed issues to changelog. Default is true
-        --[no-]issues-wo-labels      Include closed issues without labels to changelog. Default is true
+        --[no-]issues-wo-labels               Include closed issues without labels to changelog. Default is true
-        --[no-]pr-wo-labels          Include pull requests without labels to changelog. Default is true
+        --[no-]pr-wo-labels                   Include pull requests without labels to changelog. Default is true
-        --[no-]pull-requests         Include pull-requests to changelog. Default is true
+        --[no-]pull-requests                  Include pull-requests to changelog. Default is true
-        --[no-]filter-by-milestone   Use milestone to detect when issue was resolved. Default is true
+        --[no-]filter-by-milestone            Use milestone to detect when issue was resolved. Default is true
-        --[no-]author                Add author of pull-request in the end. Default is true
+        --[no-]author                         Add author of pull-request in the end. Default is true
-        --unreleased-only            Generate log from unreleased closed issues only.
+        --unreleased-only                     Generate log from unreleased closed issues only.
-        --[no-]unreleased            Add to log unreleased closed issues. Default is true
+        --[no-]unreleased                     Add to log unreleased closed issues. Default is true
-        --[no-]compare-link          Include compare link between older version and newer version. Default is true
+        --[no-]compare-link                   Include compare link between older version and newer version. Default is true
-        --include-labels  x,y,z      Issues only with that labels will be included to changelog. Default is 'bug,enhancement'
+        --include-labels  x,y,z               Issues only with that labels will be included to changelog. Default is 'bug,enhancement'
-        --exclude-labels  x,y,z      Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
+        --exclude-labels  x,y,z               Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
-        --github-site [URL]          The Enterprise Github site on which your project is hosted.
+        --max-issues [NUMBER]                 Max number of issues to fetch from GitHub. Default is unlimited.
-        --github-api [URL]           The enterprise endpoint to use for your Github API.
+        --github-site [URL]                   The Enterprise Github site on which your project is hosted.
-    -v, --version                    Print version number
+        --github-api [URL]                    The enterprise endpoint to use for your Github API.
-    -h, --help                       Displays Help
+        --future-release [RELEASE-VERSION]    Put the unreleased changes in the specified release number.
+    -v, --version                             Print version number
+    -h, --help                                Displays Help
 
 
 ### GitHub token
 
-Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with 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)
 
-**You can easily [generate it here](https://github.com/settings/applications)**.
+**You can easily [generate it here](https://github.com/settings/tokens)**.
 
 And:
 
@@ -115,23 +129,27 @@ So, if you got error like this:
 It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
 
 ##Features and advantages of this project
-- Generate canonical change log file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/)
+- Generate canonical, neat change log file, followed by [basic change log guidlines](http://keepachangelog.com/) :gem:
-- Simply add links for all closed issues and merged pull requests
+- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
-- Possible to generate **Unreleased** changes (closed issues that have not released yet)
+- **GitHub Enterprise support** via command line options! :factory:
-- Flexible format customisation:
+- Flexible format **customisation**:
-    - Customize issues, that should be added to changelog
+    - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
-    - Custom date format supported 
+    - **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :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
+    - 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:
-    - Ability to exclude specific issues from change log (by labels)
+    - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default)  :scissors:
-        - Automatically exclude "questions" - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels)
+- **Distinguish** issues **according labels**. :mag_right:
-- Distinguish bug fixes, enchantments, and closed issues according labels.
+    - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
-    - 	**Issues** (closed issues w/o any labels)
+    - Bug fixes (by label `bug` in issue) :beetle:
-    - **Merged pull-requests** (all merged pull-requests)
+    - Enhancements (by label `enhancement` in issue) :star2:
-    - **Bug-fixes** (by label `bug` in issue)
+    - 	Issues (closed issues `w/o any labels`) :non-potable_water:    
-    - **Enhancements** (by label `enhancement` in issue)
+
+- You can manually set which labels should be included/excluded. :wrench:
+- Apply a lot of other customisations, to fit changelog for your personal style :tophat: 
+(*look `github_changelog_generator --help`  for details)*
+
 
 ###Alternatives
-Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But no one was satisfy 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!*
 
@@ -139,15 +157,51 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch
 ### Projects using this library
 [Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) 
 
-*If you are using `github_changelog_generator` for generation change log in your project or know of 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'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.
 
-## Am I missed some essential feature?
+*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.*
 
-**Nothing is impossible!** 
+## Am I missing some essential feature?
 
-Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
+- **Nothing is impossible!** 
 
-*Bug reports, feature requests, patches, well-wishes are always welcome!*
+- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! 
+
+- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
+
+## FAQ
+
+- ***I already use GitHub Releases. Why do I need this?***
+
+GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations:
+
+*BDW: 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:
+
+The auto generated Changelog really helps even if you manually fill Releases notes!
+
+For example:
+
+When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
+
+- it's not so quite easy to find it in manually filled Releases notes.
+- this file can also help you to build your Release note and not miss features in manually-filled list.
+
+In the end:
+
+I think, that GitHub Releases is more for end-users.
+But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
+And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
+
+- ***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 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:
+
+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
 
@@ -157,6 +211,7 @@ Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/n
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
+7. Profit! :white_check_mark:
 
 ## License
 

Rakefile

@@ -1,9 +1,7 @@
-require "rake/testtask"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
 
-task :default => [:test]
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:rspec)
 
-Rake::TestTask.new do |t|
+task default: [:rubocop, :rspec]
-  t.verbose = true
-  t.libs.push("demo", "test")
-  t.pattern = "test/**/*_test.rb"
-end

bin/github_changelog_generator

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

bump_gemfile.rb

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

github_changelog_generator.gemspec

@@ -1,21 +1,21 @@
 # coding: utf-8
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'github_changelog_generator/version'
+require "github_changelog_generator/version"
 
 Gem::Specification.new do |spec|
   spec.name               = "github_changelog_generator"
   spec.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 = %q{sky4winder+github_changelog_generator@gmail.com}
+  spec.email = "sky4winder+github_changelog_generator@gmail.com"
   spec.date = `date +"%Y-%m-%d"`.strip!
-  spec.summary = %q{Script, that automatically generate change-log from your tags and pull-requests.}
+  spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
-  spec.description = %q{Script, that automatically generate change-log from your tags 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 = %q{https://github.com/skywinder/Github-Changelog-Generator}
+  spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
   spec.license       = "MIT"
 
   spec.files = `git ls-files -z`.split("\x0")
@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 
-  spec.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
+  spec.add_runtime_dependency("github_api", ["~> 0.12"])
-  spec.add_runtime_dependency(%q<colorize>, ["~> 0.7"])
+  spec.add_runtime_dependency("colorize", ["~> 0.7"])
-
 end

lib/CHANGELOG.md

@@ -1,522 +1,30 @@
 # Change Log
 
-## [Unreleased](https://github.com/skywinder/ActionSheetPicker-3.0/tree/HEAD) (2015-02-27)
+## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
 
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.13...HEAD)
+[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...HEAD)
 
 **Merged pull requests:**
 
-- Add additional showPickerWithTitle method [\#143](https://github.com/skywinder/ActionSheetPicker-3.0/pull/143) ([martinpfannemueller](https://github.com/martinpfannemueller))
+- Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
 
-## [1.3.13](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.13) (2015-02-09)
+## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)
 
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.12...1.3.13)
+[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
-
-**Fixed bugs:**
-
-- Wrong background color of pickers [\#136](https://github.com/skywinder/ActionSheetPicker-3.0/issues/136)
 
 **Merged pull requests:**
 
-- Fixed an issue when initial selections applied to picker with different number of rows for different components. [\#113](https://github.com/skywinder/ActionSheetPicker-3.0/pull/113) ([venj](https://github.com/venj))
+- fix \#3. hotfix. Should appear in v0.0.3 [\#4](https://github.com/skywinder/changelog_test/pull/4) ([skywinder](https://github.com/skywinder))
 
-## [1.3.12](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.12) (2015-02-04)
+## [v0.0.2](https://github.com/skywinder/changelog_test/tree/v0.0.2) (2015-03-04)
 
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.11...1.3.12)
+[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
-
-**Fixed bugs:**
-
-- Light status bar style [\#119](https://github.com/skywinder/ActionSheetPicker-3.0/issues/119)
-
-## [1.3.11](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.11) (2015-01-15)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.10...1.3.11)
 
 **Merged pull requests:**
 
-- Fixes a crash while closing when using the Classy framework for styling [\#128](https://github.com/skywinder/ActionSheetPicker-3.0/pull/128) ([sudeepsidhu](https://github.com/sudeepsidhu))
+- Here is a test hotfix should appear in v.0.0.2 [\#2](https://github.com/skywinder/changelog_test/pull/2) ([skywinder](https://github.com/skywinder))
 
-- .m files should not be included in public header files [\#127](https://github.com/skywinder/ActionSheetPicker-3.0/pull/127) ([ened](https://github.com/ened))
+## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)
-
-## [1.3.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.10) (2015-01-09)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.9...1.3.10)
-
-**Implemented enhancements:**
-
-- Should have minimum/maximum date property exposed [\#97](https://github.com/skywinder/ActionSheetPicker-3.0/issues/97)
-
-**Closed issues:**
-
-- No "cancel" button [\#122](https://github.com/skywinder/ActionSheetPicker-3.0/issues/122)
-
-- Swift; Does not conform to protocol [\#120](https://github.com/skywinder/ActionSheetPicker-3.0/issues/120)
-
-**Merged pull requests:**
-
-- add header file to public [\#115](https://github.com/skywinder/ActionSheetPicker-3.0/pull/115) ([skywinder](https://github.com/skywinder))
-
-## [1.3.9](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.9) (2014-12-11)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.8...1.3.9)
-
-**Closed issues:**
-
-- Bad interaction with submodules [\#111](https://github.com/skywinder/ActionSheetPicker-3.0/issues/111)
-
-**Merged pull requests:**
-
-- Fix bad interaction with Git submodules.  Fixes issue #111. [\#112](https://github.com/skywinder/ActionSheetPicker-3.0/pull/112) ([JimDabell](https://github.com/JimDabell))
-
-## [1.3.8](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.8) (2014-12-10)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.7...1.3.8)
-
-**Closed issues:**
-
-- Redefinition of enumerator 'Selector' [\#109](https://github.com/skywinder/ActionSheetPicker-3.0/issues/109)
-
-**Merged pull requests:**
-
-- Fix for #109 [\#110](https://github.com/skywinder/ActionSheetPicker-3.0/pull/110) ([michalciolek](https://github.com/michalciolek))
-
-- Fixed an issue when more than one ActionSheetCustomPicker is used in a ViewController [\#108](https://github.com/skywinder/ActionSheetPicker-3.0/pull/108) ([venj](https://github.com/venj))
-
-## [1.3.7](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.7) (2014-12-04)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.6...1.3.7)
-
-**Fixed bugs:**
-
-- UIDatePicker does not fire the target-action associated with the UIControlEventValueChanged event the first time [\#104](https://github.com/skywinder/ActionSheetPicker-3.0/issues/104)
-
-**Merged pull requests:**
-
-- Added workaround for a bug in UIDatePicker in count down mode. [\#105](https://github.com/skywinder/ActionSheetPicker-3.0/pull/105) ([tomaskraina](https://github.com/tomaskraina))
-
-- Added minimumDate and maximumDate to contructor of ActionSheetDatePicker [\#98](https://github.com/skywinder/ActionSheetPicker-3.0/pull/98) ([emmanuelay](https://github.com/emmanuelay))
-
-## [1.3.6](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.6) (2014-12-02)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.5...1.3.6)
-
-**Fixed bugs:**
-
-- Example projects failed to launch [\#96](https://github.com/skywinder/ActionSheetPicker-3.0/issues/96)
-
-**Closed issues:**
-
-- Travis builds is broken by fix #96 [\#99](https://github.com/skywinder/ActionSheetPicker-3.0/issues/99)
-
-**Merged pull requests:**
-
-- Add a Bitdeli Badge to README [\#107](https://github.com/skywinder/ActionSheetPicker-3.0/pull/107) ([bitdeli-chef](https://github.com/bitdeli-chef))
-
-## [1.3.5](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.5) (2014-11-14)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.4...1.3.5)
-
-**Fixed bugs:**
-
-- StatusBar visibility [\#90](https://github.com/skywinder/ActionSheetPicker-3.0/issues/90)
-
-**Merged pull requests:**
-
-- Update README.md [\#95](https://github.com/skywinder/ActionSheetPicker-3.0/pull/95) ([jeffreyjackson](https://github.com/jeffreyjackson))
-
-## [1.3.4](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.4) (2014-11-12)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.3...1.3.4)
-
-**Merged pull requests:**
-
-- Fix statusBar visibility [\#93](https://github.com/skywinder/ActionSheetPicker-3.0/pull/93) ([krin-san](https://github.com/krin-san))
-
-## [1.3.3](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.3) (2014-11-12)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.2...1.3.3)
-
-**Fixed bugs:**
-
-- Compiler warning due to Unicode char in source [\#92](https://github.com/skywinder/ActionSheetPicker-3.0/issues/92)
-
-## [1.3.2](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.2) (2014-11-11)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.1...1.3.2)
-
-**Implemented enhancements:**
-
-- Add delegate for custom button pressed [\#33](https://github.com/skywinder/ActionSheetPicker-3.0/issues/33)
-
-**Merged pull requests:**
-
-- Add additional check for UIDatePickerModeCountDownTimer [\#91](https://github.com/skywinder/ActionSheetPicker-3.0/pull/91) ([skywinder](https://github.com/skywinder))
-
-- Count down duration fix [\#89](https://github.com/skywinder/ActionSheetPicker-3.0/pull/89) ([ijameelkhan](https://github.com/ijameelkhan))
-
-## [1.3.1](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.1) (2014-11-04)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.3.0...1.3.1)
-
-**Merged pull requests:**
-
-- Fix for #84 and #63 [\#85](https://github.com/skywinder/ActionSheetPicker-3.0/pull/85) ([skywinder](https://github.com/skywinder))
-
-## [1.3.0](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.3.0) (2014-11-03)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.2.0...1.3.0)
-
-**Fixed bugs:**
-
-- iPad - Swift  Popover not visible [\#68](https://github.com/skywinder/ActionSheetPicker-3.0/issues/68)
-
-**Merged pull requests:**
-
-- Added callback for custom button being pressed [\#81](https://github.com/skywinder/ActionSheetPicker-3.0/pull/81) ([velga](https://github.com/velga))
-
-- Added support for popover customizations. [\#77](https://github.com/skywinder/ActionSheetPicker-3.0/pull/77) ([openreply](https://github.com/openreply))
-
-## [1.2.0](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.2.0) (2014-10-15)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.21...1.2.0)
-
-**Merged pull requests:**
-
-- General fixes for #74 & #50 [\#76](https://github.com/skywinder/ActionSheetPicker-3.0/pull/76) ([skywinder](https://github.com/skywinder))
-
-- Further support for countdown timer [\#74](https://github.com/skywinder/ActionSheetPicker-3.0/pull/74) ([mgmart](https://github.com/mgmart))
-
-## [1.1.21](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.21) (2014-10-13)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.20...1.1.21)
-
-**Fixed bugs:**
-
-- i used DatePicker in ActionSheetPicket-3.0, but app crashed. [\#65](https://github.com/skywinder/ActionSheetPicker-3.0/issues/65)
-
-**Closed issues:**
-
-- ActionSheetString picker Crash [\#75](https://github.com/skywinder/ActionSheetPicker-3.0/issues/75)
-
-## [1.1.20](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.20) (2014-10-13)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.19...1.1.20)
-
-**Closed issues:**
-
-- ActionSheetDatePicker: set selectedDate in response to custom button press [\#73](https://github.com/skywinder/ActionSheetPicker-3.0/issues/73)
-
-- Using ActionSheetDatePicker as CountDownTimer-Picker [\#72](https://github.com/skywinder/ActionSheetPicker-3.0/issues/72)
-
-- Example fails when clicking "Modal Test": 'Pushing a navigation controller is not supported' [\#70](https://github.com/skywinder/ActionSheetPicker-3.0/issues/70)
-
-## [1.1.19](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.19) (2014-10-07)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.18...1.1.19)
-
-**Fixed bugs:**
-
-- Xcode 6 / Swift incompatibility [\#36](https://github.com/skywinder/ActionSheetPicker-3.0/issues/36)
-
-**Merged pull requests:**
-
-- title text with attributes. [\#64](https://github.com/skywinder/ActionSheetPicker-3.0/pull/64) ([nebiros](https://github.com/nebiros))
-
-## [1.1.18](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.18) (2014-10-03)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.17...1.1.18)
-
-## [1.1.17](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.17) (2014-10-03)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.16...1.1.17)
-
-## [1.1.16](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.16) (2014-10-03)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.15...1.1.16)
-
-## [1.1.15](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.15) (2014-09-29)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.14...1.1.15)
-
-**Implemented enhancements:**
-
-- Method request: hideActionSheetPicker [\#51](https://github.com/skywinder/ActionSheetPicker-3.0/issues/51)
-
-**Fixed bugs:**
-
-- DatePicker callback freezes screen [\#42](https://github.com/skywinder/ActionSheetPicker-3.0/issues/42)
-
-**Merged pull requests:**
-
-- Update SWActionSheet.m [\#60](https://github.com/skywinder/ActionSheetPicker-3.0/pull/60) ([zhongyang](https://github.com/zhongyang))
-
-- Fix for UIDatePickerModeCountDownTimer callback [\#50](https://github.com/skywinder/ActionSheetPicker-3.0/pull/50) ([jklp](https://github.com/jklp))
-
-## [1.1.14](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.14) (2014-09-28)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.13...1.1.14)
-
-**Merged pull requests:**
-
-- add block based API to date picker [\#56](https://github.com/skywinder/ActionSheetPicker-3.0/pull/56) ([mrtj](https://github.com/mrtj))
-
-## [1.1.13](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.13) (2014-09-19)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.12...1.1.13)
-
-**Closed issues:**
-
-- impossible to run in xcode 6 [\#48](https://github.com/skywinder/ActionSheetPicker-3.0/issues/48)
-
-**Merged pull requests:**
-
-- update badge [\#46](https://github.com/skywinder/ActionSheetPicker-3.0/pull/46) ([skywinder](https://github.com/skywinder))
-
-- Add badge [\#45](https://github.com/skywinder/ActionSheetPicker-3.0/pull/45) ([skywinder](https://github.com/skywinder))
-
-- reformat [\#44](https://github.com/skywinder/ActionSheetPicker-3.0/pull/44) ([skywinder](https://github.com/skywinder))
-
-## [1.1.12](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.12) (2014-09-17)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.11...1.1.12)
-
-**Merged pull requests:**
-
-- unexpected action sheet dismissing in portrait mode only [\#40](https://github.com/skywinder/ActionSheetPicker-3.0/pull/40) ([numen31337](https://github.com/numen31337))
-
-- Support ActionSheet width to full-screen-width in 4.7 inch and 5.5 inch devices [\#38](https://github.com/skywinder/ActionSheetPicker-3.0/pull/38) ([nowsprinting](https://github.com/nowsprinting))
-
-## [1.1.11](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.11) (2014-09-16)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.10...1.1.11)
-
-**Implemented enhancements:**
-
-- Pop over direction [\#28](https://github.com/skywinder/ActionSheetPicker-3.0/issues/28)
-
-- ActionSheetDatePicker needs done/cancel blocks [\#37](https://github.com/skywinder/ActionSheetPicker-3.0/issues/37)
-
-**Fixed bugs:**
-
-- Show from a presented view controller [\#31](https://github.com/skywinder/ActionSheetPicker-3.0/issues/31)
-
-- ActionSheetStringPicker not showing on iphone [\#30](https://github.com/skywinder/ActionSheetPicker-3.0/issues/30)
-
-**Closed issues:**
-
-- ActionSheetPicker needs cancel block to handle hiding [\#39](https://github.com/skywinder/ActionSheetPicker-3.0/issues/39)
-
-**Merged pull requests:**
-
-- Notify cancel on popover dismiss [\#34](https://github.com/skywinder/ActionSheetPicker-3.0/pull/34) ([ynop](https://github.com/ynop))
-
-## [1.1.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.10) (2014-09-04)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.9...1.1.10)
-
-**Merged pull requests:**
-
-- Method for presenting overlapping views. [\#32](https://github.com/skywinder/ActionSheetPicker-3.0/pull/32) ([serebryakov-av](https://github.com/serebryakov-av))
-
-## [1.1.9](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.9) (2014-09-03)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.8...1.1.9)
-
-**Merged pull requests:**
-
-- Update SWActionSheet.m [\#29](https://github.com/skywinder/ActionSheetPicker-3.0/pull/29) ([serebryakov-av](https://github.com/serebryakov-av))
-
-## [1.1.8](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.8) (2014-08-29)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.7...1.1.8)
-
-## [1.1.7](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.7) (2014-08-29)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.6...1.1.7)
-
-## [1.1.6](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.6) (2014-08-27)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.5...1.1.6)
-
-**Closed issues:**
-
-- Still getting warnings [\#16](https://github.com/skywinder/ActionSheetPicker-3.0/issues/16)
-
-**Merged pull requests:**
-
-- fix readme code [\#26](https://github.com/skywinder/ActionSheetPicker-3.0/pull/26) ([abeyuya](https://github.com/abeyuya))
-
-## [1.1.5](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.5) (2014-08-26)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/compilerBug...1.1.5)
-
-**Fixed bugs:**
-
-- Toolbar buttons don't appear when Actionsheet is fired from an iPad Form Sheet or Page Sheet [\#22](https://github.com/skywinder/ActionSheetPicker-3.0/issues/22)
-
-## [compilerBug](https://github.com/skywinder/ActionSheetPicker-3.0/tree/compilerBug) (2014-08-26)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.4...compilerBug)
-
-## [1.1.4](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.4) (2014-08-26)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.3...1.1.4)
-
-**Fixed bugs:**
-
-- iOS 8 iPad wrong frame size. [\#18](https://github.com/skywinder/ActionSheetPicker-3.0/issues/18)
-
-**Closed issues:**
-
-- iOS8 - iPad popover, wrong size [\#24](https://github.com/skywinder/ActionSheetPicker-3.0/issues/24)
-
-**Merged pull requests:**
-
-- fix iOS8 wrong popover size in iPad [\#25](https://github.com/skywinder/ActionSheetPicker-3.0/pull/25) ([AdrianFlorian](https://github.com/AdrianFlorian))
-
-## [1.1.3](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.3) (2014-08-25)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.2...1.1.3)
-
-**Closed issues:**
-
-- Presented in wrong frame when sender is a navbar bar button item [\#23](https://github.com/skywinder/ActionSheetPicker-3.0/issues/23)
-
-- done button color [\#21](https://github.com/skywinder/ActionSheetPicker-3.0/issues/21)
-
-## [1.1.2](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.2) (2014-08-15)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.1.1...1.1.2)
-
-**Closed issues:**
-
-- Landscape broken in iOS 7 [\#17](https://github.com/skywinder/ActionSheetPicker-3.0/issues/17)
-
-- Invalid context warning in landscape [\#13](https://github.com/skywinder/ActionSheetPicker-3.0/issues/13)
-
-## [1.1.1](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.1.1) (2014-08-13)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.18...1.1.1)
-
-## [1.0.18](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.18) (2014-08-12)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.17...1.0.18)
-
-## [1.0.17](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.17) (2014-08-12)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.15...1.0.17)
-
-**Closed issues:**
-
-- Issue with iOS 8 beta  [\#9](https://github.com/skywinder/ActionSheetPicker-3.0/issues/9)
-
-## [1.0.15](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.15) (2014-08-11)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.14...1.0.15)
-
-## [1.0.14](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.14) (2014-08-01)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.13...1.0.14)
-
-**Merged pull requests:**
-
-- Set minimum date properly. [\#14](https://github.com/skywinder/ActionSheetPicker-3.0/pull/14) ([matt](https://github.com/matt))
-
-## [1.0.13](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.13) (2014-07-30)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.12...1.0.13)
-
-**Closed issues:**
-
-- Use with UITableViewCells [\#4](https://github.com/skywinder/ActionSheetPicker-3.0/issues/4)
-
-**Merged pull requests:**
-
-- Minute Interval for ActionDatePicker [\#12](https://github.com/skywinder/ActionSheetPicker-3.0/pull/12) ([Jack-s](https://github.com/Jack-s))
-
-## [1.0.12](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.12) (2014-07-24)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.11...1.0.12)
-
-**Closed issues:**
-
-- i get this warning!'sizeWithFont:' is deprecated: first deprecated in iOS 7.0 - Use -sizeWithAttributes: [\#11](https://github.com/skywinder/ActionSheetPicker-3.0/issues/11)
-
-- configurePickerView for ActionSheetCustomPicker throws exception [\#10](https://github.com/skywinder/ActionSheetPicker-3.0/issues/10)
-
-## [1.0.11](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.11) (2014-07-19)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.10...1.0.11)
-
-## [1.0.10](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.10) (2014-07-14)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.9...1.0.10)
-
-## [1.0.9](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.9) (2014-07-07)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.8...1.0.9)
-
-**Fixed bugs:**
-
-- Crash when using in 5s iOS 7.1 [\#8](https://github.com/skywinder/ActionSheetPicker-3.0/issues/8)
-
-- On Iphone 4 the ActionSheetStringPicker doesn't work Well [\#5](https://github.com/skywinder/ActionSheetPicker-3.0/issues/5)
-
-## [1.0.8](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.8) (2014-06-29)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.7...1.0.8)
-
-**Merged pull requests:**
-
-- added check for iPhone 4, to fix transparent view background problem. [\#6](https://github.com/skywinder/ActionSheetPicker-3.0/pull/6) ([JaseElder](https://github.com/JaseElder))
-
-## [1.0.7](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.7) (2014-06-20)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.6...1.0.7)
-
-## [1.0.6](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.6) (2014-06-11)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.5...1.0.6)
-
-## [1.0.5](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.5) (2014-05-27)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.4...1.0.5)
-
-## [1.0.4](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.4) (2014-05-25)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/0.0.4...1.0.4)
-
-## [0.0.4](https://github.com/skywinder/ActionSheetPicker-3.0/tree/0.0.4) (2014-05-25)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.3...0.0.4)
-
-**Merged pull requests:**
-
-- Convert screenshots over to iOS 7. [\#3](https://github.com/skywinder/ActionSheetPicker-3.0/pull/3) ([markrickert](https://github.com/markrickert))
-
-- Add basic documentation to the readme. [\#2](https://github.com/skywinder/ActionSheetPicker-3.0/pull/2) ([markrickert](https://github.com/markrickert))
-
-## [1.0.3](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.3) (2014-05-21)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.2...1.0.3)
-
-## [1.0.2](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.2) (2014-05-21)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/1.0.1...1.0.2)
-
-**Merged pull requests:**
-
-- Get tint color for actionsheet buttons from application window [\#1](https://github.com/skywinder/ActionSheetPicker-3.0/pull/1) ([Mau04](https://github.com/Mau04))
-
-## [1.0.1](https://github.com/skywinder/ActionSheetPicker-3.0/tree/1.0.1) (2014-05-19)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/0.1...1.0.1)
-
-## [0.1](https://github.com/skywinder/ActionSheetPicker-3.0/tree/0.1) (2012-05-11)
-
-[Full Changelog](https://github.com/skywinder/ActionSheetPicker-3.0/compare/v0.1...0.1)
-
-## [v0.1](https://github.com/skywinder/ActionSheetPicker-3.0/tree/v0.1) (2012-05-11)
 
 
 

lib/github_changelog_generator.rb

@@ -1,221 +1,201 @@
 #!/usr/bin/env ruby
 
-require 'github_api'
+require "github_api"
-require 'json'
+require "json"
-require 'colorize'
+require "colorize"
-require 'benchmark'
+require "benchmark"
 
-require_relative 'github_changelog_generator/parser'
+require_relative "github_changelog_generator/parser"
-require_relative 'github_changelog_generator/generator'
+require_relative "github_changelog_generator/generator"
-require_relative 'github_changelog_generator/version'
+require_relative "github_changelog_generator/version"
+require_relative "github_changelog_generator/reader"
+require_relative "github_changelog_generator/fetcher"
 
 module GitHubChangelogGenerator
-  class ChangelogGenerator
+  # Default error for ChangelogGenerator
+  class ChangelogGeneratorError < StandardError
+  end
 
+  # Main class and entry point for this script.
+  class ChangelogGenerator
     attr_accessor :options, :all_tags, :github
 
-    PER_PAGE_NUMBER = 30
+    # Class, responsible for whole change log generation cycle
-
+    # @return initialised instance of ChangelogGenerator
     def initialize
-
       @options = Parser.parse_options
 
-      if options[:verbose]
+      @fetcher = GitHubChangelogGenerator::Fetcher.new @options
-        puts 'Input options:'
+
-        pp options
+      @generator = Generator.new @options
-        puts ''
+
+      # @all_tags = get_filtered_tags
+      @all_tags = @fetcher.get_all_tags
+
+      # TODO: refactor this double asssign of @issues and @pull_requests and move all logic in one method
+      @issues, @pull_requests = @fetcher.fetch_closed_issues_and_pr
+
+      @pull_requests = @options[:pulls] ? get_filtered_pull_requests : []
+
+      @issues = @options[:issues] ? get_filtered_issues : []
+
+      fetch_event_for_issues_and_pr
+      detect_actual_closed_dates
+    end
+
+    # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
+    #
+    # @return [Array]
+    def get_filtered_tags
+      all_tags = @fetcher.get_all_tags
+      filtered_tags = []
+      if @options[:between_tags]
+        @options[:between_tags].each do |tag|
+          unless all_tags.include? tag
+            puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
+          end
+        end
+        filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag }
       end
-
+      filtered_tags
-      github_token
-
-      github_options = {per_page: PER_PAGE_NUMBER}
-      github_options[:oauth_token] = @github_token unless @github_token.nil?
-      github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
-      github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
-
-      @github = Github.new github_options
-
-      @generator = Generator.new(@options)
-
-      @all_tags = self.get_all_tags
-      @issues, @pull_requests = self.fetch_issues_and_pull_requests
-
-      if @options[:pulls]
-        @pull_requests = self.get_filtered_pull_requests
-        self.fetch_merged_at_pull_requests
-      else
-        @pull_requests = []
-      end
-
-      if @options[:issues]
-        @issues = self.get_filtered_issues
-        fetch_event_for_issues(@issues)
-        detect_actual_closed_dates
-      else
-        @issues = []
-      end
-
-      @tag_times_hash = {}
     end
 
     def detect_actual_closed_dates
-
       if @options[:verbose]
         print "Fetching closed dates for issues...\r"
       end
 
       threads = []
+
       @issues.each { |issue|
         threads << Thread.new {
           find_closed_date_by_commit(issue)
         }
       }
-      threads.each { |thr| thr.join }
+
+      @pull_requests.each { |pull_request|
+        threads << Thread.new {
+          find_closed_date_by_commit(pull_request)
+        }
+      }
+      threads.each(&:join)
 
       if @options[:verbose]
-        puts 'Fetching closed dates for issues: Done!'
+        puts "Fetching closed dates for issues: Done!"
       end
     end
 
+    # Fill :actual_date parameter of specified issue by closed date of the commit, it it was closed by commit.
+    # @param [Hash] issue
     def find_closed_date_by_commit(issue)
-      unless issue['events'].nil?
+      unless issue["events"].nil?
+        # if it's PR -> then find "merged event", in case of usual issue -> fond closed date
+        compare_string = issue[:merged_at].nil? ? "closed" : "merged"
         # reverse! - to find latest closed event. (event goes in date order)
-        issue['events'].reverse!.each { |event|
+        issue["events"].reverse!.each { |event|
-          if event[:event].eql? 'closed'
+          if event[:event].eql? compare_string
             if event[:commit_id].nil?
               issue[:actual_date] = issue[:closed_at]
             else
-              commit = @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
+              begin
-              issue[:actual_date] = commit[:author][:date]
+                commit = @fetcher.fetch_commit(event)
+                issue[:actual_date] = commit[:author][:date]
+              rescue
+                puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo.".yellow
+                issue[:actual_date] = issue[:closed_at]
+              end
             end
             break
           end
         }
       end
-      #TODO: assert issues, that remain without 'actual_date' hash for some reason.
+      # TODO: assert issues, that remain without 'actual_date' hash for some reason.
     end
 
     def print_json(json)
       puts JSON.pretty_generate(json)
     end
 
-    def exec_command(cmd)
+    # This method fetches missing params for PR and filter them by specified options
-      exec_cmd = "cd #{$project_path} and #{cmd}"
+    # It include add all PR's with labels from @options[:include_labels] array
-      %x[#{exec_cmd}]
+    # And exclude all from :exclude_labels array.
-    end
+    # @return [Array] filtered PR's
-
-    def fetch_merged_at_pull_requests
-      if @options[:verbose]
-        print "Fetching pull requests...\r"
-      end
-      response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
-
-      pull_requests = []
-      page_i = 0
-      response.each_page do |page|
-        page_i += PER_PAGE_NUMBER
-        count_pages = response.count_pages
-        print "Fetching pull requests... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
-        pull_requests.concat(page)
-      end
-      print "                                                   \r"
-
-      if @options[:verbose]
-        puts "Received pull requests: #{pull_requests.count}"
-      end
-
-      @pull_requests.each { |pr|
-        fetched_pr = pull_requests.find { |fpr|
-          fpr.number == pr.number }
-        pr[:merged_at] = fetched_pr[:merged_at]
-        pull_requests.delete(fetched_pr)
-      }
-    end
-
     def get_filtered_pull_requests
+      filter_merged_pull_requests
 
-      pull_requests = @pull_requests
+      filtered_pull_requests = include_issues_by_labels(@pull_requests)
-      filtered_pull_requests = pull_requests
-
-
-      unless @options[:include_labels].nil?
-        filtered_pull_requests = pull_requests.select { |issue|
-          #add all labels from @options[:incluse_labels] array
-          (issue.labels.map { |label| label.name } & @options[:include_labels]).any?
-        }
-      end
-
-      unless @options[:exclude_labels].nil?
-        filtered_pull_requests = filtered_pull_requests.select { |issue|
-          #delete all labels from @options[:exclude_labels] array
-          !(issue.labels.map { |label| label.name } & @options[:exclude_labels]).any?
-        }
-      end
-
-      if @options[:add_issues_wo_labels]
-        issues_wo_labels = pull_requests.select {
-          # add issues without any labels
-            |issue| !issue.labels.map { |label| label.name }.any?
-        }
-        filtered_pull_requests |= issues_wo_labels
-      end
 
+      filtered_pull_requests = exclude_issues_by_labels(filtered_pull_requests)
 
       if @options[:verbose]
         puts "Filtered pull requests: #{filtered_pull_requests.count}"
       end
 
       filtered_pull_requests
-      #
-      # #
-      #
-      #
-      # unless @options[:pull_request_labels].nil?
-      #
-      #   if @options[:verbose]
-      #     puts 'Filter all pull requests by labels.'
-      #   end
-      #
-      #   filtered_pull_requests = filtered_pull_requests.select { |pull_request|
-      #     #fetch this issue to get labels array
-      #     issue = @github.issues.get @options[:user], @options[:project], pull_request.number
-      #
-      #     #compare is there any labels from @options[:labels] array
-      #     issue_without_labels = !issue.labels.map { |label| label.name }.any?
-      #
-      #     if @options[:verbose]
-      #       puts "Filter request \##{issue.number}."
-      #     end
-      #
-      #     if @options[:pull_request_labels].any?
-      #       select_by_label = (issue.labels.map { |label| label.name } & @options[:pull_request_labels]).any?
-      #     else
-      #       select_by_label = false
-      #     end
-      #
-      #     select_by_label | issue_without_labels
-      #   }
-      #
-      #   if @options[:verbose]
-      #     puts "Filtered pull requests with specified labels and w/o labels: #{filtered_pull_requests.count}"
-      #   end
-      #   return filtered_pull_requests
-      # end
-      #
-      # filtered_pull_requests
     end
 
-    def compund_changelog
+    # This method filter only merged PR and
+    # fetch missing required attributes for pull requests
+    # :merged_at - is a date, when issue PR was merged.
+    # More correct to use merged date, rather than closed date.
+    def filter_merged_pull_requests
+      if @options[:verbose]
+        print "Fetching merged dates...\r"
+      end
+      pull_requests = @fetcher.fetch_closed_pull_requests
 
+      @pull_requests.each { |pr|
+        fetched_pr = pull_requests.find { |fpr|
+          fpr.number == pr.number
+        }
+        pr[:merged_at] = fetched_pr[:merged_at]
+        pull_requests.delete(fetched_pr)
+      }
+
+      @pull_requests.select! do |pr|
+        !pr[:merged_at].nil?
+      end
+    end
+
+    # Include issues with labels, specified in :include_labels
+    # @param [Array] issues to filter
+    # @return [Array] filtered array of issues
+    def include_issues_by_labels(issues)
+      filtered_issues = @options[:include_labels].nil? ? issues : issues.select { |issue| (issue.labels.map(&:name) & @options[:include_labels]).any? }
+
+      if @options[:add_issues_wo_labels]
+        issues_wo_labels = issues.select { |issue|
+          !issue.labels.map(&:name).any?
+        }
+        filtered_issues |= issues_wo_labels
+      end
+      filtered_issues
+    end
+
+    # delete all labels with labels from @options[:exclude_labels] array
+    # @param [Array] issues
+    # @return [Array] filtered array
+    def exclude_issues_by_labels(issues)
+      unless @options[:exclude_labels].nil?
+        issues = issues.select { |issue|
+          !(issue.labels.map(&:name) & @options[:exclude_labels]).any?
+        }
+      end
+      issues
+    end
+
+    # The entry point of this script to generate change log
+    # @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
+    def compound_changelog
       log = "# Change Log\n\n"
 
       if @options[:unreleased_only]
-        log += self.generate_log_between_tags(self.all_tags[0], nil)
+        log += generate_log_between_tags(all_tags[0], nil)
       elsif @options[:tag1] and @options[:tag2]
         tag1 = @options[:tag1]
         tag2 = @options[:tag2]
         tags_strings = []
-        self.all_tags.each { |x| tags_strings.push(x['name']) }
+        all_tags.each { |x| tags_strings.push(x["name"]) }
 
         if tags_strings.include?(tag1)
           if tags_strings.include?(tag2)
@@ -223,64 +203,63 @@ module GitHubChangelogGenerator
             hash = Hash[to_a]
             index1 = hash[tag1]
             index2 = hash[tag2]
-            log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
+            log += generate_log_between_tags(all_tags[index1], all_tags[index2])
           else
-            puts "Can't find tag #{tag2} -> exit"
+            fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
-            exit
           end
         else
-          puts "Can't find tag #{tag1} -> exit"
+          fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
-          exit
         end
       else
-        log += self.generate_log_for_all_tags
+        log += generate_log_for_all_tags
       end
 
       log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
 
       output_filename = "#{@options[:output]}"
-      File.open(output_filename, 'w') { |file| file.write(log) }
+      File.open(output_filename, "w") { |file| file.write(log) }
-      puts 'Done!'
+      puts "Done!"
-      puts "Generated log placed in #{`pwd`.strip!}/#{output_filename}"
+      puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
-
     end
 
+    # The full cycle of generation for whole project
+    # @return [String] The complete change log
     def generate_log_for_all_tags
-
       fetch_tags_dates
 
       if @options[:verbose]
-        puts "Sorting tags.."
+        puts "Sorting tags..."
       end
 
-      @all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse!
+      @all_tags.sort_by! { |x| @fetcher.get_time_of_tag(x) }.reverse!
 
       if @options[:verbose]
-        puts "Generating log.."
+        puts "Generating log..."
       end
 
+      log = ""
 
-      log = ''
+      if @options[:unreleased] && @all_tags.count != 0
-
+        unreleased_log = generate_log_between_tags(all_tags[0], nil)
-      if @options[:unreleased]
-        unreleased_log = self.generate_log_between_tags(self.all_tags[0], nil)
         if unreleased_log
           log += unreleased_log
         end
       end
 
-      (1 ... self.all_tags.size).each { |index|
+      (1...all_tags.size).each { |index|
-        log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
+        log += generate_log_between_tags(all_tags[index], all_tags[index - 1])
       }
-
+      if @all_tags.count != 0
-      log += generate_log_between_tags(nil, self.all_tags.last)
+        log += generate_log_between_tags(nil, all_tags.last)
+      end
 
       log
     end
 
+    # Async fetching of all tags dates
     def fetch_tags_dates
       if @options[:verbose]
-        print "Fetching tags dates..\r"
+        print "Fetching tag dates...\r"
       end
 
       # Async fetching tags:
@@ -288,90 +267,46 @@ module GitHubChangelogGenerator
       i = 0
       all = @all_tags.count
       @all_tags.each { |tag|
-        # explicit set @tag_times_hash to write data safety.
         threads << Thread.new {
-          self.get_time_of_tag(tag, @tag_times_hash)
+          @fetcher.get_time_of_tag(tag)
           if @options[:verbose]
-            print "Fetching tags dates: #{i+1}/#{all}\r"
+            print "Fetching tags dates: #{i + 1}/#{all}\r"
-            i+=1
+            i += 1
           end
-
         }
       }
 
       print "                                 \r"
 
-      threads.each { |thr| thr.join }
+      threads.each(&:join)
 
       if @options[:verbose]
-        puts 'Fetching tags: Done!'
+        puts "Fetching tags dates: #{i}"
       end
     end
 
-    def is_megred(number)
+    # Generate log only between 2 specified tags
-      @github.pull_requests.merged? @options[:user], @options[:project], number
+    # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
-    end
+    # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
-
-    def get_all_tags
-
-      if @options[:verbose]
-        print "Fetching tags...\r"
-      end
-
-      response = @github.repos.tags @options[:user], @options[:project]
-
-      tags = []
-      page_i = 0
-      count_pages = response.count_pages
-      response.each_page do |page|
-        page_i += PER_PAGE_NUMBER
-        print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
-        tags.concat(page)
-      end
-      print "                               \r"
-      if @options[:verbose]
-        puts "Found #{tags.count} tags"
-      end
-
-      tags
-    end
-
-    def github_token
-      if @options[:token]
-        return @github_token ||= @options[:token]
-      end
-
-      env_var = ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil
-
-      unless env_var
-        puts "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
-        puts "This script can make only 50 requests to GitHub API per hour without token!".yellow
-      end
-
-      @github_token ||= env_var
-
-    end
-
     def generate_log_between_tags(older_tag, newer_tag)
-      # older_tag nil - means it's first tag, newer_tag nil - means it unreleased section
+      filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
-      filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, older_tag, newer_tag)
       filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
 
-      newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
+      newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
-      older_tag_name = older_tag.nil? ? nil : older_tag['name']
+      older_tag_name = older_tag.nil? ? nil : older_tag["name"]
 
       if @options[:filter_issues_by_milestone]
-        #delete excess irrelevant issues (according milestones)
+        # delete excess irrelevant issues (according milestones)
         filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
         filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
       end
 
       if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil?
         # do not generate empty unreleased section
-        return nil
+        return ""
       end
 
-      self.create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
+      create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
     end
 
     def filter_by_milestone(filtered_issues, newer_tag_name, src_array)
@@ -380,18 +315,18 @@ module GitHubChangelogGenerator
         if issue.milestone.nil?
           true
         else
-          #check, that this milestone in tag list:
+          # check, that this milestone in tag list:
           @all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
         end
       }
       unless newer_tag_name.nil?
 
-        #add missed issues (according milestones)
+        # add missed issues (according milestones)
         issues_to_add = src_array.select { |issue|
           if issue.milestone.nil?
             false
           else
-            #check, that this milestone in tag list:
+            # check, that this milestone in tag list:
             milestone_is_tag = @all_tags.find { |tag|
               tag.name == issue.milestone.title
             }
@@ -409,12 +344,17 @@ module GitHubChangelogGenerator
       filtered_issues
     end
 
-    def delete_by_time(array, hash_key, older_tag = nil, newer_tag = nil)
+    # Method filter issues, that belong only specified tag range
+    # @param [Array] array of issues to filter
+    # @param [Symbol] hash_key key of date value default is :actual_date
+    # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
+    # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
+    # @return [Array] filtered issues
+    def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
+      fail ChangelogGeneratorError, "At least one of the tags should be not nil!".red if older_tag.nil? && newer_tag.nil?
 
-      raise 'At least on of the tags should be not nil!' if (older_tag.nil? && newer_tag.nil?)
+      newer_tag_time = newer_tag && @fetcher.get_time_of_tag(newer_tag)
-
+      older_tag_time = older_tag && @fetcher.get_time_of_tag(older_tag)
-      newer_tag_time = self.get_time_of_tag(newer_tag)
-      older_tag_time = self.get_time_of_tag(older_tag)
 
       array.select { |req|
         if req[hash_key]
@@ -432,7 +372,6 @@ module GitHubChangelogGenerator
             tag_in_range_new = t <= newer_tag_time
           end
 
-
           tag_in_range = (tag_in_range_old) && (tag_in_range_new)
 
           tag_in_range
@@ -442,45 +381,43 @@ module GitHubChangelogGenerator
       }
     end
 
-    # @param [Array] pull_requests
+    # Generates log for section with header and body
-    # @param [Array] issues
+    #
-    # @param [String] older_tag_name
+    # @param [Array] pull_requests List or PR's in new section
-    # @return [String]
+    # @param [Array] issues List of issues in new section
+    # @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
+    # @param [String] older_tag_name Older tag, used for the links. Could be nil for last tag.
+    # @return [String] Ready and parsed section
     def create_log(pull_requests, issues, newer_tag, older_tag_name = nil)
-
+      newer_tag_time = newer_tag.nil? ? Time.new : @fetcher.get_time_of_tag(newer_tag)
-      newer_tag_time = newer_tag.nil? ? nil : self.get_time_of_tag(newer_tag)
+      if newer_tag.nil? && @options[:future_release]
-      newer_tag_name = newer_tag.nil? ? nil : newer_tag['name']
+        newer_tag_name = @options[:future_release]
-
+        newer_tag_link = @options[:future_release]
-      github_site = options[:github_site] || 'https://github.com'
-      project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
-
-      if newer_tag.nil?
-        newer_tag_name = 'Unreleased'
-        newer_tag_link = 'HEAD'
-        newer_tag_time = Time.new
       else
-        newer_tag_link = newer_tag_name
+        newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
+        newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
       end
 
-      log = ''
+      github_site = options[:github_site] || "https://github.com"
+      project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
 
-      log += generate_header(log, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
+      log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
 
       if @options[:issues]
         # Generate issues:
         issues_a = []
         enhancement_a = []
-        bugs_a =[]
+        bugs_a = []
 
         issues.each { |dict|
           added = false
           dict.labels.each { |label|
-            if label.name == 'bug'
+            if label.name == "bug"
               bugs_a.push dict
               added = true
               next
             end
-            if label.name == 'enhancement'
+            if label.name == "enhancement"
               enhancement_a.push dict
               added = true
               next
@@ -491,23 +428,26 @@ module GitHubChangelogGenerator
           end
         }
 
-        log += generate_log_from_array(enhancement_a, @options[:enhancement_prefix])
+        log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
-        log += generate_log_from_array(bugs_a, @options[:bug_prefix])
+        log += generate_sub_section(bugs_a, @options[:bug_prefix])
-        log += generate_log_from_array(issues_a, @options[:issue_prefix])
+        log += generate_sub_section(issues_a, @options[:issue_prefix])
-
+      end
-        if @options[:pulls]
-          # Generate pull requests:
-          log += generate_log_from_array(pull_requests, @options[:merge_prefix])
-        end
 
+      if @options[:pulls]
+        # Generate pull requests:
+        log += generate_sub_section(pull_requests, @options[:merge_prefix])
       end
 
       log
     end
 
-    def generate_log_from_array(issues, prefix)
+    # @param [Array] issues List of issues on sub-section
-      log = ''
+    # @param [String] prefix Nae of sub-section
-      if options[:simple_list].nil? && issues.any?
+    # @return [String] Generate ready-to-go sub-section
+    def generate_sub_section(issues, prefix)
+      log = ""
+
+      if options[:simple_list] != true && issues.any?
         log += "#{prefix}\n\n"
       end
 
@@ -520,134 +460,63 @@ module GitHubChangelogGenerator
       log
     end
 
-    def generate_header(log, newer_tag_name, newer_tag_name2, newer_tag_time, older_tag_name, project_url)
+    # 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:
+      # Generate date string:
-      time_string = newer_tag_time.strftime @options[:format]
+      time_string = newer_tag_time.strftime @options[:dateformat]
 
       # Generate tag name and link
-      log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_name2}) (#{time_string})\n\n"
+      if newer_tag_name.equal? @options[:unreleased_label]
+        log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
+      else
+        log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n\n"
+      end
 
-      if @options[:compare_link] && older_tag_name
+      if @options[:compare_link] && older_tag_link
         # Generate compare link
-        log += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_name2})\n\n"
+        log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
       end
 
       log
     end
 
-    def get_time_of_tag(tag_name, tag_times_hash = @tag_times_hash)
+    # Filter issues according labels
-
+    # @return [Array] Filtered issues
-      if tag_name.nil?
-        return nil
-      end
-
-      if tag_times_hash[tag_name['name']]
-        return @tag_times_hash[tag_name['name']]
-      end
-
-      github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], tag_name['commit']['sha']
-      time_string = github_git_data_commits_get['committer']['date']
-      @tag_times_hash[tag_name['name']] = Time.parse(time_string)
-    end
-
     def get_filtered_issues
+      filtered_issues = include_issues_by_labels(@issues)
 
-      issues = @issues
+      filtered_issues = exclude_issues_by_labels(filtered_issues)
-
-      filtered_issues = issues
-
-      unless @options[:include_labels].nil?
-        filtered_issues = issues.select { |issue|
-          #add all labels from @options[:incluse_labels] array
-          (issue.labels.map { |label| label.name } & @options[:include_labels]).any?
-        }
-      end
-
-      unless @options[:exclude_labels].nil?
-        filtered_issues = filtered_issues.select { |issue|
-          #delete all labels from @options[:exclude_labels] array
-          !(issue.labels.map { |label| label.name } & @options[:exclude_labels]).any?
-        }
-      end
-
-      if @options[:add_issues_wo_labels]
-        issues_wo_labels = issues.select {
-          # add issues without any labels
-            |issue| !issue.labels.map { |label| label.name }.any?
-        }
-        filtered_issues |= issues_wo_labels
-      end
-
 
       if @options[:verbose]
         puts "Filtered issues: #{filtered_issues.count}"
       end
 
       filtered_issues
-
     end
 
-    def fetch_issues_and_pull_requests
+    # Fetch event for issues and pull requests
+    # @return [Array] array of fetched issues
+    def fetch_event_for_issues_and_pr
       if @options[:verbose]
-        print "Fetching closed issues...\r"
+        print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
-      end
-
-      response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
-
-      issues = []
-      page_i = 0
-      count_pages = response.count_pages
-      response.each_page do |page|
-        page_i += PER_PAGE_NUMBER
-        print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
-        issues.concat(page)
-      end
-
-      print "                               \r"
-
-      if @options[:verbose]
-        puts "Received issues: #{issues.count}"
-      end
-
-      # remove pull request from issues:
-      issues_wo_pr = issues.select { |x|
-        x.pull_request == nil
-      }
-      pull_requests = issues.select { |x|
-        x.pull_request != nil
-      }
-      return issues_wo_pr, pull_requests
-    end
-
-    def fetch_event_for_issues(filtered_issues)
-      if @options[:verbose]
-        print "Fetching events for issues: 0/#{filtered_issues.count}\r"
       end
 
       # Async fetching events:
-      threads = []
 
-      i = 0
+      @fetcher.fetch_events_async(@issues + @pull_requests)
-      filtered_issues.each { |issue|
-        threads << Thread.new {
-          obj = @github.issues.events.list user: @options[:user], repo: @options[:project], issue_number: issue['number']
-          issue[:events] = obj.body
-          print "Fetching events for issues: #{i+1}/#{filtered_issues.count}\r"
-          i +=1
-        }
-      }
-      threads.each { |thr| thr.join }
-
-      if @options[:verbose]
-        puts "Fetching events for issues: Done!"
-      end
     end
-
   end
 
-  if __FILE__ == $0
+  if __FILE__ == $PROGRAM_NAME
-    GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
+    GitHubChangelogGenerator::ChangelogGenerator.new.compound_changelog
   end
-
 end

lib/github_changelog_generator/fetcher.rb

@@ -0,0 +1,224 @@
+require "logger"
+
+module GitHubChangelogGenerator
+  # A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
+  # (such as filtering, validating, e.t.c)
+  #
+  # Example:
+  # fetcher = GitHubChangelogGenerator::Fetcher.new options
+  class Fetcher
+    PER_PAGE_NUMBER = 30
+    CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
+    GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
+    "missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
+    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!"
+
+    def initialize(options = {})
+      @options = options
+
+      @logger = Logger.new(STDOUT)
+      @logger.formatter = proc do |_severity, _datetime, _progname, msg|
+        "#{msg}\n"
+      end
+
+      @user = @options[:user]
+      @project = @options[:project]
+      @github_token = fetch_github_token
+      @tag_times_hash = {}
+      github_options = { per_page: PER_PAGE_NUMBER }
+      github_options[:oauth_token] = @github_token unless @github_token.nil?
+      github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
+      github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
+
+      @github = check_github_response { Github.new github_options }
+    end
+
+    # Returns GitHub token. First try to use variable, provided by --token option,
+    # otherwise try to fetch it from CHANGELOG_GITHUB_TOKEN env variable.
+    #
+    # @return [String]
+    def fetch_github_token
+      env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
+
+      unless env_var
+        @logger.warn NO_TOKEN_PROVIDED.yellow
+      end
+
+      env_var
+    end
+
+    # Fetch all tags from repo
+    # @return [Array] array of tags
+    def get_all_tags
+      if @options[:verbose]
+        print "Fetching tags...\r"
+      end
+
+      tags = []
+
+      check_github_response { github_fetch_tags(tags) }
+
+      tags
+    end
+
+    def check_github_response
+      begin
+        value = yield
+      rescue Github::Error::Unauthorized => e
+        @logger.error e.body.red
+        abort "Error: wrong GitHub token"
+      rescue Github::Error::Forbidden => e
+        @logger.warn e.body.red
+        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+      value
+    end
+
+    def github_fetch_tags(tags)
+      response = @github.repos.tags @options[:user], @options[:project]
+      page_i = 0
+      count_pages = response.count_pages
+      response.each_page do |page|
+        page_i += PER_PAGE_NUMBER
+        print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
+        tags.concat(page)
+      end
+      print_empty_line
+
+      if tags.count == 0
+        @logger.warn "Warning: Can't find any tags in repo.\
+Make sure, that you push tags to remote repo via 'git push --tags'".yellow
+      else
+        @logger.info "Found #{tags.count} tags"
+      end
+    end
+
+    # This method fetch all closed issues and separate them to pull requests and pure issues
+    # (pull request is kind of issue in term of GitHub)
+    # @return [Tuple] with (issues, pull-requests)
+    def fetch_closed_issues_and_pr
+      if @options[:verbose]
+        print "Fetching closed issues...\r"
+      end
+      issues = []
+
+      begin
+        response = @github.issues.list user: @options[:user],
+                                       repo: @options[:project],
+                                       state: "closed",
+                                       filter: "all",
+                                       labels: nil
+        page_i = 0
+        count_pages = response.count_pages
+        response.each_page do |page|
+          page_i += PER_PAGE_NUMBER
+          print_in_same_line("Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
+          issues.concat(page)
+          break if @options[:max_issues] && issues.length >= @options[:max_issues]
+        end
+        print_empty_line
+        @logger.info "Received issues: #{issues.count}"
+
+      rescue
+        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+
+      # separate arrays of issues and pull requests:
+      issues.partition do |x|
+        x[:pull_request].nil?
+      end
+    end
+
+    # Fetch all pull requests. We need them to detect :merged_at parameter
+    # @return [Array] all pull requests
+    def fetch_closed_pull_requests
+      pull_requests = []
+      begin
+        response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
+        page_i = 0
+        count_pages = response.count_pages
+        response.each_page do |page|
+          page_i += PER_PAGE_NUMBER
+          log_string = "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}"
+          print_in_same_line(log_string)
+          pull_requests.concat(page)
+        end
+        print_empty_line
+      rescue
+        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+
+      @logger.info "Fetching merged dates: #{pull_requests.count}"
+      pull_requests
+    end
+
+    def print_in_same_line(log_string)
+      print log_string + "\r"
+    end
+
+    def print_empty_line
+      print_in_same_line("                                                                       ")
+    end
+
+    # Fetch event for all issues and add them to :events
+    # @param [Array] issues
+    # @return [Void]
+    def fetch_events_async(issues)
+      i = 0
+      max_thread_number = 50
+      threads = []
+      issues.each_slice(max_thread_number) do |issues_slice|
+        issues_slice.each do |issue|
+          threads << Thread.new do
+            begin
+              obj = @github.issues.events.list user: @options[:user],
+                                               repo: @options[:project],
+                                               issue_number: issue["number"]
+            rescue
+              @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+            end
+            issue[:events] = obj.body
+            print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
+            i += 1
+          end
+        end
+        threads.each(&:join)
+        threads = []
+      end
+
+      # to clear line from prev print
+      print_empty_line
+
+      @logger.info "Fetching events for issues and PR: #{i}"
+    end
+
+    # Try to find tag date in local hash.
+    # Otherwise fFetch tag time and put it to local hash file.
+    # @param [String] 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?
+
+      if @tag_times_hash[tag_name["name"]]
+        return @tag_times_hash[tag_name["name"]]
+      end
+
+      begin
+        github_git_data_commits_get = @github.git_data.commits.get @options[:user],
+                                                                   @options[:project],
+                                                                   tag_name["commit"]["sha"]
+      rescue
+        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+      time_string = github_git_data_commits_get["committer"]["date"]
+      @tag_times_hash[tag_name["name"]] = Time.parse(time_string)
+    end
+
+    # Fetch commit for specifed event
+    # @return [Hash]
+    def fetch_commit(event)
+      @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
+    end
+  end
+end

lib/github_changelog_generator/generator.rb

@@ -1,12 +1,18 @@
 module GitHubChangelogGenerator
   class Generator
-
     def initialize(options = nil)
       @options = options
     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](https://github.com/skywinder))
+    #
+    # @param [Hash] issue Fetched issue from GitHub
+    # @return [String] Markdown-formatted single issue
     def get_string_for_issue(issue)
-      encapsulated_title = self.encapsulate_string issue[:title]
+      encapsulated_title = encapsulate_string issue[:title]
 
       title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
 
@@ -23,17 +29,14 @@ module GitHubChangelogGenerator
     end
 
     def encapsulate_string(string)
-
       string.gsub! '\\', '\\\\'
 
-      encpas_chars = %w(> * _ \( \) [ ])
+      encpas_chars = %w(> * _ \( \) [ ] #)
-      encpas_chars.each { |char|
+      encpas_chars.each do |char|
         string.gsub! char, "\\#{char}"
-      }
+      end
 
       string
     end
-
   end
-
+end
-end

lib/github_changelog_generator/parser.rb

@@ -1,110 +1,145 @@
 #!/usr/bin/env ruby
-require 'optparse'
+require "optparse"
-require 'pp'
+require "pp"
-require_relative 'version'
+require_relative "version"
 
 module GitHubChangelogGenerator
   class Parser
     def self.parse_options
-      # :include_labels => %w(bug enhancement),
+      options = {
-      hash = {
+        tag1: nil,
-          :tag1 => nil,
+        tag2: nil,
-          :tag2 => nil,
+        dateformat: "%Y-%m-%d",
-          :format => '%Y-%m-%d',
+        output: "CHANGELOG.md",
-          :output => 'CHANGELOG.md',
+        issues: true,
-          :exclude_labels => %w(duplicate question invalid wontfix),
+        add_issues_wo_labels: true,
-          :pulls => true,
+        add_pr_wo_labels: true,
-          :issues => true,
+        pulls: true,
-          :verbose => true,
+        filter_issues_by_milestone: true,
-          :add_issues_wo_labels => true,
+        author: true,
-          :add_pr_wo_labels => true,
+        unreleased: true,
-          :merge_prefix => '**Merged pull requests:**',
+        unreleased_label: "Unreleased",
-          :issue_prefix => '**Closed issues:**',
+        compare_link: true,
-          :bug_prefix => '**Fixed bugs:**',
+        include_labels: %w(bug enhancement),
-          :enhancement_prefix => '**Implemented enhancements:**',
+        exclude_labels: %w(duplicate question invalid wontfix),
-          :author => true,
+        max_issues: nil,
-          :filter_issues_by_milestone => true,
+        simple_list: false,
-          :compare_link => true,
+        verbose: true,
-          :unreleased => true
-      }
-      options = hash
 
-      parser = OptionParser.new { |opts|
+        merge_prefix: "**Merged pull requests:**",
-        opts.banner = 'Usage: changelog_generator [options]'
+        issue_prefix: "**Closed issues:**",
-        opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
+        bug_prefix: "**Fixed bugs:**",
+        enhancement_prefix: "**Implemented enhancements:**",
+        branch: "origin"
+      }
+
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: github_changelog_generator [options]"
+        opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
           options[:user] = last
         end
-        opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
+        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 required. You can generate it here: https://github.com/settings/tokens/new') do |last|
+        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 %d/%m/%y') do |last|
+        opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
-          options[:format] = last
+          options[:dateformat] = last
         end
-        opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
+        opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
           options[:output] = last
         end
-        opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
+        opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
           options[:issues] = v
         end
-        opts.on('--[no-]issues-wo-labels', 'Include closed issues without labels to changelog. Default is true') do |v|
+        opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true") do |v|
           options[:add_issues_wo_labels] = v
         end
-        opts.on('--[no-]pr-wo-labels', 'Include pull requests without labels to changelog. Default is true') do |v|
+        opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true") do |v|
           options[:add_pr_wo_labels] = v
         end
-        opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
+        opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true") do |v|
           options[:pulls] = v
         end
-        opts.on('--[no-]filter-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
+        opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true") do |last|
           options[:filter_issues_by_milestone] = last
         end
-        opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
+        opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
           options[:author] = author
         end
-        opts.on('--unreleased-only', 'Generate log from unreleased closed issues only.') do |v|
+        opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
           options[:unreleased_only] = v
         end
-        opts.on('--[no-]unreleased', 'Add to log unreleased closed issues. Default is true') do |v|
+        opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
           options[:unreleased] = v
         end
-        opts.on('--[no-]compare-link', 'Include compare link (Full Changelog) between older version and newer version. Default is true') do |v|
+        opts.on("--unreleased-label [label]", "Add to log unreleased closed issues. Default is true") do |v|
+          options[:unreleased_label] = v
+        end
+        opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
           options[:compare_link] = v
         end
-        opts.on('--include-labels  x,y,z', Array, 'Issues only with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
+        opts.on("--include-labels  x,y,z", Array, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') do |list|
           options[:include_labels] = list
         end
-        opts.on('--exclude-labels  x,y,z', Array, 'Issues with that 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('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
+        opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
+          options[:max_issues] = max
+        end
+        opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
           options[:github_site] = last
         end
-        opts.on('--github-api [URL]', 'The enterprise endpoint to use for your Github API.') do |last|
+        opts.on("--github-api [URL]", "The enterprise endpoint to use for your Github API.") do |last|
           options[:github_endpoint] = last
         end
-        opts.on('--simple-list', 'Create simple list from issues and pull requests. Default is false.') do |v|
+        opts.on("--simple-list", "Create simple list from issues and pull requests. Default is false.") do |v|
           options[:simple_list] = v
         end
-        opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
+        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("--[no-]verbose", "Run verbosely. Default is true") do |v|
           options[:verbose] = v
         end
-        opts.on('-v', '--version', 'Print version number') do |v|
+        opts.on("-v", "--version", "Print version number") do |_v|
           puts "Version: #{GitHubChangelogGenerator::VERSION}"
           exit
         end
-        opts.on('-h', '--help', 'Displays Help') do
+        opts.on("-h", "--help", "Displays Help") do
           puts opts
           exit
         end
-      }
+      end
 
       parser.parse!
 
+      detect_user_and_project(options)
+
+      if !options[:user] || !options[:project]
+        puts parser.banner
+        exit
+      end
+
+      if ARGV[1]
+        options[:tag1] = ARGV[0]
+        options[:tag2] = ARGV[1]
+      end
+
+      if options[:verbose]
+        puts "Performing task with options:"
+        pp options
+        puts ""
+      end
+
+      options
+    end
+
+    def self.detect_user_and_project(options)
       if ARGV[0] && !ARGV[1]
-        github_site = options[:github_site] ? options[:github_site] : 'github.com'
+        github_site = options[:github_site] ? options[:github_site] : "github.com"
         # this match should parse  strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
         match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
 
@@ -118,34 +153,39 @@ module GitHubChangelogGenerator
           exit
         else
           options[:user] = match[1]
-          options[:project]= match[2]
+          options[:project] = match[2]
         end
 
-
       end
 
       if !options[:user] && !options[:project]
-        remote = `git remote -vv`.split("\n")
+        if ENV["RUBYLIB"] =~ /ruby-debug-ide/
-        match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)?(?:\.git).*/.match(remote[0])
+          options[:user] = "skywinder"
+          options[:project] = "changelog_test"
+        else
+          remote = `git config --get remote.#{options[:branch]}.url`
+          # try to find repo in format:
+          # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
+          # git@github.com:skywinder/Github-Changelog-Generator.git
+          match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/.match(remote)
 
-        if match && match[1] && match[2]
+          if match && match[1] && match[2]
-          puts "Detected user:#{match[1]}, project:#{match[2]}"
+            puts "Detected user:#{match[1]}, project:#{match[2]}"
-          options[:user], options[:project] = match[1], match[2]
+            options[:user] = match[1]
+            options[:project] = match[2]
+          else
+            # try to find repo in format:
+            # origin	https://github.com/skywinder/ChangelogMerger (fetch)
+            # https://github.com/skywinder/ChangelogMerger
+            match = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/.match(remote)
+            if match && match[1] && match[2]
+              puts "Detected user:#{match[1]}, project:#{match[2]}"
+              options[:user] = match[1]
+              options[:project] = match[2]
+            end
+          end
         end
       end
-
-
-      if !options[:user] || !options[:project]
-        puts parser.banner
-        exit
-      end
-
-      if ARGV[1]
-        options[:tag1] = ARGV[0]
-        options[:tag2] = ARGV[1]
-      end
-
-      options
     end
   end
 end

lib/github_changelog_generator/reader.rb

@@ -0,0 +1,87 @@
+#
+# Author:: Enrico Stahn <mail@enricostahn.com>
+#
+# Copyright 2014, Zanui, <engineering@zanui.com.au>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module GitHubChangelogGenerator
+  # A Reader to read an existing ChangeLog file and return a structured object
+  #
+  # Example:
+  #   reader = GitHubChangelogGenerator::Reader.new
+  #   content = reader.read('./CHANGELOG.md')
+  class Reader
+    def initialize(options = {})
+      defaults = {
+        heading_level: "##",
+        heading_structures: [
+          /^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/,
+          /^## (?<version>.+?)( \((?<date>.+?)\))?$/
+        ]
+      }
+
+      @options = options.merge(defaults)
+
+      @heading_level = @options[:heading_level]
+      @heading_structures = @options[:heading_structures]
+    end
+
+    # Parse a single heading and return a Hash
+    #
+    # The following heading structures are currently valid:
+    # - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1) (2015-03-24)
+    # - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1)
+    # - ## v1.0.2 (2015-03-24)
+    # - ## v1.0.2
+    #
+    # @param [String] heading Heading from the ChangeLog File
+    # @return [Hash] Returns a structured Hash with version, url and date
+    def parse_heading(heading)
+      captures = { "version" => nil, "url" => nil, "date" => nil }
+
+      @heading_structures.each do |regexp|
+        matches = Regexp.new(regexp).match(heading)
+        captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil?
+
+        # Try Regular Expressions until you find one that delivers results
+        break unless matches.nil?
+      end
+
+      captures
+    end
+
+    # Parse the given ChangeLog data into a Hash
+    #
+    # @param [String] data File data from the ChangeLog.md
+    # @return [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|
+        captures = parse_heading(heading)
+        captures["content"] = sections.at(index + 1)
+        changelog.push captures
+      end
+
+      changelog
+    end
+
+    def read(file_path)
+      parse File.read(file_path)
+    end
+  end
+end

lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = '1.3.1'
+  VERSION = "1.4.1"
 end

spec/files/github-changelog-generator.md

@@ -0,0 +1,305 @@
+# Change Log
+
+## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.9...1.3.10)
+
+**Fixed bugs:**
+
+- Exclude closed PR's from changelog. [\#69](https://github.com/skywinder/Github-Changelog-Generator/issues/69)
+
+**Merged pull requests:**
+
+- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/Github-Changelog-Generator/pull/70) ([skywinder](https://github.com/skywinder))
+
+## [1.3.9](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.9) (2015-03-06)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.8...1.3.9)
+
+**Implemented enhancements:**
+
+- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/Github-Changelog-Generator/issues/63)
+
+**Merged pull requests:**
+
+- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/Github-Changelog-Generator/pull/65) ([skywinder](https://github.com/skywinder))
+
+## [1.3.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.8) (2015-03-05)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.6...1.3.8)
+
+**Merged pull requests:**
+
+- Fix `git remote` parsing in case, when script running without parameters inside destination directory [\#61](https://github.com/skywinder/Github-Changelog-Generator/pull/61) ([skywinder](https://github.com/skywinder))
+
+## [1.3.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.6) (2015-03-05)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.5...1.3.6)
+
+## [1.3.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.5) (2015-03-04)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.4...1.3.5)
+
+**Fixed bugs:**
+
+- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/Github-Changelog-Generator/issues/60)
+
+## [1.3.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.4) (2015-03-03)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.3...1.3.4)
+
+**Fixed bugs:**
+
+- --no-issues appears to break PRs [\#59](https://github.com/skywinder/Github-Changelog-Generator/issues/59)
+
+## [1.3.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.3) (2015-03-03)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.2...1.3.3)
+
+**Closed issues:**
+
+- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/Github-Changelog-Generator/issues/58)
+
+## [1.3.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.2) (2015-03-03)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.1...1.3.2)
+
+**Fixed bugs:**
+
+- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/Github-Changelog-Generator/issues/57)
+
+## [1.3.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.1) (2015-02-27)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.0...1.3.1)
+
+## [1.3.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.0) (2015-02-26)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.8...1.3.0)
+
+**Implemented enhancements:**
+
+- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/Github-Changelog-Generator/issues/55)
+
+- Separate list exclude and include labels [\#52](https://github.com/skywinder/Github-Changelog-Generator/issues/52)
+
+- Unreleased issues in separate section [\#47](https://github.com/skywinder/Github-Changelog-Generator/issues/47)
+
+- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/Github-Changelog-Generator/issues/31)
+
+**Fixed bugs:**
+
+- Test pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44)
+
+**Merged pull requests:**
+
+- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder))
+
+## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8)
+
+**Closed issues:**
+
+- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/Github-Changelog-Generator/issues/37)
+
+**Merged pull requests:**
+
+- Feature/fix 37 [\#49](https://github.com/skywinder/Github-Changelog-Generator/pull/49) ([skywinder](https://github.com/skywinder))
+
+- Prettify output [\#48](https://github.com/skywinder/Github-Changelog-Generator/pull/48) ([skywinder](https://github.com/skywinder))
+
+## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7) (2015-01-26)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7)
+
+**Merged pull requests:**
+
+- Add compare link between older version and newer version [\#46](https://github.com/skywinder/Github-Changelog-Generator/pull/46) ([sue445](https://github.com/sue445))
+
+## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6) (2015-01-21)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
+
+**Merged pull requests:**
+
+- fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao))
+
+## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
+
+**Implemented enhancements:**
+
+- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
+
+**Fixed bugs:**
+
+- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
+
+**Merged pull requests:**
+
+- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
+
+- support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
+
+## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4) (2014-12-16)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
+
+**Fixed bugs:**
+
+- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/Github-Changelog-Generator/issues/41)
+
+- Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35)
+
+## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3) (2014-12-16)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
+
+**Implemented enhancements:**
+
+- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
+
+- Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
+
+**Fixed bugs:**
+
+- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
+
+**Merged pull requests:**
+
+- Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
+
+- Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
+
+## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2) (2014-12-10)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...1.2.2)
+
+**Fixed bugs:**
+
+- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
+
+**Merged pull requests:**
+
+- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
+
+## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1) (2014-11-22)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...1.2.1)
+
+**Fixed bugs:**
+
+- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
+
+**Merged pull requests:**
+
+- Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
+
+- Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
+
+## [1.2.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0) (2014-11-19)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0)
+
+**Merged pull requests:**
+
+- Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder))
+
+- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder))
+
+- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder))
+
+## [1.1.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4) (2014-11-18)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4)
+
+**Implemented enhancements:**
+
+- Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
+
+**Merged pull requests:**
+
+- Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
+
+## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2) (2014-11-12)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2)
+
+**Merged pull requests:**
+
+- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder))
+
+- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder))
+
+## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1) (2014-11-10)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1)
+
+**Merged pull requests:**
+
+- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15) ([skywinder](https://github.com/skywinder))
+
+- Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
+
+- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder))
+
+## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0) (2014-11-10)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...1.1.0)
+
+**Implemented enhancements:**
+
+- Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
+
+**Fixed bugs:**
+
+- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
+
+- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
+
+## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1) (2014-11-10)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1)
+
+## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0) (2014-11-07)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...1.0.0)
+
+**Implemented enhancements:**
+
+- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
+
+- Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
+
+**Fixed bugs:**
+
+- Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
+
+**Merged pull requests:**
+
+- Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
+
+- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
+
+## [0.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0) (2014-11-07)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...0.1.0)
+
+**Merged pull requests:**
+
+- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
+
+- Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder))
+
+- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) ([skywinder](https://github.com/skywinder))
+
+## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2) (2014-11-06)
+
+[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2)
+
+## [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)*

spec/spec_helper.rb

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

spec/unit/fetcher_spec.rb

@@ -0,0 +1,59 @@
+VALID_TOKEN = "0123456789abcdef"
+INVALID_TOKEN = "0000000000000000"
+
+DEFAULT_OPTIONS = { user: "skywinder",
+                    project: "changelog_test" }
+
+def options_with_invalid_token
+  options = DEFAULT_OPTIONS
+  options[:token] = INVALID_TOKEN
+  options
+end
+
+describe GitHubChangelogGenerator::Fetcher do
+  before(:all) do
+    @fetcher = GitHubChangelogGenerator::Fetcher.new
+  end
+
+  describe "#fetch_github_token" do
+    token = GitHubChangelogGenerator::Fetcher::CHANGELOG_GITHUB_TOKEN
+    context "when token in ENV exist" do
+      before { stub_const("ENV", ENV.to_hash.merge(token => VALID_TOKEN)) }
+      subject { @fetcher.fetch_github_token }
+      it { is_expected.to eq(VALID_TOKEN) }
+    end
+    context "when token in ENV is nil" do
+      before { stub_const("ENV", ENV.to_hash.merge(token => nil)) }
+      subject { @fetcher.fetch_github_token }
+      it { is_expected.to be_nil }
+    end
+    context "when token in options and ENV is nil" do
+      before do
+        stub_const("ENV", ENV.to_hash.merge(token => nil))
+        @fetcher = GitHubChangelogGenerator::Fetcher.new(token: VALID_TOKEN)
+      end
+      subject { @fetcher.fetch_github_token }
+      it { is_expected.to eq(VALID_TOKEN) }
+    end
+    context "when token in options and ENV specified" do
+      before do
+        stub_const("ENV", ENV.to_hash.merge(token => "no_matter_what"))
+        @fetcher = GitHubChangelogGenerator::Fetcher.new(token: VALID_TOKEN)
+      end
+      subject { @fetcher.fetch_github_token }
+      it { is_expected.to eq(VALID_TOKEN) }
+    end
+  end
+
+  describe "#github_fetch_tags" do
+    context "when wrong token provided" do
+      before do
+        options = options_with_invalid_token
+        @fetcher = GitHubChangelogGenerator::Fetcher.new(options)
+      end
+      it "should raise Unauthorized error" do
+        expect { @fetcher.github_fetch_tags [] }.to raise_error Github::Error::Unauthorized
+      end
+    end
+  end
+end

spec/unit/reader_spec.rb

@@ -0,0 +1,113 @@
+#
+# Author:: Enrico Stahn <mail@enricostahn.com>
+#
+# Copyright 2014, Zanui, <engineering@zanui.com.au>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+describe GitHubChangelogGenerator::Reader do
+  before(:all) do
+    @reader = GitHubChangelogGenerator::Reader.new
+  end
+
+  describe "#parse_heading" do
+    context "when heading is empty" do
+      subject { @reader.parse_heading("## ") }
+      it { is_expected.to be_a(Hash) }
+      it { is_expected.to include("version", "url", "date") }
+      it { is_expected.to include("version" => nil, "url" => nil, "date" => nil) }
+      # TODO: Doesn't work?
+      # it { is_expected.to have_all_string_keys }
+    end
+    context "when given version, url and date" do
+      subject { @reader.parse_heading("## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)") }
+      it { is_expected.to include("version" => "1.3.10") }
+      it { is_expected.to include("url" => "https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10") }
+      it { is_expected.to include("date" => "2015-03-18") }
+    end
+    context "when no url and date is provided" do
+      subject { @reader.parse_heading("## foobar") }
+      it { is_expected.to include("version" => "foobar", "url" => nil, "date" => nil) }
+    end
+  end
+
+  describe "#parse" do
+    context "when file is empty" do
+      subject { @reader.parse("") }
+      it { is_expected.to be_an(Array) }
+      it { is_expected.to be_empty }
+    end
+    context "when file has only the header" do
+      subject { @reader.parse("# Change Log") }
+      it { is_expected.to be_an(Array) }
+      it { is_expected.to be_empty }
+    end
+  end
+
+  describe "example CHANGELOG files" do
+    subject { @reader.read(File.expand_path(File.join(File.dirname(__FILE__), "..", "files", self.class.description))) }
+    context "github-changelog-generator.md" do
+      it { is_expected.to be_an(Array) }
+      it { is_expected.not_to be_empty }
+      it { expect(subject.count).to eq(28) }
+      it { expect(subject.first).to include("version" => "1.3.10") }
+      it { expect(subject.first).to include("url" => "https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10") }
+      it { expect(subject.first).to include("date" => "2015-03-18") }
+      it { expect(subject.first).to include("content") }
+      it "content should not be empty" do
+        expect(subject.first["content"]).not_to be_empty
+      end
+    end
+    context "bundler.md" do
+      it { is_expected.to be_an(Array) }
+      it { is_expected.not_to be_empty }
+      it { expect(subject.count).to eq(151) }
+      it { expect(subject.first).to include("version" => "1.9.1") }
+      it { expect(subject.first).to include("url" => nil) }
+      it { expect(subject.first).to include("date" => "2015-03-21") }
+      it { expect(subject.first).to include("content") }
+      it "content should not be empty" do
+        expect(subject.first["content"]).not_to be_empty
+      end
+    end
+    context "angular.js.md" do
+      it { is_expected.to be_an(Array) }
+      it { is_expected.not_to be_empty }
+      it do
+        pending("Implement heading_level for parser.")
+        expect(subject.count).to eq(134)
+      end
+      # it do
+      #   pending('Implement heading_level for parser.')
+      #   expect(subject.first).to include('version' => '1.4.0-beta.6 cookie-liberation')
+      # end
+      # it do
+      #   pending('Implement heading_level for parser.')
+      #   expect(subject.first).to include('url' => nil)
+      # end
+      # it do
+      #   pending('Implement heading_level for parser.')
+      #   expect(subject.first).to include('date' => '2015-03-17')
+      # end
+      # it do
+      #   pending('Implement heading_level for parser.')
+      #   expect(subject.first).to include('content')
+      # end
+      # it 'content should not be empty' do
+      #   pending('Implement heading_level for parser.')
+      #   expect(subject.first['content']).not_to be_empty
+      # end
+    end
+  end
+end