Merge branch 'release/1.13.0'

Carry PR #301: usernames_as_github_logins

.gitignore

@@ -1 +1,7 @@
+bin/
+!bin/git-generate-changelog
+!bin/github_changelog_generator
+pkg/
 coverage/
+.bundle
+spec/*.lock

.travis.yml

@@ -1,10 +1,11 @@
-sudo: false
+cache:
+  - bundler
 language: ruby
 before_install:
   - gem update --system
   - gem install bundler
 rvm:
-  - 2.1.0
+  - 2.1
 script: bundle exec rake checks
 matrix:
   include:
@@ -13,6 +14,10 @@ matrix:
       script:
         - gem build github_changelog_generator
         - gem install *.gem
+    - install: true
+      script:
+        - gem build github_changelog_generator
+        - bundle install --gemfile spec/install-gem-in-bundler.gemfile
 notifications:
   email:
     recipients:

CHANGELOG.md

@@ -1,5 +1,89 @@
 # Change Log
 
+## [1.12.1](https://github.com/skywinder/github-changelog-generator/tree/1.12.1) (2016-05-09)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.12.0...1.12.1)
+
+**Fixed bugs:**
+
+- github\_changelog\_generator/generator/generator\_tags.rb:61:in `detect\_since\_tag': undefined method `\[\]' for nil:NilClass \(NoMethodError\) [\#351](https://github.com/skywinder/github-changelog-generator/issues/351)
+
+**Closed issues:**
+
+- Add a LICENSE file [\#369](https://github.com/skywinder/github-changelog-generator/issues/369)
+- Error installing on Ubuntu 14.04 [\#364](https://github.com/skywinder/github-changelog-generator/issues/364)
+
+**Merged pull requests:**
+
+- Move dev gems to add\_development\_dependency [\#373](https://github.com/skywinder/github-changelog-generator/pull/373) ([skywinder](https://github.com/skywinder))
+- Add MIT LICENSE file [\#370](https://github.com/skywinder/github-changelog-generator/pull/370) ([olleolleolle](https://github.com/olleolleolle))
+- Avoid nil bug in detect\_since\_tag [\#368](https://github.com/skywinder/github-changelog-generator/pull/368) ([olleolleolle](https://github.com/olleolleolle))
+
+## [1.12.0](https://github.com/skywinder/github-changelog-generator/tree/1.12.0) (2016-04-01)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.8...1.12.0)
+
+**Closed issues:**
+
+- .github\_changelog\_generator config file is not consistent with the internal options hash [\#312](https://github.com/skywinder/github-changelog-generator/issues/312)
+- Feature request: YAML front matter [\#276](https://github.com/skywinder/github-changelog-generator/issues/276)
+
+**Merged pull requests:**
+
+- Added tag exclusion with a filter \(string or regex\) [\#320](https://github.com/skywinder/github-changelog-generator/pull/320) ([soundstep](https://github.com/soundstep))
+
+## [1.11.8](https://github.com/skywinder/github-changelog-generator/tree/1.11.8) (2016-03-22)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.7...1.11.8)
+
+**Implemented enhancements:**
+
+- ParserFile: Allow comments in settings file [\#358](https://github.com/skywinder/github-changelog-generator/pull/358) ([olleolleolle](https://github.com/olleolleolle))
+
+**Fixed bugs:**
+
+- Error when specifying exclude\_labels [\#327](https://github.com/skywinder/github-changelog-generator/issues/327)
+- Parse options file options into arrays, integers, flags, and other [\#354](https://github.com/skywinder/github-changelog-generator/pull/354) ([olleolleolle](https://github.com/olleolleolle))
+
+**Closed issues:**
+
+- Installation fails on Ubuntu [\#352](https://github.com/skywinder/github-changelog-generator/issues/352)
+- Test installing on Windows: use AppVeyor [\#348](https://github.com/skywinder/github-changelog-generator/issues/348)
+- Can't run under RubyGems 2.5.1 and Ruby 2.3.0 [\#325](https://github.com/skywinder/github-changelog-generator/issues/325)
+- Ruby 2.3.0 - Deprecation warning: Github::ResponseWrapper\#respond\_to?\(:to\_ary\) is old fashion which takes only one parameter [\#323](https://github.com/skywinder/github-changelog-generator/issues/323)
+- between-tags and exclude-tags do not work in .github\_changelog\_generator [\#317](https://github.com/skywinder/github-changelog-generator/issues/317)
+- Add a "documentation" label [\#284](https://github.com/skywinder/github-changelog-generator/issues/284)
+
+**Merged pull requests:**
+
+- Replace shelling-out-to-Git w/ Dir call [\#360](https://github.com/skywinder/github-changelog-generator/pull/360) ([olleolleolle](https://github.com/olleolleolle))
+- ParserFile: fail parsing with config file line number; use a File instead of a filename [\#357](https://github.com/skywinder/github-changelog-generator/pull/357) ([olleolleolle](https://github.com/olleolleolle))
+- On gem install, do not try to copy manpage files in the "extensions" step [\#356](https://github.com/skywinder/github-changelog-generator/pull/356) ([olleolleolle](https://github.com/olleolleolle))
+- Refactor: call it option\_name, instead of key\_sym [\#355](https://github.com/skywinder/github-changelog-generator/pull/355) ([olleolleolle](https://github.com/olleolleolle))
+- Add a `bundle install` test [\#353](https://github.com/skywinder/github-changelog-generator/pull/353) ([jkeiser](https://github.com/jkeiser))
+- Add an AppVeyor config [\#350](https://github.com/skywinder/github-changelog-generator/pull/350) ([Arcanemagus](https://github.com/Arcanemagus))
+- README: Document GitHub token URI scope [\#345](https://github.com/skywinder/github-changelog-generator/pull/345) ([olleolleolle](https://github.com/olleolleolle))
+
+## [1.11.7](https://github.com/skywinder/github-changelog-generator/tree/1.11.7) (2016-03-04)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.6...1.11.7)
+
+**Merged pull requests:**
+
+- Add Olle Jonsson as co-author [\#347](https://github.com/skywinder/github-changelog-generator/pull/347) ([skywinder](https://github.com/skywinder))
+- Gemspec, default date [\#346](https://github.com/skywinder/github-changelog-generator/pull/346) ([olleolleolle](https://github.com/olleolleolle))
+
+## [1.11.6](https://github.com/skywinder/github-changelog-generator/tree/1.11.6) (2016-03-01)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.5...1.11.6)
+
+**Fixed bugs:**
+
+- Can't build on Windows [\#340](https://github.com/skywinder/github-changelog-generator/issues/340)
+
+**Closed issues:**
+
+- install error "Not a git repository" [\#339](https://github.com/skywinder/github-changelog-generator/issues/339)
+
+**Merged pull requests:**
+
+- Gemspec: Calculate date using Date stdlib [\#343](https://github.com/skywinder/github-changelog-generator/pull/343) ([olleolleolle](https://github.com/olleolleolle))
+
 ## [1.11.5](https://github.com/skywinder/github-changelog-generator/tree/1.11.5) (2016-03-01)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.4...1.11.5)
 

Gemfile.lock

@@ -1,14 +1,10 @@
 PATH
   remote: .
   specs:
-    github_changelog_generator (1.11.5)
+    github_changelog_generator (1.12.1)
-      bundler (>= 1.7)
       colorize (~> 0.7)
       github_api (~> 0.12)
-      overcommit (>= 0.31)
       rake (>= 10.0)
-      rspec (>= 3.2)
-      rubocop (>= 0.31)
 
 GEM
   remote: https://rubygems.org/
@@ -17,10 +13,10 @@ GEM
     ast (2.2.0)
     childprocess (0.5.9)
       ffi (~> 1.0, >= 1.0.11)
-    codeclimate-test-reporter (0.4.8)
+    codeclimate-test-reporter (0.5.0)
       simplecov (>= 0.7.1, < 1.0.0)
     colorize (0.7.7)
-    coveralls (0.8.11)
+    coveralls (0.8.13)
       json (~> 1.8)
       simplecov (~> 0.11.0)
       term-ansicolor (~> 1.3)
@@ -40,11 +36,11 @@ GEM
       hashie (>= 3.4)
       multi_json (>= 1.7.5, < 2.0)
       oauth2
-    hashie (3.4.3)
+    hashie (3.4.4)
     iniparse (1.4.2)
     json (1.8.3)
     jwt (1.5.1)
-    multi_json (1.11.2)
+    multi_json (1.12.0)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
     oauth2 (1.1.0)
@@ -53,20 +49,20 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    overcommit (0.32.0)
+    overcommit (0.33.0)
       childprocess (~> 0.5.8)
       iniparse (~> 1.4)
-    parser (2.3.0.6)
+    parser (2.3.1.0)
       ast (~> 2.2)
     powerpack (0.1.1)
     rack (1.6.4)
     rainbow (2.1.0)
-    rake (10.5.0)
+    rake (11.1.2)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
       rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.3)
+    rspec-core (3.4.4)
       rspec-support (~> 3.4.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -75,13 +71,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.37.2)
+    rubocop (0.39.0)
-      parser (>= 2.3.0.4, < 3.0)
+      parser (>= 2.3.0.7, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 0.3)
+      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.7.5)
+    ruby-progressbar (1.8.0)
     simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)
@@ -92,7 +88,7 @@ GEM
     thor (0.19.1)
     thread_safe (0.3.5)
     tins (1.6.0)
-    unicode-display_width (0.3.1)
+    unicode-display_width (1.0.5)
 
 PLATFORMS
   ruby
@@ -104,8 +100,9 @@ DEPENDENCIES
   github_changelog_generator!
   overcommit
   rake
+  rspec (>= 3.2)
   rubocop
   simplecov (~> 0.10)
 
 BUNDLED WITH
-   1.11.2
+   1.12.0.rc.2

LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+Copyright (c) 2016 Petr Korolev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

README.md

@@ -101,7 +101,7 @@ Therefore, it's recommended to run this script with authentication by using a **
 
 Here's how:
 
-- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token)
+- [Generate a token here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token) - you only need "repo" scope for private repositories
 - Either:
     - Run the script with `--token <your-40-digit-token>`; **OR**
     - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token

appveyor.yml

@@ -0,0 +1,50 @@
+version: "{build}"
+
+platform: x64
+
+branches:
+    only:
+      - master
+
+clone_depth: 10
+
+skip_tags: true
+
+# See here for Ruby versions pre-installed:
+#  http://www.appveyor.com/docs/installed-software#ruby
+environment:
+  matrix:
+    - ruby_version: "21" # Older version, but matches Travis-CI
+    - ruby_version: "21-x64"
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+
+  # Print version and location for pre-installed ruby
+  - ruby --version
+  - where ruby
+
+  # Install latest version of RubyGems
+  - gem update --system --no-document --no-post-install-message
+  - gem --version
+  - where gem
+
+  # Print version and location for pre-installed bundler
+  - bundler --version
+  - where bundler
+
+build_script:
+  # Install ruby dependencies
+  - bundle install --retry 3
+  - bundle exec rake checks
+
+test_script:
+  - gem build github_changelog_generator
+  - gem install *.gem
+
+notifications:
+  - provider: Email
+    to:
+      - sky4winder+githubchangeloggenerator@gmail.com
+    on_build_success: false
+    on_build_status_changed: true

github_changelog_generator.gemspec

@@ -1,5 +1,4 @@
 # coding: utf-8
-require "date"
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "github_changelog_generator/version"
@@ -10,25 +9,26 @@ Gem::Specification.new do |spec|
   spec.default_executable = "github_changelog_generator"
 
   spec.required_ruby_version = ">= 1.9.3"
-  spec.authors = ["Petr Korolev"]
+  spec.authors = ["Petr Korolev", "Olle Jonsson"]
   spec.email = "sky4winder+github_changelog_generator@gmail.com"
-  spec.date = Date.today.iso8601
+
   spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
   spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
   spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
   spec.license = "MIT"
-  spec.extensions = ["Rakefile"]
 
-  spec.files = `git ls-files -z`.split("\x0")
+  spec.files = Dir["{bin,lib,man,spec}/**/*"] + %w(LICENSE Rakefile README.md)
+
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "rake", ">= 10.0"
-  spec.add_runtime_dependency "bundler", ">= 1.7"
   spec.add_runtime_dependency("github_api", ["~> 0.12"])
   spec.add_runtime_dependency("colorize", ["~> 0.7"])
-  spec.add_runtime_dependency("overcommit", ">= 0.31")
+
-  spec.add_runtime_dependency("rubocop", ">= 0.31")
+  spec.add_development_dependency("overcommit", ">= 0.31")
-  spec.add_runtime_dependency("rspec", ">= 3.2")
+  spec.add_development_dependency("rspec", ">= 3.2")
+  spec.add_development_dependency "bundler", ">= 1.7"
+  spec.add_development_dependency("rubocop", ">= 0.31")
 end

lib/github_changelog_generator/fetcher.rb

@@ -71,7 +71,7 @@ module GitHubChangelogGenerator
       response.each_page do |page|
         page_i += PER_PAGE_NUMBER
         print_in_same_line("Fetching tags... #{page_i}/#{count_pages * PER_PAGE_NUMBER}")
-        tags.concat(page)
+        tags.concat(page) unless page.nil?
       end
       print_empty_line
 

lib/github_changelog_generator/generator/generator_generation.rb

@@ -160,7 +160,7 @@ module GitHubChangelogGenerator
     # 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))
+    # - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) (@skywinder)
     #
     # @param [Hash] issue Fetched issue from GitHub
     # @return [String] Markdown-formatted single issue
@@ -168,17 +168,22 @@ module GitHubChangelogGenerator
       encapsulated_title = encapsulate_string issue[:title]
 
       title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"
