v1.14.0

Fixed issue #440 - broken multi hyphen options in param file.

.gitignore

@@ -9,3 +9,4 @@ doc
 .yardoc
 Gemfile.lock
 gemfiles/Gemfile.2_4_0.lock
+gemfiles/Gemfile.jruby-9.1.5.0.lock

.rubocop_todo.yml

@@ -1,20 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-02-23 17:18:27 +0200 using RuboCop version 0.37.2.
+# on 2016-09-30 23:56:15 +0200 using RuboCop version 0.43.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: 1
-Lint/ImplicitStringConcatenation:
-  Exclude:
-    - 'lib/github_changelog_generator/parser.rb'
-
-# Offense count: 14
-Metrics/AbcSize:
-  Enabled: false
-
 # Offense count: 1
 Metrics/CyclomaticComplexity:
   Max: 7
@@ -22,30 +13,3 @@ Metrics/CyclomaticComplexity:
 # Offense count: 2
 Metrics/PerceivedComplexity:
   Max: 8
-
-# Offense count: 1
-Style/AccessorMethodName:
-  Enabled: false
-
-# Offense count: 10
-Style/Documentation:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
-# SupportedStyles: skip_modifier_ifs, always
-Style/Next:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Enabled: false

.travis.yml

@@ -14,11 +14,16 @@ matrix:
       script: gem build github_changelog_generator && bundle install
       gemfile: spec/install-gem-in-bundler.gemfile
     - rvm: 2.1
-      gemfile: gemfiles/Gemfile.with_rack16
+      gemfile: gemfiles/Gemfile.2_1
     - rvm: 2.3.1
-      gemfile: gemfiles/Gemfile.with_rack2
+      gemfile: gemfiles/Gemfile.2_3_1
     - rvm: 2.4.0-preview2
       gemfile: gemfiles/Gemfile.2_4_0
+    - rvm: jruby-9.1.5.0
+      jdk: oraclejdk8
+      gemfile: gemfiles/Gemfile.jruby-9.1.5.0
+      env:
+        - JRUBY_OPTS=--debug
 
 notifications:
   email:

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Change Log
 
+## [1.13.2](https://github.com/skywinder/github-changelog-generator/tree/1.13.2) (2016-09-29)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.13.1...1.13.2)
+
+**Implemented enhancements:**
+
+- Replace GPL'd colorize gem with MIT-licensed rainbow [\#408](https://github.com/skywinder/github-changelog-generator/pull/408) ([jamesc](https://github.com/jamesc))
+- Limit number of simultaneous requests to 25 [\#407](https://github.com/skywinder/github-changelog-generator/pull/407) ([jkeiser](https://github.com/jkeiser))
+- Report actual github error when rate limit exceeded [\#405](https://github.com/skywinder/github-changelog-generator/pull/405) ([jkeiser](https://github.com/jkeiser))
+- Make error messages print on error [\#404](https://github.com/skywinder/github-changelog-generator/pull/404) ([jkeiser](https://github.com/jkeiser))
+
+**Fixed bugs:**
+
+- Fetching events for issues and PRs triggers abuse rate limits [\#406](https://github.com/skywinder/github-changelog-generator/issues/406)
+
+**Merged pull requests:**
+
+- Add bump gem to development deps [\#423](https://github.com/skywinder/github-changelog-generator/pull/423) ([olleolleolle](https://github.com/olleolleolle))
+- Skip logger helper in coverage [\#421](https://github.com/skywinder/github-changelog-generator/pull/421) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: Test on 2.4.0-preview2 [\#420](https://github.com/skywinder/github-changelog-generator/pull/420) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: Collecting the config, gemspec: extract development deps to Gemfile [\#417](https://github.com/skywinder/github-changelog-generator/pull/417) ([olleolleolle](https://github.com/olleolleolle))
+- Update README.md [\#415](https://github.com/skywinder/github-changelog-generator/pull/415) ([dijonkitchen](https://github.com/dijonkitchen))
+- README: Add Gitter badge [\#413](https://github.com/skywinder/github-changelog-generator/pull/413) ([olleolleolle](https://github.com/olleolleolle))
+- CircleCI hook for Gitter notification [\#411](https://github.com/skywinder/github-changelog-generator/pull/411) ([olleolleolle](https://github.com/olleolleolle))
+- Spec: avoid Ruby warning about already-defined constant [\#409](https://github.com/skywinder/github-changelog-generator/pull/409) ([olleolleolle](https://github.com/olleolleolle))
+
 ## [1.13.1](https://github.com/skywinder/github-changelog-generator/tree/1.13.1) (2016-07-22)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.13.0...1.13.1)
 

Gemfile

@@ -15,6 +15,9 @@ group :development do
 end
 
 group :test do
+  gem "vcr"
+  gem "multi_json"
+  gem "webmock"
   gem "coveralls", "~>0.8", require: false
   gem "simplecov", "~>0.10", require: false
   gem "codeclimate-test-reporter", "~>0.4"

README.md

@@ -228,7 +228,7 @@ If you're seeing this warning, please do the following:
 
 - ***My Ruby version is very old, can I use this?***
 
-When your Ruby is old, and you don't want to upgrade, and your want to
+When your Ruby is old, and you don't want to upgrade, and you want to
 control which libraries you use, you can use Bundler.
 
 In a Gemfile, perhaps in a non-deployed `:development` group, add this

gemfiles/Gemfile.2_1

@@ -1,2 +1,3 @@
 eval_gemfile File.expand_path('../../Gemfile', __FILE__)
 gem 'rack', '~> 1.6'
+gem 'activesupport', '~> 4'

gemfiles/Gemfile.2_3_1

@@ -0,0 +1,3 @@
+eval_gemfile File.expand_path('../../Gemfile', __FILE__)
+gem 'rack', '>= 2'
+gem 'activesupport', '>= 4'

gemfiles/Gemfile.jruby-9.1.5.0

@@ -1,2 +1,3 @@
 eval_gemfile File.expand_path('../../Gemfile', __FILE__)
 gem 'rack', '>= 2'
+

github_changelog_generator.gemspec

@@ -25,6 +25,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "rake", ">= 10.0"
-  spec.add_runtime_dependency "github_api", ">= 0.14"
   spec.add_runtime_dependency "rainbow", ">= 2.1"
+  spec.add_runtime_dependency("octokit", ["~> 4.0"])
+  spec.add_runtime_dependency("faraday-http-cache")
+  spec.add_runtime_dependency("activesupport")
+  spec.add_runtime_dependency("retriable", ["~> 2.1"])
 end

lib/CHANGELOG.md

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

lib/github_changelog_generator.rb

@@ -1,11 +1,16 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "github_api"
+require "octokit"
+require "faraday-http-cache"
+require "logger"
+require "active_support"
 require "json"
+require "multi_json"
 require "benchmark"
 
 require_relative "github_changelog_generator/helper"
+require_relative "github_changelog_generator/options"
 require_relative "github_changelog_generator/parser"
 require_relative "github_changelog_generator/parser_file"
 require_relative "github_changelog_generator/generator/generator"

lib/github_changelog_generator/fetcher.rb

@@ -1,226 +0,0 @@
-# frozen_string_literal: true
-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
-    MAX_SIMULTANEOUS_REQUESTS = 25
-    CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
-    GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
-    "missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
-    NO_TOKEN_PROVIDED = "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found. " \
-    "This script can make only 50 requests to GitHub API per hour without token!"
-
-    def initialize(options = {})
-      @options = options || {}
-      @user = @options[:user]
-      @project = @options[:project]
-      @github_token = fetch_github_token
-      @github_options = { per_page: PER_PAGE_NUMBER }
-      @github_options[:oauth_token] = @github_token unless @github_token.nil?
-      @github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
-      @github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
-
-      @github = check_github_response { Github.new @github_options }
-    end
-
-    # Returns GitHub token. First try to use variable, provided by --token option,
-    # otherwise try to fetch it from CHANGELOG_GITHUB_TOKEN env variable.
-    #
-    # @return [String]
-    def fetch_github_token
-      env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
-
-      Helper.log.warn NO_TOKEN_PROVIDED unless env_var
-
-      env_var
-    end
-
-    # Fetch all tags from repo
-    # @return [Array] array of tags
-    def get_all_tags
-      print "Fetching tags...\r" if @options[:verbose]
-
-      check_github_response { github_fetch_tags }
-    end
-
-    # This is wrapper with rescue block
-    # @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block
-    def check_github_response
-      begin
-        value = yield
-      rescue Github::Error::Unauthorized => e
-        Helper.log.error e.response_message
-        abort "Error: wrong GitHub token"
-      rescue Github::Error::Forbidden => e
-        Helper.log.warn e.response_message
-        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
-      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) unless page.nil?
-      end
-      print_empty_line
-
-      if tags.empty?
-        Helper.log.warn "Warning: Can't find any tags in repo.\
-Make sure, that you push tags to remote repo via 'git push --tags'"
-      else
-        Helper.log.info "Found #{tags.count} tags"
-      end
-      tags
-    end
-
-    # This method fetch all closed issues and separate them to pull requests and pure issues
-    # (pull request is kind of issue in term of GitHub)
-    # @return [Tuple] with (issues, pull-requests)
-    def fetch_closed_issues_and_pr
-      print "Fetching closed issues...\r" if @options[:verbose]
-      issues = []
-
-      begin
-        response = @github.issues.list user: @options[:user],
-                                       repo: @options[:project],
-                                       state: "closed",
-                                       filter: "all",
-                                       labels: nil
-        page_i = 0
-        count_pages = response.count_pages
-        response.each_page do |page|
-          page_i += PER_PAGE_NUMBER
-          print_in_same_line("Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
-          issues.concat(page)
-          break if @options[:max_issues] && issues.length >= @options[:max_issues]
-        end
-        print_empty_line
-        Helper.log.info "Received issues: #{issues.count}"
-
-      rescue Github::Error::Forbidden => e
-        Helper.log.warn e.error_messages.map { |m| m[:message] }.join(", ")
-        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
-      end
-
-      # separate arrays of issues and pull requests:
-      issues.partition do |x|
-        x[:pull_request].nil?
-      end
-    end
-
-    # Fetch all pull requests. We need them to detect :merged_at parameter
-    # @return [Array] all pull requests
-    def fetch_closed_pull_requests
-      pull_requests = []
-      begin
-        response = if @options[:release_branch].nil?
-                     @github.pull_requests.list @options[:user],
-                                                @options[:project],
-                                                state: "closed"
-                   else
-                     @github.pull_requests.list @options[:user],
-                                                @options[:project],
-                                                state: "closed",
-                                                base: @options[:release_branch]
-                   end
-        page_i = 0
-        count_pages = response.count_pages
-        response.each_page do |page|
-          page_i += PER_PAGE_NUMBER
-          log_string = "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}"
-          print_in_same_line(log_string)
-          pull_requests.concat(page)
-        end
-        print_empty_line
-      rescue Github::Error::Forbidden => e
-        Helper.log.warn e.error_messages.map { |m| m[:message] }.join(", ")
-        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
-      end
-
-      Helper.log.info "Fetching merged dates: #{pull_requests.count}"
-      pull_requests
-    end
-
-    # Print specified line on the same string
-    # @param [String] log_string
-    def print_in_same_line(log_string)
-      print log_string + "\r"
-    end
-
-    # Print long line with spaces on same line to clear prev message
-    def print_empty_line
-      print_in_same_line("                                                                       ")
-    end
-
-    # Fetch event for all issues and add them to :events
-    # @param [Array] issues
-    # @return [Void]
-    def fetch_events_async(issues)
-      i = 0
-      threads = []
-      issues.each_slice(MAX_SIMULTANEOUS_REQUESTS) do |issues_slice|
-        issues_slice.each do |issue|
-          threads << Thread.new do
-            begin
-              response = @github.issues.events.list user: @options[:user],
-                                                    repo: @options[:project],
-                                                    issue_number: issue["number"]
-              issue[:events] = []
-              response.each_page do |page|
-                issue[:events].concat(page)
-              end
-            rescue Github::Error::Forbidden => e
-              Helper.log.warn e.error_messages.map { |m| m[:message] }.join(", ")
-              Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
-            end
-            print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
-            i += 1
-          end
-        end
-        threads.each(&:join)
-        threads = []
-      end
-
-      # to clear line from prev print
-      print_empty_line
-
-      Helper.log.info "Fetching events for issues and PR: #{i}"
-    end
-
-    # Fetch tag time from repo
-    #
-    # @param [Hash] tag
-    # @return [Time] time of specified tag
-    def fetch_date_of_tag(tag)
-      begin
-        commit_data = @github.git_data.commits.get @options[:user],
-                                                   @options[:project],
-                                                   tag["commit"]["sha"]
-      rescue Github::Error::Forbidden => e
-        Helper.log.warn e.error_messages.map { |m| m[:message] }.join(", ")
-        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
-      end
-      time_string = commit_data["committer"]["date"]
-      Time.parse(time_string)
-    end
-
-    # Fetch commit for specified event
-    # @return [Hash]
-    def fetch_commit(event)
-      @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
-    end
-  end
-end

lib/github_changelog_generator/generator/generator.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require_relative "../fetcher"
+require_relative "../octo_fetcher"
 require_relative "generator_generation"
 require_relative "generator_fetcher"
 require_relative "generator_processor"
@@ -11,25 +11,25 @@ module GitHubChangelogGenerator
   end
 
   class Generator
-    attr_accessor :options, :filtered_tags, :github
+    attr_accessor :options, :filtered_tags, :github, :tag_section_mapping, :sorted_tags
 
     # 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 || {}
+    def initialize(options = {})
+      @options        = options
       @tag_times_hash = {}
-      @fetcher = GitHubChangelogGenerator::Fetcher.new @options
+      @fetcher        = GitHubChangelogGenerator::OctoFetcher.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) : []
+      @pull_requests = options[:pulls] ? get_filtered_pull_requests(pull_requests) : []
 
-      @issues = @options[:issues] ? get_filtered_issues(issues) : []
+      @issues = options[:issues] ? get_filtered_issues(issues) : []
 
       fetch_events_for_issues_and_pr
       detect_actual_closed_dates(@issues + @pull_requests)
@@ -61,18 +61,18 @@ module GitHubChangelogGenerator
       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]}"
+      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]
+      if options[:issues]
         # Generate issues:
         log += issues_to_log(issues, pull_requests)
       end
 
-      if @options[:pulls]
+      if options[:pulls]
         # Generate pull requests:
-        log += generate_sub_section(pull_requests, @options[:merge_prefix])
+        log += generate_sub_section(pull_requests, options[:merge_prefix])
       end
 
       log
@@ -87,9 +87,9 @@ module GitHubChangelogGenerator
       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 += 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
 
@@ -106,32 +106,32 @@ module GitHubChangelogGenerator
 
       issues.each do |dict|
         added = false
-        dict.labels.each do |label|
-          if @options[:bug_labels].include? label.name
-            bugs_a.push dict
+        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
+          if options[:enhancement_labels].include?(label["name"])
+            enhancement_a.push(dict)
             added = true
             next
           end
         end
-        issues_a.push dict unless added
+        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
+      pull_requests.each do |pr|
+        pr["labels"].each do |label|
+          if options[:bug_labels].include?(label["name"])
+            bugs_a.push(pr)
+            added_pull_requests.push(pr)
             next
           end
-          if @options[:enhancement_labels].include? label.name
-            enhancement_a.push dict
-            added_pull_requests.push dict
+          if options[:enhancement_labels].include?(label["name"])
+            enhancement_a.push(pr)
+            added_pull_requests.push(pr)
             next
           end
         end

lib/github_changelog_generator/generator/generator_fetcher.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 module GitHubChangelogGenerator
   class Generator
+    MAX_THREAD_NUMBER = 25
+
     # Fetch event for issues and pull requests
     # @return [Array] array of fetched issues
     def fetch_events_for_issues_and_pr
-      if @options[:verbose]
+      if options[:verbose]
         print "Fetching events for issues and PR: 0/#{@issues.count + @pull_requests.count}\r"
       end
 
@@ -13,48 +15,47 @@ module GitHubChangelogGenerator
     end
 
     # Async fetching of all tags dates
-    def fetch_tags_dates
-      print "Fetching tag dates...\r" if @options[:verbose]
+    def fetch_tags_dates(tags)
+      print "Fetching tag dates...\r" if options[:verbose]
       # Async fetching tags:
       threads = []
       i = 0
-      all = @filtered_tags.count
-      @filtered_tags.each do |tag|
+      all = tags.count
+      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]
+          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]
+      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]
+      print "Fetching closed dates for issues...\r" if options[:verbose]
 
-      max_thread_number = 50
-      issues.each_slice(max_thread_number) do |issues_slice|
+      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]
+      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?
+      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"
+        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
+        issue["events"].reverse!.each do |event|
+          if event["event"].eql? compare_string
             set_date_from_event(event, issue)
             break
           end
@@ -68,15 +69,17 @@ module GitHubChangelogGenerator
     # @param [Hash] event
     # @param [Hash] issue
     def set_date_from_event(event, issue)
-      if event[:commit_id].nil?
-        issue[:actual_date] = issue[:closed_at]
+      if event["commit_id"].nil?
+        issue["actual_date"] = issue["closed_at"]
       else
         begin
           commit = @fetcher.fetch_commit(event)
-          issue[:actual_date] = commit[:author][:date]
+          issue["actual_date"] = commit["commit"]["author"]["date"]
+
+          # issue['actual_date'] = commit['author']['date']
         rescue
-          puts "Warning: Can't fetch commit #{event[:commit_id]}. It is probably referenced from another repo."
-          issue[:actual_date] = issue[:closed_at]
+          puts "Warning: Can't fetch commit #{event['commit_id']}. It is probably referenced from another repo."
+          issue["actual_date"] = issue["closed_at"]
         end
       end
     end

lib/github_changelog_generator/generator/generator_generation.rb

@@ -6,50 +6,26 @@ module GitHubChangelogGenerator
     # @return [String] Generated change log file
     def compound_changelog
       fetch_and_filter_tags
-      sort_tags_by_date(@filtered_tags)
       fetch_issues_and_pr
 
       log = ""
-      log += @options[:frontmatter] if @options[:frontmatter]
-      log += "#{@options[:header]}\n\n"
+      log += options[:frontmatter] if options[:frontmatter]
+      log += "#{options[:header]}\n\n"
 
-      log += if @options[:unreleased_only]
+      log += if options[:unreleased_only]
                generate_log_between_tags(filtered_tags[0], nil)
              else
                generate_log_for_all_tags
              end
 
-      log += File.read(@options[:base]) if File.file?(@options[:base])
+      log += File.read(options[:base]) if File.file?(options[:base])
 
       log += "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
       @log = log
     end
 
-    # @return [String] temp method should be removed soon
-    def generate_for_2_tags(log)
-      tag1 = @options[:tag1]
-      tag2 = @options[:tag2]
-      tags_strings = []
-      filtered_tags.each { |x| tags_strings.push(x["name"]) }
-
-      if tags_strings.include?(tag1)
-        if tags_strings.include?(tag2)
-          to_a = tags_strings.map.with_index.to_a
-          hash = Hash[to_a]
-          index1 = hash[tag1]
-          index2 = hash[tag2]
-          log += generate_log_between_tags(all_tags[index1], all_tags[index2])
-        else
-          raise ChangelogGeneratorError, "Can't find tag #{tag2} -> exit"
-        end
-      else
-        raise ChangelogGeneratorError, "Can't find tag #{tag1} -> exit"
-      end
-      log
-    end
-
     # @param [Array] issues List of issues on sub-section
-    # @param [String] prefix Nae of sub-section
+    # @param [String] prefix Name of sub-section
     # @return [String] Generate ready-to-go sub-section
     def generate_sub_section(issues, prefix)
       log = ""
@@ -77,21 +53,21 @@ module GitHubChangelogGenerator
       log = ""
 
       # Generate date string:
-      time_string = newer_tag_time.strftime @options[:date_format]
+      time_string = newer_tag_time.strftime(options[:date_format])
 
       # Generate tag name and link
-      release_url = if @options[:release_url]
-                      format(@options[:release_url], newer_tag_link)
+      release_url = if options[:release_url]
+                      format(options[:release_url], newer_tag_link)
                     else
                       "#{project_url}/tree/#{newer_tag_link}"
                     end
-      log += if newer_tag_name.equal? @options[:unreleased_label]
+      log += if newer_tag_name.equal?(options[:unreleased_label])
                "## [#{newer_tag_name}](#{release_url})\n\n"
              else
                "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n"
              end
 
-      if @options[:compare_link] && older_tag_link
+      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
@@ -119,12 +95,12 @@ module GitHubChangelogGenerator
     #
     # @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)
+      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]
+      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)
@@ -135,15 +111,13 @@ module GitHubChangelogGenerator
     # 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]
