github_changelog_generator 1.14.3 → 1.15.0.pre.alpha

data/lib/github_changelog_generator/task.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "rake"
 require "rake/tasklib"
 require "github_changelog_generator"
@@ -7,7 +8,7 @@ module GitHubChangelogGenerator
   class RakeTask < ::Rake::TaskLib
     include ::Rake::DSL if defined?(::Rake::DSL)
 
-    OPTIONS = %w( user project token date_format output
+    OPTIONS = %w[ user project token date_format output
                   bug_prefix enhancement_prefix issue_prefix
                   header merge_prefix issues
                   add_issues_wo_labels add_pr_wo_labels
@@ -18,7 +19,7 @@ module GitHubChangelogGenerator
                   between_tags exclude_tags exclude_tags_regex since_tag max_issues
                   github_site github_endpoint simple_list
                   future_release release_branch verbose release_url
-                  base )
+                  base ]
 
     OPTIONS.each do |o|
       attr_accessor o.to_sym

data/lib/github_changelog_generator/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GitHubChangelogGenerator
-  VERSION = "1.14.3"
+  VERSION = "1.15.0-alpha"
 end

data/man/git-generate-changelog.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "November 2016" "" ""
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2016" "" ""
 .
 .SH "NAME"
 \fBgit\-generate\-changelog\fR \- Generate changelog from github
@@ -256,13 +256,13 @@ Use HTTP Cache to cache Github API requests (useful for large repos) Default is
 \-\-[no\-]cache\-file [CACHE\-FILE]
 .
 .P
-Filename to use for cache\. Default is /tmp/github\-changelog\-http\-cache
+Filename to use for cache\. Default is github\-changelog\-http\-cache in a temporary directory\.
 .
 .P
 \-\-cache\-log [CACHE\-LOG]
 .
 .P
-Filename to use for cache log\. Default is /tmp/github\-changelog\-logger\.log
+Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
 .
 .P
 \-\-[no\-]verbose

data/man/git-generate-changelog.1.html

@@ -192,10 +192,6 @@
 
 <p>   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
 
-<p>   --between-tags x,y,z</p>
-
-<p>   Change log will be filled only between specified tags</p>
-
 <p>   --exclude-tags x,y,z</p>
 
 <p>   Change log will exclude specified tags</p>
@@ -246,11 +242,11 @@
 
 <p>   --[no-]cache-file [CACHE-FILE]</p>
 
-<p>   Filename to use for cache. Default is /tmp/github-changelog-http-cache</p>
+<p>   Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.</p>
 
 <p>   --cache-log [CACHE-LOG]</p>
 
-<p>   Filename to use for cache log. Default is /tmp/github-changelog-logger.log</p>
+<p>   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>
 
 <p>   --[no-]verbose</p>
 
@@ -281,7 +277,7 @@
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>November 2016</li>
+    <li class='tc'>December 2016</li>
     <li class='tr'>git-generate-changelog(1)</li>
   </ol>
 

data/man/git-generate-changelog.html

@@ -184,10 +184,6 @@
 
 <p>   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'</p>
 
-<p>   --between-tags x,y,z</p>
-
-<p>   Change log will be filled only between specified tags</p>
-
 <p>   --exclude-tags x,y,z</p>
 
 <p>   Change log will exclude specified tags</p>

data/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
@@ -173,11 +169,15 @@ Automatically generate change log from your tags, issues, labels and pull reques
 
    --[no-]cache-file [CACHE-FILE]
 
-   Filename to use for cache. Default is /tmp/github-changelog-http-cache
+   Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.
 
    --cache-log [CACHE-LOG]
 
-   Filename to use for cache log. Default is /tmp/github-changelog-logger.log
+   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
+
+    --ssl-ca-file [PATH]
+
+   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem.  Respects SSL_CA_PATH.
 
    --[no-]verbose
 

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # Author:: Enrico Stahn <mail@enricostahn.com>
 #
@@ -16,7 +17,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "codeclimate-test-reporter"
 require "simplecov"
 require "coveralls"
 require "vcr"
@@ -28,8 +28,7 @@ end
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
                                                                  Coveralls::SimpleCov::Formatter,
-                                                                 SimpleCov::Formatter::HTMLFormatter,
-                                                                 CodeClimate::TestReporter::Formatter
+                                                                 SimpleCov::Formatter::HTMLFormatter
                                                                ])
 SimpleCov.start do
   add_filter "gemfiles/"