+      issue_line_with_user(title_with_number, issue)
+    end
 
-      unless issue.pull_request.nil?
+    private
-        if @options[:author]
+
-          title_with_number += if issue.user.nil?
+    def issue_line_with_user(line, issue)
-                                 " ({Null user})"
+      return line if !@options[:author] || issue.pull_request.nil?
-                               else
+
-                                 " ([#{issue.user.login}](#{issue.user.html_url}))"
+      user = issue.user
-                               end
+      return "#{line} ({Null user})" unless user
-        end
+
+      if @options[:usernames_as_github_logins]
+        "#{line} (@#{user.login})"
+      else
+        "#{line} ([#{user.login}](#{user.html_url}))"
       end
-      title_with_number
     end
   end
 end

lib/github_changelog_generator/generator/generator_tags.rb

@@ -54,13 +54,14 @@ module GitHubChangelogGenerator
 
     # @return [Object] try to find newest tag using #Reader and :base option if specified otherwise returns nil
     def detect_since_tag
-      @since_tag ||= @options[:since_tag]
+      @since_tag ||= @options.fetch(:since_tag) { version_of_first_item }
-      if @since_tag.nil? && @options[:base] && File.file?(@options[:base])
+    end
-        reader = GitHubChangelogGenerator::Reader.new
+
-        content = reader.read(@options[:base])
+    def version_of_first_item
-        @since_tag = content[0]["version"] if content.count && content
+      return unless File.file?(@options[:base].to_s)
-      end
+
-      @since_tag
+      sections = GitHubChangelogGenerator::Reader.new.read(@options[:base])
+      sections.first["version"] if sections && sections.any?
     end
 
     # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags
