github_changelog_generator 1.3.11 → 1.4.0

data/lib/github_changelog_generator/fetcher.rb

@@ -0,0 +1,209 @@
+require "logger"
+
+module GitHubChangelogGenerator
+  # A Fetcher responsible for all requests to GitHub and all basic manipulation with related data
+  # (such as filtering, validating, e.t.c)
+  #
+  # Example:
+  # fetcher = GitHubChangelogGenerator::Fetcher.new options
+  class Fetcher
+    PER_PAGE_NUMBER = 30
+    GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: GitHub API rate limit (5000 per hour) exceeded, change log may be " \
+        "missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
+
+    def initialize(options = {})
+      @options = options
+
+      @user = @options[:user]
+      @project = @options[:project]
+      @github_token = fetch_github_token
+      @tag_times_hash = {}
+
+      @logger = Logger.new(STDOUT)
+      @logger.formatter = proc do |_severity, _datetime, _progname, msg|
+        "#{msg}\n"
+      end
+      github_options = { per_page: PER_PAGE_NUMBER }
+      github_options[:oauth_token] = @github_token unless @github_token.nil?
+      github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
+      github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
+
+      begin
+        @github = Github.new github_options
+      rescue
+        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+    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)
+
+      unless env_var
+        @logger.warn "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
+        @logger.warn "This script can make only 50 requests to GitHub API per hour without token!".yellow
+      end
+
+      env_var
+    end
+
+    # Fetch all tags from repo
+    # @return [Array] array of tags
+    def get_all_tags
+      if @options[:verbose]
+        print "Fetching tags...\r"
+      end
+
+      tags = []
+
+      begin
+        response = @github.repos.tags @options[:user], @options[:project]
+        page_i = 0
+        count_pages = response.count_pages
+        response.each_page do |page|
+          page_i += PER_PAGE_NUMBER
+          print "Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
+          tags.concat(page)
+        end
+        print "                               \r"
+
+        if tags.count == 0
+          @logger.warn "Warning: Can't find any tags in repo.\
+Make sure, that you push tags to remote repo via 'git push --tags'".yellow
+        elsif @options[:verbose]
+          @logger.info "Found #{tags.count} tags"
+        end
+
+      rescue
+        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+
+      tags
+    end
+
+    # This method fetch all closed issues and separate them to pull requests and pure issues
+    # (pull request is kind of issue in term of GitHub)
+    # @return [Tuple] with issues and pull requests
+    def fetch_issues_and_pull_requests
+      if @options[:verbose]
+        print "Fetching closed issues...\r"
+      end
+      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 "Fetching issues... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
+          issues.concat(page)
+          break if @options[:max_issues] && issues.length >= @options[:max_issues]
+        end
+      rescue
+        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+
+      print "                                                \r"
+
+      if @options[:verbose]
+        @logger.info "Received issues: #{issues.count}"
+      end
+
+      # remove pull request from issues:
+      issues.partition { |x|
+        x[:pull_request].nil?
+      }
+    end
+
+    # Fetch all pull requests. We need them to detect :merged_at parameter
+    # @return [Array] all pull requests
+    def fetch_pull_requests
+      pull_requests = []
+      begin
+        response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
+        page_i = 0
+        response.each_page do |page|
+          page_i += PER_PAGE_NUMBER
+          count_pages = response.count_pages
+          print "Fetching merged dates... #{page_i}/#{count_pages * PER_PAGE_NUMBER}\r"
+          pull_requests.concat(page)
+        end
+      rescue
+        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+
+      print "                                                   \r"
+      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
+      max_thread_number = 50
+      threads = []
+      issues.each_slice(max_thread_number) { |issues_slice|
+        issues_slice.each { |issue|
+          threads << Thread.new {
+            begin
+              obj = @github.issues.events.list user: @options[:user],
+                                               repo: @options[:project],
+                                               issue_number: issue["number"]
+            rescue
+              @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+            end
+            issue[:events] = obj.body
+            print "Fetching events for issues and PR: #{i + 1}/#{issues.count}\r"
+            i += 1
+          }
+        }
+        threads.each(&:join)
+        threads = []
+      }
+
+      # to clear line from prev print
+      print "                                                            \r"
+
+      if @options[:verbose]
+        @logger.info "Fetching events for issues and PR: #{i} Done!"
+      end
+    end
+
+    # Try to find tag date in local hash.
+    # Otherwise fFetch tag time and put it to local hash file.
+    # @param [String] tag_name name of the tag
+    # @return [Time] time of specified tag
+    def get_time_of_tag(tag_name)
+      fail ChangelogGeneratorError, "tag_name is nil".red if tag_name.nil?
+
+      if @tag_times_hash[tag_name["name"]]
+        return @tag_times_hash[tag_name["name"]]
+      end
+
+      begin
+        github_git_data_commits_get = @github.git_data.commits.get @options[:user],
+                                                                   @options[:project],
+                                                                   tag_name["commit"]["sha"]
+      rescue
+        @logger.warn GH_RATE_LIMIT_EXCEEDED_MSG.yellow
+      end
+      time_string = github_git_data_commits_get["committer"]["date"]
+      @tag_times_hash[tag_name["name"]] = Time.parse(time_string)
+    end
+
+    # Fetch commit for specifed event
+    # @return [Hash]
+    def fetch_commit(event)
+      @github.git_data.commits.get @options[:user], @options[:project], event[:commit_id]
+    end
+  end
+end

