Merge branch 'release/1.10.3'

This reverts commit fa0267b586.

.coveralls.yml

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

.gitignore

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

.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,56 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Enabled: false
+
+#http://viget.com/extend/just-use-double-quoted-ruby-strings
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+    Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+    Enabled: false
+
+Style/FileName:
+    Exclude:
+      - 'bin/git-generate-changelog'
+
+#TODOS
+# Offense count: 14
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 10
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+# SupportedStyles: skip_modifier_ifs, always
+Style/Next:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/MutableConstant:
+    Enabled: false
+    

.rubocop_todo.yml

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

.travis.yml

@@ -0,0 +1,19 @@
+sudo: false
+language: ruby
+before_install: 
+- gem update --system
+- gem install bundler
+rvm:
+- 2.1.0
+script:
+- bundle exec rake checks
+notifications:
+  email:
+    recipients:
+    - sky4winder+githubchangeloggenerator@gmail.com
+    on_success: never
+    on_failure: change
+addons:
+  code_climate:
+    repo_token:
+      secure: iMpV5IAvH+/EVGZrpWnt2BnmNFzSbsRcIumsr4ZyLC8N5nrCSXyjCSy0g48btL3Sj0bSgK9hcrJsmrFd2bkqFleyAcPAzNyUQzBuIRZx47O8yFmbZ+Pj+l3+KOlmcbzJNHfDfxkxuWTmTAcSDfsiyApin721T/ey3SUuwKpZNUc=

CHANGELOG.md

@@ -1,27 +1,473 @@
-# Changelog
+# Change Log
 
-## [1.0.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0)
-#### 07/11/14
-- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7)
+## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
 
-- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...HEAD)
 
-- *Fixed bug:* Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
+**Fixed bugs:**
 
-- *Implemented enhancement:* Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
+- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
 
-- *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
+## [1.10.2](https://github.com/skywinder/github-changelog-generator/tree/1.10.2) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.11.0...1.10.2)
 
-## [0.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0)
-#### 07/11/14
-- Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2)
+## [v1.11.0](https://github.com/skywinder/github-changelog-generator/tree/v1.11.0) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.1...v1.11.0)
 
-- Add option (-o --output) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1)
+**Implemented enhancements:**
 