@@ -129,26 +130,34 @@ module GitHubChangelogGenerator
     end
 
     # @param [Array] all_tags all tags
-    # @return [Array] filtered tags according :exclude_tags option
+    # @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option
     def filter_excluded_tags(all_tags)
-      return all_tags unless @options[:exclude_tags]
+      if @options[:exclude_tags]
-
+        apply_exclude_tags(all_tags)
-      apply_exclude_tags(all_tags)
+      elsif @options[:exclude_tags_regex]
+        apply_exclude_tags_regex(all_tags)
+      else
+        all_tags
+      end
     end
 
     private
 
     def apply_exclude_tags(all_tags)
       if @options[:exclude_tags].is_a?(Regexp)
-        filter_tags_with_regex(all_tags)
+        filter_tags_with_regex(all_tags, @options[:exclude_tags])
       else
         filter_exact_tags(all_tags)
       end
     end
 
-    def filter_tags_with_regex(all_tags)
+    def apply_exclude_tags_regex(all_tags)
+      filter_tags_with_regex(all_tags, Regexp.new(@options[:exclude_tags_regex]))
+    end
+
+    def filter_tags_with_regex(all_tags, regex)
       warn_if_nonmatching_regex(all_tags)
-      all_tags.reject { |tag| @options[:exclude_tags] =~ tag.name }
+      all_tags.reject { |tag| regex =~ tag.name }
     end
 
     def filter_exact_tags(all_tags)