+      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.any?
-        log += generate_log_between_tags(nil, filtered_tags.last)
+      @tag_section_mapping.each_pair do |_tag_section, left_right_tags|
+        older_tag, newer_tag = left_right_tags
+        log += generate_log_between_tags(older_tag, newer_tag)
       end
 
       log
@@ -151,8 +125,9 @@ module GitHubChangelogGenerator
 
     def generate_unreleased_section
       log = ""
-      if @options[:unreleased]
-        unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
+      if options[:unreleased]
+        start_tag      = filtered_tags[0] || sorted_tags.last
+        unreleased_log = generate_log_between_tags(start_tag, nil)
         log           += unreleased_log if unreleased_log
       end
       log
@@ -166,24 +141,36 @@ module GitHubChangelogGenerator
     # @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]
+      encapsulated_title = encapsulate_string issue["title"]
 
-      title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
+      title_with_number = "#{encapsulated_title} [\\##{issue['number']}](#{issue['html_url']})"
+      if options[:issue_line_labels].present?
+        title_with_number = "#{title_with_number}#{line_labels_for(issue)}"
+      end
       issue_line_with_user(title_with_number, issue)
     end
 
     private
 
-    def issue_line_with_user(line, issue)
-      return line if !@options[:author] || issue.pull_request.nil?
+    def line_labels_for(issue)
+      labels = if options[:issue_line_labels] == ["ALL"]
+                 issue["labels"]
+               else
+                 issue["labels"].select { |label| options[:issue_line_labels].include?(label["name"]) }
+               end
+      labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
+    end
 
-      user = issue.user
+    def issue_line_with_user(line, issue)
+      return line if !options[:author] || issue["pull_request"].nil?
+
+      user = issue["user"]
       return "#{line} ({Null user})" unless user
 
-      if @options[:usernames_as_github_logins]
-        "#{line} (@#{user.login})"
+      if options[:usernames_as_github_logins]
+        "#{line} (@#{user['login']})"
       else
-        "#{line} ([#{user.login}](#{user.html_url}))"
+        "#{line} ([#{user['login']}](#{user['html_url']}))"
       end
     end
   end

lib/github_changelog_generator/generator/generator_processor.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 module GitHubChangelogGenerator
   class Generator
-    # delete all labels with labels from @options[:exclude_labels] array
+    # delete all labels with labels from options[:exclude_labels] array
     # @param [Array] issues
     # @return [Array] filtered array
     def exclude_issues_by_labels(issues)
-      return issues if !@options[:exclude_labels] || @options[:exclude_labels].empty?
+      return issues if !options[:exclude_labels] || options[:exclude_labels].empty?
 
       issues.reject do |issue|