data/lib/github_changelog_generator/generator.rb

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

data/lib/github_changelog_generator/parser.rb

@@ -1,114 +1,142 @@
 #!/usr/bin/env ruby
-require 'optparse'
-require 'pp'
-require_relative 'version'
+require "optparse"
+require "pp"
+require_relative "version"
 
 module GitHubChangelogGenerator
   class Parser
     def self.parse_options
-
       options = {
-          :tag1 => nil,
-          :tag2 => nil,
-          :format => '%Y-%m-%d',
-          :output => 'CHANGELOG.md',
-          :exclude_labels => %w(duplicate question invalid wontfix),
-          :pulls => true,
-          :issues => true,
-          :verbose => true,
-          :add_issues_wo_labels => true,
-          :add_pr_wo_labels => true,
-          :merge_prefix => '**Merged pull requests:**',
-          :issue_prefix => '**Closed issues:**',
-          :bug_prefix => '**Fixed bugs:**',
-          :enhancement_prefix => '**Implemented enhancements:**',
-          :author => true,
-          :filter_issues_by_milestone => true,
-          :compare_link => true,
-          :unreleased => true,
-          :unreleased_label => 'Unreleased',
-          :branch => 'origin'
+        tag1: nil,
+        tag2: nil,
+        dateformat: "%Y-%m-%d",
+        output: "CHANGELOG.md",
+        issues: true,
+        add_issues_wo_labels: true,
+        add_pr_wo_labels: true,
+        pulls: true,
+        filter_issues_by_milestone: true,
+        author: true,
+        unreleased: true,
+        unreleased_label: "Unreleased",
+        compare_link: true,
+        include_labels: %w(bug enhancement),
+        exclude_labels: %w(duplicate question invalid wontfix),
+        max_issues: nil,
+        simple_list: false,
+        verbose: true,
+
+        merge_prefix: "**Merged pull requests:**",
+        issue_prefix: "**Closed issues:**",
+        bug_prefix: "**Fixed bugs:**",
+        enhancement_prefix: "**Implemented enhancements:**",
+        branch: "origin"
       }
 
