From 71662c55412812624cb4155be5e3caae18e4e012 Mon Sep 17 00:00:00 2001 From: Lucas Huang Date: Sun, 14 May 2017 17:35:45 -0700 Subject: [PATCH] remove between_tags option --- .../generator/generator_tags.rb | 22 +------ lib/github_changelog_generator/parser.rb | 3 - man/git-generate-changelog.1.html | 4 -- man/git-generate-changelog.html | 4 -- man/git-generate-changelog.md | 4 -- spec/unit/generator/generator_tags_spec.rb | 60 ------------------- 6 files changed, 2 insertions(+), 95 deletions(-) diff --git a/lib/github_changelog_generator/generator/generator_tags.rb b/lib/github_changelog_generator/generator/generator_tags.rb index 01480b575..039435492 100644 --- a/lib/github_changelog_generator/generator/generator_tags.rb +++ b/lib/github_changelog_generator/generator/generator_tags.rb @@ -95,13 +95,12 @@ def version_of_first_item sections.first["version"] if sections && sections.any? end - # Return tags after filtering tags in lists provided by option: --between-tags & --exclude-tags + # Return tags after filtering tags in lists provided by option: --exclude-tags # # @return [Array] def get_filtered_tags(all_tags) filtered_tags = filter_since_tag(all_tags) - filtered_tags = filter_due_tag(filtered_tags) - filter_between_tags(filtered_tags) + filter_due_tag(filtered_tags) end # @param [Array] all_tags all tags @@ -144,23 +143,6 @@ def filter_due_tag(all_tags) filtered_tags end - # @param [Array] all_tags all tags - # @return [Array] filtered tags according :between_tags option - def filter_between_tags(all_tags) - filtered_tags = all_tags - tag_names = filtered_tags.map { |ft| ft["name"] } - - if options[:between_tags] - options[:between_tags].each do |tag| - unless tag_names.include?(tag) - Helper.log.warn "Warning: can't find tag #{tag}, specified with --between-tags option." - end - end - filtered_tags = all_tags.select { |tag| options[:between_tags].include?(tag["name"]) } - end - filtered_tags - end - # @param [Array] all_tags all tags # @return [Array] filtered tags according :exclude_tags or :exclude_tags_regex option def filter_excluded_tags(all_tags) diff --git a/lib/github_changelog_generator/parser.rb b/lib/github_changelog_generator/parser.rb index e3a1ab5e8..3e42bfbf9 100755 --- a/lib/github_changelog_generator/parser.rb +++ b/lib/github_changelog_generator/parser.rb @@ -131,9 +131,6 @@ def self.setup_parser(options) opts.on("--issue-line-labels x,y,z", Array, 'The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].') do |list| options[:issue_line_labels] = list end - 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 exclude specified tags") do |list| options[:exclude_tags] = list end diff --git a/man/git-generate-changelog.1.html b/man/git-generate-changelog.1.html index ad35a9224..fda1bc383 100644 --- a/man/git-generate-changelog.1.html +++ b/man/git-generate-changelog.1.html @@ -192,10 +192,6 @@

OPTIONS

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

diff --git a/man/git-generate-changelog.html b/man/git-generate-changelog.html index be231c44b..3b67983b1 100644 --- a/man/git-generate-changelog.html +++ b/man/git-generate-changelog.html @@ -184,10 +184,6 @@

OPTIONS

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

diff --git a/man/git-generate-changelog.md b/man/git-generate-changelog.md index 6a77531da..a6aa166e2 100644 --- a/man/git-generate-changelog.md +++ b/man/git-generate-changelog.md @@ -119,10 +119,6 @@ Automatically generate change log from your tags, issues, labels and pull reques 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 diff --git a/spec/unit/generator/generator_tags_spec.rb b/spec/unit/generator/generator_tags_spec.rb index 64dab2427..bc90a2c00 100644 --- a/spec/unit/generator/generator_tags_spec.rb +++ b/spec/unit/generator/generator_tags_spec.rb @@ -12,66 +12,6 @@ def tags_from_strings(tags_strings) end end - describe "#filter_between_tags" do - context "when between_tags nil" do - before do - @generator = GitHubChangelogGenerator::Generator.new(between_tags: nil) - end - - subject do - @generator.get_filtered_tags(tags_from_strings(%w(1 2 3))) - end - it { is_expected.to be_a(Array) } - it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) } - end - context "when between_tags same as input array" do - before do - @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3)) - end - subject do - @generator.get_filtered_tags(tags_from_strings(%w(1 2 3))) - end - it { is_expected.to be_a(Array) } - it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) } - end - - context "when between_tags filled with correct values" do - before do - @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2)) - end - subject do - @generator.get_filtered_tags(tags_from_strings(%w(1 2 3))) - end - it { is_expected.to be_a(Array) } - it { is_expected.to match_array(tags_from_strings(%w(1 2))) } - end - - context "when between_tags filled with invalid values" do - before do - @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 q w)) - end - - subject do - @generator.get_filtered_tags(tags_from_strings(%w(1 2 3))) - end - it { is_expected.to be_a(Array) } - it { is_expected.to match_array(tags_from_strings(%w(1))) } - end - end - - describe "#get_filtered_tags" do - subject do - generator.get_filtered_tags(tags_from_strings(%w(1 2 3 4 5))) - end - - context "respects between tags" do - let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3)) } - - it { is_expected.to be_a Array } - it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) } - end - end - describe "#filter_excluded_tags" do subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }