github_changelog_generator 1.13.2 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 336a1ac8b95b7e15cb682b2f073fcad6c3de1eae
-  data.tar.gz: 2ab6a245bf80a345de5fd1cedeab7aa49779b53b
+  metadata.gz: 28ce5bfbf45c423de7b0e00662def73cb31dab48
+  data.tar.gz: 0f0ce064c6c069ce90d0186f308be3bdfce966cf
 SHA512:
-  metadata.gz: 78bc7037133a625102719ed21ea878e1f065dd92252052142c973be0f7cfa3236e06916a88574c1ae9534cdde100b8b202dc7aa40445a891c14a980de9608953
-  data.tar.gz: 887ee7d59c311859c8bfe55488f6a3985551fd28e16f981b8de43244239e7660af5f54ab30b8fb1759d2d19eca72968ab3b04d7d31383953bea46cff0c593349
+  metadata.gz: a855f3b32548927042e54979e40e296999636c0a2e7fbfb6c3bb5ab228ae013803a15219361b540eb7aa1bac677e0c85ac340de57a8168e8311e29d054aa5947
+  data.tar.gz: 4c8412f7522e7941ce4255a2b246c975013cf2fe99534fe716d275e28ce5fe668f00586e42a3605806b900673e71c112a0ae756888131d82b0dd5c113daf4b33

data/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

data/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"

data/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

data/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

data/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,9 +125,10 @@ module GitHubChangelogGenerator
 
     def generate_unreleased_section
       log = ""
-      if @options[:unreleased]
-        unreleased_log = generate_log_between_tags(filtered_tags[0], nil)
-        log += unreleased_log if unreleased_log
+      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
     end
@@ -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 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
+
     def issue_line_with_user(line, issue)
-      return line if !@options[:author] || issue.pull_request.nil?
+      return line if !options[:author] || issue["pull_request"].nil?
 
-      user = issue.user
+      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

data/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