lib/github_changelog_generator/parser.rb

@@ -92,6 +92,9 @@ module GitHubChangelogGenerator
         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
@@ -122,6 +125,9 @@ module GitHubChangelogGenerator
         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

lib/github_changelog_generator/parser_file.rb

@@ -3,34 +3,59 @@ require "pathname"
 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
-    FILENAME = ".github_changelog_generator"
+    # @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)
+    def initialize(options, file = open_settings_file)
       @options = options
+      @file = file
     end
 
-    # Destructively change @options using data in configured options file.
+    # Sets options using configuration file content
     def parse!
-      file.each_line { |line| parse_line!(line) } if file.exist?
+      return unless @file
+      @file.each_with_index { |line, i| parse_line!(line, i + 1) }
+      @file.close
     end
 
     private
 
-    def file
+    FILENAME = ".github_changelog_generator"
-      @file ||= Pathname(File.expand_path(@options[:params_file] || FILENAME))
+
+    def open_settings_file
+      path = Pathname(File.expand_path(FILENAME))
+      File.open(path) if path.exist?
     end
 
-    def parse_line!(line)
+    def parse_line!(line, line_number)
-      key_sym, value = extract_pair(line)
+      return if non_configuration_line?(line)
-      value = true if value =~ /^(true|t|yes|y|1)$/i
+      option_name, value = extract_pair(line)
-      value = false if value =~ /^(false|f|no|n|0)$/i
+      @options[option_key_for(option_name)] = convert_value(value, option_name)
-      @options[key_sym] = value
     rescue
-      raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
+      raise ParserError, "Failed on line ##{line_number}: \"#{line.gsub(/[\n\r]+/, '')}\""
     end
 
