Merge branch 'release/1.8.4'

Deleting elements of an array while iterating on it
results in never seeing the last element.

    > a = [1,2,3]
     => [1, 2, 3]
    > a.each do |e|
    >   p a
    >   a.delete(e)
    > end
    [1, 2, 3]
    [2, 3]
     => [2]

.overcommit.yml

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

.rubocop.yml

@@ -6,3 +6,11 @@ Metrics/LineLength:
 #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

.rubocop_todo.yml

@@ -1,81 +1,42 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-04-04 02:29:34 +0300 using RuboCop version 0.29.1.
+# on 2015-07-16 14:46:25 +0300 using RuboCop version 0.31.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 21
+# Offense count: 13
 Metrics/AbcSize:
-  Max: 71
-
-# Offense count: 2
-Metrics/BlockNesting:
-  Max: 4
-
-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 457
-
-# Offense count: 6
-Metrics/CyclomaticComplexity:
-  Max: 15
-
-# Offense count: 28
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 118
-
-# Offense count: 5
-Metrics/PerceivedComplexity:
-  Max: 18
-
-# Offense count: 3
-Style/AccessorMethodName:
   Enabled: false
 
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/AndOr:
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 2
+Style/AccessorMethodName:
   Enabled: false
 
-# Offense count: 27
-# Cop supports --auto-correct.
-Style/Blocks:
-  Enabled: false
-
-# Offense count: 7
-# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
-Style/CaseIndentation:
-  Enabled: false
-
-# Offense count: 4
+# Offense count: 10
 Style/Documentation:
   Enabled: false
 
 # Offense count: 1
-# Configuration parameters: AllowedVariables.
-Style/GlobalVars:
-  Enabled: false
-
-# Offense count: 6
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Enabled: false
 
-# Offense count: 17
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Enabled: false
-
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
 Style/Next:
   Enabled: false
 
-# Offense count: 5
-# Configuration parameters: MaxSlashes.
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
 Style/RegexpLiteral:
   Enabled: false

CHANGELOG.md

@@ -1,14 +1,127 @@
 # Change Log
 
-## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
+## [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)
 
-[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.3.11...HEAD)
+**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)
+
+## [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:**
 
@@ -16,20 +129,14 @@
 
 **Merged pull requests:**
 
-- Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))
-
+- 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:**
@@ -37,39 +144,30 @@
 - 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)
 
-**Merged pull requests:**
+**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)
 
-**Merged pull requests:**
+**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)
 
-**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:**
@@ -77,7 +175,6 @@
 - 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:**
@@ -85,7 +182,6 @@
 - --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:**
@@ -93,7 +189,6 @@
 - 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:**
@@ -101,21 +196,16 @@
 - 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:**
@@ -127,7 +217,6 @@
 - 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:**
@@ -137,19 +226,16 @@
 **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:**
+**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:**
@@ -157,41 +243,32 @@
 - 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)
-
-**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:**
@@ -201,11 +278,9 @@
 **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:**
@@ -217,7 +292,6 @@
 - 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:**
@@ -227,23 +301,18 @@
 **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:**
@@ -255,29 +324,23 @@
 - 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:**
@@ -287,22 +350,19 @@
 **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:**
 
@@ -310,28 +370,21 @@
 
 **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)*

Gemfile

@@ -1,14 +1,11 @@
 source "https://rubygems.org"
 
-gem "rake"
-
-gem "github_api"
-gem "colorize"
+gemspec
 
 group :test do
-  gem "rspec"
-  gem "rubocop"
-  gem "coveralls", require: false
-  gem "simplecov", require: false
-  gem "codeclimate-test-reporter"
+  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"
 end

Gemfile.lock

@@ -1,42 +1,50 @@
+PATH
+  remote: .
+  specs:
+    github_changelog_generator (1.8.1)
+      colorize (~> 0.7)
+      github_api (~> 0.12)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.7)
+    addressable (2.3.8)
     ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
     codeclimate-test-reporter (0.4.7)
       simplecov (>= 0.7.1, < 1.0.0)
-    colorize (0.7.5)
-    coveralls (0.7.12)
-      multi_json (~> 1.10)
+    colorize (0.7.7)
+    coveralls (0.8.2)
+      json (~> 1.8)
       rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.9.1)
+      simplecov (~> 0.10.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    domain_name (0.5.23)
+    domain_name (0.5.24)
       unf (>= 0.0.5, < 1.0.0)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
-    github_api (0.12.3)
+    github_api (0.12.4)
       addressable (~> 2.3)
       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)
+      nokogiri (~> 1.6.6)
       oauth2
-    hashie (3.4.0)
+    hashie (3.4.2)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
-    jwt (1.4.1)
-    mime-types (2.4.3)
+    json (1.8.3)
+    jwt (1.5.1)
+    mime-types (2.6.1)
     mini_portile (0.6.2)
-    multi_json (1.11.0)
+    multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
     netrc (0.10.3)
@@ -48,59 +56,62 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    parser (2.2.0.3)
+    parser (2.2.2.6)
       ast (>= 1.1, < 3.0)
-    powerpack (0.1.0)
-    rack (1.6.0)
+    powerpack (0.1.1)
+    rack (1.6.4)
     rainbow (2.0.0)
     rake (10.4.2)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.2)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    rubocop (0.29.1)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.1)
       astrolabe (~> 1.3)
-      parser (>= 2.2.0.1, < 3.0)
+      parser (>= 2.2.2.5, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
     ruby-progressbar (1.7.5)
-    simplecov (0.9.2)
+    simplecov (0.10.0)
       docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.9.0)
