github_changelog_generator 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 948686ef4f1a5836227cc06e225a9a396b58b665
-  data.tar.gz: d0c2c3d99e20dd16c2f649ceb82f321c67364bff
+  metadata.gz: 59c84fc6b47537cdca06c26c80e84ba2173eb941
+  data.tar.gz: 23353066809d7171627bce5d6ae88d004f685383
 SHA512:
-  metadata.gz: d74933a7c4ca8db21f9de2549954397cad5ab316a0150b34fd1f84297acdfd1ac987ba6bf741494eaec5061780a256a041e9c20568d448794e3232cc9e0dd474
-  data.tar.gz: 3fe8ffd4448569664696ed546dfcccb09ce45a61690f346849c3196aae4877a20677bf61551e7d56d856b7143777aaa4a2cebb1546b29809646364659b377288
+  metadata.gz: 3e62a0bcc2d7b58f4059b578dd2d5b8a3715768d29cc75b24e31660bae5f037551fdb2fa2d601e0c289b5eada5aad668d1e7dc38f93e482c2af998568eed06f0
+  data.tar.gz: bce9377b820a4cea95a2e209efa60e09b8abc3c0e2f6723b0b98a816fb18ea89880c508c2f437bc42a29dab6f950d75650a14c514bb26f06d476871fb27e931b

data/.gitignore

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

data/.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:

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Change Log
 