data/spec/unit/generator/generator_generation_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GitHubChangelogGenerator
+  describe Generator do
+    describe "#get_string_for_issue" do
+      let(:issue) do
+        { "title" => "Bug in code" }
+      end
+
+      it "formats an issue according to options" do
+        expect do
+          described_class.new.get_string_for_issue(issue)
+        end.not_to raise_error
+      end
+    end
+  end
+end

data/spec/unit/generator/generator_processor_spec.rb

@@ -1,19 +1,32 @@
 # frozen_string_literal: true
+
 module GitHubChangelogGenerator
   describe Generator do
-    context "#exclude_issues_by_labels" do
-      let(:label) { { "name" => "BAD" } }
-      let(:issue) { { "labels" => [label] } }
-      let(:good_label) { { "name" => "GOOD" } }
-      let(:good_issue) { { "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)
+    let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
+    let(:options) { {} }
+    let(:generator) { described_class.new(default_options.merge(options)) }
+
+    let(:bad_label) { { "name" => "BAD" } }
+    let(:bad_issue) { { "labels" => [bad_label] } }
+    let(:good_label) { { "name" => "GOOD" } }
+    let(:good_issue) { { "labels" => [good_label] } }
+    let(:unlabeled_issue) { { "labels" => [] } }
+    let(:issues) { [bad_issue, good_issue, unlabeled_issue] }
+
+    describe "#exclude_issues_by_labels" do
+      subject do
+        generator.exclude_issues_by_labels(issues)
+      end
+
+      let(:expected_issues) { issues }
+
+      it { is_expected.to eq(expected_issues) }
+
+      context "when 'exclude_lables' is provided" do
+        let(:options) { { exclude_labels: %w[BAD BOO] } }
+        let(:expected_issues) { [good_issue, unlabeled_issue] }
+
+        it { is_expected.to eq(expected_issues) }
       end
 
       context "with no option given" do
@@ -25,5 +38,43 @@ module GitHubChangelogGenerator
         end
       end
     end
+
+    describe "#get_filtered_issues" do
+      subject do
+        generator.get_filtered_issues(issues)
+      end
+
+      let(:expected_issues) { issues }
+
+      it { is_expected.to eq(expected_issues) }
+
+      context "when 'exclude_labels' is provided" do
+        let(:options) { { exclude_labels: %w[BAD BOO] } }
+        let(:expected_issues) { [good_issue, unlabeled_issue] }
+
+        it { is_expected.to eq(expected_issues) }
+      end
+
+      context "when 'add_issues_wo_labels' is false" do
+        let(:options) { { add_issues_wo_labels: false } }
+        let(:expected_issues) { [bad_issue, good_issue] }
+
+        it { is_expected.to eq(expected_issues) }
+
+        context "with 'exclude_labels'" do
+          let(:options) { { add_issues_wo_labels: false, exclude_labels: %w[GOOD] } }
+          let(:expected_issues) { [bad_issue] }
+
+          it { is_expected.to eq(expected_issues) }
+        end
+      end
+
+      context "when 'include_labels' is specified" do
+        let(:options) { { include_labels: %w[GOOD] } }
+        let(:expected_issues) { [good_issue] }
+
+        it { is_expected.to eq(expected_issues) }
+      end
+    end
   end
 end

data/spec/unit/generator/generator_tags_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 describe GitHubChangelogGenerator::Generator do
   def tag_with_name(tag)
     {
@@ -12,174 +13,231 @@ describe GitHubChangelogGenerator::Generator do
     end
   end
 
-  describe "#filter_between_tags" do
-    context "when between_tags nil" do
-      before do
-        @generator = GitHubChangelogGenerator::Generator.new(between_tags: nil)
-      end
+  describe "#tag_section_mapping" do
+    let(:all_tags) { tags_from_strings(%w[8 7 6 5 4 3 2 1]) }
+    let(:sorted_tags) { all_tags }
 
-      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))) }
+    let(:default_options) { GitHubChangelogGenerator::Parser.default_options }
+    let(:options) { {} }
+    let(:generator) { described_class.new(default_options.merge(options)) }
+
+    before do
+      allow_any_instance_of(GitHubChangelogGenerator::OctoFetcher).to receive(:get_all_tags).and_return(all_tags)
+      allow(generator).to receive(:fetch_tags_dates).with(all_tags)
+      allow(generator).to receive(:sort_tags_by_date).with(all_tags).and_return(sorted_tags)
+      generator.fetch_and_filter_tags
     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))) }