-    simplecov-html (0.9.0)
-    term-ansicolor (1.3.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.3.5)
+    tins (1.5.4)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.6)
+    unf_ext (0.0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  codeclimate-test-reporter
-  colorize
-  coveralls
-  github_api
-  rake
-  rspec
-  rubocop
-  simplecov
+  bundler (~> 1.7)
+  codeclimate-test-reporter (~> 0.4)
+  coveralls (~> 0.8)
+  github_changelog_generator!
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  rubocop (~> 0.31)
+  simplecov (~> 0.10)
+
+BUNDLED WITH
+   1.10.6

README.md

@@ -1,217 +1,218 @@
-[![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)
-==================
-
-  - [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:
-
-**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
-
-Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
-
->### *What’s the point of a change log?*
-To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
-### *Why should I care?*
-Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
-
-> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
-
-## Installation
-
-	[sudo] gem install github_changelog_generator
-
-## Output example
-
-- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
-- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
-
-		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
-
-- In general it looks like this:
-
-> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
-> 
-> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
-> 
-> **Implemented enhancements:**
-> 
-> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
-> 
-> **Fixed bugs:**
-> 
-> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
-> 
-> **Merged pull requests:**
-> 
-> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
-> 
-> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
-
-
-## Usage
-**It's really simple**: 
-
-- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
-
-		github_changelog_generator
-
--  or from anywhere:
-    - `github_changelog_generator -u github_username -p github_project`
-    - `github_changelog_generator  github_username/github_project`
-     
-As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
-
-### Params
-Type `github_changelog_generator --help` for detailed usage.
-
-    Usage: changelog_generator [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 required. You can generate it here: https://github.com/settings/tokens/new
-    -f, --date-format [FORMAT]       Date format. Default is %d/%m/%y
-    -o, --output [NAME]              Output file. Default is CHANGELOG.md
-        --[no-]verbose               Run verbosely. Default is true
-        --[no-]issues                Include closed issues to changelog. Default is true
-        --[no-]issues-wo-labels      Include closed issues without labels to changelog. Default is true
-        --[no-]pr-wo-labels          Include pull requests without labels to changelog. Default is true
-        --[no-]pull-requests         Include pull-requests to changelog. Default is true
-        --[no-]filter-by-milestone   Use milestone to detect when issue was resolved. Default is true
-        --[no-]author                Add author of pull-request in the end. Default is true
-        --unreleased-only            Generate log from unreleased closed issues only.
-        --[no-]unreleased            Add to log unreleased closed issues. Default is true
-        --[no-]compare-link          Include compare link between older version and newer version. Default is true
-        --include-labels  x,y,z      Issues only with that labels will be included to changelog. Default is 'bug,enhancement'
-        --exclude-labels  x,y,z      Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
-        --max-issues [NUMBER]        Max number of issues to fetch from GitHub. Default is unlimited.
-        --github-site [URL]          The Enterprise Github site on which your project is hosted.
-        --github-api [URL]           The enterprise endpoint to use for your Github API.
-    -v, --version                    Print version number
-    -h, --help                       Displays Help
-
-
-### GitHub token
-
-Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
-
-**You can easily [generate it here](https://github.com/settings/tokens)**.
-
-And:
-
-- Run with key `-t [your-16-digit-token]` 
-- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token. 
- 		
-	i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
-
-        export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
-
-So, if you got error like this:
->! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
-
-It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
-
-##Features and advantages of this project
-- Generate canonical, neat change log file, followed by [basic change log guidlines](http://keepachangelog.com/) :gem:
-- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
-- **GitHub Enterprise support** via command line options! :factory:
-- Flexible format **customisation**:
-    - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
-    - **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
-    - Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of  required version :pushpin:
-    - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default)  :scissors:
-- **Distinguish** issues **according labels**. :mag_right:
-    - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
-    - Bug fixes (by label `bug` in issue) :beetle:
-    - Enhancements (by label `enhancement` in issue) :star2:
-    - 	Issues (closed issues `w/o any labels`) :non-potable_water:    
-
-- You can manually set which labels should be included/excluded. :wrench:
-- Apply a lot of other customisations, to fit changelog for your personal style :tophat: 
-(*look `github_changelog_generator --help`  for details)*
-
-
-###Alternatives
-Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
-
-*If you know other projects - feel free to edit this Wiki page!*
-
-
-### Projects using this library
-[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) 
-
+[![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)
+==================
+
+  - [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:
+
+**Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
+
+Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
+
+>### *What’s the point of a change log?*
+To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
+### *Why should I care?*
+Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
+
+> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
+
+## Installation
+
+	[sudo] gem install github_changelog_generator
+
+## Output example
+
+- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
+- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
+
+		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
+
+- In general it looks like this:
+
+> ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
+> 
+> [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
+> 
+> **Implemented enhancements:**
+> 
+> - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
+> 
+> **Fixed bugs:**
+> 
+> - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
+> 
+> **Merged pull requests:**
+> 
+> - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
+> 
+> - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
+
+
+## Usage
+**It's really simple**: 
+
+- If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
+
+		github_changelog_generator
+
+-  or from anywhere:
+    - `github_changelog_generator -u github_username -p github_project`
+    - `github_changelog_generator  github_username/github_project`
+     
+As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
+
+### Params
+Type `github_changelog_generator --help` for details.
+
+More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
+
+### GitHub token
+
+Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
+
+**You can easily [generate it here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)**.
+
+And:
+
+- Run with key `-t [your-40-digit-token]` 
+- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token. 
+ 		
+	i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
+
+        export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
+
+So, if you got error like this:
+>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
+
+It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
+
+## 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 most likely wouln't like to have to open issues and PRs for all past features listed in your historic changelog.
+
+That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
+
+If you have a `HISTORY.md` file in your project, it will automatically be picked as the static historical changelog and appended.
+
+### Rake task
+
+You love Rake? So do we! And so we've made it easier for you by providing a Rake task library for your Change log generation. In your Rakefile, use:
+
+```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. Since you're naming the Rake task yourself, you can create as many as you want, too.
+
+##Features and advantages of this project
+- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com/) :gem:
+- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
+- **GitHub Enterprise support** via command line options! :factory:
+- Flexible format **customisation**:
+    - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk:
+    - **Custom date format** supported (but get in mind [ISO 8601](http://xkcd.com/1179/) ) :date:
+    - Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of  required version :pushpin:
+    - Automatically **exclude specific issues**, not-related to change log (any issue, that has label `question` `duplicate` `invalid` `wontfix`by default)  :scissors:
+- **Distinguish** issues **according labels**. :mag_right:
+    - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
+    - Bug fixes (by label `bug` in issue) :beetle:
+    - Enhancements (by label `enhancement` in issue) :star2:
+    - 	Issues (closed issues `w/o any labels`) :non-potable_water:    
+
+- You can manually set which labels should be included/excluded. :wrench:
+- Apply a lot of other customisations, to fit changelog for your personal style :tophat: 
+(*look `github_changelog_generator --help`  for details)*
+
+
+###Alternatives
+Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
+
+*If you know other projects - feel free to edit this Wiki page!*
+
+
+### Projects using this library
+[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) 
+
 If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
-
-*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
-
-## Am I missing some essential feature?
-
-- **Nothing is impossible!** 
-
-- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! 
-
-- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
-
-## FAQ
-
-- ***I already use GitHub Releases. Why do I need this?***
-
-GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations:
-
-*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
-
-I'm not try to compare quality of auto-generated and manually generated logs.. but:
-
-The auto generated Changelog really helps even if you manually fill Releases notes!
-
-For example:
-
-When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
-
-- it's not so quite easy to find it in manually filled Releases notes.
-- this file can also help you to build your Release note and not miss features in manually-filled list.
-
-In the end:
-
-I think, that GitHub Releases is more for end-users.
-But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
-And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
-
-- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
-
-GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
-
-If you're seeing this warning:
-
-1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
-2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
-
-## Contributing
-
-1. Create an issue to discuss about 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`)
-6. Create a new Pull Request
-7. Profit! :white_check_mark:
-
-## License
-
-Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
+
+## Am I missing some essential feature?
+
+- **Nothing is impossible!** 
+
+- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! 
+
+- *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
+
+## FAQ
+
+- ***I already use GitHub Releases. Why do I need this?***
+
+GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations:
+
+*BDW: I would like to support GitHub Releases in [next releases](https://github.com/skywinder/github-changelog-generator/issues/56) ;)*
+
+I'm not try to compare quality of auto-generated and manually generated logs.. but:
+
+The auto generated Changelog really helps even if you manually fill Releases notes!
+
+For example:
+
+When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by \# in `CHANGELOG.md`.
+
+- it's not so quite easy to find it in manually filled Releases notes.
+- this file can also help you to build your Release note and not miss features in manually-filled list.
+
+In the end:
+
+I think, that GitHub Releases is more for end-users.
+But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
+And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
+
+- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
+
+GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
+
+If you're seeing this warning:
+
+1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
+2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
+
+## Contributing
+
+1. Create an issue to discuss about 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`)
+6. Create a new Pull Request
+7. Profit! :white_check_mark:
+
+*To test change log workflow you can use [test repo](https://github.com/skywinder/changelog_test/)*
+
+## License
+
+Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

bin/github_changelog_generator

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

bump_gemfile.rb

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

github_changelog_generator.gemspec

@@ -23,9 +23,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-
   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

@@ -2,16 +2,42 @@
 
 ## [Unreleased](https://github.com/skywinder/changelog_test/tree/HEAD)
 
-[Full Changelog](https://github.com/skywinder/changelog_test/compare/v0.0.3...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:**
 
-- This PR SHOULD NOT appear in change log! [\#6](https://github.com/skywinder/changelog_test/pull/6) ([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:**
@@ -19,7 +45,6 @@
 - 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:**
@@ -29,5 +54,4 @@
 ## [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

@@ -5,511 +5,36 @@ require "json"
 require "colorize"
 require "benchmark"
 
+require_relative "github_changelog_generator/helper"
 require_relative "github_changelog_generator/parser"
-require_relative "github_changelog_generator/generator"
+require_relative "github_changelog_generator/generator/generator"
 require_relative "github_changelog_generator/version"
 require_relative "github_changelog_generator/reader"
-require_relative "github_changelog_generator/fetcher"
 
+# The main module, where placed all classes (now, at least)
 module GitHubChangelogGenerator
-  # Default error for ChangelogGenerator
-  class ChangelogGeneratorError < StandardError
-  end
-
   # Main class and entry point for this script.
   class ChangelogGenerator
-    attr_accessor :options, :all_tags, :github
-
     # Class, responsible for whole change log generation cycle
     # @return initialised instance of ChangelogGenerator
     def initialize
       @options = Parser.parse_options
-
-      @fetcher = GitHubChangelogGenerator::Fetcher.new @options
-
       @generator = Generator.new @options
-
-      # @all_tags = get_filtered_tags
-      @all_tags = @fetcher.get_all_tags
-
-      @issues, @pull_requests = @fetcher.fetch_issues_and_pull_requests
-
-      @pull_requests = @options[:pulls] ? get_filtered_pull_requests : []
-
-      @issues = @options[:issues] ? get_filtered_issues : []
-
-      fetch_event_for_issues_and_pr
-      detect_actual_closed_dates
-    end
-
-    # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
-    #
-    # @return [Array]
-    def get_filtered_tags
-      all_tags = @fetcher.get_all_tags
-      filtered_tags = []
-      if @options[:between_tags]
-        @options[:between_tags].each do |tag|
-          unless all_tags.include? tag
-            puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow
-          end
-        end
-        filtered_tags = all_tags.select { |tag| @options[:between_tags].include? tag }
-      end
-      filtered_tags
-    end
-
-    def detect_actual_closed_dates
-      if @options[:verbose]
-        print "Fetching closed dates for issues...\r"
-      end
-
-      threads = []
-
-      @issues.each { |issue|
-        threads << Thread.new {
-          find_closed_date_by_commit(issue)
-        }
-      }
-
-      @pull_requests.each { |pull_request|
-        threads << Thread.new {
-          find_closed_date_by_commit(pull_request)
-        }
-      }
-      threads.each(&:join)
-
-      if @options[:verbose]
-        puts "Fetching closed dates for issues: Done!"
-      end
-    end
-
-    # Fill :actual_date parameter of specified issue by closed date of the commit, it it was closed by commit.
-    # @param [Hash] issue
-    def find_closed_date_by_commit(issue)
-      unless issue["events"].nil?
-        # if it's PR -> then find "merged event", in case of usual issue -> fond closed date
-        compare_string = issue[:merged_at].nil? ? "closed" : "merged"
-        # reverse! - to find latest closed event. (event goes in date order)
-        issue["events"].reverse!.each { |event|
-          if event[:event].eql? compare_string
-            if event[:commit_id].nil?
-              issue[:actual_date] = issue[:closed_at]
-            else
-              begin
-                commit = @fetcher.fetch_commit(event)
-                issue[:actual_date] = commit[:author][:date]
-              rescue
-                puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo.".yellow
-                issue[:actual_date] = issue[:closed_at]
-              end
-            end
-            break
-          end
-        }
-      end
-      # TODO: assert issues, that remain without 'actual_date' hash for some reason.
-    end
-
-    def print_json(json)
-      puts JSON.pretty_generate(json)
-    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
-      fetch_merged_at_pull_requests
-
-      filtered_pull_requests = include_issues_by_labels(@pull_requests)
-
-      filtered_pull_requests = exclude_issues_by_labels(filtered_pull_requests)
-
-      if @options[:verbose]
-        puts "Filtered pull requests: #{filtered_pull_requests.count}"
-      end
-
-      filtered_pull_requests
-    end
-
-    # This method fetch missing required attributes for pull requests
-    # :merged_at - is a date, when issue PR was merged.
-    # More correct to use this date, not closed date.
-    def fetch_merged_at_pull_requests
-      if @options[:verbose]
-        print "Fetching merged dates...\r"
-      end
-      pull_requests = @fetcher.fetch_pull_requests
-
-      @pull_requests.each { |pr|
-        fetched_pr = pull_requests.find { |fpr|
-          fpr.number == pr.number
-        }
-        pr[:merged_at] = fetched_pr[:merged_at]
-        pull_requests.delete(fetched_pr)
-      }
-
-      if @options[:verbose]
-        puts "Fetching merged dates: Done!"
-      end
-    end
-
-    # Include issues with labels, specified in :include_labels
-    # @param [Array] issues to filter
-    # @return [Array] filtered array of issues
-    def include_issues_by_labels(issues)
-      filtered_issues = @options[:include_labels].nil? ? issues : issues.select { |issue| (issue.labels.map(&:name) & @options[:include_labels]).any? }
-
-      if @options[:add_issues_wo_labels]
-        issues_wo_labels = issues.select { |issue|
-          !issue.labels.map(&:name).any?
-        }
-        filtered_issues |= issues_wo_labels
-      end
-      filtered_issues
-    end
-
-    # delete all labels with labels from @options[:exclude_labels] array
-    # @param [Array] issues
-    # @return [Array] filtered array
-    def exclude_issues_by_labels(issues)
-      unless @options[:exclude_labels].nil?
-        issues = issues.select { |issue|
-          !(issue.labels.map(&:name) & @options[:exclude_labels]).any?
-        }
-      end
-      issues
     end
 
     # The entry point of this script to generate change log
     # @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
-    def compound_changelog
-      log = "# Change Log\n\n"
-
-      if @options[:unreleased_only]
-        log += generate_log_between_tags(all_tags[0], nil)
-      elsif @options[:tag1] and @options[:tag2]
-        tag1 = @options[:tag1]
-        tag2 = @options[:tag2]
-        tags_strings = []
-        all_tags.each { |x| tags_strings.push(x["name"]) }
-
-        if tags_strings.include?(tag1)
-          if tags_strings.include?(tag2)
-            to_a = tags_strings.map.with_index.to_a
-            hash = Hash[to_a]
-            index1 = hash[tag1]
-            index2 = hash[tag2]
-            log += generate_log_between_tags(all_tags[index1], all_tags[index2])
-          else
-            fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
-          end
-        else
-          fail ChangelogGeneratorError, "Can't find tag #{tag1} -> exit".red
-        end
-      else
-        log += generate_log_for_all_tags
-      end
-
-      log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
+    def run
+      log = @generator.compound_changelog
 
       output_filename = "#{@options[:output]}"
       File.open(output_filename, "w") { |file| file.write(log) }
       puts "Done!"
-      puts "Generated log placed in #{`pwd`.strip!}/#{output_filename}"
-    end
-
-    # The full cycle of generation for whole project
-    # @return [String] The complete change log
-    def generate_log_for_all_tags
-      fetch_tags_dates
-
-      if @options[:verbose]
-        puts "Sorting tags..."
-      end
-
-      @all_tags.sort_by! { |x| @fetcher.get_time_of_tag(x) }.reverse!
-
-      if @options[:verbose]
-        puts "Generating log..."
-      end
-
-      log = ""
-
-      if @options[:unreleased] && @all_tags.count != 0
-        unreleased_log = generate_log_between_tags(all_tags[0], nil)
-        if unreleased_log
-          log += unreleased_log
-        end
-      end
-
-      (1...all_tags.size).each { |index|
-        log += generate_log_between_tags(all_tags[index], all_tags[index - 1])
-      }
-      if @all_tags.count != 0
-        log += generate_log_between_tags(nil, all_tags.last)
-      end
-
-      log
-    end
-
-    # Async fetching of all tags dates
-    def fetch_tags_dates
-      if @options[:verbose]
-        print "Fetching tag dates...\r"
-      end
-
-      # Async fetching tags:
-      threads = []
-      i = 0
-      all = @all_tags.count
-      @all_tags.each { |tag|
-        threads << Thread.new {
-          @fetcher.get_time_of_tag(tag)
-          if @options[:verbose]
-            print "Fetching tags dates: #{i + 1}/#{all}\r"
-            i += 1
-          end
-        }
-      }
-
-      print "                                 \r"
-
-      threads.each(&:join)
-
-      if @options[:verbose]
-        puts "Fetching tags dates: #{i} Done!"
-      end
-    end
-
-    # 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_pull_requests = delete_by_time(@pull_requests, :actual_date, older_tag, newer_tag)
-      filtered_issues = delete_by_time(@issues, :actual_date, older_tag, newer_tag)
-
-      newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
-      older_tag_name = older_tag.nil? ? nil : older_tag["name"]
-
-      if @options[:filter_issues_by_milestone]
-        # delete excess irrelevant issues (according milestones)
-        filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
-        filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
-      end
-
-      if filtered_issues.empty? && filtered_pull_requests.empty? && newer_tag.nil?
-        # do not generate empty unreleased section
-        return ""
-      end
-
-      create_log(filtered_pull_requests, filtered_issues, newer_tag, older_tag_name)
-    end
-
-    def filter_by_milestone(filtered_issues, newer_tag_name, src_array)
-      filtered_issues.select! { |issue|
-        # leave issues without milestones
-        if issue.milestone.nil?
-          true
-        else
-          # check, that this milestone in tag list:
-          @all_tags.find { |tag| tag.name == issue.milestone.title }.nil?
-        end
-      }
-      unless newer_tag_name.nil?
-
-        # add missed issues (according milestones)
-        issues_to_add = src_array.select { |issue|
-          if issue.milestone.nil?
-            false
-          else
-            # check, that this milestone in tag list:
-            milestone_is_tag = @all_tags.find { |tag|
-              tag.name == issue.milestone.title
-            }
-
-            if milestone_is_tag.nil?
-              false
-            else
-              issue.milestone.title == newer_tag_name
-            end
-          end
-        }
-
-        filtered_issues |= issues_to_add
-      end
-      filtered_issues
-    end
-
-    # Method filter issues, that belong only specified tag range
-    # @param [Array] array of issues to filter
-    # @param [Symbol] hash_key key of date value default is :actual_date
-    # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
-    # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
-    # @return [Array] filtered issues
-    def delete_by_time(array, hash_key = :actual_date, older_tag = nil, newer_tag = nil)
-      fail ChangelogGeneratorError, "At least one of the tags should be not nil!".red if older_tag.nil? && newer_tag.nil?
-
-      newer_tag_time = newer_tag && @fetcher.get_time_of_tag(newer_tag)
-      older_tag_time = older_tag && @fetcher.get_time_of_tag(older_tag)
-
-      array.select { |req|
-        if req[hash_key]
-          t = Time.parse(req[hash_key]).utc
-
-          if older_tag_time.nil?
-            tag_in_range_old = true
-          else
-            tag_in_range_old = t > older_tag_time
-          end
-
-          if newer_tag_time.nil?
-            tag_in_range_new = true
-          else
-            tag_in_range_new = t <= newer_tag_time
-          end
-
-          tag_in_range = (tag_in_range_old) && (tag_in_range_new)
-
-          tag_in_range
-        else
-          false
-        end
-      }
-    end
-
-    # 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(pull_requests, issues, newer_tag, older_tag_name = nil)
-      newer_tag_time = newer_tag.nil? ? Time.new : @fetcher.get_time_of_tag(newer_tag)
-      newer_tag_name = newer_tag.nil? ? @options[:unreleased_label] : newer_tag["name"]
-      newer_tag_link = newer_tag.nil? ? "HEAD" : newer_tag_name
-
-      github_site = options[:github_site] || "https://github.com"
-      project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
-
-      log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
-
-      if @options[:issues]
-        # Generate issues:
-        issues_a = []
-        enhancement_a = []
-        bugs_a = []
-
-        issues.each { |dict|
-          added = false
-          dict.labels.each { |label|
-            if label.name == "bug"
-              bugs_a.push dict
-              added = true
-              next
-            end
-            if label.name == "enhancement"
-              enhancement_a.push dict
-              added = true
-              next
-            end
-          }
-          unless added
-            issues_a.push dict
-          end
-        }
-
-        log += generate_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])
-      end
-
-      if @options[:pulls]
-        # Generate pull requests:
-        log += generate_sub_section(pull_requests, @options[:merge_prefix])
-      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 options[:simple_list] != true && issues.any?
-        log += "#{prefix}\n\n"
-      end
-
-      if issues.any?
-        issues.each { |issue|
-          merge_string = @generator.get_string_for_issue(issue)
-          log += "- #{merge_string}\n\n"
-        }
-      end
-      log
-    end
-
-    # 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[:dateformat]
-
-      # Generate tag name and link
-      if newer_tag_name.equal? @options[:unreleased_label]
-        log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link})\n\n"
-      else
-        log += "## [#{newer_tag_name}](#{project_url}/tree/#{newer_tag_link}) (#{time_string})\n\n"
-      end
-
-      if @options[:compare_link] && older_tag_link
-        # Generate compare link
-        log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
-      end
-
-      log
-    end
-
-    # Filter issues according labels
-    # @return [Array] Filtered issues
-    def get_filtered_issues
-      filtered_issues = include_issues_by_labels(@issues)
-
-      filtered_issues = exclude_issues_by_labels(filtered_issues)
-
-      if @options[:verbose]
-        puts "Filtered issues: #{filtered_issues.count}"
-      end
-
-      filtered_issues
-    end
-
-    # Fetch event for issues and pull requests
-    # @return [Array] array of fetched issues
-    def fetch_event_for_issues_and_pr
-      if @options[:verbose]
-        print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
-      end
-
-      # Async fetching events:
-
-      @fetcher.fetch_events_async(@issues + @pull_requests)
+      puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
     end
   end
 
   if __FILE__ == $PROGRAM_NAME
-    GitHubChangelogGenerator::ChangelogGenerator.new.compound_changelog
+    GitHubChangelogGenerator::ChangelogGenerator.new.run
   end
 end

lib/github_changelog_generator/fetcher.rb

@@ -1,38 +1,29 @@
-require "logger"
-
 module GitHubChangelogGenerator
   # A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
   # (such as filtering, validating, e.t.c)
   #
   # Example:
   # fetcher = GitHubChangelogGenerator::Fetcher.new options
+
   class Fetcher
     PER_PAGE_NUMBER = 30
-    GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: GitHub API rate limit (5000 per hour) exceeded, change log may be " \
-        "missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
+    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
-
+      @options = options || {}
       @user = @options[:user]
       @project = @options[:project]
       @github_token = fetch_github_token
-      @tag_times_hash = {}
-
-      @logger = Logger.new(STDOUT)
-      @logger.formatter = proc do |_severity, _datetime, _progname, msg|
-        "#{msg}\n"
-      end
       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_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
+      github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
 
-      begin
-        @github = Github.new github_options
-      rescue
-        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
-      end
+      @github = check_github_response { Github.new github_options }
     end
 
     # Returns GitHub token. First try to use variable, provided by --token option,
@@ -40,12 +31,9 @@ module GitHubChangelogGenerator
     #
     # @return [String]
     def fetch_github_token
-      env_var = @options[:token] ? @options[:token] : (ENV.fetch "CHANGELOG_GITHUB_TOKEN", nil)
+      env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
 
-      unless env_var
-        @logger.warn "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
-        @logger.warn "This script can make only 50 requests to GitHub API per hour without token!".yellow
-      end
+      Helper.log.warn NO_TOKEN_PROVIDED.yellow unless env_var
 
       env_var
     end
@@ -53,44 +41,54 @@ module GitHubChangelogGenerator
     # Fetch all tags from repo
     # @return [Array] array of tags
     def get_all_tags
-      if @options[:verbose]
-        print "Fetching tags...\r"
-      end
+      print "Fetching tags...\r" if @options[:verbose]
 
-      tags = []
+      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
-        response = @github.repos.tags @options[:user], @options[:project]
-        page_i = 0
-        count_pages = response.count_pages
-        response.each_page do |page|
-          page_i += PER_PAGE_NUMBER
-          print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
-          tags.concat(page)
-        end
-        print "                               \r"
-
-        if tags.count == 0
-          @logger.warn "Warning: Can't find any tags in repo.\
-Make sure, that you push tags to remote repo via 'git push --tags'".yellow
-        elsif @options[:verbose]
-          @logger.info "Found #{tags.count} tags"
-        end
-
-      rescue
-        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+        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 and pull requests
-    def fetch_issues_and_pull_requests
-      if @options[:verbose]
-        print "Fetching closed issues...\r"
-      end
+    # @return [Tuple] with (issues, pull-requests)
+    def fetch_closed_issues_and_pr
+      print "Fetching closed issues...\r" if @options[:verbose]
       issues = []
 
       begin
@@ -103,47 +101,57 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
         count_pages = response.count_pages
         response.each_page do |page|
           page_i += PER_PAGE_NUMBER
-          print "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
+          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
-        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
       end
 
-      print "                                                \r"
-
-      if @options[:verbose]
-        @logger.info "Received issues: #{issues.count}"
-      end
-
-      # remove pull request from issues:
-      issues.partition { |x|
+      # 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_pull_requests
+    def fetch_closed_pull_requests
       pull_requests = []
       begin
         response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
         page_i = 0
+        count_pages = response.count_pages
         response.each_page do |page|
           page_i += PER_PAGE_NUMBER
-          count_pages = response.count_pages
-          print "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
+          log_string = "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}"
+          print_in_same_line(log_string)
           pull_requests.concat(page)
         end
+        print_empty_line
       rescue
-        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
       end
 
-      print "                                                   \r"
+      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]
@@ -151,56 +159,51 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
       i = 0
       max_thread_number = 50
       threads = []
-      issues.each_slice(max_thread_number) { |issues_slice|
-        issues_slice.each { |issue|
-          threads << Thread.new {
+      issues.each_slice(max_thread_number) do |issues_slice|
+        issues_slice.each do |issue|
+          threads << Thread.new do
             begin
-              obj = @github.issues.events.list user: @options[:user],
-                                               repo: @options[:project],
-                                               issue_number: issue["number"]
+              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
-              @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+              Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
             end
-            issue[:events] = obj.body
-            print "Fetching events for issues and PR: #{i + 1}/#{issues.count}\r"
+            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 "                                                            \r"
+      print_empty_line
 
-      if @options[:verbose]
-        @logger.info "Fetching events for issues and PR: #{i} Done!"
-      end
+      Helper.log.info "Fetching events for issues and PR: #{i}"
     end
 
-    # Try to find tag date in local hash.
-    # Otherwise fFetch tag time and put it to local hash file.
-    # @param [String] tag_name name of the tag
+    # Fetch tag time from repo
+    #
+    # @param [Hash] tag
     # @return [Time] time of specified tag
-    def get_time_of_tag(tag_name)
-      fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
-
-      if @tag_times_hash[tag_name["name"]]
-        return @tag_times_hash[tag_name["name"]]
-      end
-
+    def fetch_date_of_tag(tag)
       begin
-        github_git_data_commits_get = @github.git_data.commits.get @options[:user],
-                                                                   @options[:project],
-                                                                   tag_name["commit"]["sha"]
+        commit_data = @github.git_data.commits.get @options[:user],
+                                                   @options[:project],
+                                                   tag["commit"]["sha"]
       rescue
-        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
       end
-      time_string = github_git_data_commits_get["committer"]["date"]
-      @tag_times_hash[tag_name["name"]] = Time.parse(time_string)
+      time_string = commit_data["committer"]["date"]
+      Time.parse(time_string)
     end
 
-    # Fetch commit for specifed event
+    # Fetch commit for specified event
     # @return [Hash]
     def fetch_commit(event)
       @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]

lib/github_changelog_generator/generator.rb

@@ -1,42 +0,0 @@
-module GitHubChangelogGenerator
-  class Generator
-    def initialize(options = nil)
-      @options = options
-    end
-
-    # Parse issue and generate single line formatted issue line.
-    #
-    # Example output:
-    # - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
-    #
-    # @param [Hash] issue Fetched issue from GitHub
-    # @return [String] Markdown-formatted single issue
-    def get_string_for_issue(issue)
-      encapsulated_title = encapsulate_string issue[:title]
-
-      title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
-
-      unless issue.pull_request.nil?
-        if @options[:author]
-          if issue.user.nil?
-            title_with_number += " ({Null user})"
-          else
-            title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
-          end
-        end
-      end
-      title_with_number
-    end
-
-    def encapsulate_string(string)
-      string.gsub! '\\', '\\\\'
-
-      encpas_chars = %w(> * _ \( \) [ ] #)
-      encpas_chars.each do |char|
-        string.gsub! char, "\\#{char}"
-      end
-
-      string
-    end
-  end
-end

lib/github_changelog_generator/generator/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,182 @@
+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 = "#{@options[:header]}\n\n"
+
+      if @options[:unreleased_only]
+        log += generate_log_between_tags(filtered_tags[0], nil)
+      else
+        log += 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
+          fail ChangelogGeneratorError, "Can't find tag #{tag2} -> exit".red
+        end
+      else
+        fail 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
+      if @options[:release_url]
+        release_url = format(@options[:release_url], newer_tag_link)
+      else
+        release_url = "#{project_url}/tree/#{newer_tag_link}"
+      end
+      if newer_tag_name.equal? @options[:unreleased_label]
+        log += "## [#{newer_tag_name}](#{release_url})\n\n"
+      else
+        log += "## [#{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]
+          if issue.user.nil?
+            title_with_number += " ({Null user})"
+          else
+            title_with_number += " ([#{issue.user.login}](#{issue.user.html_url}))"
+          end
+        end
+      end
+      title_with_number
+    end
+  end
+end

lib/github_changelog_generator/generator/generator_processor.rb

@@ -0,0 +1,192 @@
+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)
+      if newer_tag_time.nil?
+        tag_in_range_new = true
+      else
+        tag_in_range_new = time <= newer_tag_time
+      end
+      tag_in_range_new
+    end
+
+    def tag_newer_old_tag?(older_tag_time, t)
+      if older_tag_time.nil?
+        tag_in_range_old = true
+      else
+        tag_in_range_old = 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
+        pr[:merged_at] = fetched_pr[:merged_at]
+        closed_pull_requests.delete(fetched_pr)
+      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,146 @@
+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)
+      fail 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
+      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 }
+          if idx > 0
+            filtered_tags = all_tags[0..idx - 1]
+          else
+            filtered_tags = []
+          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
+          if idx > 0 && idx < last_index
+            filtered_tags = all_tags[idx + 1..last_index]
+          else
+            filtered_tags = []
+          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)
+      filtered_tags = all_tags
+      if @options[:exclude_tags]
+        @options[:exclude_tags].each do |tag|
+          unless all_tags.map(&:name).include? tag
+            Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
+          end
+        end
+        filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
+      end
+      filtered_tags
+    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
+
+    if test?
+      @log ||= Logger.new(nil) # don't show any logs when running tests
+    else
+      @log ||= 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

@@ -2,37 +2,44 @@
 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,
-        dateformat: "%Y-%m-%d",
-        output: "CHANGELOG.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,
-        include_labels: %w(bug enhancement),
-        exclude_labels: %w(duplicate question invalid wontfix),
-        max_issues: nil,
-        simple_list: false,
-        verbose: true,
+      options = get_default_options
 
-        merge_prefix: "**Merged pull requests:**",
-        issue_prefix: "**Closed issues:**",
-        bug_prefix: "**Fixed bugs:**",
-        enhancement_prefix: "**Implemented enhancements:**",
-        branch: "origin"
-      }
+      parser = setup_parser(options)
 
+      parser.parse!
+
+      if options[:user].nil? || options[:project].nil?
+        detect_user_and_project(options, ARGV[0], ARGV[1])
+      end
+
+      if !options[:user] || !options[:project]
+        puts parser.banner
+        exit
+      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|
@@ -45,11 +52,29 @@ module GitHubChangelogGenerator
           options[:token] = last
         end
         opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
-          options[:dateformat] = 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("--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
@@ -80,15 +105,36 @@ module GitHubChangelogGenerator
         opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
           options[:compare_link] = v
         end
-        opts.on("--include-labels  x,y,z", Array, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') do |list|
+        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
@@ -98,6 +144,9 @@ module GitHubChangelogGenerator
         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("--[no-]verbose", "Run verbosely. Default is true") do |v|
           options[:verbose] = v
         end
@@ -110,77 +159,123 @@ module GitHubChangelogGenerator
           exit
         end
       end
+      parser
+    end
 
-      parser.parse!
-
-      detect_user_and_project(options)
-
-      if !options[:user] || !options[:project]
-        puts parser.banner
-        exit
-      end
-
-      if ARGV[1]
-        options[:tag1] = ARGV[0]
-        options[:tag2] = ARGV[1]
-      end
-
-      if options[:verbose]
-        puts "Performing task with options:"
-        pp options
-        puts ""
-      end
+    # just get default options
+    def self.get_default_options
+      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"
+      }
 
       options
     end
 
-    def self.detect_user_and_project(options)
-      if ARGV[0] && !ARGV[1]
-        github_site = options[:github_site] ? options[:github_site] : "github.com"
+    # Detects user and project from git
+    def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
+      options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
+      if !options[:user] || !options[:project]
+        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
+    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 = nil)
+      user = nil
+      project = nil
+      github_site ||= "github.com"
+      if arg0 && !arg1
         # this match should parse  strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
-        match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
+        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: '#{ARGV[0]}' -> exit'"
+          puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
           exit
         end
         if param
           exit
         else
-          options[:user] = match[1]
-          options[:project] = match[2]
-        end
-
-      end
-
-      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[:branch]}.url`
-          # try to find repo in format:
-          # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
-          # git@github.com:skywinder/Github-Changelog-Generator.git
-          match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/.match(remote)
-
-          if match && match[1] && match[2]
-            puts "Detected user:#{match[1]}, project:#{match[2]}"
-            options[:user], options[:project] = match[1], match[2]
-          else
-            # try to find repo in format:
-            # origin	https://github.com/skywinder/ChangelogMerger (fetch)
-            # https://github.com/skywinder/ChangelogMerger
-            match = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/.match(remote)
-            if match && match[1] && match[2]
-              puts "Detected user:#{match[1]}, project:#{match[2]}"
-              options[:user], options[:project] = match[1], match[2]
-            end
-          end
+          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
+
+  if __FILE__ == $PROGRAM_NAME
+    remote = "invalid reference to project"
+    p user_project_from_option(ARGV[0], ARGV[1], remote)
+  end
 end

lib/github_changelog_generator/task.rb

@@ -0,0 +1,68 @@
+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 verbose release_url )
+
+    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"
+
+      task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
+
+      # clear any (auto-)pre-existing task
+      Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
+
+      task @name do
+        # mimick parse_options
+        options = Parser.get_default_options
+
+        if options[:user].nil? || options[:project].nil?
+          Parser.detect_user_and_project(options)
+        end
+
+        OPTIONS.each do |o|
+          v = instance_variable_get("@#{o}")
+          options[o.to_sym] = v if v
+        end
+
+        generator = Generator.new options
+
+        log = generator.compound_changelog
+
+        output_filename = "#{options[:output]}"
+        File.open(output_filename, "w") { |file| file.write(log) }
+        puts "Done!"
+        puts "Generated log placed in #{Dir.pwd}/#{output_filename}"
+      end
+    end
+  end
+end

lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = "1.4.0"
+  VERSION = "1.8.4"
 end

spec/spec_helper.rb

@@ -19,6 +19,10 @@ 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,

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,219 @@
+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
+  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/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 exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
+    end
+
+    context "when option is valid" do
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", 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) }
+      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