+## [Unreleased](https://github.com/skywinder/github-changelog-generator/tree/HEAD)
+
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.9.0...HEAD)
+
+**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))
+
+**Merged pull requests:**
+
+- Update bundler [\#306](https://github.com/skywinder/github-changelog-generator/pull/306) ([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)
+
+**Implemented enhancements:**
+
+- Feature: exclude\_tags using regular expression [\#281](https://github.com/skywinder/github-changelog-generator/pull/281) ([olleolleolle](https://github.com/olleolleolle))
+- Auto parse options from file .github\_changelog\_generator [\#278](https://github.com/skywinder/github-changelog-generator/pull/278) ([dlanileonardo](https://github.com/dlanileonardo))
+
 ## [1.8.5](https://github.com/skywinder/github-changelog-generator/tree/1.8.5) (2015-09-15)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.4...1.8.5)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    github_changelog_generator (1.8.5)
+    github_changelog_generator (1.9.0)
       colorize (~> 0.7)
       github_api (~> 0.12)
 

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
-[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
+[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
 [![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
 [![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
 [![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
@@ -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.
 

data/lib/CHANGELOG.md

@@ -22,6 +22,7 @@
 
 **Merged pull requests:**
 
+- Merged PR to Develop [\#19](https://github.com/skywinder/changelog_test/pull/19) ([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))

data/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
-      parser_file.parse!
+      ParserFile.new(options).parse!
 
       parser = setup_parser(options)
       parser.parse!
 
-      if options[:user].nil? || options[:project].nil?
-        detect_user_and_project(options, ARGV[0], ARGV[1])
-      end
+      user_and_project_from_git(options)
 
-      if !options[:user] || !options[:project]
-        puts parser.banner
-        exit
-      end
+      abort(parser.banner) unless options[:user] && options[:project]
 
       print_options(options)
 
@@ -165,8 +159,8 @@ module GitHubChangelogGenerator
     end
 
     # just get default options
-    def self.get_default_options
-      options = {
+    def self.default_options
+      {
         tag1: nil,
         tag2: nil,
         date_format: "%Y-%m-%d",
@@ -194,21 +188,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]
-        if ENV["RUBYLIB"] =~ /ruby-debug-ide/
-          options[:user] = "skywinder"
-          options[:project] = "changelog_test"
-        else
-          remote = `git config --get remote.#{options[:git_remote]}.url`
-          options[:user], options[:project] = user_project_from_remote(remote)
-        end
+      return if options[:user] && options[:project]
+
+      if ENV["RUBYLIB"] =~ /ruby-debug-ide/
+        options[:user] = "skywinder"
+        options[:project] = "changelog_test"
+      else
+        remote = `git config --get remote.#{options[:git_remote]}.url`
+        options[:user], options[:project] = user_project_from_remote(remote)
       end
     end
 

data/lib/github_changelog_generator/parser_file.rb

@@ -1,36 +1,39 @@
 module GitHubChangelogGenerator
+  ParserError = Class.new(StandardError)
+
   class ParserFile
     def initialize(options)
       @options = options
     end
 
-    def file
-      File.expand_path(@options[:params_file] || ".github_changelog_generator")
+    def parse!
+      return unless File.exist?(file)
+
+      File.readlines(file).each { |line| parse_line!(line) }
     end
 
-    def file?
-      File.exist?(file)
+    private
+
+    def file
+      @file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
     end
 
-    def file_open
-      File.open(file)
+    def parse_line!(line)
+      key_sym, value = extract_pair(line)
+      value = true if value =~ (/^(true|t|yes|y|1)$/i)
+      value = false if value =~ (/^(false|f|no|n|0)$/i)
+      @options[key_sym] = value
+    rescue
+      raise ParserError, "Config file #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
     end
 
-    def parse!
-      return unless file?
-      file_open.each do |line|
-        begin
-          key, value = line.split("=")
-          key_sym = key.sub("-", "_").to_sym
-          value = value.gsub(/[\n\r]+/, "")
-          value = true if value =~ (/^(true|t|yes|y|1)$/i)
-          value = false if value =~ (/^(false|f|no|n|0)$/i)
-          @options[key_sym] = value
-        rescue
-          raise "File #{file} is incorrect in line \"#{line.gsub(/[\n\r]+/, '')}\""
-        end
-      end
-      @options
+    # Returns a the setting 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.sub("-", "_").to_sym, value.gsub(/[\n\r]+/, "")]
     end
   end
 end

data/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?
-
-        # Try Regular Expressions until you find one that delivers results
-        break unless matches.nil?
+        if matches
+          captures.merge!(Hash[matches.names.zip(matches.captures)])
+          break
+        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|
-        captures = parse_heading(heading)
-        captures["content"] = sections.at(index + 1)
-        changelog.push captures
+      headings.each_with_index.map do |heading, index|
+        section = parse_heading(heading)
+        section["content"] = sections.at(index + 1)
+        section
       end
-
-      changelog
     end
 
     def read(file_path)

data/lib/github_changelog_generator/task.rb

@@ -16,7 +16,7 @@ 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 )
+                  future_release verbose release_url base )
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym
@@ -43,11 +43,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.detect_user_and_project(options)
-        end
+        Parser.user_and_project_from_git(options)
 
         OPTIONS.each do |o|
           v = instance_variable_get("@#{o}")

data/lib/github_changelog_generator/version.rb

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

data/spec/files/github_changelog_params_override

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

data/spec/unit/parse_file_spec.rb

@@ -10,23 +10,32 @@ describe GitHubChangelogGenerator::ParserFile do
     context "when file is empty" do
       let(:options) { { params_file: "spec/files/github_changelog_params_empty" } }
       let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
-      subject { parse.parse! }
-      it { is_expected.to be_a(Hash) }
-      it { is_expected.to eq(options) }
+
+      it "does not change the options" do
+        expect { parse.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) }
-      it { expect { fail.raise! }.to raise_error RuntimeError }
+      it { expect { parse.parse! }.to raise_error(GitHubChangelogGenerator::ParserError) }
     end
 
     context "when override default values" do
-      let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(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) }
-      subject { parse.parse! }
-      it { is_expected.to be_a(Hash) }
-      it { is_expected.to eq(options.merge(unreleased_label: "staging", unreleased: false)) }
+
+      it "changes the options" do
+        expect { parse.parse! }.to change { options }
+          .from(options_before_change)
+          .to(options_before_change.merge(unreleased_label: "staging",
+                                          unreleased: false,
+                                          header: "=== Changelog ==="))
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_changelog_generator
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Petr Korolev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-17 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api