-## [0.0.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2)
-#### 06/11/14
-## [0.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1)
-#### 06/11/14
+- YAML front matter [\#322](https://github.com/skywinder/github-changelog-generator/pull/322) ([retorquere](https://github.com/retorquere))
+- Git Subcommand [\#288](https://github.com/skywinder/github-changelog-generator/pull/288) ([dlanileonardo](https://github.com/dlanileonardo))
+
+**Fixed bugs:**
+
+- detect\_since\_tag undefined [\#328](https://github.com/skywinder/github-changelog-generator/issues/328)
+
+**Merged pull requests:**
+
+- Update README.md [\#324](https://github.com/skywinder/github-changelog-generator/pull/324) ([Zearin](https://github.com/Zearin))
+
+## [1.10.1](https://github.com/skywinder/github-changelog-generator/tree/1.10.1) (2016-01-06)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.0...1.10.1)
+
+**Fixed bugs:**
+
+- Parser: avoid Ruby exit, to make Rake tasks work [\#315](https://github.com/skywinder/github-changelog-generator/pull/315) ([olleolleolle](https://github.com/olleolleolle))
+
+## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
+
+**Implemented enhancements:**
+
+- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
+- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
+- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
+
+**Closed issues:**
+
+- PRs not closed on master branch show up in changelog [\#280](https://github.com/skywinder/github-changelog-generator/issues/280)
+
+**Merged pull requests:**
+
+- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
+- Fixes \#280 Add release-branch option to filter the Pull Requests [\#305](https://github.com/skywinder/github-changelog-generator/pull/305) ([SteveGilvarry](https://github.com/SteveGilvarry))
+- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
+- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
+- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
+- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
+- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
+
+## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
+
+**Implemented enhancements:**
+
+- Feature: exclude\_tags using regular expression [\#281](https://github.com/skywinder/github-changelog-generator/pull/281) ([olleolleolle](https://github.com/olleolleolle))
+- Auto parse options from file .github\_changelog\_generator [\#278](https://github.com/skywinder/github-changelog-generator/pull/278) ([dlanileonardo](https://github.com/dlanileonardo))
+
+## [1.8.5](https://github.com/skywinder/github-changelog-generator/tree/1.8.5) (2015-09-15)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.4...1.8.5)
+
+**Merged pull requests:**
+
+- Rake task: Be able to set false value in config [\#279](https://github.com/skywinder/github-changelog-generator/pull/279) ([olleolleolle](https://github.com/olleolleolle))
+
+## [1.8.4](https://github.com/skywinder/github-changelog-generator/tree/1.8.4) (2015-09-01)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.3...1.8.4)
+
+**Fixed bugs:**
+
+- Sending OATH through -t fails [\#274](https://github.com/skywinder/github-changelog-generator/issues/274)
+
+## [1.8.3](https://github.com/skywinder/github-changelog-generator/tree/1.8.3) (2015-08-31)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.2...1.8.3)
+
+**Merged pull requests:**
+
+- Do not alter pull\_requests while iterating on it [\#271](https://github.com/skywinder/github-changelog-generator/pull/271) ([raphink](https://github.com/raphink))
+
+## [1.8.2](https://github.com/skywinder/github-changelog-generator/tree/1.8.2) (2015-08-26)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.1...1.8.2)
+
+**Closed issues:**
+
+- Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270)
+
+**Merged pull requests:**
+
+- This PRi will fix \#274. [\#275](https://github.com/skywinder/github-changelog-generator/pull/275) ([skywinder](https://github.com/skywinder))
+
+## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1)
+
+**Implemented enhancements:**
+
+- Honor labels for Pull Requests [\#266](https://github.com/skywinder/github-changelog-generator/pull/266) ([raphink](https://github.com/raphink))
+
+**Merged pull requests:**
+
+- Fix issue with missing events \(in case of events for issue \>30\) [\#268](https://github.com/skywinder/github-changelog-generator/pull/268) ([skywinder](https://github.com/skywinder))
+- Use since\_tag as default for older\_tag [\#267](https://github.com/skywinder/github-changelog-generator/pull/267) ([raphink](https://github.com/raphink))
+
+## [1.8.0](https://github.com/skywinder/github-changelog-generator/tree/1.8.0) (2015-08-24)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.7.0...1.8.0)
+
+**Implemented enhancements:**
+
+- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
+- Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))
+
+**Merged pull requests:**
+
+- Add `--due-tag` option [\#265](https://github.com/skywinder/github-changelog-generator/pull/265) ([skywinder](https://github.com/skywinder))
+- Add release\_url to rake task options [\#264](https://github.com/skywinder/github-changelog-generator/pull/264) ([raphink](https://github.com/raphink))
+- Add a rake task [\#260](https://github.com/skywinder/github-changelog-generator/pull/260) ([raphink](https://github.com/raphink))
+- Add release\_url option [\#259](https://github.com/skywinder/github-changelog-generator/pull/259) ([raphink](https://github.com/raphink))
+- Add --since-tag [\#257](https://github.com/skywinder/github-changelog-generator/pull/257) ([raphink](https://github.com/raphink))
+
+## [1.7.0](https://github.com/skywinder/github-changelog-generator/tree/1.7.0) (2015-07-16)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.2...1.7.0)
+
+**Implemented enhancements:**
+
+- Custom header [\#251](https://github.com/skywinder/github-changelog-generator/issues/251)
+- Arbitrary templates [\#242](https://github.com/skywinder/github-changelog-generator/issues/242)
+
+## [1.6.2](https://github.com/skywinder/github-changelog-generator/tree/1.6.2) (2015-07-16)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.1...1.6.2)
+
+**Fixed bugs:**
+
+- --unreleased-only broken [\#250](https://github.com/skywinder/github-changelog-generator/issues/250)
+
+## [1.6.1](https://github.com/skywinder/github-changelog-generator/tree/1.6.1) (2015-06-12)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.6.0...1.6.1)
+
+**Implemented enhancements:**
+
+- Ability to specify custom section header [\#241](https://github.com/skywinder/github-changelog-generator/issues/241)
+
+**Fixed bugs:**
+
+- not encapsulated character `\<` [\#249](https://github.com/skywinder/github-changelog-generator/issues/249)
+
+## [1.6.0](https://github.com/skywinder/github-changelog-generator/tree/1.6.0) (2015-06-11)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.5.0...1.6.0)
+
+**Implemented enhancements:**
+
+- Issues with any label  except "bug", "enhancement" should not be excluded by default. [\#240](https://github.com/skywinder/github-changelog-generator/issues/240)
+- Add ability to specify custom labels for enhancements & bugfixes [\#54](https://github.com/skywinder/github-changelog-generator/issues/54)
+
+**Fixed bugs:**
+
+- --user and --project options are broken [\#246](https://github.com/skywinder/github-changelog-generator/issues/246)
+- Exclude and Include tags is broken [\#245](https://github.com/skywinder/github-changelog-generator/issues/245)
+
+## [1.5.0](https://github.com/skywinder/github-changelog-generator/tree/1.5.0) (2015-05-26)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.1...1.5.0)
+
+**Implemented enhancements:**
+
+- Show `Unreleased` section even when there is no tags in repo. [\#228](https://github.com/skywinder/github-changelog-generator/issues/228)
+- Add option `--exclude-tags x,y,z` [\#214](https://github.com/skywinder/github-changelog-generator/issues/214)
+- Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
+- Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53)
+
+**Merged pull requests:**
+
+- Big refactoring [\#243](https://github.com/skywinder/github-changelog-generator/pull/243) ([skywinder](https://github.com/skywinder))
+
+## [1.4.1](https://github.com/skywinder/github-changelog-generator/tree/1.4.1) (2015-05-19)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.4.0...1.4.1)
+
+**Implemented enhancements:**
+
+- Trees/Archives with missing change log notes for the current tag. [\#230](https://github.com/skywinder/github-changelog-generator/issues/230)
+
+**Fixed bugs:**
+
+- github\_changelog\_generator.rb:220:in ``': No such file or directory - pwd \(Errno::ENOENT\) [\#237](https://github.com/skywinder/github-changelog-generator/issues/237)
+- Doesnot generator changelog [\#235](https://github.com/skywinder/github-changelog-generator/issues/235)
+- Exclude closed \(not merged\) PR's from changelog. [\#69](https://github.com/skywinder/github-changelog-generator/issues/69)
+
+**Merged pull requests:**
+
+- Wrap GitHub requests in function check\_github\_response [\#238](https://github.com/skywinder/github-changelog-generator/pull/238) ([skywinder](https://github.com/skywinder))
+- Add fetch token tests [\#236](https://github.com/skywinder/github-changelog-generator/pull/236) ([skywinder](https://github.com/skywinder))
+- Add future release option [\#231](https://github.com/skywinder/github-changelog-generator/pull/231) ([sildur](https://github.com/sildur))
+
+## [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.3.11...1.4.0)
+
+**Implemented enhancements:**
+
+- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
+- Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
+- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
+
+**Closed issues:**
+
+- Add CodeClimate and Inch CI [\#219](https://github.com/skywinder/github-changelog-generator/issues/219)
+
+**Merged pull requests:**
+
+- 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))
+- Rspec & rubocop integration [\#217](https://github.com/skywinder/github-changelog-generator/pull/217) ([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))
+- Add --max-issues argument to limit requests [\#76](https://github.com/skywinder/github-changelog-generator/pull/76) ([sneal](https://github.com/sneal))
+
+## [1.3.11](https://github.com/skywinder/github-changelog-generator/tree/1.3.11) (2015-03-21)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.10...1.3.11)
+
+**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))
+
+## [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:**
+
+- 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)
+
+**Fixed bugs:**
+
+- 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)
+
+## [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:**
+
+- 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)
+
+**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))
+
+## [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)
+- support enterprise github via command line options [\#42](https://github.com/skywinder/github-changelog-generator/pull/42) ([glenlovett](https://github.com/glenlovett))
+
+**Fixed bugs:**
+
+- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/github-changelog-generator/issues/32)
+- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/github-changelog-generator/pull/43) ([schwing](https://github.com/schwing))
+
+## [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)
+- Implement support of different tags. [\#8](https://github.com/skywinder/github-changelog-generator/pull/8) ([skywinder](https://github.com/skywinder))
+
+**Fixed bugs:**
+
+- Last tag not appeared in changelog [\#5](https://github.com/skywinder/github-changelog-generator/issues/5)
+
+**Merged pull requests:**
+
+- 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 file was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

Gemfile

@@ -1,3 +1,12 @@
-source 'https://rubygems.org'
-gem 'github_api'
-gem 'httparty'
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "rspec", "~>3.2"
+  gem "rubocop", "~>0.31"
+  gem "coveralls", "~>0.8", require: false
+  gem "simplecov", "~>0.10", require: false
+  gem "codeclimate-test-reporter", "~>0.4"
+  gem "overcommit", "~>0.31"
+end

Gemfile.lock

@@ -1,43 +1,107 @@
+PATH
+  remote: .
+  specs:
+    github_changelog_generator (1.10.2)
+      colorize (~> 0.7)
+      github_api (~> 0.12)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.6)
+    addressable (2.4.0)
+    ast (2.2.0)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    colorize (0.7.7)
+    coveralls (0.8.11)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    faraday (0.9.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    github_api (0.12.2)
-      addressable (~> 2.3)
+    ffi (1.9.10)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
-      hashie (>= 3.3)
+      hashie (>= 3.4)
       multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.3)
       oauth2
-    hashie (3.3.1)
-    httparty (0.13.2)
-      json (~> 1.8)
-      multi_xml (>= 0.5.2)
-    json (1.8.1)
-    jwt (1.0.0)
-    mini_portile (0.6.1)
-    multi_json (1.10.1)
+    hashie (3.4.3)
+    iniparse (1.4.2)
+    json (1.8.3)
+    jwt (1.5.1)
+    multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.4)
-      mini_portile (~> 0.6.0)
-    oauth2 (1.0.0)
+    oauth2 (1.1.0)
       faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
+      jwt (~> 1.0, < 1.5.2)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.5.2)
-    thread_safe (0.3.4)
+      rack (>= 1.2, < 3)
+    overcommit (0.32.0)
+      childprocess (~> 0.5.8)
+      iniparse (~> 1.4)
+    parser (2.3.0.6)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.37.2)
+      parser (>= 2.3.0.4, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
+    ruby-progressbar (1.7.5)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.6.0)
+    unicode-display_width (0.3.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  github_api
-  httparty
+  bundler (~> 1.7)
+  codeclimate-test-reporter (~> 0.4)
+  coveralls (~> 0.8)
+  github_changelog_generator!
+  overcommit (~> 0.31)
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  rubocop (~> 0.31)
+  simplecov (~> 0.10)
+
+BUNDLED WITH
+   1.11.2

README.md

@@ -1,68 +1,233 @@
-GitHub Changelog Generator
+[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
+[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
+[![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 Logo](../master/images/logo.jpg)
 ==================
 
-[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
+  - [Installation](#installation)
+  - [Output example](#output-example)
+  - [Usage](#usage)
+    - [Params](#params)
+    - [GitHub token](#github-token)
+  - [Features and advantages of this project](#features-and-advantages-of-this-project)
+    - [Alternatives](#alternatives)
+    - [Projects using this library](#projects-using-this-library)
+  - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
+  - [Contributing](#contributing)
+  - [License](#license)
 
-Changelog generation has never been so easy.
 
-This script automatically generate change-log from your tags and merged pull-requests.
+### Changelog generation has never been so easy
+
+**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
+
+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.
+
+> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com)*
+
+## Installation
 
-## Installation:
 	[sudo] gem install github_changelog_generator
 
-## Usage
+## Output example
 
-	github_changelog_generator -u github-username -p github-project
-
-In output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelogs in your current directory.
-
-### Params:
-See `github_changelog_generator --help` for detailed usage.
-
-    Usage: changelog_generator --user username --project project_name [options]
-        -u, --user [USER]                Username of the owner of target GitHub repo (required)
-        -p, --project [PROJECT]          Name of project on GitHub (required)
-        -t, --token [TOKEN]              To make more than 50 requests this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
-        -h, --help                       Displays Help
-        -v, --[no-]verbose               Run verbosely
-            --[no-]issues                Include closed issues to changelog. Default is true
-            --[no-]pull-requests         Include pull-requests to changelog. Default is true
-        -l, --last-changes               Generate log between last 2 tags only
-        -f, --date-format [FORMAT]       Date format. Default is %d/%m/%y
-        -o, --output [NAME]              Output file. Default is CHANGELOG.md
-            --labels  x,y,z              List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'a
-
-## Examples:
-Look at changelog in this project!
-
-### This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)
-
-Was generated by command:
+- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
+- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
 
 		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
 
+- In general, it looks like this:
 
-## FAQ:
-Since GitHub allow to make only 50 requests without authentication it's recommended to run this scrip with key `-t [your-16-digit-token]` that you can easily **[generate it here](https://github.com/settings/applications)**.
+> ## [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))
 
-So, if you got error like this:
->! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete': GET https://api.github.com/repos/skywinder/ActionSheetPicker-3.0/git/commits/89678f7d7f66873c858e6cb07bf697192aca6768: 403 API rate limit exceeded for 195.88.177.9. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.) (Github::Error::Forbidden) 
 
-It's time to generate this token or wait for 1 hour before GitHub reset counter for your IP.
+## Usage
+**It's really simple!**
 
-## License
+- If your **`git remote`** `origin` refers to your GitHub repo, just go to your project folder and run:
 
-Github the Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+		github_changelog_generator
+
+-  Or, run this from anywhere:
+    - `github_changelog_generator -u github_username -p github_project`
+    - `github_changelog_generator  github_username/github_project`
+
+This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.
+
+### Params
+Type `github_changelog_generator --help` for details.
+
+For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
+
+### Params File
+In your project root, you can put a params file named `.github_changelog_generator` to override default params:
+
+Example:
+```
+unreleased=false
+future-release=5.0.0
+since-tag=1.0.0
+```
+
+### GitHub token
+
+GitHub only allows only 50 unauthenticated requests per hour. 
+Therefore, it's recommended to run this script with authentication by using a **token**.
+
+Here's how:
+
+- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)
+- Either:
+    - Run the script with `--token <your-40-digit-token>`; **OR**
+    - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
+
+You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
+
+        export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
+
+So, if you got an error like this:
+>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
+
+It's time to create this token! (Or, wait an hour for GitHub to reset your unauthenticated request limit.)
+
+## Migrating from a manual changelog
+
+Knowing how dedicated you are to your project, you probably haven't been waiting for `github-changelog-generator` to keep a changelog.
+But you probably don't want your project's open issues and PRs for all past features listed in your historic changelog, either.
+
+That's where `--base <your-manual-changelog.md>` comes in handy!
+This option lets append your old manual changelog to the end of the generated entries.
+
+If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
+
+### Rake task
+
+You love `rake`? We do, too! So, we've made it even easier for you: 
+we've provided a `rake` task library for your changelog generation.
+
+Just put something like this in your `Rakefile`:
+
+```ruby
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.since_tag = '0.1.14'
+  config.future_release = '0.2.0'
+end
+```
+
+All command line options can be passed to the `rake` task as `config` parameters. And since you're naming the `rake` task yourself, you can create as many as you want.
+
+## Features and advantages of this project
+- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
+- Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
+- **GitHub Enterprise support** via command line options! :factory:
+- Flexible format **customization**:
+    - **Customize** issues that **should be added** to changelog :eight_spoked_asterisk:
+    - **Custom date formats** supported (but keep [ISO 8601](http://xkcd.com/1179/) in mind!) :date:
+    - Manually specify the version that fixed an issue (for cases when the issue's Closed date doesn't match) by giving the issue's `milestone` the same name as the tag of version :pushpin:
+    - Automatically **exclude specific issues** that are irrelevant to your changelog (by default, any issue labeled `question`, `duplicate`, `invalid`, or `wontfix`) :scissors:
+- **Distinguish** issues **by labels**. :mag_right:
+    - Merged pull requests (all merged pull-requests) :twisted_rightwards_arrows:
+    - Bug fixes (issues labeled `bug`) :beetle:
+    - Enhancements (issues labeled `enhancement`) :star2:
+    - Issues (closed issues with no labels) :non-potable_water:
+
+- Manually include or exclude issues by labels :wrench:
+- Customize lots more! Tweak the changelog to fit your preferences :tophat:
+(*See `github_changelog_generator --help`  for details)*
+
+
+###Alternatives
+Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
+
+*If you know other projects, feel free to edit this Wiki page!*
+
+
+### Projects using this library
+Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).
+
+If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
+
+*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).*
+
+## Am I missing some essential feature?
+
+- **Nothing is impossible!**
+
+- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make the generator better together!
+
+- *Bug reports, feature requests, patches, and well-wishes are always welcome.* :heavy_exclamation_mark:
+
+## FAQ
+
+- ***I already use GitHub Releases. Why do I need this?***
+
+GitHub Releases is a very good thing. And it's very good practice to maintain it. (Not a lot of people are using it yet!) :congratulations:
+
+*BTW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
+
+I'm not trying to compare the quality of handwritten and auto-generated logs. That said....
+
+An auto-generated changelog really helps, even if you manually fill in the release notes!
+
+For example:
+
+When I found a closed bug, it's very useful know which release fixed it. 
+In this case, you can easily find the issue by \# in `CHANGELOG.md`.
+
+- it's not quite as easy to find this in handwritten releases notes
+- a generated file saves you the trouble of remembering everything;
+  sometimes people forget to add things to a handwritten file
+
+Ultimately, I think GitHub Releases is ideal for end-users. 
+Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
+Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
+
+- ***I received a warning: "GitHub API rate limit exceed"  What does this mean?***
+
+GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
+
+If you're seeing this warning, please do the following:
+
+1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
+2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
 
 ## Contributing
 
-1. Create an issue to discuss about your idea
+1. Create an issue and describe your idea
 2. [Fork it] (https://github.com/skywinder/Github-Changelog-Generator/fork)
 3. Create your feature branch (`git checkout -b my-new-feature`)
 4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
+5. Publish the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
+7. Profit! :white_check_mark:
 
-**Bug reports, feature requests, patches, well-wishes, and rap demo tapes are always welcome!**
+*To test your workflow with changelog generator, you can use [test repo](https://github.com/skywinder/changelog_test/)*
 
-*Improvements more than welcome - they are kindly requested! :)*
+## License
+
+Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

Rakefile

@@ -0,0 +1,23 @@
+require "bundler"
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+require "pathname"
+require "fileutils"
+require "overcommit"
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:rspec)
+
+task :create_man do |_t|
+  os_prefix = "/usr/local"
+  man_prefix = Pathname("#{os_prefix}/share/man/man1")
+  man_pages = "man/git-*"
+
+  Pathname.glob(man_pages) do |path|
+    FileUtils.cp(path, man_prefix + path.basename)
+  end
+end
+
+task checks: [:rubocop, :rspec]
+task default: [:checks, :create_man]

bin/git-generate-changelog

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

bin/github_changelog_generator

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

bump_gemfile.rb

@@ -1,228 +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? Click 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?\nClick 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,33 @@
-Gem::Specification.new do |s|
-  s.name               = "github_changelog_generator"
-  s.version            = "1.0.1"
-  s.default_executable = "github_changelog_generator"
+# coding: utf-8
 
-  s.required_ruby_version     = '>= 1.9.3'
-  s.authors = ["Petr Korolev"]
-  s.date = %q{2014-10-10}
-  s.description = %q{Script, that automatically generate change-log from your tags and pull-requests}
-  s.email = %q{sky4winder+github_changelog_generator@gmail.com}
-  s.files = ["lib/github_changelog_generator.rb", "lib/github_changelog_generator/parser.rb", "bin/github_changelog_generator"]
-  s.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Script, that automatically generate change-log from your tags and pull-requests.}
-  s.license       = "MIT"
-  s.add_runtime_dependency(%q<httparty>, ["~> 0.13"])
-  s.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "github_changelog_generator/version"
 
-  s.executables   = %w(github_changelog_generator)
+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.authors = ["Petr Korolev"]
+  spec.email = "sky4winder+github_changelog_generator@gmail.com"
+  spec.date = `date +"%Y-%m-%d"`.strip!
+  spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
+  spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
+  spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
+  spec.license = "MIT"
+  spec.extensions = ["Rakefile"]
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("github_api", ["~> 0.12"])
+  spec.add_runtime_dependency("colorize", ["~> 0.7"])
+
+  # Development only
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
 end

lib/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Change Log
+
+## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
+
+[Full Changelog](https://github.com/skywinder/changelog_test/compare/0.0.4...HEAD)
+
+**Implemented enhancements:**
+
+- Enchancment [\#9](https://github.com/skywinder/changelog_test/issues/9)
+- PR with enhancement label [\#16](https://github.com/skywinder/changelog_test/pull/16) ([skywinder](https://github.com/skywinder))
+
+**Fixed bugs:**
+
+- BugFix [\#11](https://github.com/skywinder/changelog_test/issues/11)
+
+**Closed issues:**
+
+- Issue closed from commit from PR [\#14](https://github.com/skywinder/changelog_test/issues/14)
+- Issue, closed by PR [\#12](https://github.com/skywinder/changelog_test/issues/12)
+- Issue [\#10](https://github.com/skywinder/changelog_test/issues/10)
+- Issue with some other label - Should be in closed issues [\#8](https://github.com/skywinder/changelog_test/issues/8)
+
+**Merged pull requests:**
+
+- Merged br \(should appear in change log also\) [\#21](https://github.com/skywinder/changelog_test/pull/21) ([skywinder](https://github.com/skywinder))
+- This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
+- This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
+- This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))
+
+## [0.0.4](https://github.com/skywinder/changelog_test/tree/0.0.4) (2015-05-22)
+[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...0.0.4)
+
+**Closed issues:**
+
+- Test issue, that should appear in 0.0.4 [\#3](https://github.com/skywinder/changelog_test/issues/3)
+
+**Merged pull requests:**
+
+- Add automatically generated change log file. [\#5](https://github.com/skywinder/changelog_test/pull/5) ([skywinder](https://github.com/skywinder))
+
+## [v0.0.3](https://github.com/skywinder/changelog_test/tree/v0.0.3) (2015-03-04)
+[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.2...v0.0.3)
+
+**Merged pull requests:**
+
+- fix \#3. hotfix. Should appear in v0.0.3 [\#4](https://github.com/skywinder/changelog_test/pull/4) ([skywinder](https://github.com/skywinder))
+
+## [v0.0.2](https://github.com/skywinder/changelog_test/tree/v0.0.2) (2015-03-04)
+[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.1...v0.0.2)
+
+**Merged pull requests:**
+
+- Here is a test hotfix should appear in v.0.0.2 [\#2](https://github.com/skywinder/changelog_test/pull/2) ([skywinder](https://github.com/skywinder))
+
+## [v0.0.1](https://github.com/skywinder/changelog_test/tree/v0.0.1) (2015-03-02)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

lib/github_changelog_generator.rb

@@ -1,301 +1,41 @@
 #!/usr/bin/env ruby
 
-require 'github_api'
-require 'json'
-require 'httparty'
-require_relative 'github_changelog_generator/parser'
+require "github_api"
+require "json"
+require "colorize"
+require "benchmark"
 
+require_relative "github_changelog_generator/helper"
+require_relative "github_changelog_generator/parser"
+require_relative "github_changelog_generator/parser_file"
+require_relative "github_changelog_generator/generator/generator"
+require_relative "github_changelog_generator/version"
+require_relative "github_changelog_generator/reader"
 
+# The main module, where placed all classes (now, at least)
+module GitHubChangelogGenerator
+  # Main class and entry point for this script.
   class ChangelogGenerator
-
-  attr_accessor :options, :all_tags, :github
-
-  def initialize()
-
+    # Class, responsible for whole change log generation cycle
+    # @return initialised instance of ChangelogGenerator
+    def initialize
       @options = Parser.parse_options
-    if @options[:token]
-      @github = Github.new oauth_token: @options[:token]
-    else
-      @github = Github.new
-    end
-    @all_tags = self.get_all_tags
-    @pull_requests = self.get_all_closed_pull_requests
-    @issues = self.get_all_issues
-
-    @tag_times_hash = {}
+      @generator = Generator.new @options
     end
 
-  def print_json(json)
-    puts JSON.pretty_generate(json)
-  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 run
+      log = @generator.compound_changelog
 
-  def exec_command(cmd)
-    exec_cmd = "cd #{$project_path} && #{cmd}"
-    %x[#{exec_cmd}]
-  end
-
-
-  def get_all_closed_pull_requests
-    request = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
-    pull_requests = request.body
-
-    if @options[:verbose]
-      puts 'Receive all pull requests'
-    end
-
-    pull_requests
-  end
-
-  def compund_changelog
-    if @options[:verbose]
-      puts 'Generating changelog:'
-    end
-
-    log = "# Changelog\n\n"
-
-    if @options[:last]
-      log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
-    elsif @options[:tag1] && @options[:tag2]
-
-      tag1 = @options[:tag1]
-      tag2 = @options[:tag2]
-      tags_strings = []
-      self.all_tags.each { |x| tags_strings.push(x['name'])}
-
-      if tags_strings.include?(tag1)
-        if tags_strings.include?(tag2)
-          hash = Hash[tags_strings.map.with_index.to_a]
-          index1 = hash[tag1]
-          index2 = hash[tag2]
-          log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
-        else
-          puts "Can't find tag #{tag2} -> exit"
-          exit
-        end
-      else
-        puts "Can't find tag #{tag1} -> exit"
-        exit
-      end
-    else
-      log += self.generate_log_for_all_tags
-    end
-
-
-    if @options[:verbose]
-      puts log
-    end
-
-    log += "\n\n* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
-
-    output_filename = "#{@options[:output]}"
-    File.open(output_filename, 'w') { |file| file.write(log) }
-
-    puts "Done! Generated log placed in #{output_filename}"
-
-  end
-
-  def generate_log_for_all_tags
-    log = ''
-    for index in 1 ... self.all_tags.size
-      log += self.generate_log_between_tags(self.all_tags[index-1], self.all_tags[index])
-    end
-
-    log += self.generate_log_before_tag(self.all_tags.last)
-
-    log
-  end
-
-  def is_megred(number)
-    @github.pull_requests.merged? @options[:user], @options[:project], number
-  end
-
-  def get_all_tags
-
-    url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags"
-
-    if @options[:verbose]
-      puts "Receive tags for repo #{url}"
-    end
-
-    response = HTTParty.get(url,
-                            :headers => {'Authorization' => "token #{@options[:token]}",
-                                        'User-Agent' => 'Changelog-Generator'})
-
-    json_parse = JSON.parse(response.body)
-
-    if @options[:verbose]
-      puts "Found #{json_parse.count} tags"
-    end
-
-    json_parse
-  end
-
-  def generate_log_between_tags(since_tag, till_tag)
-    since_tag_time = self.get_time_of_tag(since_tag)
-    till_tag_time = self.get_time_of_tag(till_tag)
-
-    # if we mix up tags order - lits fix it!
-    if since_tag_time > till_tag_time
-      since_tag, till_tag = till_tag, since_tag
-      since_tag_time, till_tag_time = till_tag_time, since_tag_time
-    end
-
-    till_tag_name = till_tag['name']
-
-    pull_requests = Array.new(@pull_requests)
-
-    pull_requests.delete_if { |req|
-      if req[:merged_at]
-        t = Time.parse(req[:merged_at]).utc
-        tag_is_later_since = t > since_tag_time
-        tag_is_before_till = t <= till_tag_time
-
-        in_range = (tag_is_later_since) && (tag_is_before_till)
-        !in_range
-      else
-        true
-      end
-
-    }
-
-    issues = Array.new(@issues)
-
-    issues.delete_if{ |issue|
-      if issue[:closed_at]
-        t = Time.parse(issue[:closed_at]).utc
-        tag_is_later_since = t > since_tag_time
-        tag_is_before_till = t <= till_tag_time
-
-        in_range = (tag_is_later_since) && (tag_is_before_till)
-        !in_range
-      else
-        true
-      end
-
-    }
-
-    self.create_log(pull_requests, issues, till_tag_name, till_tag_time)
-
-  end
-
-  def generate_log_before_tag(tag)
-    tag_time = self.get_time_of_tag(tag)
-    tag_name = tag['name']
-
-    pull_requests = Array.new(@pull_requests)
-
-    pull_requests.delete_if { |req|
-      if req[:merged_at]
-        t = Time.parse(req[:merged_at]).utc
-        t > tag_time
-      else
-        true
-      end
-
-    }
-
-    issues = Array.new(@issues)
-
-    issues.delete_if{ |issue|
-      if issue[:closed_at]
-        t = Time.parse(issue[:closed_at]).utc
-        t > tag_time
-      else
-        true
-      end
-    }
-
-    self.create_log(pull_requests, issues, tag_name, tag_time)
-
-  end
-
-  def create_log(pull_requests, issues, tag_name, tag_time)
-
-    # Generate tag name and link
-    trimmed_tag = tag_name.tr('v', '')
-    log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
-
-    #Generate date string:
-    time_string = tag_time.strftime @options[:format]
-    log += "#### #{time_string}\n"
-
-    if @options[:pulls]
-      # Generate pull requests:
-      if pull_requests
-        pull_requests.each { |dict|
-          merge = "#{dict[:title]} [\\##{dict[:number]}](https://github.com/#{@options[:user]}/#{@options[:project]}/pull/#{dict[:number]})\n\n"
-          log += "- #{merge}"
-        }
+      output_filename = (@options[:output]).to_s
+      File.open(output_filename, "w") { |file| file.write(log) }
+      puts "Done!"
+      puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
     end
   end
 
-    if @options[:issues]
-      # Generate issues:
-      if issues
-        issues.each { |dict|
-          is_bug = false
-          is_enhancement  = false
-          dict.labels.each { |label|
-            if label.name == 'bug'
-              is_bug = true
+  if __FILE__ == $PROGRAM_NAME
+    GitHubChangelogGenerator::ChangelogGenerator.new.run
   end
-            if label.name == 'enhancement'
-              is_enhancement  = true
-            end
-          }
-
-          intro = 'Closed issue'
-          if is_bug
-            intro =  'Fixed bug'
-          end
-
-          if is_enhancement
-            intro = 'Implemented enhancement'
-          end
-
-          merge = "*#{intro}:* #{dict[:title]} [\\##{dict[:number]}](https://github.com/#{@options[:user]}/#{@options[:project]}/issues/#{dict[:number]})\n\n"
-          log += "- #{merge}"
-        }
-      end
-
-    end
-
-    log
-  end
-
-  def get_time_of_tag(prev_tag)
-
-    if @tag_times_hash[prev_tag['name']]
-      return @tag_times_hash[prev_tag['name']]
-    end
-
-    if @options[:verbose]
-      puts "Get time for tag #{prev_tag['name']}"
-    end
-
-    github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
-    time_string = github_git_data_commits_get['committer']['date']
-    Time.parse(time_string)
-    @tag_times_hash[prev_tag['name']] = Time.parse(time_string)
-  end
-
-  def get_all_issues
-    all_issues = []
-    @options[:labels].each { |label|
-      issues = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: label
-      all_issues = all_issues.concat(issues.body)
-    }
-    if @options[:verbose]
-      puts "Receive all closed issues with labels #{@options[:labels]}: #{all_issues.count} issues"
-    end
-
-    all_issues
-
-  end
-
-end
-
-if __FILE__ == $0
-  changelog_generator = ChangelogGenerator.new
-  changelog_generator.compund_changelog
 end

lib/github_changelog_generator/fetcher.rb

@@ -0,0 +1,221 @@
+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 || {}
+      @user = @options[:user]
+      @project = @options[:project]
+      @github_token = fetch_github_token
+      @github_options = { per_page: PER_PAGE_NUMBER }
+      @github_options[:oauth_token] = @github_token unless @github_token.nil?
+      @github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
+      @github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
+
+      @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)
+
+      Helper.log.warn NO_TOKEN_PROVIDED.yellow unless env_var
+
+      env_var
+    end
+
+    # Fetch all tags from repo
+    # @return [Array] array of tags
+    def get_all_tags
+      print "Fetching tags...\r" if @options[:verbose]
+
+      check_github_response { github_fetch_tags }
+    end
+
+    # This is wrapper with rescue block
+    # @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block
+    def check_github_response
+      begin
+        value = yield
+      rescue Github::Error::Unauthorized => e
+        Helper.log.error e.body.red
+        abort "Error: wrong GitHub token"
+      rescue Github::Error::Forbidden => e
+        Helper.log.warn e.body.red
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+      value
+    end
+
+    # Fill input array with tags
+    # @return [Array] array of tags in repo
+    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
+        Helper.log.warn "Warning: Can't find any tags in repo.\
+Make sure, that you push tags to remote repo via 'git push --tags'".yellow
+      else
+        Helper.log.info "Found #{tags.count} tags"
+      end
+      tags
+    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
+      print "Fetching closed issues...\r" if @options[:verbose]
+      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
+        Helper.log.info "Received issues: #{issues.count}"
+
+      rescue
+        Helper.log.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 = if @options[:release_branch].nil?
+                     @github.pull_requests.list @options[:user],
+                                                @options[:project],
+                                                state: "closed"
+                   else
+                     @github.pull_requests.list @options[:user],
+                                                @options[:project],
+                                                state: "closed",
+                                                base: @options[:release_branch]
+                   end
+        page_i = 0
+        count_pages = response.count_pages
+        response.each_page do |page|
+          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
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+
+      Helper.log.info "Fetching merged dates: #{pull_requests.count}"
+      pull_requests
+    end
+
+    # Print specified line on the same string
+    # @param [String] log_string
+    def print_in_same_line(log_string)
+      print log_string + "\r"
+    end
+
+    # Print long line with spaces on same line to clear prev message
+    def print_empty_line
+      print_in_same_line("                                                                       ")
+    end
+
+    # 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
+              response = @github.issues.events.list user: @options[:user],
+                                                    repo: @options[:project],
+                                                    issue_number: issue["number"]
+              issue[:events] = []
+              response.each_page do |page|
+                issue[:events].concat(page)
+              end
+            rescue
+              Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+            end
+            print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
+            i += 1
+          end
+        end
+        threads.each(&:join)
+        threads = []
+      end
+
+      # to clear line from prev print
+      print_empty_line
+
+      Helper.log.info "Fetching events for issues and PR: #{i}"
+    end
+
+    # Fetch tag time from repo
+    #
+    # @param [Hash] tag
+    # @return [Time] time of specified tag
+    def fetch_date_of_tag(tag)
+      begin
+        commit_data = @github.git_data.commits.get @options[:user],
+                                                   @options[:project],
+                                                   tag["commit"]["sha"]
+      rescue
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+      time_string = commit_data["committer"]["date"]
+      Time.parse(time_string)
+    end
+
+    # Fetch commit for specified 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/generator.rb

@@ -0,0 +1,143 @@
+require_relative "../fetcher"
+require_relative "generator_generation"
+require_relative "generator_fetcher"
+require_relative "generator_processor"
+require_relative "generator_tags"
+
+module GitHubChangelogGenerator
+  # Default error for ChangelogGenerator
+  class ChangelogGeneratorError < StandardError
+  end
+
+  class Generator
+    attr_accessor :options, :filtered_tags, :github
+
+    # A Generator responsible for all logic, related with change log generation from ready-to-parse issues
+    #
+    # Example:
+    #   generator = GitHubChangelogGenerator::Generator.new
+    #   content = generator.compound_changelog
+    def initialize(options = nil)
+      @options = options || {}
+      @tag_times_hash = {}
+      @fetcher = GitHubChangelogGenerator::Fetcher.new @options
+    end
+
+    def fetch_issues_and_pr
+      issues, pull_requests = @fetcher.fetch_closed_issues_and_pr
+
+      @pull_requests = @options[:pulls] ? get_filtered_pull_requests(pull_requests) : []
+
+      @issues = @options[:issues] ? get_filtered_issues(issues) : []
+
+      fetch_events_for_issues_and_pr
+      detect_actual_closed_dates(@issues + @pull_requests)
+    end
+
+    # Encapsulate characters to make markdown look as expected.
+    #
+    # @param [String] string
+    # @return [String] encapsulated input string
+    def encapsulate_string(string)
+      string.gsub! '\\', '\\\\'
+
+      encpas_chars = %w(< > * _ \( \) [ ] #)
+      encpas_chars.each do |char|
+        string.gsub! char, "\\#{char}"
+      end
+
+      string
+    end
+
+    # Generates log for section with header and body
+    #
+    # @param [Array] pull_requests List or PR's in new section
+    # @param [Array] issues List of issues in new section
+    # @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
+    # @param [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_for_tag(pull_requests, issues, newer_tag, older_tag_name = nil)
+      newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
+
+      github_site = options[:github_site] || "https://github.com"
+      project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
+
+      log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
+
+      if @options[:issues]
+        # Generate issues:
+        log += issues_to_log(issues, pull_requests)
+      end
+
+      if @options[:pulls]
+        # Generate pull requests:
+        log += generate_sub_section(pull_requests, @options[:merge_prefix])
+      end
+
+      log
+    end
+
+    # Generate ready-to-paste log from list of issues and pull requests.
+    #
+    # @param [Array] issues
+    # @param [Array] pull_requests
+    # @return [String] generated log for issues
+    def issues_to_log(issues, pull_requests)
+      log = ""
+      bugs_a, enhancement_a, issues_a = parse_by_sections(issues, pull_requests)
+
+      log += generate_sub_section(enhancement_a, @options[:enhancement_prefix])
+      log += generate_sub_section(bugs_a, @options[:bug_prefix])
+      log += generate_sub_section(issues_a, @options[:issue_prefix])
+      log
+    end
+
+    # This method sort issues by types
+    # (bugs, features, or just closed issues) by labels
+    #
+    # @param [Array] issues
+    # @param [Array] pull_requests
+    # @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
+    def parse_by_sections(issues, pull_requests)
+      issues_a = []
+      enhancement_a = []
+      bugs_a = []
+
+      issues.each do |dict|
+        added = false
+        dict.labels.each do |label|
+          if @options[:bug_labels].include? label.name
+            bugs_a.push dict
+            added = true
+            next
+          end
+          if @options[:enhancement_labels].include? label.name
+            enhancement_a.push dict
+            added = true
+            next
+          end
+        end
+        issues_a.push dict unless added
+      end
+
+      added_pull_requests = []
+      pull_requests.each do |dict|
+        dict.labels.each do |label|
+          if @options[:bug_labels].include? label.name
+            bugs_a.push dict
+            added_pull_requests.push dict
+            next
+          end
+          if @options[:enhancement_labels].include? label.name
+            enhancement_a.push dict
+            added_pull_requests.push dict
+            next
+          end
+        end
+      end
+      added_pull_requests.each { |p| pull_requests.delete(p) }
+
+      [bugs_a, enhancement_a, issues_a]
+    end
+  end
+end

lib/github_changelog_generator/generator/generator_fetcher.rb

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

lib/github_changelog_generator/generator/generator_generation.rb

@@ -0,0 +1,184 @@
+module GitHubChangelogGenerator
+  class Generator
+    # Main function to start change log generation
+    #
+    # @return [String] Generated change log file
+    def compound_changelog
+      fetch_and_filter_tags
+      sort_tags_by_date(@filtered_tags)
+      fetch_issues_and_pr
+
+      log = ""
+      log += @options[:frontmatter] if @options[:frontmatter]
+      log += "#{@options[:header]}\n\n"
+
+      log += if @options[:unreleased_only]
+               generate_log_between_tags(filtered_tags[0], nil)
+             else
+               generate_log_for_all_tags
+             end
+
+      log += File.read(@options[:base]) if File.file?(@options[:base])
+
+      log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
+      @log = log
+    end
+
+    # @return [String] temp method should be removed soon
+    def generate_for_2_tags(log)
+      tag1 = @options[:tag1]
+      tag2 = @options[:tag2]
+      tags_strings = []
+      filtered_tags.each { |x| tags_strings.push(x["name"]) }
+
+      if tags_strings.include?(tag1)
+        if tags_strings.include?(tag2)
+          to_a = tags_strings.map.with_index.to_a
+          hash = Hash[to_a]
+          index1 = hash[tag1]
+          index2 = hash[tag2]
+          log += generate_log_between_tags(all_tags[index1], all_tags[index2])
+        else
+          raise ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
+        end
+      else
+        raise ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
+      end
+      log
+    end
+
+    # @param [Array] issues List of issues on sub-section
+    # @param [String] prefix Nae of sub-section
+    # @return [String] Generate ready-to-go sub-section
+    def generate_sub_section(issues, prefix)
+      log = ""
+
+      if issues.any?
+        log += "#{prefix}\n\n" unless options[:simple_list]
+        issues.each do |issue|
+          merge_string = get_string_for_issue(issue)
+          log += "- #{merge_string}\n"
+        end
+        log += "\n"
+      end
+      log
+    end
+
+    # It generate one header for section with specific parameters.
+    #
+    # @param [String] newer_tag_name - name of newer tag
+    # @param [String] newer_tag_link - used for links. Could be same as #newer_tag_name or some specific value, like HEAD
+    # @param [Time] newer_tag_time - time, when newer tag created
+    # @param [String] older_tag_link - tag name, used for links.
+    # @param [String] project_url - url for current project.
+    # @return [String] - Generate one ready-to-add section.
+    def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_link, project_url)
+      log = ""
+
+      # Generate date string:
+      time_string = newer_tag_time.strftime @options[:date_format]
+
+      # Generate tag name and link
+      release_url = if @options[:release_url]
+                      format(@options[:release_url], newer_tag_link)
+                    else
+                      "#{project_url}/tree/#{newer_tag_link}"
+                    end
+      log += if newer_tag_name.equal? @options[:unreleased_label]
+               "## [#{newer_tag_name}](#{release_url})\n\n"
+             else
+               "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
+             end
+
+      if @options[:compare_link] && older_tag_link
+        # Generate compare link
+        log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
+      end
+
+      log
+    end
+
+    # Generate log only between 2 specified tags
+    # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
+    # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
+    def generate_log_between_tags(older_tag, newer_tag)
+      filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
+
+      older_tag_name = older_tag.nil? ? detect_since_tag : older_tag["name"]
+
+      if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
+        # do not generate empty unreleased section
+        return ""
+      end
+
+      create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
+    end
+
+    # Apply all filters to issues and pull requests
+    #
+    # @return [Array] filtered issues and pull requests
+    def filter_issues_for_tags(newer_tag, older_tag)
+      filtered_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
+      filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
+
+      newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
+
+      if @options[:filter_issues_by_milestone]
+        # delete excess irrelevant issues (according milestones). Issue #22.
+        filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
+        filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
+      end
+      [filtered_issues, filtered_pull_requests]
+    end
+
+    # The full cycle of generation for whole project
+    # @return [String] The complete change log
+    def generate_log_for_all_tags
+      puts "Generating log..." if @options[:verbose]
+
+      log = generate_unreleased_section
+
+      (1...filtered_tags.size).each do |index|
+        log += generate_log_between_tags(filtered_tags[index], filtered_tags[index - 1])
+      end
+      if @filtered_tags.count != 0
+        log += generate_log_between_tags(nil, filtered_tags.last)
+      end
+
+      log
+    end
+
+    def generate_unreleased_section
+      log = ""
+      if @options[:unreleased]
+        unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
+        log += unreleased_log if unreleased_log
+      end
+      log
+    end
+
+    # Parse issue and generate single line formatted issue line.
+    #
+    # Example output:
+    # - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](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 = encapsulate_string issue[:title]
+
+      title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
+
+      unless issue.pull_request.nil?
+        if @options[:author]
+          title_with_number += if issue.user.nil?
+                                 " ({Null user})"
+                               else
+                                 " ([#{issue.user.login}](#{issue.user.html_url}))"
+                               end
+        end
+      end
+      title_with_number
+    end
+  end
+end

lib/github_changelog_generator/generator/generator_processor.rb

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

lib/github_changelog_generator/generator/generator_tags.rb

@@ -0,0 +1,175 @@
+module GitHubChangelogGenerator
+  class Generator
+    # fetch, filter tags, fetch dates and sort them in time order
+    def fetch_and_filter_tags
+      @filtered_tags = get_filtered_tags(@fetcher.get_all_tags)
+      fetch_tags_dates
+    end
+
+    # Sort all tags by date
+    def sort_tags_by_date(tags)
+      puts "Sorting tags..." if @options[:verbose]
+      tags.sort_by! do |x|
+        get_time_of_tag(x)
+      end.reverse!
+    end
+
+    # Try to find tag date in local hash.
+    # Otherwise fFetch tag time and put it to local hash file.
+    # @param [Hash] tag_name name of the tag
+    # @return [Time] time of specified tag
+    def get_time_of_tag(tag_name)
+      raise ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
+
+      name_of_tag = tag_name["name"]
+      time_for_name = @tag_times_hash[name_of_tag]
+      if !time_for_name.nil?
+        time_for_name
+      else
+        time_string = @fetcher.fetch_date_of_tag tag_name
+        @tag_times_hash[name_of_tag] = time_string
+        time_string
+      end
+    end
+
+    # Detect link, name and time for specified tag.
+    #
+    # @param [Hash] newer_tag newer tag. Can be nil, if it's Unreleased section.
+    # @return [Array] link, name and time of the tag
+    def detect_link_tag_time(newer_tag)
+      # if tag is nil - set current time
+      newer_tag_time = newer_tag.nil? ? Time.new : get_time_of_tag(newer_tag)
+
+      # if it's future release tag - set this value
+      if newer_tag.nil? && @options[:future_release]
+        newer_tag_name = @options[:future_release]
+        newer_tag_link = @options[:future_release]
+      else
+        # put unreleased label if there is no name for the tag
+        newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
+        newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
+      end
+      [newer_tag_link, newer_tag_name, newer_tag_time]
+    end
+
+    # @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
+    def detect_since_tag
+      @since_tag ||= @options[:since_tag]
+      if @since_tag.nil? && @options[:base] && File.file?(@options[:base])
+        reader = GitHubChangelogGenerator::Reader.new
+        content = reader.read(@options[:base])
+        @since_tag = content[0]["version"] if content.count && content
+      end
+      @since_tag
+    end
+
+    # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
+    #
+    # @return [Array]
+    def get_filtered_tags(all_tags)
+      filtered_tags = filter_since_tag(all_tags)
+      filtered_tags = filter_between_tags(filtered_tags)
+      filter_excluded_tags(filtered_tags)
+    end
+
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :since_tag option
+    def filter_since_tag(all_tags)
+      filtered_tags = all_tags
+      tag = detect_since_tag
+      if tag
+        if all_tags.map(&:name).include? tag
+          idx = all_tags.index { |t| t.name == tag }
+          filtered_tags = if idx > 0
+                            all_tags[0..idx - 1]
+                          else
+                            []
+                          end
+        else
+          Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
+        end
+      end
+      filtered_tags
+    end
+
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :due_tag option
+    def filter_due_tag(all_tags)
+      filtered_tags = all_tags
+      tag = @options[:due_tag]
+      if tag
+        if (all_tags.count > 0) && (all_tags.map(&:name).include? tag)
+          idx = all_tags.index { |t| t.name == tag }
+          last_index = all_tags.count - 1
+          filtered_tags = if idx > 0 && idx < last_index
+                            all_tags[idx + 1..last_index]
+                          else
+                            []
+                          end
+        else
+          Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
+        end
+      end
+      filtered_tags
+    end
+
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :between_tags option
+    def filter_between_tags(all_tags)
+      filtered_tags = all_tags
+      if @options[:between_tags]
+        @options[:between_tags].each do |tag|
+          unless all_tags.map(&:name).include? tag
+            Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option."
+          end
+        end
+        filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag.name }
+      end
+      filtered_tags
+    end
+
+    # @param [Array] all_tags all tags
+    # @return [Array] filtered tags according :exclude_tags option
+    def filter_excluded_tags(all_tags)
+      return all_tags unless @options[:exclude_tags]
+
+      apply_exclude_tags(all_tags)
+    end
+
+    private
+
+    def apply_exclude_tags(all_tags)
+      if @options[:exclude_tags].is_a?(Regexp)
+        filter_tags_with_regex(all_tags)
+      else
+        filter_exact_tags(all_tags)
+      end
+    end
+
+    def filter_tags_with_regex(all_tags)
+      warn_if_nonmatching_regex(all_tags)
+      all_tags.reject { |tag| @options[:exclude_tags] =~ tag.name }
+    end
+
+    def filter_exact_tags(all_tags)
+      @options[:exclude_tags].each do |tag|
+        warn_if_tag_not_found(all_tags, tag)
+      end
+      all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
+    end
+
+    def warn_if_nonmatching_regex(all_tags)
+      unless all_tags.map(&:name).any? { |t| @options[:exclude_tags] =~ t }
+        Helper.log.warn "Warning: unable to reject any tag, using regex "\
+                        "#{@options[:exclude_tags].inspect} in --exclude-tags "\
+                        "option."
+      end
+    end
+
+    def warn_if_tag_not_found(all_tags, tag)
+      unless all_tags.map(&:name).include? tag
+        Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
+      end
+    end
+  end
+end

lib/github_changelog_generator/helper.rb

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

lib/github_changelog_generator/parser.rb

@@ -1,67 +1,282 @@
 #!/usr/bin/env ruby
-require 'optparse'
-
+require "optparse"
+require "pp"
+require_relative "version"
+require_relative "helper"
+module GitHubChangelogGenerator
   class Parser
+    # parse options with optparse
     def self.parse_options
-    options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true  }
+      options = default_options
 
-    parser = OptionParser.new { |opts|
-      opts.banner = 'Usage: changelog_generator --user username --project project_name [options]'
-      opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo (required)') do |last|
-        options[:user] = last
-      end
-      opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub (required)') do |last|
-        options[:project] = last
-      end
-      opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications') do |last|
-        options[:token] = last
-      end
-      opts.on('-h', '--help', 'Displays Help') do
-        puts opts
-        exit
-      end
-      opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
-        options[:verbose] = v
-      end
-      opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
-        options[:issues] = v
-      end
-      opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
-        options[:pulls] = v
-      end
-      opts.on('-l', '--last-changes', 'Generate log between last 2 tags only') do |last|
-        options[:last] = last
-      end
-      opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
-        options[:format] = last
-      end
-      opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
-        options[:output] = last
-      end
-      opts.on('--labels  x,y,z', Array, 'List of labels. Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
-        options[:labels] = list
-      end
-    }
+      ParserFile.new(options).parse!
 
+      parser = setup_parser(options)
       parser.parse!
 
-    #udefined case with 1 parameter:
-    if ARGV[0] && !ARGV[1]
-      puts parser.banner
-      exit
-    end
+      user_and_project_from_git(options)
 
-    if !options[:user] || !options[:project]
-      puts parser.banner
-      exit
-    end
+      abort(parser.banner) unless options[:user] && options[:project]
 
-    if ARGV[1]
-      options[:tag1] = ARGV[0]
-      options[:tag2] = ARGV[1]
-
-    end
+      print_options(options)
 
       options
     end
+
+    # @param [Hash] options to display
+    def self.print_options(options)
+      if options[:verbose]
+        Helper.log.info "Performing task with options:"
+        options_to_display = options.clone
+        options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
+        pp options_to_display
+        puts ""
+      end
+    end
+
+    # setup parsing options
+    def self.setup_parser(options)
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: github_changelog_generator [options]"
+        opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
+          options[:user] = last
+        end
+        opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last|
+          options[:project] = last
+        end
+        opts.on("-t", "--token [TOKEN]", "To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last|
+          options[:token] = last
+        end
+        opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
+          options[:date_format] = last
+        end
+        opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
+          options[:output] = last
+        end
+        opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
+          options[:base] = last
+        end
+        opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**""") do |v|
+          options[:bug_prefix] = v
+        end
+        opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
+          options[:enhancement_prefix] = v
+        end
+        opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
+          options[:issue_prefix] = v
+        end
+        opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
+          options[:header] = v
+        end
+        opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
+          options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
+        end
+        opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
+          options[:merge_prefix] = v
+        end
+        opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
+          options[:issues] = v
+        end
+        opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true") do |v|
+          options[:add_issues_wo_labels] = v
+        end
+        opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true") do |v|
+          options[:add_pr_wo_labels] = v
+        end
+        opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true") do |v|
+          options[:pulls] = v
+        end
+        opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true") do |last|
+          options[:filter_issues_by_milestone] = last
+        end
+        opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
+          options[:author] = author
+        end
+        opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
+          options[:unreleased_only] = v
+        end
+        opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
+          options[:unreleased] = v
+        end
+        opts.on("--unreleased-label [label]", "Add to log unreleased closed issues. Default is true") do |v|
+          options[:unreleased_label] = v
+        end
+        opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
+          options[:compare_link] = v
+        end
+        opts.on("--include-labels  x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
+          options[:include_labels] = list
+        end
+        opts.on("--exclude-labels  x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
+          options[:exclude_labels] = list
+        end
+        opts.on("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
+          options[:bug_labels] = list
+        end
+        opts.on("--enhancement-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
+          options[:enhancement_labels] = list
+        end
+        opts.on("--between-tags  x,y,z", Array, "Change log will be filled only between specified tags") do |list|
+          options[:between_tags] = list
+        end
+        opts.on("--exclude-tags  x,y,z", Array, "Change log will exclude specified tags") do |list|
+          options[:exclude_tags] = list
+        end
+        opts.on("--since-tag  x", "Change log will start after specified tag") do |v|
+          options[:since_tag] = v
+        end
+        opts.on("--due-tag  x", "Change log will end before specified tag") do |v|
+          options[:due_tag] = v
+        end
+        opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
+          options[:max_issues] = max
+        end
+        opts.on("--release-url [URL]", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
+          options[:release_url] = url
+        end
+        opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
+          options[:github_site] = last
+        end
+        opts.on("--github-api [URL]", "The enterprise endpoint to use for your Github API.") do |last|
+          options[:github_endpoint] = last
+        end
+        opts.on("--simple-list", "Create simple list from issues and pull requests. Default is false.") do |v|
+          options[:simple_list] = v
+        end
+        opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
+          options[:future_release] = future_release
+        end
+        opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
+          options[:release_branch] = release_branch
+        end
+        opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
+          options[:verbose] = v
+        end
+        opts.on("-v", "--version", "Print version number") do |_v|
+          puts "Version: #{GitHubChangelogGenerator::VERSION}"
+          exit
+        end
+        opts.on("-h", "--help", "Displays Help") do
+          puts opts
+          exit
+        end
+      end
+      parser
+    end
+
+    # just get default options
+    def self.default_options
+      {
+        tag1: nil,
+        tag2: nil,
+        date_format: "%Y-%m-%d",
+        output: "CHANGELOG.md",
+        base: "HISTORY.md",
+        issues: true,
+        add_issues_wo_labels: true,
+        add_pr_wo_labels: true,
+        pulls: true,
+        filter_issues_by_milestone: true,
+        author: true,
+        unreleased: true,
+        unreleased_label: "Unreleased",
+        compare_link: true,
+        enhancement_labels: %w(enhancement Enhancement),
+        bug_labels: %w(bug Bug),
+        exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix),
+        max_issues: nil,
+        simple_list: false,
+        verbose: true,
+        header: "# Change Log",
+        merge_prefix: "**Merged pull requests:**",
+        issue_prefix: "**Closed issues:**",
+        bug_prefix: "**Fixed bugs:**",
+        enhancement_prefix: "**Implemented enhancements:**",
+        git_remote: "origin"
+      }
+    end
+
+    def self.user_and_project_from_git(options)
+      if options[:user].nil? || options[:project].nil?
+        detect_user_and_project(options, ARGV[0], ARGV[1])
+      end
+    end
+
+    # Detects user and project from git
+    def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
+      options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
+      return if options[:user] && options[:project]
+
+      if ENV["RUBYLIB"] =~ /ruby-debug-ide/
+        options[:user] = "skywinder"
+        options[:project] = "changelog_test"
+      else
+        remote = `git config --get remote.#{options[:git_remote]}.url`
+        options[:user], options[:project] = user_project_from_remote(remote)
+      end
+    end
+
+    # Try to find user and project name from git remote output
+    #
+    # @param [String] output of git remote command
+    # @return [Array] user and project
+    def self.user_project_from_option(arg0, arg1, github_site)
+      user = nil
+      project = nil
+      github_site ||= "github.com"
+      if arg0 && !arg1
+        # this match should parse  strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
+        puts arg0
+        match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(arg0)
+
+        begin
+          param = match[2].nil?
+        rescue
+          puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
+          return
+        end
+        if param
+          return
+        else
+          user = match[1]
+          project = match[2]
+        end
+      end
+      [user, project]
+    end
+
+    # Try to find user and project name from git remote output
+    #
+    # @param [String] output of git remote command
+    # @return [Array] user and project
+    def self.user_project_from_remote(remote)
+      # try to find repo in format:
+      # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
+      # git@github.com:skywinder/Github-Changelog-Generator.git
+      regex1 = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/
+
+      # try to find repo in format:
+      # origin	https://github.com/skywinder/ChangelogMerger (fetch)
+      # https://github.com/skywinder/ChangelogMerger
+      regex2 = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/
+
+      remote_structures = [regex1, regex2]
+
+      user = nil
+      project = nil
+      remote_structures.each do |regex|
+        matches = Regexp.new(regex).match(remote)
+
+        if matches && matches[1] && matches[2]
+          puts "Detected user:#{matches[1]}, project:#{matches[2]}"
+          user = matches[1]
+          project = matches[2]
+        end
+
+        break unless matches.nil?
+      end
+
+      [user, project]
+    end
+  end
 end

lib/github_changelog_generator/parser_file.rb

@@ -0,0 +1,39 @@
+module GitHubChangelogGenerator
+  ParserError = Class.new(StandardError)
+
+  class ParserFile
+    def initialize(options)
+      @options = options
+    end
+
+    def parse!
+      return unless File.exist?(file)
+
+      File.readlines(file).each { |line| parse_line!(line) }
+    end
+
+    private
+
+    def file
+      @file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
+    end
+
+    def parse_line!(line)
+      key_sym, value = extract_pair(line)
+      value = true if value =~ /^(true|t|yes|y|1)$/i
+      value = false if value =~ /^(false|f|no|n|0)$/i
+      @options[key_sym] = value
+    rescue
+      raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
+    end
+
+    # Returns a the setting as a symbol and its string value sans newlines.
+    #
+    # @param line [String] unparsed line from config file
+    # @return [Array<Symbol, String>]
+    def extract_pair(line)
+      key, value = line.split("=", 2)
+      [key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
+    end
+  end
+end

lib/github_changelog_generator/reader.rb

@@ -0,0 +1,84 @@
+#
+# 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)
+        if matches
+          captures.merge!(Hash[matches.names.zip(matches.captures)])
+          break
+        end
+      end
+
+      captures
+    end
+
+    # Parse the given ChangeLog data into a list of Hashes
+    #
+    # @param [String] data File data from the ChangeLog.md
+    # @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
+    def parse(data)
+      sections = data.split(/^## .+?$/)
+      headings = data.scan(/^## .+?$/)
+
+      headings.each_with_index.map do |heading, index|
+        section = parse_heading(heading)
+        section["content"] = sections.at(index + 1)
+        section
+      end
+    end
+
+    def read(file_path)
+      parse File.read(file_path)
+    end
+  end
+end

lib/github_changelog_generator/task.rb

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

lib/github_changelog_generator/version.rb

@@ -0,0 +1,3 @@
+module GitHubChangelogGenerator
+  VERSION = "1.10.3"
+end

man/git-generate-changelog.1

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

man/git-generate-changelog.html

@@ -0,0 +1,262 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>git-generate-changelog(1) - Generate changelog from github</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#AUTHOR">AUTHOR</a>
+    <a href="#REPORTING-BUGS">REPORTING BUGS</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>git-generate-changelog(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>git-generate-changelog(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>git generate-changelog</code> [-h|--help] [-u|--user] [-p|--project]</p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>  -u, --user [USER]</p>
+
+<p>  Username of the owner of target GitHub repo</p>
+
+<p>  -p, --project [PROJECT]</p>
+
+<p>  Name of project on GitHub</p>
+
+<p>  -t, --token [TOKEN]</p>
+
+<p>  To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
+
+<p>  -f, --date-format [FORMAT]</p>
+
+<p>  Date format. Default is %Y-%m-%d</p>
+
+<p>  -o, --output [NAME]</p>
+
+<p>  Output file. Default is CHANGELOG.md</p>
+
+<p>  -b, --base [NAME]</p>
+
+<p>  Optional base file to append generated changes to.</p>
+
+<p>   --bugs-label [LABEL]</p>
+
+<p>   Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
+
+<p>   --enhancement-label [LABEL]</p>
+
+<p>   Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
+
+<p>   --issues-label [LABEL]</p>
+
+<p>   Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
+
+<p>   --header-label [LABEL]</p>
+
+<p>   Setup custom header label. Default is "# Change Log"</p>
+
+<p>   --pr-label [LABEL]</p>
+
+<p>   Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
+
+<p>   --[no-]issues</p>
+
+<p>   Include closed issues in changelog. Default is true</p>
+
+<p>   --[no-]issues-wo-labels</p>
+
+<p>   Include closed issues without labels in changelog. Default is true</p>
+
+<p>   --[no-]pr-wo-labels</p>
+
+<p>   Include pull requests without labels in changelog. Default is true</p>
+
+<p>   --[no-]pull-requests</p>
+
+<p>   Include pull-requests in changelog. Default is true</p>
+
+<p>   --[no-]filter-by-milestone</p>
+
+<p>   Use milestone to detect when issue was resolved. Default is true</p>
+
+<p>   --[no-]author</p>
+
+<p>   Add author of pull-request in the end. Default is true</p>
+
+<p>   --unreleased-only</p>
+
+<p>   Generate log from unreleased closed issues only.</p>
+
+<p>   --[no-]unreleased</p>
+
+<p>   Add to log unreleased closed issues. Default is true</p>
+
+<p>   --unreleased-label [label]</p>
+
+<p>   Add to log unreleased closed issues. Default is true</p>
+
+<p>   --[no-]compare-link</p>
+
+<p>   Include compare link (Full Changelog) between older version and newer version. Default is true</p>
+
+<p>   --include-labels x,y,z</p>
+
+<p>   Only issues with the specified labels will be included in the changelog.</p>
+
+<p>   --exclude-labels x,y,z</p>
+
+<p>   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
+
+<p>   --bug-labels x,y,z</p>
+
+<p>   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
+
+<p>   --enhancement-labels x,y,z</p>
+
+<p>   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
+
+<p>   --between-tags x,y,z</p>
+
+<p>   Change log will be filled only between specified tags</p>
+
+<p>   --exclude-tags x,y,z</p>
+
+<p>   Change log will exclude specified tags</p>
+
+<p>   --since-tag x</p>
+
+<p>   Change log will start after specified tag</p>
+
+<p>   --due-tag x</p>
+
+<p>   Change log will end before specified tag</p>
+
+<p>   --max-issues [NUMBER]</p>
+
+<p>   Max number of issues to fetch from GitHub. Default is unlimited</p>
+
+<p>   --release-url [URL]</p>
+
+<p>   The URL to point to for release links, in printf format (with the tag as variable).</p>
+
+<p>   --github-site [URL]</p>
+
+<p>   The Enterprise Github site on which your project is hosted.</p>
+
+<p>   --github-api [URL]</p>
+
+<p>   The enterprise endpoint to use for your Github API.</p>
+
+<p>   --simple-list</p>
+
+<p>   Create simple list from issues and pull requests. Default is false.</p>
+
+<p>   --future-release [RELEASE-VERSION]</p>
+
+<p>   Put the unreleased changes in the specified release number.</p>
+
+<p>   --[no-]verbose</p>
+
+<p>   Run verbosely. Default is true</p>
+
+<p>  -v, --version</p>
+
+<p>  Print version number</p>
+
+<p>  -h, --help</p>
+
+<p>  Displays Help</p>
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<h2 id="AUTHOR">AUTHOR</h2>
+
+<p>Written by Petr Korolev sky4winder@gmail.com</p>
+
+<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
+
+<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>&gt;</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>&gt;</p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>October 2015</li>
+    <li class='tr'>git-generate-changelog(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

man/git-generate-changelog.md

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

spec/files/github-changelog-generator.md

@@ -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/files/github_changelog_params_incorrect

@@ -0,0 +1,2 @@
+unreleased_label: staging
+unreleased: false

spec/files/github_changelog_params_override

@@ -0,0 +1,3 @@
+unreleased_label=staging
+unreleased=false
+header==== Changelog ===

spec/spec_helper.rb

@@ -0,0 +1,55 @@
+#
+# 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"
+
+# This module is only used to check the environment is currently a testing env
+module SpecHelper
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  Coveralls::SimpleCov::Formatter,
+  SimpleCov::Formatter::HTMLFormatter,
+  CodeClimate::TestReporter::Formatter
+]
+SimpleCov.start
+
+require "github_changelog_generator"
+require "github_changelog_generator/task"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.warnings = true
+
+  config.default_formatter = "doc" if config.files_to_run.one?
+
+  config.order = :random
+
+  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/generator/generator_tags_spec.rb

@@ -0,0 +1,231 @@
+def tag_mash_with_name(tag)
+  mash_tag = Hashie::Mash.new
+  mash_tag.name = tag
+  mash_tag
+end
+
+def tags_mash_from_strings(tags_strings)
+  mash_array = []
+  tags_strings.each do |tag|
+    mash_tag = tag_mash_with_name(tag)
+    mash_array << mash_tag
+  end
+  mash_array
+end
+
+describe GitHubChangelogGenerator::Generator do
+  describe "#filter_between_tags" do
+    context "when between_tags nil" do
+      before do
+        @generator = GitHubChangelogGenerator::Generator.new(between_tags: nil)
+      end
+
+      subject do
+        @generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
+      end
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+    end
+    context "when between_tags same as input array" do
+      before do
+        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3))
+      end
+      subject do
+        @generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
+      end
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+    end
+
+    context "when between_tags filled with correct values" do
+      before do
+        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
+      end
+      subject do
+        @generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
+      end
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
+    end
+
+    context "when between_tags filled with invalid values" do
+      before do
+        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 q w))
+      end
+
+      subject do
+        @generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
+      end
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
+    end
+  end
+
+  describe "#get_filtered_tags" do
+    subject do
+      generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3 4 5)))
+    end
+
+    context "with excluded and between tags" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3), exclude_tags: %w(2)) }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1 3))) }
+    end
+  end
+
+  describe "#filter_excluded_tags" do
+    subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
+
+    context "with valid excluded tags" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
+    end
+
+    context "with invalid excluded tags" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+    end
+
+    context "with regex exclude_tags" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
+    end
+
+    context "with non-matching regex in exclude_tags" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+    end
+  end
+
+  describe "#filter_since_tag" do
+    context "with filled array" do
+      subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
+
+      context "with valid since tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
+      end
+
+      context "with invalid since tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+      end
+    end
+
+    context "with empty array" do
+      subject { generator.filter_since_tag(tags_mash_from_strings(%w())) }
+
+      context "with valid since tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
+      end
+
+      context "with invalid since tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
+      end
+    end
+  end
+
+  describe "#filter_due_tag" do
+    context "with filled array" do
+      subject { generator.filter_due_tag(tags_mash_from_strings(%w(1 2 3))) }
+
+      context "with valid due tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w(3))) }
+      end
+
+      context "with invalid due tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+      end
+    end
+
+    context "with empty array" do
+      subject { generator.filter_due_tag(tags_mash_from_strings(%w())) }
+
+      context "with valid due tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
+      end
+
+      context "with invalid due tag" do
+        let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
+        it { is_expected.to be_a Array }
+        it { is_expected.to match_array(tags_mash_from_strings(%w())) }
+      end
+    end
+  end
+
+  describe "#get_time_of_tag" do
+    current_time = Time.now
+    before(:all) { @generator = GitHubChangelogGenerator::Generator.new }
+    context "run with nil parameter" do
+      it "should raise ChangelogGeneratorError" do
+        expect { @generator.get_time_of_tag nil }.to raise_error(GitHubChangelogGenerator::ChangelogGeneratorError)
+      end
+    end
+    context "fetch already filled tag" do
+      before { @generator.instance_variable_set :@tag_times_hash, "valid_tag" => current_time }
+      subject { @generator.get_time_of_tag tag_mash_with_name("valid_tag") }
+      it { is_expected.to be_a_kind_of(Time) }
+      it { is_expected.to eq(current_time) }
+    end
+    context "fetch not filled tag" do
+      before do
+        mock = double("fake fetcher")
+        allow(mock).to receive_messages(fetch_date_of_tag: current_time)
+        @generator.instance_variable_set :@fetcher, mock
+      end
+      subject do
+        of_tag = @generator.get_time_of_tag tag_mash_with_name("valid_tag")
+        of_tag
+      end
+      it { is_expected.to be_a_kind_of(Time) }
+      it { is_expected.to eq(current_time) }
+    end
+  end
+
+  describe "#sort_tags_by_date" do
+    time1 = Time.now
+    time2 = Time.now
+    time3 = Time.now
+    before(:all) do
+      @generator = GitHubChangelogGenerator::Generator.new
+    end
+    context "sort unsorted tags" do
+      tags = tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3)
+      before do
+        @generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
+      end
+      subject do
+        @generator.sort_tags_by_date tags
+      end
+      it { is_expected.to be_a_kind_of(Array) }
+      it { is_expected.to match_array(tags.reverse!) }
+    end
+    context "sort sorted tags" do
+      tags = tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1)
+      before do
+        @generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
+      end
+      subject do
+        @generator.sort_tags_by_date tags
+      end
+      it { is_expected.to be_a_kind_of(Array) }
+      it { is_expected.to match_array(tags) }
+    end
+  end
+end

spec/unit/parse_file_spec.rb

@@ -0,0 +1,41 @@
+describe GitHubChangelogGenerator::ParserFile do
+  describe ".github_changelog_generator" do
+    context "when no has file" do
+      let(:options) { {} }
+      let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
+      subject { parse.parse! }
+      it { is_expected.to be_nil }
+    end
+
+    context "when file is empty" do
+      let(:options) { { params_file: "spec/files/github_changelog_params_empty" } }
+      let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
+
+      it "does not change the options" do
+        expect { parse.parse! }.to_not change { options }
+      end
+    end
+
+    context "when file is incorrect" do
+      let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
+      let(:options_before_change) { options.dup }
+      let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
+      it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) }
+    end
+
+    context "when override default values" do
+      let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
+      let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
+      let(:options_before_change) { options.dup }
+      let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
+
+      it "changes the options" do
+        expect { parse.parse! }.to change { options }
+          .from(options_before_change)
+          .to(options_before_change.merge(unreleased_label: "staging",
+                                          unreleased: false,
+                                          header: "=== Changelog ==="))
+      end
+    end
+  end
+end

spec/unit/parser_spec.rb

@@ -0,0 +1,60 @@
+describe GitHubChangelogGenerator::Parser do
+  describe ".user_project_from_remote" do
+    context "when remote is type 1" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin  https://github.com/skywinder/ActionSheetPicker-3.0 (fetch)") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when remote is type 2" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when remote is type 3" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("https://github.com/skywinder/ActionSheetPicker-3.0") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when remote is type 4" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("origin git@github.com:skywinder/ActionSheetPicker-3.0.git (fetch)") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when remote is invalid" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_remote("some invalid text") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array([nil, nil]) }
+    end
+  end
+  describe ".user_project_from_option" do
+    context "when option is invalid" do
+      it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil }
+    end
+
+    context "when option is valid" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when option nil" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array([nil, nil]) }
+    end
+    context "when site is nil" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when site is valid" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, "https://codeclimate.com") }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
+    end
+    context "when second arg is not nil" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", "blah", nil) }
+      it { is_expected.to be_a(Array) }
+      it { is_expected.to match_array([nil, nil]) }
+    end
+  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