-    # Returns a the setting as a symbol and its string value sans newlines.
+    # 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>]
@@ -38,5 +63,41 @@ module GitHubChangelogGenerator
       key, value = line.split("=", 2)
       [key.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
     end
+
+    KNOWN_ARRAY_KEYS = [:exclude_labels, :include_labels, :bug_labels,
+                        :enhancement_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,
+      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

lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = "1.11.6"
+  VERSION = "1.13.0"
 end

spec/files/github_changelog_params_327

@@ -1 +0,0 @@
-exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90

spec/files/github_changelog_params_incorrect

@@ -1,2 +0,0 @@
-unreleased_label: staging
-unreleased: false

spec/files/github_changelog_params_override

@@ -1,3 +0,0 @@
-unreleased_label=staging
-unreleased=false
-header==== Changelog ===

spec/install-gem-in-bundler.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "github_changelog_generator", path: Dir.glob("../pkg/github_changelog_generator-*.gem")[0]

spec/unit/generator/generator_tags_spec.rb

@@ -1,19 +1,14 @@
-def tag_mash_with_name(tag)
-  mash_tag = Hashie::Mash.new
-  mash_tag.name = tag
-  mash_tag
-end
-
-def tags_mash_from_strings(tags_strings)
-  mash_array = []
-  tags_strings.each do |tag|
-    mash_tag = tag_mash_with_name(tag)
-    mash_array << mash_tag
-  end
-  mash_array
-end
-
 describe GitHubChangelogGenerator::Generator do
+  def tag_mash_with_name(tag)
+    Hashie::Mash.new.tap { |mash_tag| mash_tag.name = tag }
+  end
+
+  def tags_mash_from_strings(tags_strings)
+    tags_strings.map do |tag|
+      tag_mash_with_name(tag)
+    end
+  end
+
   describe "#filter_between_tags" do
     context "when between_tags nil" do
       before do
@@ -76,31 +71,47 @@ describe GitHubChangelogGenerator::Generator do
   describe "#filter_excluded_tags" do
     subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
 
-    context "with valid excluded tags" do
+    context "with matching string" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
       it { is_expected.to be_a Array }
       it { is_expected.to match_array(tags_mash_from_strings(%w(1 2))) }
     end
 
-    context "with invalid excluded tags" do
+    context "with non-matching string" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
       it { is_expected.to be_a Array }
       it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
     end
 
-    context "with regex exclude_tags" do
+    context "with matching regex" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
       it { is_expected.to be_a Array }
       it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
     end
 
-    context "with non-matching regex in exclude_tags" do
+    context "with non-matching regex" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
       it { is_expected.to be_a Array }
       it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
     end
   end
 
+  describe "#filter_excluded_tags_regex" do
+    subject { generator.filter_excluded_tags(tags_mash_from_strings(%w(1 2 3))) }
+
+    context "with matching regex" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[23]") }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1))) }
+    end
+
+    context "with non-matching regex" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[45]") }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(tags_mash_from_strings(%w(1 2 3))) }
+    end
+  end
+
   describe "#filter_since_tag" do
     context "with filled array" do
       subject { generator.filter_since_tag(tags_mash_from_strings(%w(1 2 3))) }
@@ -190,7 +201,7 @@ describe GitHubChangelogGenerator::Generator do
         @generator.instance_variable_set :@fetcher, mock
       end
       subject do
-        of_tag = @generator.get_time_of_tag tag_mash_with_name("valid_tag")
+        of_tag = @generator.get_time_of_tag(tag_mash_with_name("valid_tag"))
         of_tag
       end
       it { is_expected.to be_a_kind_of(Time) }
@@ -199,31 +210,32 @@ describe GitHubChangelogGenerator::Generator do
   end
 
   describe "#sort_tags_by_date" do
-    time1 = Time.now
+    let(:time1) { Time.now }
-    time2 = Time.now
+    let(:time2) { Time.now }
-    time3 = Time.now
+    let(:time3) { Time.now }
+
     before(:all) do
       @generator = GitHubChangelogGenerator::Generator.new
     end
+
+    before do
+      @generator.instance_variable_set(:@tag_times_hash, "valid_tag1" => time1,
+                                                         "valid_tag2" => time2,
+                                                         "valid_tag3" => time3)
+    end
+
+    subject do
+      @generator.sort_tags_by_date(tags)
+    end
     context "sort unsorted tags" do
-      tags = tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3)
+      let(:tags) { tags_mash_from_strings %w(valid_tag1 valid_tag2 valid_tag3) }
-      before do
+
-        @generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
-      end
-      subject do
-        @generator.sort_tags_by_date tags
-      end
       it { is_expected.to be_a_kind_of(Array) }
       it { is_expected.to match_array(tags.reverse!) }
     end
     context "sort sorted tags" do
-      tags = tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1)
+      let(:tags) { tags_mash_from_strings %w(valid_tag3 valid_tag2 valid_tag1) }
-      before do
+
-        @generator.instance_variable_set :@tag_times_hash, "valid_tag1" => time1, "valid_tag2" => time2, "valid_tag3" => time3
-      end
-      subject do
-        @generator.sort_tags_by_date tags
-      end
       it { is_expected.to be_a_kind_of(Array) }
       it { is_expected.to match_array(tags) }
     end

