Merge branch 'release/1.11.4'

- OS X, Ubuntu manpath files checked

.rubocop.yml

@@ -18,3 +18,39 @@ Metrics/MethodLength:
 Style/FileName:
     Exclude:
       - 'bin/git-generate-changelog'
+
+#TODOS
+# Offense count: 14
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 10
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+# SupportedStyles: skip_modifier_ifs, always
+Style/Next:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/MutableConstant:
+    Enabled: false
+    

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-02-23 12:36:44 +0200 using RuboCop version 0.37.2.
+# on 2016-02-23 17:18:27 +0200 using RuboCop version 0.37.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

CHANGELOG.md

@@ -1,5 +1,72 @@
 # Change Log
 
+## [1.11.3](https://github.com/skywinder/github-changelog-generator/tree/1.11.3) (2016-02-25)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.2...1.11.3)
+
+**Closed issues:**
+
+- Cannot install gem [\#335](https://github.com/skywinder/github-changelog-generator/issues/335)
+
+## [1.11.2](https://github.com/skywinder/github-changelog-generator/tree/1.11.2) (2016-02-25)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.1...1.11.2)
+
+**Fixed bugs:**
+
+- Getting an error on install [\#329](https://github.com/skywinder/github-changelog-generator/issues/329)
+
+**Merged pull requests:**
+
+- Fix installation by not running the specs - which have dependencies [\#337](https://github.com/skywinder/github-changelog-generator/pull/337) ([skywinder](https://github.com/skywinder))
+
+## [1.11.1](https://github.com/skywinder/github-changelog-generator/tree/1.11.1) (2016-02-25)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.11.0...1.11.1)
+
+**Merged pull requests:**
+
+- Add rubocop and rspec as runtime dependencies [\#336](https://github.com/skywinder/github-changelog-generator/pull/336) ([jkeiser](https://github.com/jkeiser))
+- \[Refactor\] ParserFile class use Pathname [\#334](https://github.com/skywinder/github-changelog-generator/pull/334) ([olleolleolle](https://github.com/olleolleolle))
+- \[Refactor\] Generator\#exclude\_issues\_by\_labels simpler, tested [\#332](https://github.com/skywinder/github-changelog-generator/pull/332) ([olleolleolle](https://github.com/olleolleolle))
+
+## [1.11.0](https://github.com/skywinder/github-changelog-generator/tree/1.11.0) (2016-02-24)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.5...1.11.0)
+
+## [1.10.5](https://github.com/skywinder/github-changelog-generator/tree/1.10.5) (2016-02-24)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.4...1.10.5)
+
+## [1.10.4](https://github.com/skywinder/github-changelog-generator/tree/1.10.4) (2016-02-24)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.3...1.10.4)
+
+**Fixed bugs:**
+
+- Rake and Bundler as runtime deps [\#333](https://github.com/skywinder/github-changelog-generator/pull/333) ([olleolleolle](https://github.com/olleolleolle))
+
+**Merged pull requests:**
+
+- Test case for \#327 [\#331](https://github.com/skywinder/github-changelog-generator/pull/331) ([olleolleolle](https://github.com/olleolleolle))
+- Fix crash installing on systems without overcommit [\#330](https://github.com/skywinder/github-changelog-generator/pull/330) ([jkeiser](https://github.com/jkeiser))
+
+## [1.10.3](https://github.com/skywinder/github-changelog-generator/tree/1.10.3) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.2...1.10.3)
+
+## [1.10.2](https://github.com/skywinder/github-changelog-generator/tree/1.10.2) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.11.0...1.10.2)
+
+## [v1.11.0](https://github.com/skywinder/github-changelog-generator/tree/v1.11.0) (2016-02-23)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.1...v1.11.0)
+
+**Implemented enhancements:**
+
+- YAML front matter [\#322](https://github.com/skywinder/github-changelog-generator/pull/322) ([retorquere](https://github.com/retorquere))
+- Git Subcommand [\#288](https://github.com/skywinder/github-changelog-generator/pull/288) ([dlanileonardo](https://github.com/dlanileonardo))
+
+**Fixed bugs:**
+
+- detect\_since\_tag undefined [\#328](https://github.com/skywinder/github-changelog-generator/issues/328)
+
+**Merged pull requests:**
+
+- Update README.md [\#324](https://github.com/skywinder/github-changelog-generator/pull/324) ([Zearin](https://github.com/Zearin))
+
 ## [1.10.1](https://github.com/skywinder/github-changelog-generator/tree/1.10.1) (2016-01-06)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/1.10.0...1.10.1)
 

Gemfile

@@ -3,10 +3,11 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem "rspec", "~>3.2"
+  gem "rake"
-  gem "rubocop", "~>0.31"
+  gem "bundler"
+  gem "rubocop"
+  gem "overcommit"
   gem "coveralls", "~>0.8", require: false
   gem "simplecov", "~>0.10", require: false
   gem "codeclimate-test-reporter", "~>0.4"
-  gem "overcommit", "~>0.31"
 end

Gemfile.lock

@@ -1,9 +1,14 @@
 PATH
   remote: .
   specs:
-    github_changelog_generator (1.11.0)
+    github_changelog_generator (1.11.3)
+      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/
@@ -93,14 +98,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.7)
+  bundler
   codeclimate-test-reporter (~> 0.4)
   coveralls (~> 0.8)
   github_changelog_generator!
-  overcommit (~> 0.31)
+  overcommit
-  rake (~> 10.0)
+  rake
-  rspec (~> 3.2)
+  rubocop
-  rubocop (~> 0.31)
   simplecov (~> 0.10)
 
 BUNDLED WITH

Rakefile

@@ -1,3 +1,4 @@
+require "bundler"
 require "bundler/gem_tasks"
 require "rubocop/rake_task"
 require "rspec/core/rake_task"
@@ -8,15 +9,31 @@ require "overcommit"
 RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:rspec)
 
-task :create_man do |_t|
+task :copy_man_page_to_manpath do |_t|
-  os_prefix = "/usr/local"
+  known_manpath_paths = %w(/etc/manpath.config /etc/manpaths)
-  man_prefix = Pathname("#{os_prefix}/share/man/man1")
+  manpath = known_manpath_paths.find do |f|
-  man_pages = "man/git-*"
+    path = Pathname(f)
+    path.file? && path.readable?
+  end
+
+  return unless manpath
+
+  writable_man_path = Pathname(manpath).each_line.find do |line|
+    path = Pathname(line.chomp)
+    path.directory? && path.writable?
+  end
+
+  return unless writable_man_path
+
+  man_prefix = Pathname("#{writable_man_path.chomp}/man1")
+  man_pages = "man/git-*.1"
 
   Pathname.glob(man_pages) do |path|
+    if path.exist? && man_prefix.exist? && man_prefix.writable?
       FileUtils.cp(path, man_prefix + path.basename)
     end
   end
+end
 
 task checks: [:rubocop, :rspec]
-task default: [:checks, :create_man]
+task default: [:copy_man_page_to_manpath]

github_changelog_generator.gemspec

@@ -24,10 +24,11 @@ Gem::Specification.new do |spec|
   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")
-  # Development only
+  spec.add_runtime_dependency("rubocop", ">= 0.31")
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_runtime_dependency("rspec", ">= 3.2")
-  spec.add_development_dependency "rake", "~> 10.0"
 end

lib/github_changelog_generator/fetcher.rb

@@ -7,11 +7,11 @@ module GitHubChangelogGenerator
 
   class Fetcher
     PER_PAGE_NUMBER = 30
-    CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN".freeze
+    CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
     GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
-    "missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument.".freeze
+    "missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
     NO_TOKEN_PROVIDED = "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found. " \
-    "This script can make only 50 requests to GitHub API per hour without token!".freeze
+    "This script can make only 50 requests to GitHub API per hour without token!"
 
     def initialize(options = {})
       @options = options || {}

lib/github_changelog_generator/generator/generator_processor.rb

@@ -4,14 +4,13 @@ module GitHubChangelogGenerator
     # @param [Array] issues
     # @return [Array] filtered array
     def exclude_issues_by_labels(issues)
-      unless @options[:exclude_labels].nil?
+      return issues if !@options[:exclude_labels] || @options[:exclude_labels].empty?
-        issues = issues.select do |issue|
+
-          var = issue.labels.map(&:name) & @options[:exclude_labels]
+      issues.reject do |issue|
-          !var.any?
+        labels = issue.labels.map(&:name)
+        (labels & @options[:exclude_labels]).any?
       end
     end
-      issues
-    end
 
     # @return [Array] filtered issues accourding milestone
     def filter_by_milestone(filtered_issues, tag_name, all_issues)

lib/github_changelog_generator/parser_file.rb

@@ -1,21 +1,24 @@
+require "pathname"
+
 module GitHubChangelogGenerator
   ParserError = Class.new(StandardError)
 
   class ParserFile
+    FILENAME = ".github_changelog_generator"
+
     def initialize(options)
       @options = options
     end
 
+    # Destructively change @options using data in configured options file.
     def parse!
-      return unless File.exist?(file)
+      file.each_line { |line| parse_line!(line) } if file.exist?
-
-      File.readlines(file).each { |line| parse_line!(line) }
     end
 
     private
 
     def file
-      @file ||= File.expand_path(@options[:params_file] || ".github_changelog_generator")
+      @file ||= Pathname(File.expand_path(@options[:params_file] || FILENAME))
     end
 
     def parse_line!(line)

lib/github_changelog_generator/task.rb

@@ -17,7 +17,7 @@ module GitHubChangelogGenerator
                   between_tags exclude_tags since_tag max_issues
                   github_site github_endpoint simple_list
                   future_release release_branch verbose release_url
-                  base ).freeze
+                  base )
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym

lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = "1.11.0".freeze
+  VERSION = "1.11.4"
 end

spec/files/github_changelog_params_327

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

spec/spec_helper.rb

@@ -23,11 +23,11 @@ require "coveralls"
 module SpecHelper
 end
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
                                                                  Coveralls::SimpleCov::Formatter,
                                                                  SimpleCov::Formatter::HTMLFormatter,
                                                                  CodeClimate::TestReporter::Formatter
-]
+                                                               ])
 SimpleCov.start
 
 require "github_changelog_generator"

spec/unit/fetcher_spec.rb

@@ -1,8 +1,8 @@
-VALID_TOKEN = "0123456789abcdef".freeze
+VALID_TOKEN = "0123456789abcdef"
-INVALID_TOKEN = "0000000000000000".freeze
+INVALID_TOKEN = "0000000000000000"
 
 DEFAULT_OPTIONS = { user: "skywinder",
-                    project: "changelog_test" }.freeze
+                    project: "changelog_test" }
 
 def options_with_invalid_token
   options = DEFAULT_OPTIONS

spec/unit/generator/generator_processor_spec.rb

@@ -0,0 +1,28 @@
+module GitHubChangelogGenerator
+  describe Generator do
+    context "#exclude_issues_by_labels" do
+      let(:label) { double("the-bad-label", name: "BAD") }
+      let(:issue) { double("the-issue-to-be-excluded", labels: [label]) }
+      let(:good_label) { double("a-good-label", name: "GOOD") }
+      let(:good_issue) { double("an-issue-to-be-kept", labels: [good_label]) }
+      let(:issues) { [issue, good_issue] }
+      subject(:generator) { described_class.new(exclude_labels: %w(BAD BOO)) }
+
+      it "removes issues with labels in the exclude_label list" do
+        result = generator.exclude_issues_by_labels(issues)
+
+        expect(result).to include(good_issue)
+        expect(result).not_to include(issue)
+      end
+
+      context "with no option given" do
+        subject(:generator) { described_class.new }
+        it "passes everything through when no option given" do
+          result = generator.exclude_issues_by_labels(issues)
+
+          expect(result).to eq(issues)
+        end
+      end
+    end
+  end
+end

spec/unit/parse_file_spec.rb

@@ -36,6 +36,20 @@ describe GitHubChangelogGenerator::ParserFile do
                                           unreleased: false,
                                           header: "=== Changelog ==="))
       end
+
+      context "turns exclude-labels into an Array", bug: '#327' do
+        let(:options) do
+          {
+            params_file: "spec/files/github_changelog_params_327"
+          }
+        end
+        it "reads exclude_labels into an Array" do
+          pending("Related with Bug #327.")
+          expect { parse.parse! }.to change { options[:exclude_labels] }
+            .from(nil)
+            .to(["73a91042-da6f-11e5-9335-1040f38d7f90", "7adf83b4-da6f-11e5-ae18-1040f38d7f90"])
+        end
+      end
     end
   end
 end