px_github_changelog_generator 0.0.0

data/lib/github_changelog_generator/parser.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "github_changelog_generator/helper"
+require "github_changelog_generator/argv_parser"
+require "github_changelog_generator/parser_file"
+require "github_changelog_generator/file_parser_chooser"
+
+module GitHubChangelogGenerator
+  class Parser
+    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
+
+      def parse_options(argv = ARGV)
+        options = default_options
+
+        PARSERS.each do |parser|
+          parser.new(options).parse!(argv)
+        end
+
+        abort_if_user_and_project_not_given!(options)
+
+        options.print_options
+
+        options
+      end
+
+      def abort_if_user_and_project_not_given!(options)
+        return if 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."
+        warn ArgvParser.banner
+
+        Kernel.abort
+      end
+
+      # @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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module GitHubChangelogGenerator
+  ParserError = Class.new(StandardError)
+
+  # ParserFile is a configuration file reader which sets options in the
+  # given Hash.
+  #
+  # In your project's root, you can put a file named
+  # <tt>.github_changelog_generator</tt> to override defaults.
+  #
+  # Example:
+  #   header_label=# My Super Changelog
+  #   ; Comments are allowed
+  #   future-release=5.0.0
+  #   # Ruby-style comments, too
+  #   since-tag=1.0.0
+  #
+  # The configuration format is <tt>some-key=value</tt> or <tt>some_key=value</tt>.
+  #
+  class ParserFile
+    # @param options [Hash] options to be configured from file contents
+    # @param io [nil, IO] configuration file handle
+    def initialize(options, io = nil)
+      @options = options
+      @io = io
+    end
+
+    # Sets options using configuration file content
+    def parse!
+      return unless @io
+
+      @io.each_with_index { |line, i| parse_line!(line, i + 1) }
+      @io.close
+    end
+
+    private
+
+    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
+      raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
+    end
+
+    # Returns true if the line starts with a pound sign or a semi-colon.
+    def non_configuration_line?(line)
+      line =~ /^[\#;]/ || line =~ /^\s+$/
+    end
+
+    # Returns a the option name as a symbol and its string value sans newlines.
+    #
+    # @param line [String] unparsed line from config file
+    # @return [Array<Symbol, String>]
+    def extract_pair(line)
+      key, value = line.split("=", 2)
+      [key.tr("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
+    end
+
+    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)
+      if KNOWN_ARRAY_KEYS.include?(option_name)
+        value.split(",")
+      elsif KNOWN_INTEGER_KEYS.include?(option_name)
+        value.to_i
+      elsif value =~ /^(true|t|yes|y|1)$/i
+        true
+      elsif value =~ /^(false|f|no|n|0)$/i
+        false
+      else
+        value
+      end
+    end
+
+    IRREGULAR_OPTIONS = {
+      bugs_label: :bug_prefix,
+      enhancement_label: :enhancement_prefix,
+      issues_label: :issue_prefix,
+      header_label: :header,
+      front_matter: :frontmatter,
+      pr_label: :merge_prefix,
+      breaking_label: :breaking_prefix,
+      issues_wo_labels: :add_issues_wo_labels,
+      pr_wo_labels: :add_pr_wo_labels,
+      pull_requests: :pulls,
+      filter_by_milestone: :filter_issues_by_milestone,
+      github_api: :github_endpoint
+    }
+
+    def option_key_for(option_name)
+      IRREGULAR_OPTIONS.fetch(option_name) { option_name }
+    end
+  end
+end

data/lib/github_changelog_generator/reader.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+#
+# Author:: Enrico Stahn <mail@enricostahn.com>
+#
+# Copyright 2014, Zanui, <engineering@zanui.com.au>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module GitHubChangelogGenerator
+  # A Reader to read an existing ChangeLog file and return a structured object
+  #
+  # Example:
+  #   reader = GitHubChangelogGenerator::Reader.new
+  #   content = reader.read('./CHANGELOG.md')
+  class Reader
+    def initialize(options = {})
+      defaults = {
+        heading_level: "##",
+        heading_structures: [
+          /^## \[(?<version>.+?)\](\((?<url>.+?)\))?( \((?<date>.+?)\))?$/, # rubocop:disable Lint/MixedRegexpCaptureTypes
+          /^## (?<version>.+?)( \((?<date>.+?)\))?$/ # rubocop:disable Lint/MixedRegexpCaptureTypes
+        ]
+      }
+
+      @options = options.merge(defaults)
+
+      @heading_level = @options[:heading_level]
+      @heading_structures = @options[:heading_structures]
+    end
+
+    # Parse a single heading and return a Hash
+    #
+    # The following heading structures are currently valid:
+    # - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1) (2015-03-24)
+    # - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1)
+    # - ## [v1.0.2] (2015-03-24)
+    # - ## [v1.0.2]
+    # - ## v1.0.2 (2015-03-24)
+    # - ## v1.0.2
+    #
+    # @param [String] heading Heading from the ChangeLog File
+    # @return [Hash] Returns a structured Hash with version, url and date
+    def parse_heading(heading)
+      captures = { "version" => nil, "url" => nil, "date" => nil }
+
+      @heading_structures.each do |regexp|
+        matches = Regexp.new(regexp).match(heading)
+        if matches
+          captures.merge!(Hash[matches.names.zip(matches.captures)])
+          break
+        end
+      end
+
+      captures
+    end
+
+    # Parse the given ChangeLog data into a list of Hashes
+    #
+    # @param [String] data File data from the ChangeLog.md
+    # @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
+    def parse(data)
+      sections = data.split(/^## .+?$/)
+      headings = data.scan(/^## .+?$/)
+
+      headings.each_with_index.map do |heading, index|
+        section = parse_heading(heading)
+        section["content"] = sections.at(index + 1)
+        section
+      end
+    end
+
+    def read(file_path)
+      parse File.read(file_path)
+    end
+  end
+end