-        labels = issue.labels.map(&:name)
-        (labels & @options[:exclude_labels]).any?
+        labels = issue["labels"].map { |l| l["name"] }
+        (labels & options[:exclude_labels]).any?
       end
     end
 
@@ -32,18 +32,18 @@ module GitHubChangelogGenerator
     # @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?
+        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
+            tag["name"] == issue["milestone"]["title"]
           end
 
           if milestone_is_tag.nil?
             false
           else
-            issue.milestone.title == tag_name
+            issue["milestone"]["title"] == tag_name
           end
         end
       end
@@ -53,11 +53,11 @@ module GitHubChangelogGenerator
     def remove_issues_in_milestones(filtered_issues)
       filtered_issues.select! do |issue|
         # leave issues without milestones
-        if issue.milestone.nil?
+        if issue["milestone"].nil?
           true
         else
           # check, that this milestone in tag list:
-          @filtered_tags.find { |tag| tag.name == issue.milestone.title }.nil?
+          @filtered_tags.find { |tag| tag["name"] == issue["milestone"]["title"] }.nil?
         end
       end
     end
@@ -68,16 +68,18 @@ module GitHubChangelogGenerator
     # @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)
+    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?
 
+      older_tag = ensure_older_tag(older_tag, newer_tag)
+
       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
+          time = Time.parse(issue[hash_key].to_s).utc
 
           tag_in_range_old = tag_newer_old_tag?(older_tag_time, time)
 
@@ -92,6 +94,14 @@ module GitHubChangelogGenerator
       end
     end
 
+    def ensure_older_tag(older_tag, newer_tag)
+      return older_tag if older_tag
+      idx = sorted_tags.index { |t| t["name"] == newer_tag["name"] }
+      # skip if we are already at the oldest element
+      return if idx == sorted_tags.size - 1
+      sorted_tags[idx - 1]
+    end
+
     def tag_older_new_tag?(newer_tag_time, time)
       tag_in_range_new = if newer_tag_time.nil?
                            true
@@ -121,9 +131,9 @@ module GitHubChangelogGenerator
 
     # @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]
+      if options[:add_issues_wo_labels]
         issues_wo_labels = issues.select do |issue|
-          !issue.labels.map(&:name).any?
+          !issue["labels"].map { |l| l["name"] }.any?
         end
         return issues_wo_labels
       end
@@ -131,11 +141,11 @@ module GitHubChangelogGenerator
     end
 
     def filter_by_include_labels(issues)
-      if @options[:include_labels].nil?
+      if options[:include_labels].nil?
         issues
       else
         issues.select do |issue|
-          labels = issue.labels.map(&:name) & @options[:include_labels]
+          labels = issue["labels"].map { |l| l["name"] } & options[:include_labels]
           labels.any?
         end
       end
@@ -154,18 +164,18 @@ module GitHubChangelogGenerator
     # @return [Array] Filtered issues
     def get_filtered_issues(issues)
       issues = filter_array_by_labels(issues)
-      puts "Filtered issues: #{issues.count}" if @options[:verbose]
+      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
+    # 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]
+      puts "Filtered pull requests: #{pull_requests.count}" if options[:verbose]
       pull_requests
     end
 
@@ -174,21 +184,21 @@ module GitHubChangelogGenerator
     # :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]
+      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
+          fpr["number"] == pr["number"]
         end
         if fetched_pr
-          pr[:merged_at] = fetched_pr[:merged_at]
+          pr["merged_at"] = fetched_pr["merged_at"]
           closed_pull_requests.delete(fetched_pr)
         end
       end
 
       pull_requests.select! do |pr|
-        !pr[:merged_at].nil?
+        !pr["merged_at"].nil?
       end
 
       pull_requests

lib/github_changelog_generator/generator/generator_tags.rb

@@ -3,33 +3,59 @@ 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
+      detect_since_tag
+      detect_due_tag
+
+      all_tags      = @fetcher.get_all_tags
+      included_tags = filter_excluded_tags(all_tags)
+
+      fetch_tags_dates(all_tags) # Creates a Hash @tag_times_hash
+      @sorted_tags   = sort_tags_by_date(included_tags)
+      @filtered_tags = get_filtered_tags(included_tags)
+
+      @tag_section_mapping = build_tag_section_mapping(@filtered_tags, sorted_tags)
+
+      @filtered_tags
     end
 
-    # Sort all tags by date
+    # @param [Array] filtered_tags are the tags that need a subsection output
+    # @param [Array] all_tags is the list of all tags ordered from newest -> oldest
+    # @return [Hash] key is the tag to output, value is an array of [Left Tag, Right Tag]
+    # PRs to include in this section will be >= [Left Tag Date] and <= [Right Tag Date]
+    def build_tag_section_mapping(filtered_tags, all_tags)
+      tag_mapping = {}
+      filtered_tags.each do |tag|
+        older_tag_idx = all_tags.index(tag) + 1
+        older_tag = all_tags[older_tag_idx]
+        tag_mapping[tag] = [older_tag, tag]
+      end
+      tag_mapping
+    end
+
+    # Sort all tags by date, newest to oldest
     def sort_tags_by_date(tags)
-      puts "Sorting tags..." if @options[:verbose]
+      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
+    # Returns date for given GitHub Tag hash
+    #
+    # Memoize the date by tag name.
+    #
+    # @param [Hash] tag_name
+    #
     # @return [Time] time of specified tag
     def get_time_of_tag(tag_name)
       raise ChangelogGeneratorError, "tag_name is nil" 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
+      name_of_tag = tag_name.fetch("name")
+      time_for_tag_name = @tag_times_hash[name_of_tag]
+      return time_for_tag_name if time_for_tag_name
+
+      @fetcher.fetch_date_of_tag(tag_name).tap do |time_string|
         @tag_times_hash[name_of_tag] = time_string
-        time_string
       end
     end
 
@@ -42,12 +68,12 @@ module GitHubChangelogGenerator
       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]
+      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_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]
@@ -55,13 +81,17 @@ module GitHubChangelogGenerator
 
     # @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
     def detect_since_tag
-      @since_tag ||= @options.fetch(:since_tag) { version_of_first_item }
+      @since_tag ||= options.fetch(:since_tag) { version_of_first_item }
+    end
+
+    def detect_due_tag
+      @due_tag ||= options.fetch(:due_tag, nil)
     end
 
     def version_of_first_item
-      return unless File.file?(@options[:base].to_s)
+      return unless File.file?(options[:base].to_s)
 
-      sections = GitHubChangelogGenerator::Reader.new.read(@options[:base])
+      sections = GitHubChangelogGenerator::Reader.new.read(options[:base])
       sections.first["version"] if sections && sections.any?
     end
 
@@ -70,8 +100,8 @@ module GitHubChangelogGenerator
     # @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)
+      filtered_tags = filter_due_tag(filtered_tags)
+      filter_between_tags(filtered_tags)
     end
 
     # @param [Array] all_tags all tags
@@ -80,8 +110,8 @@ module GitHubChangelogGenerator
       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 all_tags.map { |t| t["name"] }.include? tag
+          idx = all_tags.index { |t| t["name"] == tag }
           filtered_tags = if idx > 0
                             all_tags[0..idx - 1]
                           else
@@ -98,13 +128,12 @@ module GitHubChangelogGenerator
     # @return [Array] filtered tags according :due_tag option
     def filter_due_tag(all_tags)
       filtered_tags = all_tags
-      tag = @options[:due_tag]
+      tag           = detect_due_tag
       if tag
-        if all_tags.any? && all_tags.map(&:name).include?(tag)
-          idx = all_tags.index { |t| t.name == tag }
-          last_index = all_tags.count - 1
-          filtered_tags = if idx > 0 && idx < last_index
-                            all_tags[idx + 1..last_index]
+        if all_tags.any? && all_tags.map { |t| t["name"] }.include?(tag)
+          idx = all_tags.index { |t| t["name"] == tag }
+          filtered_tags = if idx > 0
+                            all_tags[(idx + 1)..-1]
                           else
                             []
                           end
@@ -119,13 +148,15 @@ module GitHubChangelogGenerator
     # @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
+      tag_names     = filtered_tags.map { |ft| ft["name"] }
+
+      if options[:between_tags]
+        options[:between_tags].each do |tag|
+          unless tag_names.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 }
+        filtered_tags = all_tags.select { |tag| options[:between_tags].include?(tag["name"]) }
       end
       filtered_tags
     end
@@ -133,9 +164,9 @@ module GitHubChangelogGenerator
     # @param [Array] all_tags all tags
     # @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option
     def filter_excluded_tags(all_tags)
-      if @options[:exclude_tags]
+      if options[:exclude_tags]
         apply_exclude_tags(all_tags)
-      elsif @options[:exclude_tags_regex]
+      elsif options[:exclude_tags_regex]
         apply_exclude_tags_regex(all_tags)
       else
         all_tags
@@ -145,39 +176,39 @@ module GitHubChangelogGenerator
     private
 
     def apply_exclude_tags(all_tags)
-      if @options[:exclude_tags].is_a?(Regexp)
-        filter_tags_with_regex(all_tags, @options[:exclude_tags])
+      if options[:exclude_tags].is_a?(Regexp)
+        filter_tags_with_regex(all_tags, options[:exclude_tags])
       else
         filter_exact_tags(all_tags)
       end
     end
 
     def apply_exclude_tags_regex(all_tags)
-      filter_tags_with_regex(all_tags, Regexp.new(@options[:exclude_tags_regex]))
+      filter_tags_with_regex(all_tags, Regexp.new(options[:exclude_tags_regex]))
     end
 
     def filter_tags_with_regex(all_tags, regex)
       warn_if_nonmatching_regex(all_tags)
-      all_tags.reject { |tag| regex =~ tag.name }
+      all_tags.reject { |tag| regex =~ tag["name"] }
     end
 
     def filter_exact_tags(all_tags)
-      @options[:exclude_tags].each do |tag|
+      options[:exclude_tags].each do |tag|
         warn_if_tag_not_found(all_tags, tag)
       end
-      all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
+      all_tags.reject { |tag| options[:exclude_tags].include?(tag["name"]) }
     end
 
     def warn_if_nonmatching_regex(all_tags)
-      unless all_tags.map(&:name).any? { |t| @options[:exclude_tags] =~ t }
+      unless all_tags.map { |t| t["name"] }.any? { |t| options[:exclude_tags] =~ t }
         Helper.log.warn "Warning: unable to reject any tag, using regex "\
-                        "#{@options[:exclude_tags].inspect} in --exclude-tags "\
+                        "#{options[:exclude_tags].inspect} in --exclude-tags "\
                         "option."
       end
     end
 
     def warn_if_tag_not_found(all_tags, tag)
-      unless all_tags.map(&:name).include? tag
+      unless all_tags.map { |t| t["name"] }.include?(tag)
         Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
       end
     end

lib/github_changelog_generator/octo_fetcher.rb

