github_changelog_generator 1.8.5 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3052222eaa5f4018fd50fe3a24981c3da115cef4
-  data.tar.gz: 29fd68df3fa54f54286312ad8dfcc03a8173309a
+  metadata.gz: 948686ef4f1a5836227cc06e225a9a396b58b665
+  data.tar.gz: d0c2c3d99e20dd16c2f649ceb82f321c67364bff
 SHA512:
-  metadata.gz: 6b7e04ac4fff6007bb9f4b7513917729bd14f22d1ec0310f0dfaae3f75010a83347c476b560877c65d8b6bc9980688617f60a4ba3f446face8b528e502cdfd78
-  data.tar.gz: 7cbe17645e2489301f5cd0591e745cd5afaf17c672962013ee79f9049b11a75e8fefa286d603debc56ca2121294acea3d153bf3529a816c75847dd3216f5ba8f
+  metadata.gz: d74933a7c4ca8db21f9de2549954397cad5ab316a0150b34fd1f84297acdfd1ac987ba6bf741494eaec5061780a256a041e9c20568d448794e3232cc9e0dd474
+  data.tar.gz: 3fe8ffd4448569664696ed546dfcccb09ce45a61690f346849c3196aae4877a20677bf61551e7d56d856b7143777aaa4a2cebb1546b29809646364659b377288

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [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)
+
+**Merged pull requests:**
+
+- Rake task: Be able to set false value in config [\#279](https://github.com/skywinder/github-changelog-generator/pull/279) ([olleolleolle](https://github.com/olleolleolle))
+
 ## [1.8.4](https://github.com/skywinder/github-changelog-generator/tree/1.8.4) (2015-09-01)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.3...1.8.4)
 
@@ -21,6 +28,10 @@
 
 - Output should not include security information [\#270](https://github.com/skywinder/github-changelog-generator/issues/270)
 
+**Merged pull requests:**
+
+- This PRi will fix \#274. [\#275](https://github.com/skywinder/github-changelog-generator/pull/275) ([skywinder](https://github.com/skywinder))
+
 ## [1.8.1](https://github.com/skywinder/github-changelog-generator/tree/1.8.1) (2015-08-25)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.8.0...1.8.1)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    github_changelog_generator (1.8.1)
+    github_changelog_generator (1.8.5)
       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)
@@ -20,7 +20,7 @@ GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
   - [Contributing](#contributing)
   - [License](#license)
 
- 
+
 ### Changelog generation has never been so easy:
 
 **Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according labels) from :octocat: GitHub Issue Tracker.
@@ -48,26 +48,26 @@ Because software tools are for people. If you don’t care, why are you contribu
 - In general it looks like this:
 
 > ## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
-> 
+>
 > [Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
-> 
+>
 > **Implemented enhancements:**
-> 
+>
 > - Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
-> 
+>
 > **Fixed bugs:**
-> 
+>
 > - Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
-> 
+>
 > **Merged pull requests:**
-> 
+>
 > - PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
-> 
+>
 > - support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
 
 
 ## Usage
-**It's really simple**: 
+**It's really simple**:
 
 - If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
 
@@ -76,7 +76,7 @@ Because software tools are for people. If you don’t care, why are you contribu
 -  or from anywhere:
     - `github_changelog_generator -u github_username -p github_project`
     - `github_changelog_generator  github_username/github_project`
-     
+
 As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog.
 
 ### Params
@@ -84,6 +84,16 @@ Type `github_changelog_generator --help` for details.
 
 More detailed info about params you can find in Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
 
+### Params File
+You can put Params in a .github_changelog_generator file in Project Root to override default params:
+
+Example:
+```
+unreleased=false
+future-release=5.0.0
+since-tag=1.0.0
+```
+
 ### GitHub token
 
 Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
@@ -92,9 +102,9 @@ Since GitHub allows you to make only 50 requests without authentication it's rec
 
 And:
 
-- Run with key `-t [your-40-digit-token]` 
-- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token. 
- 		
+- Run with key `-t [your-40-digit-token]`
+- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token.
+
 	i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string :
 
         export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"
@@ -139,10 +149,10 @@ All command line options can be passed to the Rake task as `config` parameters.
     - Merged pull requests (all `merged` pull-requests) :twisted_rightwards_arrows:
     - Bug fixes (by label `bug` in issue) :beetle:
     - Enhancements (by label `enhancement` in issue) :star2:
-    - 	Issues (closed issues `w/o any labels`) :non-potable_water:    
+    - 	Issues (closed issues `w/o any labels`) :non-potable_water:
 
 - You can manually set which labels should be included/excluded. :wrench:
-- Apply a lot of other customisations, to fit changelog for your personal style :tophat: 
+- Apply a lot of other customisations, to fit changelog for your personal style :tophat:
 (*look `github_changelog_generator --help`  for details)*
 
 
@@ -153,7 +163,7 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch
 
 
 ### Projects using this library
-[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) 
+[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator)
 
 If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
 
@@ -161,9 +171,9 @@ If you've used this project in a live app, please let me know! Nothing makes me
 
 ## Am I missing some essential feature?
 
-- **Nothing is impossible!** 
+- **Nothing is impossible!**
 
-- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! 
+- Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
 
 - *Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark:
 

data/lib/github_changelog_generator.rb

@@ -7,6 +7,7 @@ require "benchmark"
 
 require_relative "github_changelog_generator/helper"
 require_relative "github_changelog_generator/parser"
+require_relative "github_changelog_generator/parser_file"
 require_relative "github_changelog_generator/generator/generator"
 require_relative "github_changelog_generator/version"
 require_relative "github_changelog_generator/reader"

data/lib/github_changelog_generator/generator/generator_tags.rb

@@ -131,16 +131,45 @@ module GitHubChangelogGenerator
     # @param [Array] all_tags all tags
     # @return [Array] filtered tags according :exclude_tags option
     def filter_excluded_tags(all_tags)
-      filtered_tags = all_tags
-      if @options[:exclude_tags]
-        @options[:exclude_tags].each do |tag|
-          unless all_tags.map(&:name).include? tag
-            Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
-          end
-        end
-        filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
+      return all_tags unless @options[:exclude_tags]
+
+      apply_exclude_tags(all_tags)
+    end
+
+    private
+
+    def apply_exclude_tags(all_tags)
+      if @options[:exclude_tags].is_a?(Regexp)
+        filter_tags_with_regex(all_tags)
+      else
+        filter_exact_tags(all_tags)
+      end
+    end
+
+    def filter_tags_with_regex(all_tags)
+      warn_if_nonmatching_regex(all_tags)
+      all_tags.reject { |tag| @options[:exclude_tags] =~ tag.name }
+    end
+
+    def filter_exact_tags(all_tags)
+      @options[:exclude_tags].each do |tag|
+        warn_if_tag_not_found(all_tags, tag)
+      end
+      all_tags.reject { |tag| @options[:exclude_tags].include? tag.name }
+    end
+
+    def warn_if_nonmatching_regex(all_tags)
+      unless all_tags.map(&:name).any? { |t| @options[:exclude_tags] =~ t }
+        Helper.log.warn "Warning: unable to reject any tag, using regex "\
+                        "#{@options[:exclude_tags].inspect} in --exclude-tags "\
+                        "option."
+      end
+    end
+
+    def warn_if_tag_not_found(all_tags, tag)
+      unless all_tags.map(&:name).include? tag
+        Helper.log.warn "Warning: can't find tag #{tag}, specified with --exclude-tags option."
       end
-      filtered_tags
     end
   end
 end

data/lib/github_changelog_generator/parser.rb

@@ -9,8 +9,10 @@ module GitHubChangelogGenerator
     def self.parse_options
       options = get_default_options
 
-      parser = setup_parser(options)
+      parser_file = ParserFile.new options
+      parser_file.parse!
 
+      parser = setup_parser(options)
       parser.parse!
 
       if options[:user].nil? || options[:project].nil?

data/lib/github_changelog_generator/parser_file.rb

@@ -0,0 +1,36 @@
+module GitHubChangelogGenerator
+  class ParserFile
+    def initialize(options)
+      @options = options
+    end
+
+    def file
+      File.expand_path(@options[:params_file] || ".github_changelog_generator")
+    end
+
+    def file?
+      File.exist?(file)
+    end
+
+    def file_open
+      File.open(file)
+    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
+    end
+  end
+end

data/lib/github_changelog_generator/version.rb

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

data/spec/files/github_changelog_params_incorrect

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

data/spec/files/github_changelog_params_override

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

data/spec/spec_helper.rb

@@ -31,91 +31,25 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 SimpleCov.start
 
 require "github_changelog_generator"
+require "github_changelog_generator/task"
 
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
   config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
     mocks.verify_partial_doubles = true
   end
 
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
   config.filter_run :focus
   config.run_all_when_everything_filtered = true
 
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  # config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
   config.warnings = true
 
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = "doc"
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  # config.profile_examples = 10
+  config.default_formatter = "doc" if config.files_to_run.one?
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = :random
 
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
   Kernel.srand config.seed
 end

data/spec/unit/generator/generator_tags_spec.rb

@@ -87,6 +87,18 @@ describe GitHubChangelogGenerator::Generator do
       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
+      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
+      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_since_tag" do

data/spec/unit/parse_file_spec.rb

@@ -0,0 +1,32 @@
+describe GitHubChangelogGenerator::ParserFile do
+  describe ".github_changelog_generator" do
+    context "when no has file" do
+      let(:options) { {} }
+      let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
+      subject { parse.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(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
+      subject { parse.parse! }
+      it { is_expected.to be_a(Hash) }
+      it { is_expected.to eq(options) }
+    end
+
+    context "when file is incorrect" do
+      let(:options) { { params_file: "spec/files/github_changelog_params_incorrect" } }
+      let(:parse) { GitHubChangelogGenerator::ParserFile.new(options) }
+      it { expect { fail.raise! }.to raise_error RuntimeError }
+    end
+
+    context "when override default values" do
+      let(:options) { { params_file: "spec/files/github_changelog_params_override" }.merge(GitHubChangelogGenerator::Parser.get_default_options) }
+      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)) }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_changelog_generator
 version: !ruby/object:Gem::Version
-  version: 1.8.5
+  version: 1.9.0
 platform: ruby
 authors:
 - Petr Korolev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -101,15 +101,20 @@ files:
 - lib/github_changelog_generator/generator/generator_tags.rb
 - lib/github_changelog_generator/helper.rb
 - lib/github_changelog_generator/parser.rb
+- lib/github_changelog_generator/parser_file.rb
 - lib/github_changelog_generator/reader.rb
 - lib/github_changelog_generator/task.rb
 - lib/github_changelog_generator/version.rb
 - spec/files/angular.js.md
 - spec/files/bundler.md
 - spec/files/github-changelog-generator.md
+- spec/files/github_changelog_params_empty
+- spec/files/github_changelog_params_incorrect
+- spec/files/github_changelog_params_override
 - spec/spec_helper.rb
 - spec/unit/fetcher_spec.rb
 - spec/unit/generator/generator_tags_spec.rb
+- spec/unit/parse_file_spec.rb
 - spec/unit/parser_spec.rb
 - spec/unit/reader_spec.rb
 homepage: https://github.com/skywinder/Github-Changelog-Generator
@@ -132,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Script, that automatically generate changelog from your tags, issues, labels
@@ -141,9 +146,13 @@ test_files:
 - spec/files/angular.js.md
 - spec/files/bundler.md
 - spec/files/github-changelog-generator.md
+- spec/files/github_changelog_params_empty
+- spec/files/github_changelog_params_incorrect
+- spec/files/github_changelog_params_override
 - spec/spec_helper.rb
 - spec/unit/fetcher_spec.rb
 - spec/unit/generator/generator_tags_spec.rb
+- spec/unit/parse_file_spec.rb
 - spec/unit/parser_spec.rb
 - spec/unit/reader_spec.rb
 has_rdoc: