github_changelog_generator 1.15.0.pre.rc → 1.15.0

data/lib/github_changelog_generator/generator/generator_processor.rb

@@ -2,7 +2,7 @@
 
 module GitHubChangelogGenerator
   class Generator
-    # delete all labels with labels from options[:exclude_labels] array
+    # delete all issues with labels from options[:exclude_labels] array
     # @param [Array] issues
     # @return [Array] filtered array
     def exclude_issues_by_labels(issues)
@@ -14,6 +14,19 @@ module GitHubChangelogGenerator
       end
     end
 
+    # Only include issues without labels if options[:add_issues_wo_labels]
+    # @param [Array] issues
+    # @return [Array] filtered array
+    def exclude_issues_without_labels(issues)
+      return issues if issues.empty?
+      return issues if issues.first.key?("pull_request") && options[:add_pr_wo_labels]
+      return issues if !issues.first.key?("pull_request") && options[:add_issues_wo_labels]
+
+      issues.reject do |issue|
+        issue["labels"].empty?
+      end
+    end
+
     # @return [Array] filtered issues accourding milestone
     def filter_by_milestone(filtered_issues, tag_name, all_issues)
       remove_issues_in_milestones(filtered_issues)
@@ -63,11 +76,22 @@ module GitHubChangelogGenerator
       end
     end
 
+    # Method filter issues, that belong only specified tag range
+    #
+    # @param [Array] issues issues to filter
+    # @param [Hash, Nil] newer_tag Tag to find PRs of. May be nil for unreleased section
+    # @return [Array] filtered issues
+    def filter_by_tag(issues, newer_tag = nil)
+      issues.select do |issue|
+        issue["first_occurring_tag"] == (newer_tag.nil? ? nil : newer_tag["name"])
+      end
+    end
+
     # Method filter issues, that belong only specified tag range
     # @param [Array] issues issues to filter
     # @param [Symbol] hash_key key of date value default is :actual_date
-    # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
-    # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
+    # @param [Hash, Nil] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
+    # @param [Hash, Nil] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
     # @return [Array] filtered issues
     def delete_by_time(issues, hash_key = "actual_date", older_tag = nil, newer_tag = nil)
       # in case if not tags specified - return unchanged array
@@ -97,9 +121,11 @@ module GitHubChangelogGenerator
 
     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
 
@@ -112,11 +138,11 @@ module GitHubChangelogGenerator
       tag_in_range_new
     end
 
-    def tag_newer_old_tag?(older_tag_time, t)
+    def tag_newer_old_tag?(older_tag_time, time)
       tag_in_range_old = if older_tag_time.nil?
                            true
                          else
-                           t > older_tag_time
+                           time > older_tag_time
                          end
       tag_in_range_old
     end
@@ -130,33 +156,37 @@ module GitHubChangelogGenerator
       filtered_issues
     end
 
-    # @return [Array] issues without labels or empty array if add_issues_wo_labels is false
+    # @param [Array] issues Issues & PRs to filter when without labels
+    # @return [Array] Issues & PRs without labels or empty array if
+    #                 add_issues_wo_labels or add_pr_wo_labels are false
     def filter_wo_labels(issues)
-      if options[:add_issues_wo_labels]
+      if (!issues.empty? && issues.first.key?("pull_requests") && options[:add_pr_wo_labels]) || options[:add_issues_wo_labels]
         issues
       else
         issues.select { |issue| issue["labels"].map { |l| l["name"] }.any? }
       end
     end
 
+    # @todo Document this
     def filter_by_include_labels(issues)
       if options[:include_labels].nil?
         issues
       else
         issues.select do |issue|
           labels = issue["labels"].map { |l| l["name"] } & options[:include_labels]
-          labels.any?
+          labels.any? || issue["labels"].empty?
         end
       end
     end
 
     # General filtered function
     #
-    # @param [Array] all_issues
+    # @param [Array] all_issues PRs or issues
     # @return [Array] filtered issues
     def filter_array_by_labels(all_issues)
       filtered_issues = include_issues_by_labels(all_issues)
-      exclude_issues_by_labels(filtered_issues)
+      filtered_issues = exclude_issues_by_labels(filtered_issues)
+      exclude_issues_without_labels(filtered_issues)
     end
 
     # Filter issues according labels

data/lib/github_changelog_generator/generator/generator_tags.rb