@@ -0,0 +1,363 @@
+# frozen_string_literal: true
+require "retriable"
+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::OctoFetcher.new(options)
+  class OctoFetcher
+    PER_PAGE_NUMBER   = 100
+    MAX_THREAD_NUMBER = 25
+    MAX_FORBIDDEN_RETRIES = 100
+    CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
+    GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
+    "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!"
+
+    # @param options [Hash] Options passed in
+    # @option options [String] :user GitHub username
+    # @option options [String] :project GitHub project
+    # @option options [String] :since Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. eg. Time.parse("2016-01-01 10:00:00").iso8601
+    # @option options [Boolean] :http_cache Use ActiveSupport::Cache::FileStore to cache http requests
+    # @option options [Boolean] :cache_file If using http_cache, this is the cache file path
+    # @option options [Boolean] :cache_log If using http_cache, this is the cache log file path
+    def initialize(options = {}) # rubocop:disable Metrics/CyclomaticComplexity
+      @options      = options || {}
+      @user         = @options[:user]
+      @project      = @options[:project]
+      @since        = @options[:since]
+      @http_cache   = @options[:http_cache]
+      @cache_file   = @options.fetch(:cache_file, "/tmp/github-changelog-http-cache") if @http_cache
+      @cache_log    = @options.fetch(:cache_log, "/tmp/github-changelog-logger.log") if @http_cache
+      init_cache if @http_cache
+
+      @github_token = fetch_github_token
+
+      @request_options               = { per_page: PER_PAGE_NUMBER }
+      @github_options                = {}
+      @github_options[:access_token] = @github_token unless @github_token.nil?
+      @github_options[:api_endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
+
+      client_type = @options[:github_endpoint].nil? ? Octokit::Client : Octokit::EnterpriseAdminClient
+      @client     = client_type.new(@github_options)
+    end
+
+    def init_cache
+      middleware_opts = {
+        serializer: Marshal,
+        store: ActiveSupport::Cache::FileStore.new(@cache_file),
+        logger: Logger.new(@cache_log),
+        shared_cache: false
+      }
+      stack = Faraday::RackBuilder.new do |builder|
+        builder.use Faraday::HttpCache, middleware_opts
+        builder.use Octokit::Response::RaiseError
+        builder.adapter Faraday.default_adapter
+        # builder.response :logger
+      end
+      Octokit.middleware = stack
+    end
+
+    # Fetch all tags from repo
+    #
+    # @return [Array <Hash>] array of tags
+    def get_all_tags
+      print "Fetching tags...\r" if @options[:verbose]
+
+      check_github_response { github_fetch_tags }
+    end
+
+    # Returns the number of pages for a API call
+    #
+    # @return [Integer] number of pages for this API call in total
+    def calculate_pages(client, method, request_options)
+      # Makes the first API call so that we can call last_response
+      check_github_response do
+        client.send(method, user_project, @request_options.merge(request_options))
+      end
+
+      last_response = client.last_response
+
+      if (last_pg = last_response.rels[:last])
+        querystring_as_hash(last_pg.href)["page"].to_i
+      else
+        1
+      end
+    end
+
+    # Fill input array with tags
+    #
+    # @return [Array <Hash>] array of tags in repo
+    def github_fetch_tags
+      tags        = []
+      page_i      = 0
+      count_pages = calculate_pages(@client, "tags", {})
+
+      iterate_pages(@client, "tags", {}) do |new_tags|
+        page_i += PER_PAGE_NUMBER
+        print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
+        tags.concat(new_tags)
+      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'"
+      else
+        Helper.log.info "Found #{tags.count} tags"
+      end
+      # tags are a Sawyer::Resource. Convert to hash
+      tags = tags.map { |h| stringify_keys_deep(h.to_hash) }
+      tags
+    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 [Array <Hash>], pull-requests [Array <Hash>])
+    def fetch_closed_issues_and_pr
+      print "Fetching closed issues...\r" if @options[:verbose]
+      issues = []
+      options = {
+        state: "closed",
+        filter: "all",
+        labels: nil
+      }
+      options[:since] = @since unless @since.nil?
+
+      page_i      = 0
+      count_pages = calculate_pages(@client, "issues", options)
+
+      iterate_pages(@client, "issues", options) do |new_issues|
+        page_i += PER_PAGE_NUMBER
+        print_in_same_line("Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
+        issues.concat(new_issues)
+        break if @options[:max_issues] && issues.length >= @options[:max_issues]
+      end
+      print_empty_line
+      Helper.log.info "Received issues: #{issues.count}"
+
+      issues = issues.map { |h| stringify_keys_deep(h.to_hash) }
+
+      # separate arrays of issues and pull requests:
+      issues.partition do |x|
+        x["pull_request"].nil?
+      end
+    end
+
+    # Fetch all pull requests. We need them to detect :merged_at parameter
+    #
+    # @return [Array <Hash>] all pull requests
+    def fetch_closed_pull_requests
+      pull_requests = []
+      options = { state: "closed" }
+
+      unless @options[:release_branch].nil?
+        options[:base] = @options[:release_branch]
+      end
+
+      page_i      = 0
+      count_pages = calculate_pages(@client, "pull_requests", options)
+
+      iterate_pages(@client, "pull_requests", options) do |new_pr|
+        page_i += PER_PAGE_NUMBER
+        log_string = "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}"
+        print_in_same_line(log_string)
+        pull_requests.concat(new_pr)
+      end
+      print_empty_line
+
+      Helper.log.info "Pull Request count: #{pull_requests.count}"
+      pull_requests = pull_requests.map { |h| stringify_keys_deep(h.to_hash) }
+      pull_requests
+    end
+
+    # Fetch event for all issues and add them to 'events'
+    #
+    # @param [Array] issues
+    # @return [Void]
+    def fetch_events_async(issues)
+      i       = 0
+      threads = []
+
+      issues.each_slice(MAX_THREAD_NUMBER) do |issues_slice|
+        issues_slice.each do |issue|
+          threads << Thread.new do
+            issue["events"] = []
+            iterate_pages(@client, "issue_events", issue["number"], {}) do |new_event|
+              issue["events"].concat(new_event)
+            end
+            issue["events"] = issue["events"].map { |h| stringify_keys_deep(h.to_hash) }
+            print_in_same_line("Fetching events for issues and PR: #{i + 1}/#{issues.count}")
+            i += 1
+          end
+        end
+        threads.each(&:join)
+        threads = []
+      end
+
+      # to clear line from prev print
+      print_empty_line
+
+      Helper.log.info "Fetching events for issues and PR: #{i}"
+    end
+
+    # Fetch tag time from repo
+    #
+    # @param [Hash] tag GitHub data item about a Tag
+    #
+    # @return [Time] time of specified tag
+    def fetch_date_of_tag(tag)
+      commit_data = check_github_response { @client.commit(user_project, tag["commit"]["sha"]) }
+      commit_data = stringify_keys_deep(commit_data.to_hash)
+
+      commit_data["commit"]["committer"]["date"]
+    end
+
+    # Fetch commit for specified event
+    #
+    # @return [Hash]
+    def fetch_commit(event)
+      check_github_response do
+        commit = @client.commit(user_project, event["commit_id"])
+        commit = stringify_keys_deep(commit.to_hash)
+        commit
+      end
+    end
+
+    private
+
+    def stringify_keys_deep(indata)
+      case indata
+      when Array
+        indata.map do |value|
+          stringify_keys_deep(value)
+        end
+      when Hash
+        indata.each_with_object({}) do |(k, v), output|
+          output[k.to_s] = stringify_keys_deep(v)
+        end
+      else
+        indata
+      end
+    end
+
+    # Iterates through all pages until there are no more :next pages to follow
+    # yields the result per page
+    #
+    # @param [Octokit::Client] client
+    # @param [String] method (eg. 'tags')
+    # @return [Integer] total number of pages
+    def iterate_pages(client, method, *args)
+      if args.size == 1 && args.first.is_a?(Hash)
+        request_options = args.delete_at(0)
+      elsif args.size > 1 && args.last.is_a?(Hash)
+        request_options = args.delete_at(args.length - 1)
+      end
+
+      args.push(@request_options.merge(request_options))
+
+      pages = 1
+
+      check_github_response do
+        client.send(method, user_project, *args)
+      end
+      last_response = client.last_response
+
+      yield last_response.data
+
+      until (next_one = last_response.rels[:next]).nil?
+        pages += 1
+
+        last_response = check_github_response { next_one.get }
+        yield last_response.data
+      end
+
+      pages
+    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
+      Retriable.retriable(retry_options) do
+        yield
+      end
+
+    rescue Octokit::Forbidden => e
+      Helper.log.error("#{e.class}: #{e.message}")
+      sys_abort("Exceeded retry limit")
+    rescue Octokit::Unauthorized => e
+      Helper.log.error("#{e.class}: #{e.message}")
+      sys_abort("Error: wrong GitHub token")
+    end
+
+    # Exponential backoff
+    def retry_options
+      {
+        on: [Octokit::Forbidden],
+        tries: MAX_FORBIDDEN_RETRIES,
+        base_interval: sleep_base_interval,
+        multiplier: 1.0,
+        rand_factor: 0.0,
+        on_retry: retry_callback
+      }
+    end
+
+    def sleep_base_interval
+      1.0
+    end
+
+    def retry_callback
+      proc do |exception, try, elapsed_time, next_interval|
+        Helper.log.warn("RETRY - #{exception.class}: '#{exception.message}'")
+        Helper.log.warn("#{try} tries in #{elapsed_time} seconds and #{next_interval} seconds until the next try")
+        Helper.log.warn GH_RATE_LIMIT_EXCEEDED_MSG
+        Helper.log.warn @client.rate_limit
+      end
+    end
+
+    def sys_abort(msg)
+      abort(msg)
+    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
+
+    # Returns GitHub token. First try to use variable, provided by --token option,
+    # otherwise try to fetch it from CHANGELOG_GITHUB_TOKEN env variable.
+    #
+    # @return [String]
+    def fetch_github_token
+      env_var = @options[:token] ? @options[:token] : (ENV.fetch CHANGELOG_GITHUB_TOKEN, nil)
+
+      Helper.log.warn NO_TOKEN_PROVIDED unless env_var
+
+      env_var
+    end
+
+    # @return [String] helper to return Github "user/project"
+    def user_project
+      "#{@options[:user]}/#{@options[:project]}"
+    end
+
+    # Returns Hash of all querystring variables in given URI.
+    #
+    # @param [String] uri eg. https://api.github.com/repositories/43914960/tags?page=37&foo=1
+    # @return [Hash] of all GET variables. eg. { 'page' => 37, 'foo' => 1 }
+    def querystring_as_hash(uri)
+      Hash[URI.decode_www_form(URI(uri).query || "")]
+    end
+  end
+end

lib/github_changelog_generator/options.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+require "delegate"
+module GitHubChangelogGenerator
+  class Options < SimpleDelegator
+    UnsupportedOptionError = Class.new(ArgumentError)
+
+    KNOWN_OPTIONS = [
+      :add_issues_wo_labels,
+      :add_pr_wo_labels,
+      :author,
+      :base,
+      :between_tags,
+      :bug_labels,
+      :bug_prefix,
+      :cache_file,
+      :cache_log,
+      :compare_link,
+      :date_format,
+      :due_tag,
+      :enhancement_labels,
+      :enhancement_prefix,
+      :exclude_labels,
+      :exclude_tags,
+      :exclude_tags_regex,
+      :filter_issues_by_milestone,
+      :frontmatter,
+      :future_release,
+      :git_remote,
+      :github_endpoint,
+      :github_site,
+      :header,
+      :http_cache,
+      :include_labels,
+      :issue_prefix,
+      :issue_line_labels,
+      :issues,
+      :max_issues,
+      :merge_prefix,
+      :output,
+      :project,
+      :pulls,
+      :release_branch,
+      :release_url,
+      :simple_list,
+      :since_tag,
+      :token,
+      :unreleased,
+      :unreleased_label,
+      :unreleased_only,
+      :user,
+      :usernames_as_github_logins,
+      :verbose
+    ]
+
+    THESE_ARE_DIFFERENT = [
+      :tag1,
+      :tag2
+    ]
+
+    def initialize(values)
+      super(values)
+      unsupported_options.any? && raise(UnsupportedOptionError, unsupported_options.inspect)
+    end
+
+    def []=(key, val)
+      supported_option?(key) || raise(UnsupportedOptionError, key.inspect)
+      values[key] = val
+    end
+
+    def to_hash
+      values
+    end
+
+    private
+
+    def values
+      __getobj__
+    end
+
+    def unsupported_options
+      values.keys - supported_options
+    end
+
+    def supported_option?(key)
+      supported_options.include?(key)
+    end
+
+    def supported_options
+      KNOWN_OPTIONS + THESE_ARE_DIFFERENT
+    end
+  end
+end

lib/github_changelog_generator/parser.rb

@@ -42,7 +42,7 @@ module GitHubChangelogGenerator
 
     # setup parsing options
     def self.setup_parser(options)
-      parser = OptionParser.new do |opts|
+      parser = OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
         opts.banner = "Usage: github_changelog_generator [options]"
         opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
           options[:user] = last
@@ -107,7 +107,7 @@ module GitHubChangelogGenerator
         opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true") do |v|
           options[:unreleased] = v
         end
-        opts.on("--unreleased-label [label]", "Add to log unreleased closed issues. Default is true") do |v|
+        opts.on("--unreleased-label [label]", "Setup custom label for unreleased closed issues section. Default is \"**Unreleased:**\"") do |v|
           options[:unreleased_label] = v
         end
         opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
@@ -125,6 +125,9 @@ module GitHubChangelogGenerator
         opts.on("--enhancement-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
           options[:enhancement_labels] = list
         end
+        opts.on("--issue-line-labels x,y,z", Array, 'The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].') do |list|
+          options[:issue_line_labels] = list
+        end
         opts.on("--between-tags  x,y,z", Array, "Change log will be filled only between specified tags") do |list|
           options[:between_tags] = list
         end
@@ -161,6 +164,15 @@ module GitHubChangelogGenerator
         opts.on("--release-branch [RELEASE-BRANCH]", "Limit pull requests to the release branch, such as master or release") do |release_branch|
           options[:release_branch] = release_branch
         end
+        opts.on("--[no-]http-cache", "Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.") do |http_cache|
+          options[:http_cache] = http_cache
+        end
+        opts.on("--cache-file [CACHE-FILE]", "Filename to use for cache. Default is /tmp/github-changelog-http-cache") do |cache_file|
+          options[:cache_file] = cache_file
+        end
+        opts.on("--cache-log [CACHE-LOG]", "Filename to use for cache log. Default is /tmp/github-changelog-logger.log") do |cache_log|
+          options[:cache_log] = cache_log
+        end
         opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
           options[:verbose] = v
         end
@@ -178,7 +190,7 @@ module GitHubChangelogGenerator
 
     # @return [Hash] Default options
     def self.default_options
-      {
+      Options.new(
         tag1: nil,
         tag2: nil,
         date_format: "%Y-%m-%d",
@@ -196,6 +208,7 @@ module GitHubChangelogGenerator
         enhancement_labels: %w(enhancement Enhancement),
         bug_labels: %w(bug Bug),
         exclude_labels: %w(duplicate question invalid wontfix Duplicate Question Invalid Wontfix),
+        issue_line_labels: [],
         max_issues: nil,
         simple_list: false,
         verbose: true,
@@ -204,8 +217,11 @@ module GitHubChangelogGenerator
         issue_prefix: "**Closed issues:**",
         bug_prefix: "**Fixed bugs:**",
         enhancement_prefix: "**Implemented enhancements:**",
-        git_remote: "origin"
-      }
+        git_remote: "origin",
+        http_cache: true,
+        cache_file: "/tmp/github-changelog-http-cache",
+        cache_log: "/tmp/github-changelog-logger.log"
+      )
     end
 
     # If `:user` or `:project` not set in options, try setting them

lib/github_changelog_generator/parser_file.rb

@@ -62,11 +62,11 @@ module GitHubChangelogGenerator
     # @return [Array<Symbol, String>]
     def extract_pair(line)
       key, value = line.split("=", 2)
-      [key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
+      [key.tr("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
     end
 
     KNOWN_ARRAY_KEYS = [:exclude_labels, :include_labels, :bug_labels,
-                        :enhancement_labels, :between_tags, :exclude_tags]
+                        :enhancement_labels, :issue_line_labels, :between_tags, :exclude_tags]
     KNOWN_INTEGER_KEYS = [:max_issues]
 
     def convert_value(value, option_name)

lib/github_changelog_generator/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module GitHubChangelogGenerator
-  VERSION = "1.13.2"
+  VERSION = "1.14.0"
 end

man/git-generate-changelog.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2015" "" ""
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "November 2016" "" ""
 .
 .SH "NAME"
 \fBgit\-generate\-changelog\fR \- Generate changelog from github
@@ -73,6 +73,12 @@ Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR
 Setup custom header label\. Default is "# Change Log"
 .
 .P
+\-\-front\-matter [JSON]
+.
+.P
+Add YAML front matter\. Formatted as JSON because it\'s easier to add on the command line
+.
+.P
 \-\-pr\-label [LABEL]
 .
 .P
@@ -115,6 +121,12 @@ Use milestone to detect when issue was resolved\. Default is true
 Add author of pull\-request in the end\. Default is true
 .
 .P
+\-\-usernames\-as\-github\-logins
+.
+.P
+Use GitHub tags instead of Markdown links for the author of an issue or pull\-request\.
+.
+.P
 \-\-unreleased\-only
 .
 .P
@@ -130,7 +142,7 @@ Add to log unreleased closed issues\. Default is true
 \-\-unreleased\-label [label]
 .
 .P
-Add to log unreleased closed issues\. Default is true
+Setup custom label for unreleased closed issues section\. Default is "\fBUnreleased:\fR"
 .
 .P
 \-\-[no\-]compare\-link
@@ -175,6 +187,12 @@ Change log will be filled only between specified tags
 Change log will exclude specified tags
 .
 .P
+\-\-exclude\-tags\-regex [REGEX]
+.
+.P
+Apply a regular expression on tag names so that they can be excluded, for example: \-\-exclude\-tags\-regex "\.*+\ed{1,}"
+.
+.P
 \-\-since\-tag x
 .
 .P
@@ -223,6 +241,30 @@ Create simple list from issues and pull requests\. Default is false\.
 Put the unreleased changes in the specified release number\.
 .
 .P
+\-\-release\-branch [RELEASE\-BRANCH]
+.
+.P
+Limit pull requests to the release branch, such as master or release
+.
+.P
+\-\-http\-cache
+.
+.P
+Use HTTP Cache to cache Github API requests (useful for large repos) Default is true\.
+.
+.P
+\-\-[no\-]cache\-file [CACHE\-FILE]
+.
+.P
+Filename to use for cache\. Default is /tmp/github\-changelog\-http\-cache
+.
+.P
+\-\-cache\-log [CACHE\-LOG]
+.
+.P
+Filename to use for cache log\. Default is /tmp/github\-changelog\-logger\.log
+.
+.P
 \-\-[no\-]verbose
 .
 .P

man/git-generate-changelog.1.html

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

man/git-generate-changelog.md

@@ -51,6 +51,10 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    Setup custom header label. Default is "# Change Log"
 
+   --front-matter [JSON]
+
+   Add YAML front matter. Formatted as JSON because it's easier to add on the command line
+
    --pr-label [LABEL]
 
    Setup custom label for pull requests section. Default is "**Merged pull requests:**"
@@ -79,6 +83,10 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    Add author of pull-request in the end. Default is true
 
+   --usernames-as-github-logins
+
+   Use GitHub tags instead of Markdown links for the author of an issue or pull-request.
+
    --unreleased-only
 
    Generate log from unreleased closed issues only.
@@ -89,7 +97,7 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    --unreleased-label [label]
 
-   Add to log unreleased closed issues. Default is true
+   Setup custom label for unreleased closed issues section. Default is "**Unreleased:**"
 
    --[no-]compare-link
 
@@ -119,6 +127,10 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    Change log will exclude specified tags
 
+   --exclude-tags-regex [REGEX]
+
+   Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*\+\d{1,}"
+
    --since-tag x
 
    Change log will start after specified tag
@@ -151,6 +163,22 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    Put the unreleased changes in the specified release number.
 
+   --release-branch [RELEASE-BRANCH]
+
+   Limit pull requests to the release branch, such as master or release
+
+   --http-cache
+
+   Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.
+
+   --[no-]cache-file [CACHE-FILE]
+
+   Filename to use for cache. Default is /tmp/github-changelog-http-cache
+
+   --cache-log [CACHE-LOG]
+
+   Filename to use for cache log. Default is /tmp/github-changelog-logger.log
+
    --[no-]verbose
 
    Run verbosely. Default is true

spec/spec_helper.rb

@@ -19,6 +19,8 @@
 require "codeclimate-test-reporter"
 require "simplecov"
 require "coveralls"
+require "vcr"
+require "webmock/rspec"
 
 # This module is only used to check the environment is currently a testing env
 module SpecHelper
@@ -36,6 +38,25 @@ end
 require "github_changelog_generator"
 require "github_changelog_generator/task"
 
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = true
+  c.cassette_library_dir = "spec/vcr"
+  c.ignore_localhost = true
+  c.default_cassette_options = {
+    record: :new_episodes,
+    serialize_with: :json,
+    preserve_exact_body_bytes: true,
+    decode_compressed_response: true
+  }
+  c.filter_sensitive_data("<GITHUB_TOKEN>") do
+    "token #{ENV.fetch('CHANGELOG_GITHUB_TOKEN') { 'frobnitz' }}"
+  end
+
+  c.configure_rspec_metadata!
+
+  c.hook_into :webmock, :faraday
+end
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true

spec/unit/fetcher_spec.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-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_processor_spec.rb

@@ -2,10 +2,10 @@
 module GitHubChangelogGenerator
   describe Generator do
     context "#exclude_issues_by_labels" do
-      let(:label) { double("the-bad-label", name: "BAD") }
-      let(:issue) { double("the-issue-to-be-excluded", labels: [label]) }
-      let(:good_label) { double("a-good-label", name: "GOOD") }
-      let(:good_issue) { double("an-issue-to-be-kept", labels: [good_label]) }
+      let(:label) { { "name" => "BAD" } }
+      let(:issue) { { "labels" => [label] } }
+      let(:good_label) { { "name" => "GOOD" } }
+      let(:good_issue) { { "labels" => [good_label] } }
       let(:issues) { [issue, good_issue] }
       subject(:generator) { described_class.new(exclude_labels: %w(BAD BOO)) }
 

spec/unit/generator/generator_tags_spec.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 describe GitHubChangelogGenerator::Generator do
-  def tag_mash_with_name(tag)
-    Hashie::Mash.new.tap { |mash_tag| mash_tag.name = tag }
+  def tag_with_name(tag)
+    {
+      "name" => tag
+    }
   end
 
-  def tags_mash_from_strings(tags_strings)
+  def tags_from_strings(tags_strings)
     tags_strings.map do |tag|
-      tag_mash_with_name(tag)
+      tag_with_name(tag)
     end
   end
 
@@ -17,20 +19,20 @@ describe GitHubChangelogGenerator::Generator do
       end
 
       subject do
-        @generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
+        @generator.get_filtered_tags(tags_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))) }
+      it { is_expected.to match_array(tags_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)))
+        @generator.get_filtered_tags(tags_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))) }
+      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
     end
 
     context "when between_tags filled with correct values" do
