github_changelog_generator 1.15.0.pre.rc → 1.16.2

data/lib/github_changelog_generator/options.rb

@@ -7,7 +7,7 @@ module GitHubChangelogGenerator
   # This class wraps Options, and knows a list of known options. Others options
   # will raise exceptions.
   class Options < SimpleDelegator
-    # Raised on intializing with unknown keys in the values hash,
+    # Raised on initializing with unknown keys in the values hash,
     # and when trying to store a value on an unknown key.
     UnsupportedOptionError = Class.new(ArgumentError)
 
@@ -15,24 +15,30 @@ module GitHubChangelogGenerator
     KNOWN_OPTIONS = %i[
       add_issues_wo_labels
       add_pr_wo_labels
+      add_sections
       author
       base
       between_tags
+      breaking_labels
+      breaking_prefix
       bug_labels
       bug_prefix
       cache_file
       cache_log
+      config_file
       compare_link
+      configure_sections
       date_format
+      deprecated_labels
+      deprecated_prefix
       due_tag
       enhancement_labels
       enhancement_prefix
-      breaking_labels
-      breaking_prefix
       exclude_labels
       exclude_tags
       exclude_tags_regex
       filter_issues_by_milestone
+      issues_of_open_milestones
       frontmatter
       future_release
       github_endpoint
@@ -40,8 +46,10 @@ module GitHubChangelogGenerator
       header
       http_cache
       include_labels
+      include_tags_regex
       issue_prefix
       issue_line_labels
+      issue_line_body
       issues
       max_issues
       merge_prefix
@@ -50,10 +58,17 @@ module GitHubChangelogGenerator
       pulls
       release_branch
       release_url
+      removed_labels
+      removed_prefix
       require
+      security_labels
+      security_prefix
       simple_list
       since_tag
+      since_commit
       ssl_ca_file
+      summary_labels
+      summary_prefix
       token
       unreleased
       unreleased_label
@@ -95,11 +110,31 @@ module GitHubChangelogGenerator
     # Pretty-prints a censored options hash, if :verbose.
     def print_options
       return unless self[:verbose]
+
       Helper.log.info "Using these options:"
-      pp(censored_values)
+      # For ruby 2.5.0+
+      censored_values.each do |key, value|
+        print(key.inspect, "=>", value.inspect)
+        puts ""
+      end
       puts ""
     end
 
+    # Boolean method for whether the user is using configure_sections
+    def configure_sections?
+      !self[:configure_sections].nil? && !self[:configure_sections].empty?
+    end
+
+    # Boolean method for whether the user is using add_sections
+    def add_sections?
+      !self[:add_sections].nil? && !self[:add_sections].empty?
+    end
+
+    # @return [Boolean] whether write to `:output`
+    def write_to_file?
+      self[:output].present?
+    end
+
     private
 
     def values

data/lib/github_changelog_generator/parser.rb

@@ -1,228 +1,89 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "optparse"
-require "pp"
-require "github_changelog_generator/version"
 require "github_changelog_generator/helper"
+require "github_changelog_generator/argv_parser"
+require "github_changelog_generator/parser_file"
 
 module GitHubChangelogGenerator
   class Parser
-    # parse options with optparse
-    def self.parse_options
-      options = default_options
+    class << self
+      PARSERS = [
+        ArgvParser, # Parse arguments first to get initial options populated
+        FileParserChooser, # Then parse possible configuration files
+        ArgvParser # Lastly parse arguments again to keep the given arguments the strongest
+      ].freeze
 
-      ParserFile.new(options).parse!
+      def parse_options(argv = ARGV)
+        options = default_options
 
-      parser = setup_parser(options)
-      begin parser.parse!
-      rescue OptionParser::InvalidOption => e
-        abort [e, parser].join("\n")
-      end
+        PARSERS.each do |parser|
+          parser.new(options).parse!(argv)
+        end
 
-      unless options[:user] && options[:project]
-        warn "Configure which user and project to work on."
-        warn "Options --user and --project, or settings to that effect. See --help for more."
-        abort(parser.banner)
+        abort_if_user_and_project_not_given!(options)
+
+        options.print_options
+
+        options
       end
 
-      options.print_options
+      def abort_if_user_and_project_not_given!(options)
+        return if options[:user] && options[:project]
 
-      options
-    end
+        warn "Configure which user and project to work on."
+        warn "Options --user and --project, or settings to that effect. See --help for more."
+        warn ArgvParser.banner
 
-    # Setup parsing options
-    #
-    # @param options [Options]
-    # @return [OptionParser]
-    def self.setup_parser(options)
-      OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
-        opts.banner = "Usage: github_changelog_generator --user USER --project PROJECT [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|
-          options[:project] = last
-        end
-        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 %Y-%m-%d") do |last|
-          options[:date_format] = last
-        end
-        opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
-          options[:output] = last
-        end
-        opts.on("-b", "--base [NAME]", "Optional base file to append generated changes to.") do |last|
-          options[:base] = last
-        end
-        opts.on("--bugs-label [LABEL]", "Setup custom label for bug-fixes section. Default is \"**Fixed bugs:**\"") do |v|
-          options[:bug_prefix] = v
-        end
-        opts.on("--enhancement-label [LABEL]", "Setup custom label for enhancements section. Default is \"**Implemented enhancements:**\"") do |v|
-          options[:enhancement_prefix] = v
-        end
-        opts.on("--breaking-label [LABEL]", "Setup custom label for the breaking changes section. Default is \"**Breaking changes:**\"") do |v|
-          options[:breaking_prefix] = v
-        end
-        opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
-          options[:issue_prefix] = v
-        end
-        opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
-          options[:header] = v
-        end
-        opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
-          options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
-        end
-        opts.on("--pr-label [LABEL]", "Setup custom label for pull requests section. Default is \"**Merged pull requests:**\"") do |v|
-          options[:merge_prefix] = v
-        end
-        opts.on("--[no-]issues", "Include closed issues in changelog. Default is true") do |v|
-          options[:issues] = v
-        end
-        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 in changelog. Default is true") do |v|
-          options[:add_pr_wo_labels] = v
-        end
-        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|
-          options[:filter_issues_by_milestone] = last
-        end
-        opts.on("--[no-]author", "Add author of pull-request in the end. Default is true") do |author|
-          options[:author] = author
-        end
-        opts.on("--usernames-as-github-logins", "Use GitHub tags instead of Markdown links for the author of an issue or pull-request.") do |v|
-          options[:usernames_as_github_logins] = v
-        end
-        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|
-          options[:unreleased] = v
-        end
-        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|
-          options[:compare_link] = v
-        end
-        opts.on("--include-labels  x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
-          options[:include_labels] = list
-        end
-        opts.on("--exclude-labels  x,y,z", Array, "Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'") do |list|
-          options[:exclude_labels] = list
-        end
-        opts.on("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
-          options[:bug_labels] = list
-        end
-        opts.on("--enhancement-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
-          options[:enhancement_labels] = list
-        end
-        opts.on("--breaking-labels x,y,z", Array, 'Issues with these labels will be added to a new section, called "Breaking Changes". Default is \'backwards-incompatible\'') do |list|
-          options[:breaking_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("--exclude-tags  x,y,z", Array, "Change log will exclude specified tags") do |list|
-          options[:exclude_tags] = list
-        end
-        opts.on("--exclude-tags-regex [REGEX]", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\" ") do |last|
-          options[:exclude_tags_regex] = last
-        end
-        opts.on("--since-tag  x", "Change log will start after specified tag") do |v|
-          options[:since_tag] = v
-        end
-        opts.on("--due-tag  x", "Change log will end before specified tag") do |v|
-          options[:due_tag] = v
-        end
-        opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
-          options[:max_issues] = max
-        end
-        opts.on("--release-url [URL]", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
-          options[:release_url] = url
-        end
-        opts.on("--github-site [URL]", "The Enterprise Github site on which your project is hosted.") do |last|
-          options[:github_site] = last
-        end
-        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|
-          options[:simple_list] = v
-        end
-        opts.on("--future-release [RELEASE-VERSION]", "Put the unreleased changes in the specified release number.") do |future_release|
-          options[:future_release] = future_release
-        end
-        opts.on("--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 github-changelog-http-cache in a temporary directory.") do |cache_file|
-          options[:cache_file] = cache_file
-        end
-        opts.on("--cache-log [CACHE-LOG]", "Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.") do |cache_log|
-          options[:cache_log] = cache_log
-        end
-        opts.on("--ssl-ca-file [PATH]", "Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.") do |ssl_ca_file|
-          options[:ssl_ca_file] = ssl_ca_file
-        end
-        opts.on("--require x,y,z", Array, "Path to Ruby file(s) to require.") do |paths|
-          options[:require] = paths
-        end
-        opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
-          options[:verbose] = v
-        end
-        opts.on("-v", "--version", "Print version number") do |_v|
-          puts "Version: #{GitHubChangelogGenerator::VERSION}"
-          exit
-        end
-        opts.on("-h", "--help", "Displays Help") do
-          puts opts
-          exit
-        end
+        Kernel.abort
       end
-    end
 
-    # @return [Options] Default options
-    def self.default_options
-      Options.new(
-        date_format: "%Y-%m-%d",
-        output: "CHANGELOG.md",
-        base: "HISTORY.md",
-        issues: true,
-        add_issues_wo_labels: true,
-        add_pr_wo_labels: true,
-        pulls: true,
-        filter_issues_by_milestone: true,
-        author: true,
-        unreleased: true,
-        unreleased_label: "Unreleased",
-        compare_link: true,
-        enhancement_labels: ["enhancement", "Enhancement", "Type: Enhancement"],
-        bug_labels: ["bug", "Bug", "Type: Bug"],
-        exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"],
-        breaking_labels: %w[backwards-incompatible breaking],
-        issue_line_labels: [],
-        max_issues: nil,
-        simple_list: false,
-        ssl_ca_file: nil,
-        verbose: true,
-        header: "# Change Log",
-        merge_prefix: "**Merged pull requests:**",
-        issue_prefix: "**Closed issues:**",
-        bug_prefix: "**Fixed bugs:**",
-        enhancement_prefix: "**Implemented enhancements:**",
-        breaking_prefix: "**Breaking changes:**",
-        http_cache: true,
-        require: []
-      )
+      # @return [Options] Default options
+      def default_options
+        Options.new(
+          date_format: "%Y-%m-%d",
+          output: "CHANGELOG.md",
+          base: "HISTORY.md",
+          issues: true,
+          add_issues_wo_labels: true,
+          add_pr_wo_labels: true,
+          pulls: true,
+          filter_issues_by_milestone: true,
+          issues_of_open_milestones: true,
+          author: true,
+          unreleased: true,
+          unreleased_label: "Unreleased",
+          compare_link: true,
+          exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"],
+          summary_labels: ["Release summary", "release-summary", "Summary", "summary"],
+          breaking_labels: ["backwards-incompatible", "Backwards incompatible", "breaking"],
+          enhancement_labels: ["enhancement", "Enhancement", "Type: Enhancement"],
+          bug_labels: ["bug", "Bug", "Type: Bug"],
+          deprecated_labels: ["deprecated", "Deprecated", "Type: Deprecated"],
+          removed_labels: ["removed", "Removed", "Type: Removed"],
+          security_labels: ["security", "Security", "Type: Security"],
+          configure_sections: {},
+          add_sections: {},
+          issue_line_labels: [],
+          max_issues: nil,
+          simple_list: false,
+          ssl_ca_file: nil,
+          verbose: true,
+          header: "# Changelog",
+          merge_prefix: "**Merged pull requests:**",
+          issue_prefix: "**Closed issues:**",
+          summary_prefix: "",
+          breaking_prefix: "**Breaking changes:**",
+          enhancement_prefix: "**Implemented enhancements:**",
+          bug_prefix: "**Fixed bugs:**",
+          deprecated_prefix: "**Deprecated:**",
+          removed_prefix: "**Removed:**",
+          security_prefix: "**Security fixes:**",
+          http_cache: true,
+          require: [],
+          config_file: ".github_changelog_generator"
+        )
+      end
     end
   end
 end

data/lib/github_changelog_generator/parser_file.rb

@@ -5,6 +5,28 @@ require "pathname"
 module GitHubChangelogGenerator
   ParserError = Class.new(StandardError)
 
+  class FileParserChooser
+    def initialize(options)
+      @options     = options
+      @config_file = Pathname.new(options[:config_file])
+    end
+
+    def parse!(_argv)
+      return nil unless (path = resolve_path)
+
+      ParserFile.new(@options, File.open(path)).parse!
+    end
+
+    def resolve_path
+      return @config_file if @config_file.exist?
+
+      path = @config_file.expand_path
+      return path if File.exist?(path)
+
+      nil
+    end
+  end
+
   # ParserFile is a configuration file reader which sets options in the
   # given Hash.
   #
@@ -22,30 +44,25 @@ module GitHubChangelogGenerator
   #
   class ParserFile
     # @param options [Hash] options to be configured from file contents
-    # @param file [nil,IO] configuration file handle, defaults to opening `.github_changelog_generator`
-    def initialize(options, file = open_settings_file)
+    # @param io [nil, IO] configuration file handle
+    def initialize(options, io = nil)
       @options = options
-      @file = file
+      @io = io
     end
 
     # Sets options using configuration file content
     def parse!
-      return unless @file
-      @file.each_with_index { |line, i| parse_line!(line, i + 1) }
-      @file.close
+      return unless @io
+
+      @io.each_with_index { |line, i| parse_line!(line, i + 1) }
+      @io.close
     end
 
     private
 
-    FILENAME = ".github_changelog_generator"
-
-    def open_settings_file
-      path = Pathname(File.expand_path(FILENAME))
-      File.open(path) if path.exist?
-    end
-
     def parse_line!(line, line_number)
       return if non_configuration_line?(line)
+
       option_name, value = extract_pair(line)
       @options[option_key_for(option_name)] = convert_value(value, option_name)
     rescue StandardError
@@ -54,7 +71,7 @@ module GitHubChangelogGenerator
 
     # Returns true if the line starts with a pound sign or a semi-colon.
     def non_configuration_line?(line)
-      line =~ /^[\#;]/ || line =~ /^[\s]+$/
+      line =~ /^[\#;]/ || line =~ /^\s+$/
     end
 
     # Returns a the option name as a symbol and its string value sans newlines.
@@ -66,8 +83,10 @@ module GitHubChangelogGenerator
       [key.tr("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
     end
 
-    KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels bug_labels
-                          enhancement_labels breaking_labels issue_line_labels between_tags exclude_tags]
+    KNOWN_ARRAY_KEYS = %i[exclude_labels include_labels
+                          summary_labels breaking_labels enhancement_labels bug_labels
+                          deprecated_labels removed_labels security_labels
+                          issue_line_labels between_tags exclude_tags]
     KNOWN_INTEGER_KEYS = [:max_issues]
 
     def convert_value(value, option_name)