From 783d8f306e73719601610f2ac3ac6c4cf24044a2 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Tue, 26 May 2015 16:01:23 +0300 Subject: [PATCH] Resolved #214. Added tests for this case. small refacroting --- .rubocop.yml | 8 +++++++ .rubocop_todo.yml | 14 ++--------- .../generator/generator_tags.rb | 19 ++++++++++++++- lib/github_changelog_generator/parser.rb | 5 +++- spec/unit/generator/generator_tags_spec.rb | 23 ++++++++++++++++++- 5 files changed, 54 insertions(+), 15 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 5a712a8..d9eac99 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -6,3 +6,11 @@ Metrics/LineLength: #http://viget.com/extend/just-use-double-quoted-ruby-strings Style/StringLiterals: EnforcedStyle: double_quotes + +# Configuration parameters: CountComments. +Metrics/ClassLength: + Enabled: false + +# Configuration parameters: CountComments. +Metrics/MethodLength: + Enabled: false diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 56e2cc5..0e98934 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,5 +1,5 @@ # This configuration was generated by `rubocop --auto-gen-config` -# on 2015-05-25 17:16:04 +0300 using RuboCop version 0.31.0. +# on 2015-05-26 16:00:55 +0300 using RuboCop version 0.31.0. # 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 @@ -7,22 +7,12 @@ # Offense count: 14 Metrics/AbcSize: - Max: 57 - -# Offense count: 4 -# Configuration parameters: CountComments. -Metrics/ClassLength: - Max: 182 + Max: 59 # Offense count: 1 Metrics/CyclomaticComplexity: Max: 7 -# Offense count: 22 -# Configuration parameters: CountComments. -Metrics/MethodLength: - Max: 84 - # Offense count: 1 Metrics/PerceivedComplexity: Max: 8 diff --git a/lib/github_changelog_generator/generator/generator_tags.rb b/lib/github_changelog_generator/generator/generator_tags.rb index 3020f24..6e4cc7d 100644 --- a/lib/github_changelog_generator/generator/generator_tags.rb +++ b/lib/github_changelog_generator/generator/generator_tags.rb @@ -37,7 +37,11 @@ module GitHubChangelogGenerator # # @return [Array] def get_filtered_tags(all_tags) - all_tags = all_tags + filtered_tags = filter_between_tags(all_tags) + filter_excluded_tags(filtered_tags) + end + + def filter_between_tags(all_tags) filtered_tags = all_tags if @options[:between_tags] @options[:between_tags].each do |tag| @@ -49,5 +53,18 @@ module GitHubChangelogGenerator end filtered_tags end + + def filter_excluded_tags(all_tags) + filtered_tags = all_tags + if @options[:exclude_tags] + @options[:exclude_tags].each do |tag| + unless all_tags.include? tag + puts "Warning: can't find tag #{tag}, specified with --between-tags option.".yellow + end + end + filtered_tags = all_tags.reject { |tag| @options[:exclude_tags].include? tag } + end + filtered_tags + end end end diff --git a/lib/github_changelog_generator/parser.rb b/lib/github_changelog_generator/parser.rb index 598a561..683b294 100644 --- a/lib/github_changelog_generator/parser.rb +++ b/lib/github_changelog_generator/parser.rb @@ -84,9 +84,12 @@ module GitHubChangelogGenerator opts.on("--exclude-labels x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list| options[:exclude_labels] = list end - opts.on("--between-tags x,y,z", Array, "Change log will be filed only between specified tags") do |list| + opts.on("--between-tags x,y,z", Array, "Change log will be filled only between specified tags") do |list| options[:between_tags] = list end + opts.on("--exclude-tags x,y,z", Array, "Change log will be exclude specified tags") do |list| + options[:exclude_tags] = list + end opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max| options[:max_issues] = max end diff --git a/spec/unit/generator/generator_tags_spec.rb b/spec/unit/generator/generator_tags_spec.rb index 5e6b442..f3ffca7 100644 --- a/spec/unit/generator/generator_tags_spec.rb +++ b/spec/unit/generator/generator_tags_spec.rb @@ -1,5 +1,5 @@ describe GitHubChangelogGenerator::Generator do - describe "#get_filtered_tags" do + describe "#filter_between_tags" do context "when between_tags nil" do before do @generator = GitHubChangelogGenerator::Generator.new(between_tags: nil) @@ -45,4 +45,25 @@ describe GitHubChangelogGenerator::Generator do it { is_expected.to match_array(%w(1)) } end end + + describe "#get_filtered_tags" do + subject { generator.get_filtered_tags(%w(1 2 3 4 5)) } + # before { generator.get_filtered_tags(%w(1 2 3 4 5)) } + + context "with excluded and between tags" do + let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3), exclude_tags: %w(2)) } + it { is_expected.to be_a Array } + it { is_expected.to match_array(%w(1 3)) } + end + end + + describe "#filter_excluded_tags" do + subject { generator.filter_excluded_tags(%w(1 2 3)) } + + context "with valid excluded tags" do + let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) } + it { is_expected.to be_a Array } + it { is_expected.to match_array(%w(1 2)) } + end + end end