@@ -38,10 +40,10 @@ describe GitHubChangelogGenerator::Generator 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)))
+        @generator.get_filtered_tags(tags_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))) }
+      it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
     end
 
     context "when between_tags filled with invalid values" do
@@ -50,133 +52,134 @@ describe GitHubChangelogGenerator::Generator do
       end
 
       subject do
-        @generator.get_filtered_tags(tags_mash_from_strings(%w(1 2 3)))
+        @generator.get_filtered_tags(tags_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))) }
+      it { is_expected.to match_array(tags_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)))
+      generator.get_filtered_tags(tags_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)) }
+    context "respects between tags" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3)) }
+
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1 3))) }
+      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
     end
   end
 
   describe "#filter_excluded_tags" do
-    subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
+    subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
 
     context "with matching string" 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))) }
+      it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
     end
 
     context "with non-matching string" 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))) }
+      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
     end
 
     context "with matching regex" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
+      it { is_expected.to match_array(tags_from_strings(%w(1))) }
     end
 
     context "with non-matching regex" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
     end
   end
 
   describe "#filter_excluded_tags_regex" do
-    subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
+    subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
 
     context "with matching regex" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[23]") }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
+      it { is_expected.to match_array(tags_from_strings(%w(1))) }
     end
 
     context "with non-matching regex" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[45]") }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+      it { is_expected.to match_array(tags_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))) }