@@ -4,8 +4,8 @@ module GitHubChangelogGenerator
   class Generator
     # fetch, filter tags, fetch dates and sort them in time order
     def fetch_and_filter_tags
-      detect_since_tag
-      detect_due_tag
+      since_tag
+      due_tag
 
       all_tags = @fetcher.get_all_tags
       fetch_tags_dates(all_tags) # Creates a Hash @tag_times_hash
@@ -35,7 +35,7 @@ module GitHubChangelogGenerator
         tag = section_tags[i]
 
         # Don't create section header for the "since" tag
-        next if @since_tag && tag["name"] == @since_tag
+        next if since_tag && tag["name"] == since_tag
 
         # Don't create a section header for the first tag in between_tags
         next if options[:between_tags] && tag == section_tags.last
@@ -98,11 +98,11 @@ module GitHubChangelogGenerator
     end
 
     # @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
-    def detect_since_tag
+    def since_tag
       @since_tag ||= options.fetch(:since_tag) { version_of_first_item }
     end
 
-    def detect_due_tag
+    def due_tag
       @due_tag ||= options.fetch(:due_tag, nil)
     end
 
@@ -125,7 +125,7 @@ module GitHubChangelogGenerator
     # @return [Array] filtered tags according :since_tag option
     def filter_since_tag(all_tags)
       filtered_tags = all_tags
-      tag = detect_since_tag
+      tag = since_tag
       if tag
         if all_tags.map { |t| t["name"] }.include? tag
           idx = all_tags.index { |t| t["name"] == tag }
@@ -135,7 +135,7 @@ module GitHubChangelogGenerator
                             []
                           end
         else
-          Helper.log.warn "Warning: can't find tag #{tag}, specified with --since-tag option."
+          raise ChangelogGeneratorError, "Error: can't find tag #{tag}, specified with --since-tag option."
         end
       end
       filtered_tags
@@ -145,7 +145,7 @@ module GitHubChangelogGenerator
     # @return [Array] filtered tags according :due_tag option
     def filter_due_tag(all_tags)
       filtered_tags = all_tags
-      tag           = detect_due_tag
+      tag           = due_tag
       if tag
         if all_tags.any? && all_tags.map { |t| t["name"] }.include?(tag)
           idx = all_tags.index { |t| t["name"] == tag }
@@ -155,7 +155,7 @@ module GitHubChangelogGenerator
                             []
                           end
         else
-          Helper.log.warn "Warning: can't find tag #{tag}, specified with --due-tag option."
+          raise ChangelogGeneratorError, "Error: can't find tag #{tag}, specified with --due-tag option."
         end
       end
       filtered_tags