-      parser = OptionParser.new { |opts|
-        opts.banner = 'Usage: github_changelog_generator [options]'
-        opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: github_changelog_generator [options]"
+        opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
           options[:user] = last
         end
-        opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
+        opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last|
           options[:project] = last
         end
-        opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new') do |last|
+        opts.on("-t", "--token [TOKEN]", "To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last|
           options[:token] = last
         end
-        opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
-          options[:format] = last
+        opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
+          options[:dateformat] = last
         end
-        opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
+        opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
           options[:output] = last
         end
-        opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
+        opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
           options[:issues] = v
         end
-        opts.on('--[no-]issues-wo-labels', 'Include closed issues without labels to changelog. Default is true') do |v|
+        opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true") do |v|
           options[:add_issues_wo_labels] = v
         end
-        opts.on('--[no-]pr-wo-labels', 'Include pull requests without labels to changelog. Default is true') do |v|
+        opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true") do |v|
           options[:add_pr_wo_labels] = v
         end
-        opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
+        opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true") do |v|
           options[:pulls] = v
         end
-        opts.on('--[no-]filter-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
+        opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true") do |last|
           options[:filter_issues_by_milestone] = last
         end
-        opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
+        opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
           options[:author] = author
         end
-        opts.on('--unreleased-only', 'Generate log from unreleased closed issues only.') do |v|
+        opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
           options[:unreleased_only] = v
         end
-        opts.on('--[no-]unreleased', 'Add to log unreleased closed issues. Default is true') do |v|
+        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]", "Add to log unreleased closed issues. Default is true") do |v|
           options[:unreleased_label] = v
         end
-        opts.on('--[no-]compare-link', 'Include compare link (Full Changelog) between older version and newer version. Default is true') do |v|
+        opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true") do |v|
           options[:compare_link] = v
         end
-        opts.on('--include-labels  x,y,z', Array, 'Issues only with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
+        opts.on("--include-labels  x,y,z", Array, 'Only issues with the specified labels will be included in the changelog. Default is \'bug,enhancement\'') do |list|
           options[:include_labels] = list
         end
-        opts.on('--exclude-labels  x,y,z', Array, 'Issues with that labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
+        opts.on("--exclude-labels  x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
           options[:exclude_labels] = list
         end
-        opts.on('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
+        opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
+          options[:max_issues] = max
+        end
+        opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
           options[:github_site] = last
         end
-        opts.on('--github-api [URL]', 'The enterprise endpoint to use for your Github API.') do |last|
+        opts.on("--github-api [URL]", "The enterprise endpoint to use for your Github API.") do |last|
           options[:github_endpoint] = last
         end
-        opts.on('--simple-list', 'Create simple list from issues and pull requests. Default is false.') do |v|
+        opts.on("--simple-list", "Create simple list from issues and pull requests. Default is false.") do |v|
           options[:simple_list] = v
         end
-        opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
+        opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
           options[:verbose] = v
         end
-        opts.on('-v', '--version', 'Print version number') do |v|
+        opts.on("-v", "--version", "Print version number") do |_v|
           puts "Version: #{GitHubChangelogGenerator::VERSION}"
           exit
         end
-        opts.on('-h', '--help', 'Displays Help') do
+        opts.on("-h", "--help", "Displays Help") do
           puts opts
           exit
         end
-      }
+      end
 
       parser.parse!
 
+      detect_user_and_project(options)
+
+      if !options[:user] || !options[:project]
+        puts parser.banner
+        exit
+      end
+
+      if ARGV[1]
+        options[:tag1] = ARGV[0]
+        options[:tag2] = ARGV[1]
+      end
+
+      if options[:verbose]
+        puts "Performing task with options:"
+        pp options
+        puts ""
+      end
+
+      options
+    end
+
+    def self.detect_user_and_project(options)
       if ARGV[0] && !ARGV[1]
-        github_site = options[:github_site] ? options[:github_site] : 'github.com'
+        github_site = options[:github_site] ? options[:github_site] : "github.com"
         # this match should parse  strings such "https://github.com/skywinder/Github-Changelog-Generator" or "skywinder/Github-Changelog-Generator" to user and name
         match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
 
@@ -122,52 +150,37 @@ module GitHubChangelogGenerator
           exit
         else
           options[:user] = match[1]
-          options[:project]= match[2]
+          options[:project] = match[2]
         end
 
-
       end
 
       if !options[:user] && !options[:project]
-        remote = `git config --get remote.#{options[:branch]}.url`
-        # try to find repo in format:
-        # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
-        # git@github.com:skywinder/Github-Changelog-Generator.git
-        match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/.match(remote)
-
-        if match && match[1] && match[2]
-          puts "Detected user:#{match[1]}, project:#{match[2]}"
-          options[:user], options[:project] = match[1], match[2]
+        if ENV["RUBYLIB"] =~ /ruby-debug-ide/
+          options[:user] = "skywinder"
+          options[:project] = "changelog_test"
         else
-        # try to find repo in format:
-        # origin	https://github.com/skywinder/ChangelogMerger (fetch)
-        # https://github.com/skywinder/ChangelogMerger
-          match = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/.match(remote)
+          remote = `git config --get remote.#{options[:branch]}.url`
+          # try to find repo in format:
+          # origin	git@github.com:skywinder/Github-Changelog-Generator.git (fetch)
+          # git@github.com:skywinder/Github-Changelog-Generator.git
+          match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)(?:\.git).*/.match(remote)
+
           if match && match[1] && match[2]
             puts "Detected user:#{match[1]}, project:#{match[2]}"
             options[:user], options[:project] = match[1], match[2]
+          else
+            # try to find repo in format:
+            # origin	https://github.com/skywinder/ChangelogMerger (fetch)
+            # https://github.com/skywinder/ChangelogMerger
+            match = /.*\/((?:-|\w|\.)*)\/((?:-|\w|\.)*).*/.match(remote)
+            if match && match[1] && match[2]
+              puts "Detected user:#{match[1]}, project:#{match[2]}"
+              options[:user], options[:project] = match[1], match[2]
+            end
           end
         end
       end
-
-
-      if !options[:user] || !options[:project]
-        puts parser.banner
-        exit
-      end
-
-      if ARGV[1]
-        options[:tag1] = ARGV[0]
-        options[:tag2] = ARGV[1]
-      end
-
-      if options[:verbose]
-        puts 'Performing task with options:'
-        pp options
-        puts ''
-      end
-
-      options
     end
   end
 end