+      subject { generator.filter_since_tag(tags_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))) }
+        it { is_expected.to match_array(tags_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))) }
+        it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
       end
     end
 
     context "with empty array" do
-      subject { generator.filter_since_tag(tags_mash_from_strings(%w())) }
+      subject { generator.filter_since_tag(tags_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())) }
+        it { is_expected.to match_array(tags_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())) }
+        it { is_expected.to match_array(tags_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))) }
+      subject { generator.filter_due_tag(tags_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))) }
+        it { is_expected.to match_array(tags_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))) }
+        it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
       end
     end
 
     context "with empty array" do
-      subject { generator.filter_due_tag(tags_mash_from_strings(%w())) }
+      subject { generator.filter_due_tag(tags_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())) }
+        it { is_expected.to match_array(tags_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())) }
+        it { is_expected.to match_array(tags_from_strings(%w())) }
       end
     end
   end
@@ -191,7 +194,7 @@ describe GitHubChangelogGenerator::Generator do
     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") }
+      subject { @generator.get_time_of_tag tag_with_name("valid_tag") }
       it { is_expected.to be_a_kind_of(Time) }
       it { is_expected.to eq(current_time) }
     end
@@ -202,7 +205,7 @@ describe GitHubChangelogGenerator::Generator do
         @generator.instance_variable_set :@fetcher, mock
       end
       subject do
-        of_tag = @generator.get_time_of_tag(tag_mash_with_name("valid_tag"))
+        of_tag = @generator.get_time_of_tag(tag_with_name("valid_tag"))
         of_tag
       end
       it { is_expected.to be_a_kind_of(Time) }
@@ -229,13 +232,13 @@ describe GitHubChangelogGenerator::Generator do
       @generator.sort_tags_by_date(tags)
     end
     context "sort unsorted tags" do
-      let(:tags) { tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3) }
+      let(:tags) { tags_from_strings %w(valid_tag1 valid_tag2 valid_tag3) }
 
       it { is_expected.to be_a_kind_of(Array) }
       it { is_expected.to match_array(tags.reverse!) }
     end
     context "sort sorted tags" do
-      let(:tags) { tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1) }
+      let(:tags) { tags_from_strings %w(valid_tag3 valid_tag2 valid_tag1) }
 
       it { is_expected.to be_a_kind_of(Array) }
       it { is_expected.to match_array(tags) }

spec/unit/octo_fetcher_spec.rb

@@ -0,0 +1,528 @@
+# frozen_string_literal: true
+VALID_TOKEN = "0123456789abcdef"
+INVALID_TOKEN = "0000000000000000"
+
+describe GitHubChangelogGenerator::OctoFetcher do
+  let(:options) do
+    {
+      user: "skywinder",
+      project: "changelog_test"
+    }
+  end
+
+  let(:fetcher) { GitHubChangelogGenerator::OctoFetcher.new(options) }
+
+  describe "#check_github_response" do
+    context "when returns successfully" do
+      it "returns block value" do
+        expect(fetcher.send(:check_github_response) { 1 + 1 }).to eq(2)
+      end
+    end
+
+    context "when raises Octokit::Unauthorized" do
+      it "aborts" do
+        expect(fetcher).to receive(:sys_abort).with("Error: wrong GitHub token")
+        fetcher.send(:check_github_response) { raise(Octokit::Unauthorized) }
+      end
+    end
+
+    context "when raises Octokit::Forbidden" do
+      it "sleeps and retries and then aborts" do
+        retry_limit = GitHubChangelogGenerator::OctoFetcher::MAX_FORBIDDEN_RETRIES - 1
+        allow(fetcher).to receive(:sleep_base_interval).exactly(retry_limit).times.and_return(0)
+
+        expect(fetcher).to receive(:sys_abort).with("Exceeded retry limit")
+        fetcher.send(:check_github_response) { raise(Octokit::Forbidden) }
+      end
+    end
+  end
+
+  describe "#fetch_github_token" do
+    token = GitHubChangelogGenerator::OctoFetcher::CHANGELOG_GITHUB_TOKEN
+    context "when token in ENV exist" do
+      before { stub_const("ENV", ENV.to_hash.merge(token => VALID_TOKEN)) }
+      subject { fetcher.send(: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.send(:fetch_github_token) }
+      it { is_expected.to be_nil }
+    end
+
+    context "when token in options and ENV is nil" do
+      let(:options) { { token: VALID_TOKEN } }
+
+      before do
+        stub_const("ENV", ENV.to_hash.merge(token => nil))
+      end
+
+      subject { fetcher.send(:fetch_github_token) }
+      it { is_expected.to eq(VALID_TOKEN) }
+    end
+
+    context "when token in options and ENV specified" do
+      let(:options) { { token: VALID_TOKEN } }
+
+      before do
+        stub_const("ENV", ENV.to_hash.merge(token => "no_matter_what"))
+      end
+
+      subject { fetcher.send(:fetch_github_token) }
+      it { is_expected.to eq(VALID_TOKEN) }
+    end
+  end
+
+  describe "#get_all_tags" do
+    context "when github_fetch_tags returns tags" do
+      it "returns tags" do
+        mock_tags = ["tag"]
+        allow(fetcher).to receive(:github_fetch_tags).and_return(mock_tags)
+        expect(fetcher.get_all_tags).to eq(mock_tags)
+      end
+    end
+  end
+
+  describe "#github_fetch_tags" do
+    context "when wrong token provided", :vcr do
+      let(:options) do
+        {
+          user: "skywinder",
+          project: "changelog_test",
+          token: INVALID_TOKEN
+        }
+      end
+
+      it "should raise Unauthorized error" do
+        expect { fetcher.github_fetch_tags }.to raise_error SystemExit, "Error: wrong GitHub token"
+      end
+    end
+
+    context "when API call is valid", :vcr do
+      it "should return tags" do
+        expected_tags = [{ "name"        => "v0.0.3",
+                           "zipball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.3",
+                           "tarball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.3",
+                           "commit"      =>
+                             { "sha" => "a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90",
+                               "url" =>
+                                 "https://api.github.com/repos/skywinder/changelog_test/commits/a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90" } },
+                         { "name"        => "v0.0.2",
+                           "zipball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.2",
+                           "tarball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.2",
+                           "commit"      =>
+                             { "sha" => "9b35bb13dcd15b68e7bcbf10cde5eb937a54f710",
+                               "url" =>
+                                 "https://api.github.com/repos/skywinder/changelog_test/commits/9b35bb13dcd15b68e7bcbf10cde5eb937a54f710" } },
+                         { "name"        => "v0.0.1",
+                           "zipball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.1",
+                           "tarball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.1",
+                           "commit"      =>
+                             { "sha" => "4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d",
+                               "url" =>
+                                 "https://api.github.com/repos/skywinder/changelog_test/commits/4c2d6d1ed58bdb24b870dcb5d9f2ceed0283d69d" } },
+                         { "name"        => "0.0.4",
+                           "zipball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/zipball/0.0.4",
+                           "tarball_url" =>
+                             "https://api.github.com/repos/skywinder/changelog_test/tarball/0.0.4",
+                           "commit"      =>
+                             { "sha" => "ece0c3ab7142b21064b885061c55ede00ef6ce94",
+                               "url" =>
+                                 "https://api.github.com/repos/skywinder/changelog_test/commits/ece0c3ab7142b21064b885061c55ede00ef6ce94" } }]
+
+        expect(fetcher.github_fetch_tags).to eq(expected_tags)
+      end
+
+      it "should return tags count" do
+        tags = fetcher.github_fetch_tags
+        expect(tags.size).to eq(4)
+      end
+    end
+  end
+
+  describe "#fetch_closed_issues_and_pr" do
+    context "when API call is valid", :vcr do
+      it "returns issues" do
+        issues, pull_requests = fetcher.fetch_closed_issues_and_pr
+        expect(issues.size).to eq(7)
+        expect(pull_requests.size).to eq(14)
+      end
+
+      it "returns issue with proper key/values" do
+        issues, _pull_requests = fetcher.fetch_closed_issues_and_pr
+
+        expected_issue = { "url"            => "https://api.github.com/repos/skywinder/changelog_test/issues/14",
+                           "repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
+                           "labels_url"     =>
+                             "https://api.github.com/repos/skywinder/changelog_test/issues/14/labels{/name}",
+                           "comments_url"   =>
+                             "https://api.github.com/repos/skywinder/changelog_test/issues/14/comments",
+                           "events_url"     =>
+                             "https://api.github.com/repos/skywinder/changelog_test/issues/14/events",
+                           "html_url"       => "https://github.com/skywinder/changelog_test/issues/14",
+                           "id"             => 95_419_412,
+                           "number"         => 14,
+                           "title"          => "Issue closed from commit from PR",
+                           "user"           =>
+                             { "login"               => "skywinder",
+                               "id"                  => 3_356_474,
+                               "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                               "gravatar_id"         => "",
+                               "url"                 => "https://api.github.com/users/skywinder",
+                               "html_url"            => "https://github.com/skywinder",
+                               "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                               "following_url"       =>
+                                 "https://api.github.com/users/skywinder/following{/other_user}",
+                               "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                               "starred_url"         =>
+                                 "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                               "subscriptions_url"   => "https://api.github.com/users/skywinder/subscriptions",
+                               "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                               "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                               "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                               "received_events_url" =>
+                                 "https://api.github.com/users/skywinder/received_events",
+                               "type"                => "User",
+                               "site_admin"          => false },
+                           "labels"         => [],
+                           "state"          => "closed",
+                           "locked"         => false,
+                           "assignee"       => nil,
+                           "assignees" => [],
+                           "milestone"      => nil,
+                           "comments"       => 0,
+                           "created_at"     => "2015-07-16T12:06:08Z",
+                           "updated_at"     => "2015-07-16T12:21:42Z",
+                           "closed_at"      => "2015-07-16T12:21:42Z",
+                           "body"           => "" }
+
+        # Convert times to Time
+        expected_issue.each_pair do |k, v|
+          expected_issue[k] = Time.parse(v) if v =~ /^2015-/
+        end
+
+        expect(issues.first).to eq(expected_issue)
+      end
+
+      it "returns pull request with proper key/values" do
+        _issues, pull_requests = fetcher.fetch_closed_issues_and_pr
+
+        expected_pr = { "url"            => "https://api.github.com/repos/skywinder/changelog_test/issues/21",
+                        "repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
+                        "labels_url"     =>
+                          "https://api.github.com/repos/skywinder/changelog_test/issues/21/labels{/name}",
+                        "comments_url"   =>
+                          "https://api.github.com/repos/skywinder/changelog_test/issues/21/comments",
+                        "events_url"     =>
+                          "https://api.github.com/repos/skywinder/changelog_test/issues/21/events",
+                        "html_url"       => "https://github.com/skywinder/changelog_test/pull/21",
+                        "id"             => 124_925_759,
+                        "number"         => 21,
+                        "title"          => "Merged br (should appear in change log with  #20)",
+                        "user"           =>
+                          { "login"               => "skywinder",
+                            "id"                  => 3_356_474,
+                            "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                            "gravatar_id"         => "",
+                            "url"                 => "https://api.github.com/users/skywinder",
+                            "html_url"            => "https://github.com/skywinder",
+                            "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                            "following_url"       =>
+                              "https://api.github.com/users/skywinder/following{/other_user}",
+                            "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                            "starred_url"         =>
+                              "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                            "subscriptions_url"   => "https://api.github.com/users/skywinder/subscriptions",
+                            "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                            "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                            "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                            "received_events_url" =>
+                              "https://api.github.com/users/skywinder/received_events",
+                            "type"                => "User",
+                            "site_admin"          => false },
+                        "labels"         => [],
+                        "state"          => "closed",
+                        "locked"         => false,
+                        "assignee"       => nil,
+                        "assignees" => [],
+                        "milestone"      => nil,
+                        "comments"       => 0,
+                        "created_at"     => "2016-01-05T09:24:08Z",
+                        "updated_at"     => "2016-01-05T09:26:53Z",
+                        "closed_at"      => "2016-01-05T09:24:27Z",
+                        "pull_request"   =>
+                          { "url"       => "https://api.github.com/repos/skywinder/changelog_test/pulls/21",
+                            "html_url"  => "https://github.com/skywinder/changelog_test/pull/21",
+                            "diff_url"  => "https://github.com/skywinder/changelog_test/pull/21.diff",
+                            "patch_url" => "https://github.com/skywinder/changelog_test/pull/21.patch" },
+                        "body"           =>
+                          "to test https://github.com/skywinder/github-changelog-generator/pull/305\r\nshould appear in change log with #20" }
+
+        # Convert times to Time
+        expected_pr.each_pair do |k, v|
+          expected_pr[k] = Time.parse(v) if v =~ /^2016-01/
+        end
+
+        expect(pull_requests.first).to eq(expected_pr)
+      end
+
+      it "returns issues with labels" do
+        issues, _pull_requests = fetcher.fetch_closed_issues_and_pr
+        expected = [[], [], ["Bug"], [], ["enhancement"], ["some label"], []]
+        expect(issues.map { |i| i["labels"].map { |l| l["name"] } }).to eq(expected)
+      end
+
+      it "returns pull_requests with labels" do
+        _issues, pull_requests = fetcher.fetch_closed_issues_and_pr
+        expected = [[], [], [], [], [], ["enhancement"], [], [], ["invalid"], [], [], [], [], ["invalid"]]
+        expect(pull_requests.map { |i| i["labels"].map { |l| l["name"] } }).to eq(expected)
+      end
+    end
+  end
+
+  describe "#fetch_closed_pull_requests" do
+    context "when API call is valid", :vcr do
+      it "returns pull requests" do
+        pull_requests = fetcher.fetch_closed_pull_requests
+        expect(pull_requests.size).to eq(14)
+      end
+
+      it "returns correct pull request keys" do
+        pull_requests = fetcher.fetch_closed_pull_requests
+
+        pr = pull_requests.first
+        expect(pr.keys).to eq(%w(url id html_url diff_url patch_url issue_url number state locked title user body created_at updated_at closed_at merged_at merge_commit_sha assignee assignees milestone commits_url review_comments_url review_comment_url comments_url statuses_url head base _links))
+      end
+    end
+  end
+
+  describe "#fetch_events_async" do
+    context "when API call is valid", :vcr do
+      it "populates issues" do
+        issues = [{ "url"            => "https://api.github.com/repos/skywinder/changelog_test/issues/14",
+                    "repository_url" => "https://api.github.com/repos/skywinder/changelog_test",
+                    "labels_url"     =>
+                      "https://api.github.com/repos/skywinder/changelog_test/issues/14/labels{/name}",
+                    "comments_url"   =>
+                      "https://api.github.com/repos/skywinder/changelog_test/issues/14/comments",
+                    "events_url"     =>
+                      "https://api.github.com/repos/skywinder/changelog_test/issues/14/events",
+                    "html_url"       => "https://github.com/skywinder/changelog_test/issues/14",
+                    "id"             => 95_419_412,
+                    "number"         => 14,
+                    "title"          => "Issue closed from commit from PR",
+                    "user"           =>
+                      { "login"               => "skywinder",
+                        "id"                  => 3_356_474,
+                        "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                        "gravatar_id"         => "",
+                        "url"                 => "https://api.github.com/users/skywinder",
+                        "html_url"            => "https://github.com/skywinder",
+                        "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                        "following_url"       =>
+                          "https://api.github.com/users/skywinder/following{/other_user}",
+                        "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                        "starred_url"         =>
+                          "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                        "subscriptions_url"   =>
+                          "https://api.github.com/users/skywinder/subscriptions",
+                        "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                        "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                        "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                        "received_events_url" =>
+                          "https://api.github.com/users/skywinder/received_events",
+                        "type"                => "User",
+                        "site_admin"          => false },
+                    "labels"         => [],
+                    "state"          => "closed",
+                    "locked"         => false,
+                    "assignee"       => nil,
+                    "assignees" => [],
+                    "milestone"      => nil,
+                    "comments"       => 0,
+                    "created_at"     => "2015-07-16T12:06:08Z",
+                    "updated_at"     => "2015-07-16T12:21:42Z",
+                    "closed_at"      => "2015-07-16T12:21:42Z",
+                    "body"           => "" }]
+
+        # Check that they are blank to begin with
+        expect(issues.first["events"]).to be_nil
+
+        fetcher.fetch_events_async(issues)
+        issue_events = issues.first["events"]
+
+        expected_events = [{ "id"         => 357_462_189,
+                             "url"        =>
+                               "https://api.github.com/repos/skywinder/changelog_test/issues/events/357462189",
+                             "actor"      =>
+                               { "login"               => "skywinder",
+                                 "id"                  => 3_356_474,
+                                 "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                                 "gravatar_id"         => "",
+                                 "url"                 => "https://api.github.com/users/skywinder",
+                                 "html_url"            => "https://github.com/skywinder",
+                                 "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                                 "following_url"       =>
+                                   "https://api.github.com/users/skywinder/following{/other_user}",
+                                 "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                                 "starred_url"         =>
+                                   "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                                 "subscriptions_url"   =>
+                                   "https://api.github.com/users/skywinder/subscriptions",
+                                 "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                                 "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                                 "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                                 "received_events_url" =>
+                                   "https://api.github.com/users/skywinder/received_events",
+                                 "type"                => "User",
+                                 "site_admin"          => false },
+                             "event"      => "referenced",
+                             "commit_id"  => "decfe840d1a1b86e0c28700de5362d3365a29555",
+                             "commit_url" =>
+                               "https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
+                             "created_at" => "2015-07-16T12:21:16Z" },
+                           { "id"         => 357_462_542,
+                             "url"        =>
+                               "https://api.github.com/repos/skywinder/changelog_test/issues/events/357462542",
+                             "actor"      =>
+                               { "login"               => "skywinder",
+                                 "id"                  => 3_356_474,
+                                 "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                                 "gravatar_id"         => "",
+                                 "url"                 => "https://api.github.com/users/skywinder",
+                                 "html_url"            => "https://github.com/skywinder",
+                                 "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                                 "following_url"       =>
+                                   "https://api.github.com/users/skywinder/following{/other_user}",
+                                 "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                                 "starred_url"         =>
+                                   "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                                 "subscriptions_url"   =>
+                                   "https://api.github.com/users/skywinder/subscriptions",
+                                 "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                                 "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                                 "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                                 "received_events_url" =>
+                                   "https://api.github.com/users/skywinder/received_events",
+                                 "type"                => "User",
+                                 "site_admin"          => false },
+                             "event"      => "closed",
+                             "commit_id"  => "decfe840d1a1b86e0c28700de5362d3365a29555",
+                             "commit_url" =>
+                               "https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
+                             "created_at" => "2015-07-16T12:21:42Z" }]
+
+        # Convert times to Time
+        expected_events.map! do |event|
+          event.each_pair do |k, v|
+            event[k] = Time.parse(v) if v =~ /^201[56]-/
+          end
+        end
+
+        expect(issue_events).to eq(expected_events)
+      end
+    end
+  end
+
+  describe "#fetch_date_of_tag" do
+    context "when API call is valid", :vcr do
+      it "returns date" do
+        tag = { "name"        => "v0.0.3",
+                "zipball_url" =>
+                  "https://api.github.com/repos/skywinder/changelog_test/zipball/v0.0.3",
+                "tarball_url" =>
+                  "https://api.github.com/repos/skywinder/changelog_test/tarball/v0.0.3",
+                "commit"      =>
+                  { "sha" => "a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90",
+                    "url" =>
+                      "https://api.github.com/repos/skywinder/changelog_test/commits/a0cba2b1a1ea9011ab07ee1ac140ba5a5eb8bd90" } }
+
+        dt = fetcher.fetch_date_of_tag(tag)
+        expect(dt).to eq(Time.parse("2015-03-04 19:01:48 UTC"))
+      end
+    end
+  end
+
+  describe "#querystring_as_hash" do
+    it "works on the blank URL" do
+      expect { fetcher.send(:querystring_as_hash, "") }.not_to raise_error
+    end
+
+    it "where there are no querystring params" do
+      expect { fetcher.send(:querystring_as_hash, "http://example.com") }.not_to raise_error
+    end
+
+    it "returns a String-keyed Hash of querystring params" do
+      expect(fetcher.send(:querystring_as_hash, "http://example.com/o.html?str=18&wis=12")).to include("wis" => "12", "str" => "18")
+    end
+  end
+
+  describe "#fetch_commit" do
+    context "when API call is valid", :vcr do
+      it "returns commit" do
+        event = { "id"         => 357_462_189,
+                  "url"        =>
+                    "https://api.github.com/repos/skywinder/changelog_test/issues/events/357462189",
+                  "actor"      =>
+                    { "login"               => "skywinder",
+                      "id"                  => 3_356_474,
+                      "avatar_url"          => "https://avatars.githubusercontent.com/u/3356474?v=3",
+                      "gravatar_id"         => "",
+                      "url"                 => "https://api.github.com/users/skywinder",
+                      "html_url"            => "https://github.com/skywinder",
+                      "followers_url"       => "https://api.github.com/users/skywinder/followers",
+                      "following_url"       =>
+                        "https://api.github.com/users/skywinder/following{/other_user}",
+                      "gists_url"           => "https://api.github.com/users/skywinder/gists{/gist_id}",
+                      "starred_url"         =>
+                        "https://api.github.com/users/skywinder/starred{/owner}{/repo}",
+                      "subscriptions_url"   => "https://api.github.com/users/skywinder/subscriptions",
+                      "organizations_url"   => "https://api.github.com/users/skywinder/orgs",
+                      "repos_url"           => "https://api.github.com/users/skywinder/repos",
+                      "events_url"          => "https://api.github.com/users/skywinder/events{/privacy}",
+                      "received_events_url" =>
+                        "https://api.github.com/users/skywinder/received_events",
+                      "type"                => "User",
+                      "site_admin"          => false },
+                  "event"      => "referenced",
+                  "commit_id"  => "decfe840d1a1b86e0c28700de5362d3365a29555",
+                  "commit_url" =>
+                    "https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555",
+                  "created_at" => "2015-07-16T12:21:16Z" }
+        commit = fetcher.fetch_commit(event)
+
+        expectations = [
+          %w(sha decfe840d1a1b86e0c28700de5362d3365a29555),
+          ["url",
+           "https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
+          # OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
+          ["html_url",
+           "https://github.com/skywinder/changelog_test/commit/decfe840d1a1b86e0c28700de5362d3365a29555"],
+          ["author",
+           { "login" => "skywinder", "id" => 3_356_474, "avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
+          ["committer",
+           { "login" => "skywinder", "id" => 3_356_474, "avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=3", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
+          ["parents",
+           [{ "sha" => "7ec095e5e3caceacedabf44d0b9b10da17c92e51",
+              "url" =>
+               "https://api.github.com/repos/skywinder/changelog_test/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
+              # OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
+              "html_url" =>
+               "https://github.com/skywinder/changelog_test/commit/7ec095e5e3caceacedabf44d0b9b10da17c92e51" }]]
+        ]
+
+        expectations.each do |property, val|
+          expect(commit[property]).to eq(val)
+        end
+      end
+    end
+  end
+end

spec/unit/options_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+RSpec.describe GitHubChangelogGenerator::Options do
+  describe "#initialize" do
+    context "with known options" do
+      it "instantiates successfully" do
+        expect(described_class.new(user: "olle")[:user]).to eq("olle")
+      end
+    end
+
+    context "with unknown options" do
+      it "raises an error" do
+        expect do
+          described_class.new(
+            git_remote: "origin",
+            strength: "super-strength",
+            wisdom: "deep"
+          )
+        end.to raise_error("[:strength, :wisdom]")
+      end
+    end
+  end
+
+  describe "#[]=(key, value)" do
+    let(:options) { described_class.new(git_remote: "origin") }
+
+    context "with known options" do
+      it "sets the option value" do
+        expect do
+          options[:git_remote] = "in the cloud"
+        end.to change { options[:git_remote] }.to "in the cloud"
+      end
+    end
+
+    context "with unknown options" do
+      it "raises an error" do
+        expect do
+          options[:charisma] = 8
+        end.to raise_error(":charisma")
+      end
+    end
+  end
+end

spec/unit/reader_spec.rb

@@ -85,10 +85,6 @@ describe GitHubChangelogGenerator::Reader do
     context "angular.js.md" do
       it { is_expected.to be_an(Array) }
       it { is_expected.not_to be_empty }
-      it do
-        pending("Implement heading_level for parser.")
-        expect(subject.count).to eq(134)
-      end
       # it do
       #   pending('Implement heading_level for parser.')
       #   expect(subject.first).to include('version' => '1.4.0-beta.6 cookie-liberation')

spec/vcr/GitHubChangelogGenerator_OctoFetcher/_fetch_events_async/when_API_call_is_valid.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/issues/14/events?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Server":["GitHub.com"],"Date":["Fri, 20 May 2016 06:13:06 GMT"],"Content-Type":["application/json; charset=utf-8"],"Transfer-Encoding":["chunked"],"Status":["200 OK"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["37"],"X-Ratelimit-Reset":["1463724861"],"Cache-Control":["public, max-age=60, s-maxage=60"],"Vary":["Accept","Accept-Encoding"],"Etag":["W/\"4d408c4e8053c706d7255563141ccb80\""],"X-Github-Media-Type":["github.v3; format=json"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Served-By":["2d7a5e35115884240089368322196939"],"X-Github-Request-Id":["6C2F0F69:7F8B:2084B01:573EAAF2"]},"body":{"encoding":"ASCII-8BIT","base64_string":"W3siaWQiOjM1NzQ2MjE4OSwidXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNv\nbS9yZXBvcy9za3l3aW5kZXIvY2hhbmdlbG9nX3Rlc3QvaXNzdWVzL2V2ZW50\ncy8zNTc0NjIxODkiLCJhY3RvciI6eyJsb2dpbiI6InNreXdpbmRlciIsImlk\nIjozMzU2NDc0LCJhdmF0YXJfdXJsIjoiaHR0cHM6Ly9hdmF0YXJzLmdpdGh1\nYnVzZXJjb250ZW50LmNvbS91LzMzNTY0NzQ/dj0zIiwiZ3JhdmF0YXJfaWQi\nOiIiLCJ1cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdp\nbmRlciIsImh0bWxfdXJsIjoiaHR0cHM6Ly9naXRodWIuY29tL3NreXdpbmRl\nciIsImZvbGxvd2Vyc191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3Vz\nZXJzL3NreXdpbmRlci9mb2xsb3dlcnMiLCJmb2xsb3dpbmdfdXJsIjoiaHR0\ncHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvZm9sbG93aW5n\ney9vdGhlcl91c2VyfSIsImdpc3RzX3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1\nYi5jb20vdXNlcnMvc2t5d2luZGVyL2dpc3Rzey9naXN0X2lkfSIsInN0YXJy\nZWRfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5k\nZXIvc3RhcnJlZHsvb3duZXJ9ey9yZXBvfSIsInN1YnNjcmlwdGlvbnNfdXJs\nIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvc3Vi\nc2NyaXB0aW9ucyIsIm9yZ2FuaXphdGlvbnNfdXJsIjoiaHR0cHM6Ly9hcGku\nZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvb3JncyIsInJlcG9zX3VybCI6\nImh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMvc2t5d2luZGVyL3JlcG9z\nIiwiZXZlbnRzX3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vdXNlcnMv\nc2t5d2luZGVyL2V2ZW50c3svcHJpdmFjeX0iLCJyZWNlaXZlZF9ldmVudHNf\ndXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIv\ncmVjZWl2ZWRfZXZlbnRzIiwidHlwZSI6IlVzZXIiLCJzaXRlX2FkbWluIjpm\nYWxzZX0sImV2ZW50IjoicmVmZXJlbmNlZCIsImNvbW1pdF9pZCI6ImRlY2Zl\nODQwZDFhMWI4NmUwYzI4NzAwZGU1MzYyZDMzNjVhMjk1NTUiLCJjb21taXRf\ndXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS9yZXBvcy9za3l3aW5kZXIv\nY2hhbmdlbG9nX3Rlc3QvY29tbWl0cy9kZWNmZTg0MGQxYTFiODZlMGMyODcw\nMGRlNTM2MmQzMzY1YTI5NTU1IiwiY3JlYXRlZF9hdCI6IjIwMTUtMDctMTZU\nMTI6MjE6MTZaIn0seyJpZCI6MzU3NDYyNTQyLCJ1cmwiOiJodHRwczovL2Fw\naS5naXRodWIuY29tL3JlcG9zL3NreXdpbmRlci9jaGFuZ2Vsb2dfdGVzdC9p\nc3N1ZXMvZXZlbnRzLzM1NzQ2MjU0MiIsImFjdG9yIjp7ImxvZ2luIjoic2t5\nd2luZGVyIiwiaWQiOjMzNTY0NzQsImF2YXRhcl91cmwiOiJodHRwczovL2F2\nYXRhcnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tL3UvMzM1NjQ3ND92PTMiLCJn\ncmF2YXRhcl9pZCI6IiIsInVybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20v\ndXNlcnMvc2t5d2luZGVyIiwiaHRtbF91cmwiOiJodHRwczovL2dpdGh1Yi5j\nb20vc2t5d2luZGVyIiwiZm9sbG93ZXJzX3VybCI6Imh0dHBzOi8vYXBpLmdp\ndGh1Yi5jb20vdXNlcnMvc2t5d2luZGVyL2ZvbGxvd2VycyIsImZvbGxvd2lu\nZ191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdpbmRl\nci9mb2xsb3dpbmd7L290aGVyX3VzZXJ9IiwiZ2lzdHNfdXJsIjoiaHR0cHM6\nLy9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3aW5kZXIvZ2lzdHN7L2dpc3Rf\naWR9Iiwic3RhcnJlZF91cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3Vz\nZXJzL3NreXdpbmRlci9zdGFycmVkey9vd25lcn17L3JlcG99Iiwic3Vic2Ny\naXB0aW9uc191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3Nr\neXdpbmRlci9zdWJzY3JpcHRpb25zIiwib3JnYW5pemF0aW9uc191cmwiOiJo\ndHRwczovL2FwaS5naXRodWIuY29tL3VzZXJzL3NreXdpbmRlci9vcmdzIiwi\ncmVwb3NfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHViLmNvbS91c2Vycy9za3l3\naW5kZXIvcmVwb3MiLCJldmVudHNfdXJsIjoiaHR0cHM6Ly9hcGkuZ2l0aHVi\nLmNvbS91c2Vycy9za3l3aW5kZXIvZXZlbnRzey9wcml2YWN5fSIsInJlY2Vp\ndmVkX2V2ZW50c191cmwiOiJodHRwczovL2FwaS5naXRodWIuY29tL3VzZXJz\nL3NreXdpbmRlci9yZWNlaXZlZF9ldmVudHMiLCJ0eXBlIjoiVXNlciIsInNp\ndGVfYWRtaW4iOmZhbHNlfSwiZXZlbnQiOiJjbG9zZWQiLCJjb21taXRfaWQi\nOiJkZWNmZTg0MGQxYTFiODZlMGMyODcwMGRlNTM2MmQzMzY1YTI5NTU1Iiwi\nY29tbWl0X3VybCI6Imh0dHBzOi8vYXBpLmdpdGh1Yi5jb20vcmVwb3Mvc2t5\nd2luZGVyL2NoYW5nZWxvZ190ZXN0L2NvbW1pdHMvZGVjZmU4NDBkMWExYjg2\nZTBjMjg3MDBkZTUzNjJkMzM2NWEyOTU1NSIsImNyZWF0ZWRfYXQiOiIyMDE1\nLTA3LTE2VDEyOjIxOjQyWiJ9XQ==\n"},"http_version":null},"recorded_at":"Fri, 20 May 2016 06:13:10 GMT"}],"recorded_with":"VCR 3.0.1"}

spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_wrong_token_provided.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/tags?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Authorization":["token 0000000000000000"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":401,"message":"Unauthorized"},"headers":{"Server":["GitHub.com"],"Date":["Fri, 20 May 2016 05:47:03 GMT"],"Content-Type":["application/json; charset=utf-8"],"Content-Length":["83"],"Status":["401 Unauthorized"],"X-Github-Media-Type":["github.v3; format=json"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["42"],"X-Ratelimit-Reset":["1463724861"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Github-Request-Id":["6C2F0F69:1271A:B8980B7:573EA4D6"]},"body":{"encoding":"UTF-8","base64_string":"eyJtZXNzYWdlIjoiQmFkIGNyZWRlbnRpYWxzIiwiZG9jdW1lbnRhdGlvbl91\ncmwiOiJodHRwczovL2RldmVsb3Blci5naXRodWIuY29tL3YzIn0=\n"},"http_version":null},"recorded_at":"Fri, 20 May 2016 05:47:07 GMT"}],"recorded_with":"VCR 3.0.1"}

spec/vcr/GitHubChangelogGenerator_OctoFetcher/_github_fetch_tags/when_wrong_token_provided/should_raise_Unauthorized_error.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/repos/skywinder/changelog_test/tags?per_page=100","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.v3+json"],"User-Agent":["Octokit Ruby Gem 4.3.0"],"Content-Type":["application/json"],"Authorization":["token 0000000000000000"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":401,"message":"Unauthorized"},"headers":{"Server":["GitHub.com"],"Date":["Sat, 02 Jul 2016 14:13:57 GMT"],"Content-Type":["application/json; charset=utf-8"],"Content-Length":["83"],"Status":["401 Unauthorized"],"X-Github-Media-Type":["github.v3; format=json"],"X-Ratelimit-Limit":["60"],"X-Ratelimit-Remaining":["59"],"X-Ratelimit-Reset":["1467472437"],"Access-Control-Expose-Headers":["ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval"],"Access-Control-Allow-Origin":["*"],"Content-Security-Policy":["default-src 'none'"],"Strict-Transport-Security":["max-age=31536000; includeSubdomains; preload"],"X-Content-Type-Options":["nosniff"],"X-Frame-Options":["deny"],"X-Xss-Protection":["1; mode=block"],"X-Github-Request-Id":["54DBAB83:300E:76DBC85:5777CC25"]},"body":{"encoding":"UTF-8","base64_string":"eyJtZXNzYWdlIjoiQmFkIGNyZWRlbnRpYWxzIiwiZG9jdW1lbnRhdGlvbl91\ncmwiOiJodHRwczovL2RldmVsb3Blci5naXRodWIuY29tL3YzIn0=\n"},"http_version":null},"recorded_at":"Sat, 02 Jul 2016 14:13:58 GMT"}],"recorded_with":"VCR 3.0.1"}