+
+    subject do
+      generator.tag_section_mapping
     end
 
-    context "when between_tags filled with correct values" do
-      before do
-        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2))
+    shared_examples_for "a section mapping" do
+      it { is_expected.to be_a(Hash) }
+      it { is_expected.to eq(expected_mapping) }
+    end
+
+    shared_examples_for "a full changelog" do
+      let(:expected_mapping) do
+        {
+          tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
+          tag_with_name("7") => [tag_with_name("6"), tag_with_name("7")],
+          tag_with_name("6") => [tag_with_name("5"), tag_with_name("6")],
+          tag_with_name("5") => [tag_with_name("4"), tag_with_name("5")],
+          tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
+          tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
+          tag_with_name("2") => [tag_with_name("1"), tag_with_name("2")],
+          tag_with_name("1") => [nil, tag_with_name("1")]
+        }
       end
-      subject do
-        @generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
+
+      it_behaves_like "a section mapping"
+    end
+
+    shared_examples_for "a changelog with some exclusions" do
+      let(:expected_mapping) do
+        {
+          tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
+          tag_with_name("6") => [tag_with_name("5"), tag_with_name("6")],
+          tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
+          tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
+          tag_with_name("1") => [nil, tag_with_name("1")]
+        }
       end
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
+
+      it_behaves_like "a section mapping"
     end
 
-    context "when between_tags filled with invalid values" do
-      before do
-        @generator = GitHubChangelogGenerator::Generator.new(between_tags: %w(1 q w))
+    context "with no constraints" do
+      it_behaves_like "a full changelog"
+    end
+
+    context "with since only" do
+      let(:options) { { since_tag: "6" } }
+      let(:expected_mapping) do
+        {
+          tag_with_name("8") => [tag_with_name("7"), tag_with_name("8")],
+          tag_with_name("7") => [tag_with_name("6"), tag_with_name("7")]
+        }
       end
 
-      subject do
-        @generator.get_filtered_tags(tags_from_strings(%w(1 2 3)))
+      it_behaves_like "a section mapping"
+    end
+
+    context "with due only" do
+      let(:options) { { due_tag: "4" } }
+      let(:expected_mapping) do
+        {
+          tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")],
+          tag_with_name("2") => [tag_with_name("1"), tag_with_name("2")],
+          tag_with_name("1") => [nil, tag_with_name("1")]
+        }
       end
-      it { is_expected.to be_a(Array) }
-      it { is_expected.to match_array(tags_from_strings(%w(1))) }
+
+      it_behaves_like "a section mapping"
     end
-  end
 
-  describe "#get_filtered_tags" do
-    subject do
-      generator.get_filtered_tags(tags_from_strings(%w(1 2 3 4 5)))
+    context "with since and due" do
+      let(:options) { { since_tag: "2", due_tag: "5" } }
+      let(:expected_mapping) do
+        {
+          tag_with_name("4") => [tag_with_name("3"), tag_with_name("4")],
+          tag_with_name("3") => [tag_with_name("2"), tag_with_name("3")]
+        }
+      end
+
+      it_behaves_like "a section mapping"
     end
 
-    context "respects between tags" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(between_tags: %w(1 2 3)) }
+    context "with excluded tags" do
+      context "as a list of strings" do
+        let(:options) { { exclude_tags: %w[2 5 7] } }
 
-      it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
+        it_behaves_like "a changelog with some exclusions"
+      end
+
+      context "as a regex" do
+        let(:options) { { exclude_tags: /[257]/ } }
+
+        it_behaves_like "a changelog with some exclusions"
+      end
+
+      context "as a regex string" do
+        let(:options) { { exclude_tags_regex: "[257]" } }
+
+        it_behaves_like "a changelog with some exclusions"
+      end
     end
   end
 
   describe "#filter_excluded_tags" do
-    subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
+    subject { generator.filter_excluded_tags(tags_from_strings(%w[1 2 3])) }
 
     context "with matching string" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(3)) }
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w[3]) }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_from_strings(%w(1 2))) }
+      it { is_expected.to match_array(tags_from_strings(%w[1 2])) }
     end
 
     context "with non-matching string" do