@@ -208,9 +208,7 @@ module GitHubChangelogGenerator
     end
 
     def warn_if_tag_not_found(all_tags, 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
+      Helper.log.warn("Warning: can't find tag #{tag}, specified with --exclude-tags option.") unless all_tags.map { |t| t["name"] }.include?(tag)
     end
   end
 end

data/lib/github_changelog_generator/generator/section.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module GitHubChangelogGenerator
+  # This class generates the content for a single section of a changelog entry.
+  # It turns the tagged issues and PRs into a well-formatted list of changes to
+  # be later incorporated into a changelog entry.
+  #
+  # @see GitHubChangelogGenerator::Entry
+  class Section
+    attr_accessor :name, :prefix, :issues, :labels, :body_only
+
+    def initialize(opts = {})
+      @name = opts[:name]
+      @prefix = opts[:prefix]
+      @labels = opts[:labels] || []
+      @issues = opts[:issues] || []
+      @options = opts[:options] || Options.new({})
+      @body_only = opts[:body_only] || false
+    end
+
+    # Returns the content of a section.
+    #
+    # @return [String] Generate section content
+    def generate_content
+      content = ""
+
+      if @issues.any?
+        content += "#{@prefix}\n\n" unless @options[:simple_list] || @prefix.blank?
+        @issues.each do |issue|
+          merge_string = get_string_for_issue(issue)
+          content += "- " unless @body_only
+          content += "#{merge_string}\n"
+        end
+        content += "\n"
+      end
+      content
+    end
+
+    private
+
+    # Parse issue and generate single line formatted issue line.
+    #
+    # Example output:
+    # - Add coveralls integration [\#223](https://github.com/github-changelog-generator/github-changelog-generator/pull/223) (@github-changelog-generator)
+    #
+    # @param [Hash] issue Fetched issue from GitHub
+    # @return [String] Markdown-formatted single issue
+    def get_string_for_issue(issue)
+      encapsulated_title = encapsulate_string issue["title"]
+
+      title_with_number = "#{encapsulated_title} [\\##{issue['number']}](#{issue['html_url']})"
+      title_with_number = "#{title_with_number}#{line_labels_for(issue)}" if @options[:issue_line_labels].present?
+      line = issue_line_with_user(title_with_number, issue)
+      issue_line_with_body(line, issue)
+    end
+
+    def issue_line_with_body(line, issue)
+      return issue["body"] if @body_only && issue["body"].present?
+      return line if !@options[:issue_line_body] || issue["body"].blank?
+
+      # get issue body till first line break
+      body_paragraph = body_till_first_break(issue["body"])
+      # remove spaces from begining and end of the string
+      body_paragraph.rstrip!
+      # encapsulate to md
+      encapsulated_body = "\s\s\n" + encapsulate_string(body_paragraph)
+
+      "**#{line}** #{encapsulated_body}"
+    end
+
+    def body_till_first_break(body)
+      body.split(/\n/).first
+    end
+
+    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']})"
+      else
+        "#{line} ([#{user['login']}](#{user['html_url']}))"
+      end
+    end
+
+    ENCAPSULATED_CHARACTERS = %w(< > * _ \( \) [ ] #)
+
+    # Encapsulate characters to make Markdown look as expected.
+    #
+    # @param [String] string
+    # @return [String] encapsulated input string
+    def encapsulate_string(string)
+      string = string.gsub('\\', '\\\\')
+
+      ENCAPSULATED_CHARACTERS.each do |char|
+        string = string.gsub(char, "\\#{char}")
+      end
+
+      string
+    end
+  end
+end

data/lib/github_changelog_generator/octo_fetcher.rb

@@ -10,10 +10,10 @@ module GitHubChangelogGenerator
   # fetcher = GitHubChangelogGenerator::OctoFetcher.new(options)
   class OctoFetcher
     PER_PAGE_NUMBER   = 100
-    MAX_THREAD_NUMBER = 25
+    MAX_THREAD_NUMBER = 10
     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 " \
+    GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, changelog 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!"
@@ -33,6 +33,8 @@ module GitHubChangelogGenerator
       @http_cache   = @options[:http_cache]
       @cache_file   = nil
       @cache_log    = nil
+      @commits      = []
+      @compares     = {}
       prepare_cache
       configure_octokit_ssl
       @client = Octokit::Client.new(github_options)
@@ -40,6 +42,7 @@ module GitHubChangelogGenerator
 
     def prepare_cache
       return unless @http_cache
+
       @cache_file = @options.fetch(:cache_file) { File.join(Dir.tmpdir, "github-changelog-http-cache") }
       @cache_log  = @options.fetch(:cache_log) { File.join(Dir.tmpdir, "github-changelog-logger.log") }
       init_cache
@@ -55,7 +58,7 @@ module GitHubChangelogGenerator
     end
 
     def configure_octokit_ssl
-      ca_file = @options[:ssl_ca_file] || ENV["SSL_CA_FILE"] || File.expand_path("../ssl_certs/cacert.pem", __FILE__)
+      ca_file = @options[:ssl_ca_file] || ENV["SSL_CA_FILE"] || File.expand_path("ssl_certs/cacert.pem", __dir__)
       Octokit.connection_options = { ssl: { ca_file: ca_file } }
     end
 
@@ -138,7 +141,7 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     def fetch_closed_issues_and_pr
       print "Fetching closed issues...\r" if @options[:verbose]
       issues = []
-      page_i      = 0
+      page_i = 0
       count_pages = calculate_pages(@client, "issues", closed_pr_options)
 
       iterate_pages(@client, "issues", closed_pr_options) do |new_issues|
@@ -162,10 +165,6 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
       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)
 
@@ -211,38 +210,129 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
       Helper.log.info "Fetching events for issues and PR: #{i}"
     end
 
+    # Fetch comments for PRs and add them to "comments"
+    #
+    # @param [Array] prs The array of PRs.
+    # @return [Void] No return; PRs are updated in-place.
+    def fetch_comments_async(prs)
+      threads = []
+
+      prs.each_slice(MAX_THREAD_NUMBER) do |prs_slice|
+        prs_slice.each do |pr|
+          threads << Thread.new do
+            pr["comments"] = []
+            iterate_pages(@client, "issue_comments", pr["number"]) do |new_comment|
+              pr["comments"].concat(new_comment)
+            end
+            pr["comments"] = pr["comments"].map { |comment| stringify_keys_deep(comment.to_hash) }
+          end
+        end
+        threads.each(&:join)
+        threads = []
+      end
+      nil
+    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 = fetch_commit(tag["commit"]["sha"])
       commit_data = stringify_keys_deep(commit_data.to_hash)
 
       commit_data["commit"]["committer"]["date"]
     end
 
+    # Fetch and cache comparison between two github refs
+    #
+    # @param [String] older The older sha/tag/branch.
+    # @param [String] newer The newer sha/tag/branch.
+    # @return [Hash] Github api response for comparison.
+    def fetch_compare(older, newer)
+      unless @compares["#{older}...#{newer}"]
+        compare_data = check_github_response { @client.compare(user_project, older, newer || "HEAD") }
+        raise StandardError, "Sha #{older} and sha #{newer} are not related; please file a github-changelog-generator issues and describe how to replicate this issue." if compare_data["status"] == "diverged"
+
+        @compares["#{older}...#{newer}"] = stringify_keys_deep(compare_data.to_hash)
+      end
+      @compares["#{older}...#{newer}"]
+    end
+
     # Fetch commit for specified event
     #
+    # @param [String] commit_id the SHA of a commit to fetch
     # @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
+    def fetch_commit(commit_id)
+      found = commits.find do |commit|
+        commit["sha"] == commit_id
+      end
+      if found
+        stringify_keys_deep(found.to_hash)
+      else
+        # cache miss; don't add to @commits because unsure of order.
+        check_github_response do
+          commit = @client.commit(user_project, commit_id)
+          commit = stringify_keys_deep(commit.to_hash)
+          commit
+        end
       end
     end
 
-    # Fetch all commits before certain point
+    # Fetch all commits
     #
-    # @return [String]
-    def commits_before(start_time)
-      commits = []
-      iterate_pages(@client, "commits_before", start_time.to_datetime.to_s) do |new_commits|
-        commits.concat(new_commits)
+    # @return [Array] Commits in a repo.
+    def commits
+      if @commits.empty?
+        iterate_pages(@client, "commits") do |new_commits|
+          @commits.concat(new_commits)
+        end
       end
-      commits
+      @commits
+    end
+
+    # Return the oldest commit in a repo
+    #
+    # @return [Hash] Oldest commit in the github git history.
+    def oldest_commit
+      commits.last
+    end
+
+    # @return [String] Default branch of the repo
+    def default_branch
+      @default_branch ||= @client.repository(user_project)[:default_branch]
+    end
+
+    # Fetch all SHAs occurring in or before a given tag and add them to
+    # "shas_in_tag"
+    #
+    # @param [Array] tags The array of tags.
+    # @return [Nil] No return; tags are updated in-place.
+    def fetch_tag_shas_async(tags)
+      i = 0
+      threads = []
+      print_in_same_line("Fetching SHAs for tags: #{i}/#{tags.count}\r") if @options[:verbose]
+
+      tags.each_slice(MAX_THREAD_NUMBER) do |tags_slice|
+        tags_slice.each do |tag|
+          threads << Thread.new do
+            # Use oldest commit because comparing two arbitrary tags may be diverged
+            commits_in_tag = fetch_compare(oldest_commit["sha"], tag["name"])
+            tag["shas_in_tag"] = commits_in_tag["commits"].collect { |commit| commit["sha"] }
+            print_in_same_line("Fetching SHAs for tags: #{i + 1}/#{tags.count}") if @options[:verbose]
+            i += 1
+          end
+        end
+        threads.each(&:join)
+        threads = []
+      end
+
+      # to clear line from prev print
+      print_empty_line
+
+      Helper.log.info "Fetching SHAs for tags: #{i}"
+      nil
     end
 
     private
@@ -316,8 +406,8 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     end
 
     # Presents the exception, and the aborts with the message.
-    def fail_with_message(e, message)
-      Helper.log.error("#{e.class}: #{e.message}")
+    def fail_with_message(error, message)
+      Helper.log.error("#{error.class}: #{error.message}")
       sys_abort(message)
     end