spec/unit/parse_file_spec.rb

@@ -1,36 +1,47 @@
 describe GitHubChangelogGenerator::ParserFile do
   describe ".github_changelog_generator" do
-    context "when no has file" do
+    let(:options) { {} }
-      let(:options) { {} }
+
-      let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
+    context "when the well-known default file does not exist" do
-      subject { parse.parse! }
+      let(:parser) { GitHubChangelogGenerator::ParserFile.new(options) }
+      subject { parser.parse! }
       it { is_expected.to be_nil }
     end
 
     context "when file is empty" do
-      let(:options) { { params_file: "spec/files/github_changelog_params_empty" } }
+      let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) }
-      let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
 
       it "does not change the options" do
-        expect { parse.parse! }.to_not change { options }
+        expect { parser.parse! }.to_not change { options }
       end
     end
 
     context "when file is incorrect" do
-      let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
       let(:options_before_change) { options.dup }
-      let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
+      let(:file) { StringIO.new("unreleased_label=staging\nunreleased: false") }
-      it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) }
+      let(:parser) do
+        GitHubChangelogGenerator::ParserFile.new(options, file)
+      end
+      it { expect { parser.parse! }.to raise_error(/line #2/) }
+    end
+
+    context "allows empty lines and comments with semi-colon or pound sign" do
+      let(:file) { StringIO.new("\n   \n# Comment on first line\nunreleased_label=staging\n; Comment on third line\nunreleased=false") }
+      let(:parser) do
+        GitHubChangelogGenerator::ParserFile.new(options, file)
+      end
+      it { expect { parser.parse! }.not_to raise_error }
     end
 
     context "when override default values" do
       let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
-      let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
+      let(:options) { {}.merge(default_options) }
       let(:options_before_change) { options.dup }
-      let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
+      let(:file) { StringIO.new("unreleased_label=staging\nunreleased=false\nheader==== Changelog ===") }
+      let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, file) }
 
       it "changes the options" do
-        expect { parse.parse! }.to change { options }
+        expect { parser.parse! }.to change { options }
           .from(options_before_change)
           .to(options_before_change.merge(unreleased_label: "staging",
                                           unreleased: false,
@@ -38,17 +49,24 @@ describe GitHubChangelogGenerator::ParserFile do
       end
 
       context "turns exclude-labels into an Array", bug: '#327' do
-        let(:options) do
+        let(:file) do
-          {
+          StringIO.new(<<EOF
-            params_file: "spec/files/github_changelog_params_327"
+exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
-          }
+header_label=# My changelog
+EOF
+                      )
         end
         it "reads exclude_labels into an Array" do
-          pending("Related with Bug #327.")
+          expect { parser.parse! }.to change { options[:exclude_labels] }
-          expect { parse.parse! }.to change { options[:exclude_labels] }
+            .from(default_options[:exclude_labels])
-            .from(nil)
             .to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
         end
+
+        it "translates given header_label into the :header option" do
+          expect { parser.parse! }.to change { options[:header] }
+            .from(default_options[:header])
+            .to("# My changelog")
+        end
       end
     end
   end