-      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w(invalid tags)) }
+      let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: %w[invalid tags]) }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
+      it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
     end
 
     context "with matching regex" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[23]/) }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_from_strings(%w(1))) }
+      it { is_expected.to match_array(tags_from_strings(%w[1])) }
     end
 
     context "with non-matching regex" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags: /[abc]/) }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
+      it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
     end
   end
 
   describe "#filter_excluded_tags_regex" do
-    subject { generator.filter_excluded_tags(tags_from_strings(%w(1 2 3))) }
+    subject { generator.filter_excluded_tags(tags_from_strings(%w[1 2 3])) }
 
     context "with matching regex" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[23]") }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_from_strings(%w(1))) }
+      it { is_expected.to match_array(tags_from_strings(%w[1])) }
     end
 
     context "with non-matching regex" do
       let(:generator) { GitHubChangelogGenerator::Generator.new(exclude_tags_regex: "[45]") }
       it { is_expected.to be_a Array }
-      it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
+      it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
     end
   end
 
   describe "#filter_since_tag" do
     context "with filled array" do
-      subject { generator.filter_since_tag(tags_from_strings(%w(1 2 3))) }
+      subject { generator.filter_since_tag(tags_from_strings(%w[1 2 3])) }
 
       context "with valid since tag" do
         let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
         it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_from_strings(%w(1))) }
+        it { is_expected.to match_array(tags_from_strings(%w[1 2])) }
       end
 
       context "with invalid since tag" do
         let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
         it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
+        it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
       end
     end
 
     context "with empty array" do
-      subject { generator.filter_since_tag(tags_from_strings(%w())) }
+      subject { generator.filter_since_tag(tags_from_strings(%w[])) }
 
       context "with valid since tag" do
         let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "2") }
         it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_from_strings(%w())) }
+        it { is_expected.to match_array(tags_from_strings(%w[])) }
       end
 
       context "with invalid since tag" do
         let(:generator) { GitHubChangelogGenerator::Generator.new(since_tag: "Invalid tag") }
         it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_from_strings(%w())) }
+        it { is_expected.to match_array(tags_from_strings(%w[])) }
       end
     end
   end
 
   describe "#filter_due_tag" do
     context "with filled array" do
-      subject { generator.filter_due_tag(tags_from_strings(%w(1 2 3))) }
+      subject { generator.filter_due_tag(tags_from_strings(%w[1 2 3])) }
 
       context "with valid due tag" do
         let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
         it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_from_strings(%w(3))) }
+        it { is_expected.to match_array(tags_from_strings(%w[3])) }
       end
 
       context "with invalid due tag" do
         let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
         it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_from_strings(%w(1 2 3))) }
+        it { is_expected.to match_array(tags_from_strings(%w[1 2 3])) }
       end
     end
 
     context "with empty array" do
-      subject { generator.filter_due_tag(tags_from_strings(%w())) }
+      subject { generator.filter_due_tag(tags_from_strings(%w[])) }
 
       context "with valid due tag" do
         let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "2") }
         it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_from_strings(%w())) }
+        it { is_expected.to match_array(tags_from_strings(%w[])) }
       end
 
       context "with invalid due tag" do
         let(:generator) { GitHubChangelogGenerator::Generator.new(due_tag: "Invalid tag") }
         it { is_expected.to be_a Array }
-        it { is_expected.to match_array(tags_from_strings(%w())) }
+        it { is_expected.to match_array(tags_from_strings(%w[])) }
       end
     end
   end
@@ -232,13 +290,13 @@ describe GitHubChangelogGenerator::Generator do
       @generator.sort_tags_by_date(tags)
     end
     context "sort unsorted tags" do
-      let(:tags) { tags_from_strings %w(valid_tag1 valid_tag2 valid_tag3) }
+      let(:tags) { tags_from_strings %w[valid_tag1 valid_tag2 valid_tag3] }
 
       it { is_expected.to be_a_kind_of(Array) }
       it { is_expected.to match_array(tags.reverse!) }
     end
     context "sort sorted tags" do
-      let(:tags) { tags_from_strings %w(valid_tag3 valid_tag2 valid_tag1) }
+      let(:tags) { tags_from_strings %w[valid_tag3 valid_tag2 valid_tag1] }
 
       it { is_expected.to be_a_kind_of(Array) }
       it { is_expected.to match_array(tags) }