Merge branch 'release/1.10.1'

- made the method take three arguments
- specs all note these three

.gitignore

@@ -0,0 +1 @@
+coverage/

.rubocop.yml

@@ -14,7 +14,3 @@ Metrics/ClassLength:
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
     Enabled: false
-
-Style/FileName:
-    Exclude:
-      - 'bin/git-generate-changelog'

.travis.yml

@@ -1,5 +1,8 @@
+sudo: false
 language: ruby
-before_install: gem update --system
+before_install: 
+- gem update --system
+- gem install bundler
 rvm:
 - 2.1.0
 script:

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Change Log
 
+## [1.10.0](https://github.com/skywinder/github-changelog-generator/tree/1.10.0) (2016-01-05)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...1.10.0)
+
+**Implemented enhancements:**
+
+- Rubocop: less complex methods in parser.rb [\#297](https://github.com/skywinder/github-changelog-generator/pull/297) ([olleolleolle](https://github.com/olleolleolle))
+- Introduce ParserError exception class [\#296](https://github.com/skywinder/github-changelog-generator/pull/296) ([olleolleolle](https://github.com/olleolleolle))
+- ParserFile: support values with equals signs [\#285](https://github.com/skywinder/github-changelog-generator/pull/285) ([olleolleolle](https://github.com/olleolleolle))
+
+**Closed issues:**
+
+- PRs not closed on master branch show up in changelog [\#280](https://github.com/skywinder/github-changelog-generator/issues/280)
+
+**Merged pull requests:**
+
+- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([SteveGilvarry](https://github.com/SteveGilvarry))
+- Fixes \#280 Add release-branch option to filter the Pull Requests [\#305](https://github.com/skywinder/github-changelog-generator/pull/305) ([SteveGilvarry](https://github.com/SteveGilvarry))
+- Add options to def self.user\_and\_project\_from\_git to fix parser.rb:19… [\#303](https://github.com/skywinder/github-changelog-generator/pull/303) ([SteveGilvarry](https://github.com/SteveGilvarry))
+- Git ignore coverage/ [\#300](https://github.com/skywinder/github-changelog-generator/pull/300) ([olleolleolle](https://github.com/olleolleolle))
+- \[refactor\] Fix docblock datatype, use \#map [\#299](https://github.com/skywinder/github-changelog-generator/pull/299) ([olleolleolle](https://github.com/olleolleolle))
+- \[refactor\] Reader: positive Boolean; unused \#map [\#298](https://github.com/skywinder/github-changelog-generator/pull/298) ([olleolleolle](https://github.com/olleolleolle))
+- Add base option to RakeTask [\#287](https://github.com/skywinder/github-changelog-generator/pull/287) ([jkeiser](https://github.com/jkeiser))
+
 ## [1.9.0](https://github.com/skywinder/github-changelog-generator/tree/1.9.0) (2015-09-17)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.5...1.9.0)
 

Gemfile.lock

@@ -1,62 +1,59 @@
 PATH
   remote: .
   specs:
-    github_changelog_generator (1.9.0)
+    github_changelog_generator (1.10.0)
       colorize (~> 0.7)
       github_api (~> 0.12)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.8)
+    addressable (2.4.0)
-    ast (2.0.0)
+    ast (2.2.0)
     astrolabe (1.3.1)
       parser (~> 2.2)
-    codeclimate-test-reporter (0.4.7)
+    codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
     colorize (0.7.7)
-    coveralls (0.8.2)
+    coveralls (0.8.10)
       json (~> 1.8)
       rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.10.0)
+      simplecov (~> 0.11.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
+      tins (~> 1.6.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    domain_name (0.5.24)
+    domain_name (0.5.25)
       unf (>= 0.0.5, < 1.0.0)
-    faraday (0.9.1)
+    faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    github_api (0.12.4)
+    github_api (0.13.1)
-      addressable (~> 2.3)
+      addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
       hashie (>= 3.4)
       multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.6)
       oauth2
-    hashie (3.4.2)
+    hashie (3.4.3)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
     json (1.8.3)
-    jwt (1.5.1)
+    jwt (1.5.2)
-    mime-types (2.6.1)
+    mime-types (2.99)
-    mini_portile (0.6.2)
     multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    netrc (0.10.3)
+    netrc (0.11.0)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
     oauth2 (1.0.0)
       faraday (>= 0.8, < 0.10)
       jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    parser (2.2.2.6)
+    parser (2.2.3.0)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.1)
     rack (1.6.4)
@@ -66,27 +63,28 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
-    rspec (3.3.0)
+    rspec (3.4.0)
-      rspec-core (~> 3.3.0)
+      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.3.0)
+      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.3.0)
+      rspec-mocks (~> 3.4.0)
-    rspec-core (3.3.2)
+    rspec-core (3.4.1)
-      rspec-support (~> 3.3.0)
+      rspec-support (~> 3.4.0)
-    rspec-expectations (3.3.1)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
+      rspec-support (~> 3.4.0)
-    rspec-mocks (3.3.2)
+    rspec-mocks (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
+      rspec-support (~> 3.4.0)
-    rspec-support (3.3.0)
+    rspec-support (3.4.1)
-    rubocop (0.32.1)
+    rubocop (0.35.1)
       astrolabe (~> 1.3)
-      parser (>= 2.2.2.5, < 3.0)
+      parser (>= 2.2.3.0, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
+      ruby-progressbar (~> 1.7)
+      tins (<= 1.6.0)
     ruby-progressbar (1.7.5)
-    simplecov (0.10.0)
+    simplecov (0.11.1)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
@@ -95,7 +93,7 @@ GEM
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.5)
-    tins (1.5.4)
+    tins (1.6.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)

README.md

@@ -32,7 +32,7 @@ To make it easier for users and contributors to see precisely what notable chang
 ### *Why should I care?*
 Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.
 
-> :copyright: *[http://keepachangelog.com](http://keepachangelog.com/)*
+> :arrow_right: *[http://keepachangelog.com](http://keepachangelog.com/)*
 
 ## Installation
 
@@ -117,7 +117,7 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
 ## Migrating from a manual changelog
 
 Knowing how dedicated you are to your project, you probably haven't been waiting for github-changelog-generator to keep a changelog,
-but you most likely wouln't like to have to open issues and PRs for all past features listed in your historic changelog.
+but you most likely wouldn't like to have to open issues and PRs for all past features listed in your historic changelog.
 
 That's where `--base` comes handy. This option lets you pass a static changelog to be appended at the end of the generated entries.
 

bin/git-generate-changelog

@@ -1,4 +0,0 @@
-#! /usr/bin/env ruby
-
-require_relative "../lib/github_changelog_generator"
-GitHubChangelogGenerator::ChangelogGenerator.new.run

ext/mkrf_conf.rb

@@ -1,10 +0,0 @@
-PREFIX = "/usr/local"
-MANPREFIX = "#{PREFIX}/share/man/man1"
-MAN_PAGES = "man/git-*"
-
-require "fileutils"
-
-Dir.glob(MAN_PAGES).each do |f|
-  filename = File.basename(f)
-  FileUtils.cp(f, "#{MANPREFIX}/#{filename}")
-end

github_changelog_generator.gemspec

@@ -9,15 +9,14 @@ Gem::Specification.new do |spec|
   spec.version            = GitHubChangelogGenerator::VERSION
   spec.default_executable = "github_changelog_generator"
 
-  spec.required_ruby_version     = ">= 1.9.3"
+  spec.required_ruby_version = ">= 1.9.3"
   spec.authors = ["Petr Korolev"]
   spec.email = "sky4winder+github_changelog_generator@gmail.com"
   spec.date = `date +"%Y-%m-%d"`.strip!
   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.license = "MIT"
-  spec.extensions  = "ext/mkrf_conf.rb"
 
   spec.files = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

lib/CHANGELOG.md

@@ -22,6 +22,7 @@
 
 **Merged pull requests:**
 
+- Merged br \(should appear in change log also\) [\#21](https://github.com/skywinder/changelog_test/pull/21) ([skywinder](https://github.com/skywinder))
 - This a PR with a lot of comments and events [\#17](https://github.com/skywinder/changelog_test/pull/17) ([skywinder](https://github.com/skywinder))
 - This PR closes 14 from commit [\#15](https://github.com/skywinder/changelog_test/pull/15) ([skywinder](https://github.com/skywinder))
 - This PR to close \#12 from body [\#13](https://github.com/skywinder/changelog_test/pull/13) ([skywinder](https://github.com/skywinder))

lib/github_changelog_generator/fetcher.rb

@@ -18,12 +18,12 @@ module GitHubChangelogGenerator
       @user = @options[:user]
       @project = @options[:project]
       @github_token = fetch_github_token
-      github_options = { per_page: PER_PAGE_NUMBER }
+      @github_options = { per_page: PER_PAGE_NUMBER }
-      github_options[:oauth_token] = @github_token unless @github_token.nil?
+      @github_options[:oauth_token] = @github_token unless @github_token.nil?
-      github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
+      @github_options[:endpoint] = @options[:github_endpoint] unless @options[:github_endpoint].nil?
-      github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
+      @github_options[:site] = @options[:github_endpoint] unless @options[:github_site].nil?
 
-      @github = check_github_response { Github.new github_options }
+      @github = check_github_response { Github.new @github_options }
     end
 
     # Returns GitHub token. First try to use variable, provided by --token option,
@@ -123,7 +123,16 @@ Make sure, that you push tags to remote repo via 'git push --tags'".yellow
     def fetch_closed_pull_requests
       pull_requests = []
       begin
-        response = @github.pull_requests.list @options[:user], @options[:project], state: "closed"
+        if @options[:release_branch].nil?
+          response = @github.pull_requests.list @options[:user],
+                                                @options[:project],
+                                                state: "closed"
+        else
+          response = @github.pull_requests.list @options[:user],
+                                                @options[:project],
+                                                state: "closed",
+                                                base: @options[:release_branch]
+        end
         page_i = 0
         count_pages = response.count_pages
         response.each_page do |page|

lib/github_changelog_generator/generator/generator_processor.rb

@@ -178,8 +178,10 @@ module GitHubChangelogGenerator
         fetched_pr = closed_pull_requests.find do |fpr|
           fpr.number == pr.number
         end
-        pr[:merged_at] = fetched_pr[:merged_at]
+        if fetched_pr
-        closed_pull_requests.delete(fetched_pr)
+          pr[:merged_at] = fetched_pr[:merged_at]
+          closed_pull_requests.delete(fetched_pr)
+        end
       end
 
       pull_requests.select! do |pr|

lib/github_changelog_generator/parser.rb

@@ -7,22 +7,16 @@ module GitHubChangelogGenerator
   class Parser
     # parse options with optparse
     def self.parse_options
-      options = get_default_options
+      options = default_options
 
-      parser_file = ParserFile.new options
+      ParserFile.new(options).parse!
-      parser_file.parse!
 
       parser = setup_parser(options)
       parser.parse!
 
-      if options[:user].nil? || options[:project].nil?
+      user_and_project_from_git(options)
-        detect_user_and_project(options, ARGV[0], ARGV[1])
-      end
 
-      if !options[:user] || !options[:project]
+      abort(parser.banner) unless options[:user] && options[:project]
-        puts parser.banner
-        exit
-      end
 
       print_options(options)
 
@@ -149,6 +143,9 @@ module GitHubChangelogGenerator
         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-]verbose", "Run verbosely. Default is true") do |v|
           options[:verbose] = v
         end
@@ -165,8 +162,8 @@ module GitHubChangelogGenerator
     end
 
     # just get default options
-    def self.get_default_options
+    def self.default_options
-      options = {
+      {
         tag1: nil,
         tag2: nil,
         date_format: "%Y-%m-%d",
@@ -194,21 +191,25 @@ module GitHubChangelogGenerator
         enhancement_prefix: "**Implemented enhancements:**",
         git_remote: "origin"
       }
+    end
 
-      options
+    def self.user_and_project_from_git(options)
+      if options[:user].nil? || options[:project].nil?
+        detect_user_and_project(options, ARGV[0], ARGV[1])
+      end
     end
 
     # Detects user and project from git
     def self.detect_user_and_project(options, arg0 = nil, arg1 = nil)
       options[:user], options[:project] = user_project_from_option(arg0, arg1, options[:github_site])
-      if !options[:user] || !options[:project]
+      return if options[:user] && options[:project]
-        if ENV["RUBYLIB"] =~ /ruby-debug-ide/
+
-          options[:user] = "skywinder"
+      if ENV["RUBYLIB"] =~ /ruby-debug-ide/
-          options[:project] = "changelog_test"
+        options[:user] = "skywinder"
-        else
+        options[:project] = "changelog_test"
-          remote = `git config --get remote.#{options[:git_remote]}.url`
+      else
-          options[:user], options[:project] = user_project_from_remote(remote)
+        remote = `git config --get remote.#{options[:git_remote]}.url`
-        end
+        options[:user], options[:project] = user_project_from_remote(remote)
       end
     end
 
@@ -216,7 +217,7 @@ module GitHubChangelogGenerator
     #
     # @param [String] output of git remote command
     # @return [Array] user and project
-    def self.user_project_from_option(arg0, arg1, github_site = nil)
+    def self.user_project_from_option(arg0, arg1, github_site)
       user = nil
       project = nil
       github_site ||= "github.com"
@@ -229,10 +230,10 @@ module GitHubChangelogGenerator
           param = match[2].nil?
         rescue
           puts "Can't detect user and name from first parameter: '#{arg0}' -> exit'"
-          exit
+          return
         end
         if param
-          exit
+          return
         else
           user = match[1]
           project = match[2]
@@ -275,9 +276,4 @@ module GitHubChangelogGenerator
       [user, project]
     end
   end
-
-  if __FILE__ == $PROGRAM_NAME
-    remote = "invalid reference to project"
-    p user_project_from_option(ARGV[0], ARGV[1], remote)
-  end
 end

lib/github_changelog_generator/parser_file.rb

@@ -1,4 +1,6 @@
 module GitHubChangelogGenerator
+  ParserError = Class.new(StandardError)
+
   class ParserFile
     def initialize(options)
       @options = options
@@ -22,7 +24,7 @@ module GitHubChangelogGenerator
       value = false if value =~ (/^(false|f|no|n|0)$/i)
       @options[key_sym] = value
     rescue
-      raise "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
+      raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
     end
 
     # Returns a the setting as a symbol and its string value sans newlines.

lib/github_changelog_generator/reader.rb

@@ -53,31 +53,28 @@ module GitHubChangelogGenerator
 
       @heading_structures.each do |regexp|
         matches = Regexp.new(regexp).match(heading)
-        captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil?
+        if matches
-
+          captures.merge!(Hash[matches.names.zip(matches.captures)])
-        # Try Regular Expressions until you find one that delivers results
+          break
-        break unless matches.nil?
+        end
       end
 
       captures
     end
 
-    # Parse the given ChangeLog data into a Hash
+    # Parse the given ChangeLog data into a list of Hashes
     #
     # @param [String] data File data from the ChangeLog.md
-    # @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
+    # @return [Array<Hash>] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
     def parse(data)
       sections = data.split(/^## .+?$/)
       headings = data.scan(/^## .+?$/)
-      changelog = []
 
-      headings.each_with_index do |heading, index|
+      headings.each_with_index.map do |heading, index|
-        captures = parse_heading(heading)
+        section = parse_heading(heading)
-        captures["content"] = sections.at(index + 1)
+        section["content"] = sections.at(index + 1)
-        changelog.push captures
+        section
       end
-
-      changelog
     end
 
     def read(file_path)

lib/github_changelog_generator/task.rb

@@ -16,7 +16,8 @@ module GitHubChangelogGenerator
                   bug_labels enhancement_labels
                   between_tags exclude_tags since_tag max_issues
                   github_site github_endpoint simple_list
-                  future_release verbose release_url base )
+                  future_release release_branch verbose release_url
+                  base )
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym
@@ -43,11 +44,9 @@ module GitHubChangelogGenerator
 
       task @name do
         # mimick parse_options
-        options = Parser.get_default_options
+        options = Parser.default_options
 
-        if options[:user].nil? || options[:project].nil?
+        Parser.user_and_project_from_git(options)
-          Parser.detect_user_and_project(options)
-        end
 
         OPTIONS.each do |o|
           v = instance_variable_get("@#{o}")

lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = "1.9.0"
+  VERSION = "1.10.1"
 end

man/git-generate-changelog.1

@@ -1,252 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2015" "" ""
-.
-.SH "NAME"
-\fBgit\-generate\-changelog\fR \- Generate changelog from github
-.
-.SH "SYNOPSIS"
-\fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
-.
-.SH "DESCRIPTION"
-Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
-.
-.SH "OPTIONS"
-\-u, \-\-user [USER]
-.
-.P
-Username of the owner of target GitHub repo
-.
-.P
-\-p, \-\-project [PROJECT]
-.
-.P
-Name of project on GitHub
-.
-.P
-\-t, \-\-token [TOKEN]
-.
-.P
-To make more than 50 requests per hour your GitHub token is required\. You can generate it at: https://github\.com/settings/tokens/new
-.
-.P
-\-f, \-\-date\-format [FORMAT]
-.
-.P
-Date format\. Default is %Y\-%m\-%d
-.
-.P
-\-o, \-\-output [NAME]
-.
-.P
-Output file\. Default is CHANGELOG\.md
-.
-.P
-\-b, \-\-base [NAME]
-.
-.P
-Optional base file to append generated changes to\.
-.
-.P
-\-\-bugs\-label [LABEL]
-.
-.P
-Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
-.
-.P
-\-\-enhancement\-label [LABEL]
-.
-.P
-Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
-.
-.P
-\-\-issues\-label [LABEL]
-.
-.P
-Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
-.
-.P
-\-\-header\-label [LABEL]
-.
-.P
-Setup custom header label\. Default is "# Change Log"
-.
-.P
-\-\-pr\-label [LABEL]
-.
-.P
-Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
-.
-.P
-\-\-[no\-]issues
-.
-.P
-Include closed issues in changelog\. Default is true
-.
-.P
-\-\-[no\-]issues\-wo\-labels
-.
-.P
-Include closed issues without labels in changelog\. Default is true
-.
-.P
-\-\-[no\-]pr\-wo\-labels
-.
-.P
-Include pull requests without labels in changelog\. Default is true
-.
-.P
-\-\-[no\-]pull\-requests
-.
-.P
-Include pull\-requests in changelog\. Default is true
-.
-.P
-\-\-[no\-]filter\-by\-milestone
-.
-.P
-Use milestone to detect when issue was resolved\. Default is true
-.
-.P
-\-\-[no\-]author
-.
-.P
-Add author of pull\-request in the end\. Default is true
-.
-.P
-\-\-unreleased\-only
-.
-.P
-Generate log from unreleased closed issues only\.
-.
-.P
-\-\-[no\-]unreleased
-.
-.P
-Add to log unreleased closed issues\. Default is true
-.
-.P
-\-\-unreleased\-label [label]
-.
-.P
-Add to log unreleased closed issues\. Default is true
-.
-.P
-\-\-[no\-]compare\-link
-.
-.P
-Include compare link (Full Changelog) between older version and newer version\. Default is true
-.
-.P
-\-\-include\-labels x,y,z
-.
-.P
-Only issues with the specified labels will be included in the changelog\.
-.
-.P
-\-\-exclude\-labels x,y,z
-.
-.P
-Issues with the specified labels will be always excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'
-.
-.P
-\-\-bug\-labels x,y,z
-.
-.P
-Issues with the specified labels will be always added to "Fixed bugs" section\. Default is \'bug,Bug\'
-.
-.P
-\-\-enhancement\-labels x,y,z
-.
-.P
-Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
-.
-.P
-\-\-between\-tags x,y,z
-.
-.P
-Change log will be filled only between specified tags
-.
-.P
-\-\-exclude\-tags x,y,z
-.
-.P
-Change log will exclude specified tags
-.
-.P
-\-\-since\-tag x
-.
-.P
-Change log will start after specified tag
-.
-.P
-\-\-due\-tag x
-.
-.P
-Change log will end before specified tag
-.
-.P
-\-\-max\-issues [NUMBER]
-.
-.P
-Max number of issues to fetch from GitHub\. Default is unlimited
-.
-.P
-\-\-release\-url [URL]
-.
-.P
-The URL to point to for release links, in printf format (with the tag as variable)\.
-.
-.P
-\-\-github\-site [URL]
-.
-.P
-The Enterprise Github site on which your project is hosted\.
-.
-.P
-\-\-github\-api [URL]
-.
-.P
-The enterprise endpoint to use for your Github API\.
-.
-.P
-\-\-simple\-list
-.
-.P
-Create simple list from issues and pull requests\. Default is false\.
-.
-.P
-\-\-future\-release [RELEASE\-VERSION]
-.
-.P
-Put the unreleased changes in the specified release number\.
-.
-.P
-\-\-[no\-]verbose
-.
-.P
-Run verbosely\. Default is true
-.
-.P
-\-v, \-\-version
-.
-.P
-Print version number
-.
-.P
-\-h, \-\-help
-.
-.P
-Displays Help
-.
-.SH "EXAMPLES"
-.
-.SH "AUTHOR"
-Written by Petr Korolev sky4winder@gmail\.com
-.
-.SH "REPORTING BUGS"
-<\fIhttps://github\.com/skywinder/github\-changelog\-generator/issues\fR>
-.
-.SH "SEE ALSO"
-<\fIhttps://github\.com/skywinder/github\-changelog\-generator/\fR>

man/git-generate-changelog.html

@@ -1,262 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta http-equiv='content-type' value='text/html;charset=utf8'>
-  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
-  <title>git-generate-changelog(1) - Generate changelog from github</title>
-  <style type='text/css' media='all'>
-  /* style: man */
-  body#manpage {margin:0}
-  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
-  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
-  .mp h2 {margin:10px 0 0 0}
-  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
-  .mp h3 {margin:0 0 0 4ex}
-  .mp dt {margin:0;clear:left}
-  .mp dt.flush {float:left;width:8ex}
-  .mp dd {margin:0 0 0 9ex}
-  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
-  .mp pre {margin-bottom:20px}
-  .mp pre+h2,.mp pre+h3 {margin-top:22px}
-  .mp h2+pre,.mp h3+pre {margin-top:5px}
-  .mp img {display:block;margin:auto}
-  .mp h1.man-title {display:none}
-  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
-  .mp h2 {font-size:16px;line-height:1.25}
-  .mp h1 {font-size:20px;line-height:2}
-  .mp {text-align:justify;background:#fff}
-  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
-  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
-  .mp u {text-decoration:underline}
-  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
-  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
-  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
-  .mp b.man-ref {font-weight:normal;color:#434241}
-  .mp pre {padding:0 4ex}
-  .mp pre code {font-weight:normal;color:#434241}
-  .mp h2+pre,h3+pre {padding-left:0}
-  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
-  ol.man-decor {width:100%}
-  ol.man-decor li.tl {text-align:left}
-  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
-  ol.man-decor li.tr {text-align:right;float:right}
-  </style>
-</head>
-<!--
-  The following styles are deprecated and will be removed at some point:
-  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
-
-  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
-  .man-navigation should be used instead.
--->
-<body id='manpage'>
-  <div class='mp' id='man'>
-
-  <div class='man-navigation' style='display:none'>
-    <a href="#NAME">NAME</a>
-    <a href="#SYNOPSIS">SYNOPSIS</a>
-    <a href="#DESCRIPTION">DESCRIPTION</a>
-    <a href="#OPTIONS">OPTIONS</a>
-    <a href="#EXAMPLES">EXAMPLES</a>
-    <a href="#AUTHOR">AUTHOR</a>
-    <a href="#REPORTING-BUGS">REPORTING BUGS</a>
-    <a href="#SEE-ALSO">SEE ALSO</a>
-  </div>
-
-  <ol class='man-decor man-head man head'>
-    <li class='tl'>git-generate-changelog(1)</li>
-    <li class='tc'></li>
-    <li class='tr'>git-generate-changelog(1)</li>
-  </ol>
-
-  <h2 id="NAME">NAME</h2>
-<p class="man-name">
-  <code>git-generate-changelog</code> - <span class="man-whatis">Generate changelog from github</span>
-</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<p><code>git generate-changelog</code> [-h|--help] [-u|--user] [-p|--project]</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
-<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
-
-<h2 id="OPTIONS">OPTIONS</h2>
-
-<p>  -u, --user [USER]</p>
-
-<p>  Username of the owner of target GitHub repo</p>
-
-<p>  -p, --project [PROJECT]</p>
-
-<p>  Name of project on GitHub</p>
-
-<p>  -t, --token [TOKEN]</p>
-
-<p>  To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new</p>
-
-<p>  -f, --date-format [FORMAT]</p>
-
-<p>  Date format. Default is %Y-%m-%d</p>
-
-<p>  -o, --output [NAME]</p>
-
-<p>  Output file. Default is CHANGELOG.md</p>
-
-<p>  -b, --base [NAME]</p>
-
-<p>  Optional base file to append generated changes to.</p>
-
-<p>   --bugs-label [LABEL]</p>
-
-<p>   Setup custom label for bug-fixes section. Default is "<strong>Fixed bugs:</strong></p>
-
-<p>   --enhancement-label [LABEL]</p>
-
-<p>   Setup custom label for enhancements section. Default is "<strong>Implemented enhancements:</strong>"</p>
-
-<p>   --issues-label [LABEL]</p>
-
-<p>   Setup custom label for closed-issues section. Default is "<strong>Closed issues:</strong>"</p>
-
-<p>   --header-label [LABEL]</p>
-
-<p>   Setup custom header label. Default is "# Change Log"</p>
-
-<p>   --pr-label [LABEL]</p>
-
-<p>   Setup custom label for pull requests section. Default is "<strong>Merged pull requests:</strong>"</p>
-
-<p>   --[no-]issues</p>
-
-<p>   Include closed issues in changelog. Default is true</p>
-
-<p>   --[no-]issues-wo-labels</p>
-
-<p>   Include closed issues without labels in changelog. Default is true</p>
-
-<p>   --[no-]pr-wo-labels</p>
-
-<p>   Include pull requests without labels in changelog. Default is true</p>
-
-<p>   --[no-]pull-requests</p>
-
-<p>   Include pull-requests in changelog. Default is true</p>
-
-<p>   --[no-]filter-by-milestone</p>
-
-<p>   Use milestone to detect when issue was resolved. Default is true</p>
-
-<p>   --[no-]author</p>
-
-<p>   Add author of pull-request in the end. Default is true</p>
-
-<p>   --unreleased-only</p>
-
-<p>   Generate log from unreleased closed issues only.</p>
-
-<p>   --[no-]unreleased</p>
-
-<p>   Add to log unreleased closed issues. Default is true</p>
-
-<p>   --unreleased-label [label]</p>
-
-<p>   Add to log unreleased closed issues. Default is true</p>
-
-<p>   --[no-]compare-link</p>
-
-<p>   Include compare link (Full Changelog) between older version and newer version. Default is true</p>
-
-<p>   --include-labels x,y,z</p>
-
-<p>   Only issues with the specified labels will be included in the changelog.</p>
-
-<p>   --exclude-labels x,y,z</p>
-
-<p>   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'</p>
-
-<p>   --bug-labels x,y,z</p>
-
-<p>   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'</p>
-
-<p>   --enhancement-labels x,y,z</p>
-
-<p>   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
-
-<p>   --between-tags x,y,z</p>
-
-<p>   Change log will be filled only between specified tags</p>
-
-<p>   --exclude-tags x,y,z</p>
-
-<p>   Change log will exclude specified tags</p>
-
-<p>   --since-tag x</p>
-
-<p>   Change log will start after specified tag</p>
-
-<p>   --due-tag x</p>
-
-<p>   Change log will end before specified tag</p>
-
-<p>   --max-issues [NUMBER]</p>
-
-<p>   Max number of issues to fetch from GitHub. Default is unlimited</p>
-
-<p>   --release-url [URL]</p>
-
-<p>   The URL to point to for release links, in printf format (with the tag as variable).</p>
-
-<p>   --github-site [URL]</p>
-
-<p>   The Enterprise Github site on which your project is hosted.</p>
-
-<p>   --github-api [URL]</p>
-
-<p>   The enterprise endpoint to use for your Github API.</p>
-
-<p>   --simple-list</p>
-
-<p>   Create simple list from issues and pull requests. Default is false.</p>
-
-<p>   --future-release [RELEASE-VERSION]</p>
-
-<p>   Put the unreleased changes in the specified release number.</p>
-
-<p>   --[no-]verbose</p>
-
-<p>   Run verbosely. Default is true</p>
-
-<p>  -v, --version</p>
-
-<p>  Print version number</p>
-
-<p>  -h, --help</p>
-
-<p>  Displays Help</p>
-
-<h2 id="EXAMPLES">EXAMPLES</h2>
-
-<h2 id="AUTHOR">AUTHOR</h2>
-
-<p>Written by Petr Korolev sky4winder@gmail.com</p>
-
-<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
-
-<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/issues" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/issues</a>&gt;</p>
-
-<h2 id="SEE-ALSO">SEE ALSO</h2>
-
-<p>&lt;<a href="https://github.com/skywinder/github-changelog-generator/" data-bare-link="true">https://github.com/skywinder/github-changelog-generator/</a>&gt;</p>
-
-
-  <ol class='man-decor man-foot man foot'>
-    <li class='tl'></li>
-    <li class='tc'>October 2015</li>
-    <li class='tr'>git-generate-changelog(1)</li>
-  </ol>
-
-  </div>
-</body>
-</html>

man/git-generate-changelog.md

@@ -1,179 +0,0 @@
-git-generate-changelog(1) - Generate changelog from github
-================================
-
-## SYNOPSIS
-
-`git generate-changelog` [-h|--help] [-u|--user] [-p|--project]
-
-## DESCRIPTION
-
-Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
-
-## OPTIONS
-
-  -u, --user [USER]
-
-  Username of the owner of target GitHub repo
-
-  -p, --project [PROJECT]
-
-  Name of project on GitHub
-
-  -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
-
-  -f, --date-format [FORMAT]
-
-  Date format. Default is %Y-%m-%d
-
-  -o, --output [NAME]
-
-  Output file. Default is CHANGELOG.md
-
-  -b, --base [NAME]
-
-  Optional base file to append generated changes to.
-
-   --bugs-label [LABEL]
-
-   Setup custom label for bug-fixes section. Default is "**Fixed bugs:**
-
-   --enhancement-label [LABEL]
-
-   Setup custom label for enhancements section. Default is "**Implemented enhancements:**"
-
-   --issues-label [LABEL]
-
-   Setup custom label for closed-issues section. Default is "**Closed issues:**"
-
-   --header-label [LABEL]
-
-   Setup custom header label. Default is "# Change Log"
-
-   --pr-label [LABEL]
-
-   Setup custom label for pull requests section. Default is "**Merged pull requests:**"
-
-   --[no-]issues
-
-   Include closed issues in changelog. Default is true
-
-   --[no-]issues-wo-labels
-
-   Include closed issues without labels in changelog. Default is true
-
-   --[no-]pr-wo-labels
-
-   Include pull requests without labels in changelog. Default is true
-
-   --[no-]pull-requests
-
-   Include pull-requests in changelog. Default is true
-
-   --[no-]filter-by-milestone
-
-   Use milestone to detect when issue was resolved. Default is true
-
-   --[no-]author
-
-   Add author of pull-request in the end. Default is true
-
-   --unreleased-only
-
-   Generate log from unreleased closed issues only.
-
-   --[no-]unreleased
-
-   Add to log unreleased closed issues. Default is true
-
-   --unreleased-label [label]
-
-   Add to log unreleased closed issues. Default is true
-
-   --[no-]compare-link
-
-   Include compare link (Full Changelog) between older version and newer version. Default is true
-
-   --include-labels x,y,z
-
-   Only issues with the specified labels will be included in the changelog.
-
-   --exclude-labels x,y,z
-
-   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
-
-   --bug-labels x,y,z
-
-   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'
-
-   --enhancement-labels x,y,z
-
-   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
-
-   --between-tags x,y,z
-
-   Change log will be filled only between specified tags
-
-   --exclude-tags x,y,z
-
-   Change log will exclude specified tags
-
-   --since-tag x
-
-   Change log will start after specified tag
-
-   --due-tag x
-
-   Change log will end before specified tag
-
-   --max-issues [NUMBER]
-
-   Max number of issues to fetch from GitHub. Default is unlimited
-
-   --release-url [URL]
-
-   The URL to point to for release links, in printf format (with the tag as variable).
-
-   --github-site [URL]
-
-   The Enterprise Github site on which your project is hosted.
-
-   --github-api [URL]
-
-   The enterprise endpoint to use for your Github API.
-
-   --simple-list
-
-   Create simple list from issues and pull requests. Default is false.
-
-   --future-release [RELEASE-VERSION]
-
-   Put the unreleased changes in the specified release number.
-
-   --[no-]verbose
-
-   Run verbosely. Default is true
-
-  -v, --version
-
-  Print version number
-
-  -h, --help
-
-  Displays Help
-
-
-## EXAMPLES
-
-## AUTHOR
-
-Written by Petr Korolev sky4winder@gmail.com
-
-## REPORTING BUGS
-
-&lt;<https://github.com/skywinder/github-changelog-generator/issues>&gt;
-
-## SEE ALSO
-
-&lt;<https://github.com/skywinder/github-changelog-generator/>&gt;

spec/unit/parse_file_spec.rb

@@ -20,11 +20,11 @@ describe GitHubChangelogGenerator::ParserFile do
       let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
       let(:options_before_change) { options.dup }
       let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
-      it { expect { parse.parse! }.to raise_error }
+      it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) }
     end
 
     context "when override default values" do
-      let(:default_options) { GitHubChangelogGenerator::Parser.get_default_options }
+      let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
       let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(default_options) }
       let(:options_before_change) { options.dup }
       let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }

spec/unit/parser_spec.rb

@@ -28,16 +28,16 @@ describe GitHubChangelogGenerator::Parser do
   end
   describe ".user_project_from_option" do
     context "when option is invalid" do
-      it("should exit") { expect { GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil) }.to raise_error(SystemExit) }
+      it("should return nil") { expect(GitHubChangelogGenerator::Parser.user_project_from_option("blah", nil, nil)).to be_nil }
     end
 
     context "when option is valid" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil) }
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option("skywinder/ActionSheetPicker-3.0", nil, nil) }
       it { is_expected.to be_a(Array) }
       it { is_expected.to match_array(["skywinder", "ActionSheetPicker-3.0"]) }
     end
     context "when option nil" do
-      subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil) }
+      subject { GitHubChangelogGenerator::Parser.user_project_from_option(nil, nil, nil) }
       it { is_expected.to be_a(Array) }
       it { is_expected.to match_array([nil, nil]) }
     end