github_changelog_generator 1.15.0 → 1.16.3

data/spec/unit/generator/generator_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "github_changelog_generator/generator/generator"
+
+RSpec.describe GitHubChangelogGenerator::Generator do
+  let(:header) { "# Changelog" }
+  let(:generator) { described_class.new({ header: header }) }
+  let(:content) do
+    <<~'BASE'
+      ## [1.3.10](https://github.com/xxx/yyy/tree/1.3.10) (2015-03-18)
+
+      [Full Changelog](https://github.com/xxx/yyy/compare/1.3.9...1.3.10)
+
+      **Fixed bugs:**
+
+
+    BASE
+  end
+  let(:footer) do
+    <<~CREDIT
+      \\* *This Changelog was automatically generated \
+      by [github_changelog_generator]\
+      (https://github.com/github-changelog-generator/github-changelog-generator)*
+    CREDIT
+  end
+
+  context "when the given base file has previously appended template messages" do
+    describe "#remove_old_fixed_string" do
+      it "removes old template headers and footers" do
+        log = +"#{header}\n\n#{header}\n#{header}#{content}\n\n#{footer}\n#{footer}#{footer}"
+
+        expect(generator.send(:remove_old_fixed_string, log)).to eq content
+      end
+    end
+  end
+
+  context "when plain contents string was given" do
+    describe "#insert_fixed_string" do
+      it "append template messages at header and footer" do
+        log = String.new(content)
+        ans = "#{header}\n\n#{content}\n\n#{footer}"
+
+        expect(generator.send(:insert_fixed_string, log)).to eq ans
+      end
+    end
+  end
+end

data/spec/unit/generator/generator_tags_spec.rb

@@ -13,6 +13,33 @@ describe GitHubChangelogGenerator::Generator do
     end
   end
 
+  describe "#detect_link_tag_time" do
+    let(:newer_tag) { nil }
+
+    let(:default_options) { GitHubChangelogGenerator::Parser.default_options.merge(verbose: false) }
+    let(:options) do
+      {
+        future_release: "2.0.0"
+      }
+    end
+    let(:generator) { described_class.new(default_options.merge(options)) }
+
+    subject do
+      generator.detect_link_tag_time(newer_tag)
+    end
+
+    context "When the local date is not the same as the UTC date" do
+      before do
+        # 2020-12-27T17:00:00-10:00 is 2020-12-28T03:00:00Z.
+        # GitHub API date & time use UTC, so this instant when converted as a
+        # date should be 2020-12-28.
+        expect(Time).to receive(:new).and_return(Time.new(2020, 12, 27, 17, 0, 0, "-10:00"))
+      end
+
+      it { is_expected.to eq(["2.0.0", "2.0.0", Time.gm(2020, 12, 28, 3)]) }
+    end
+  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 }
@@ -57,10 +84,10 @@ describe GitHubChangelogGenerator::Generator do
     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("8") => [tag_with_name("6"), tag_with_name("8")],
+          tag_with_name("6") => [tag_with_name("4"), 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("3") => [tag_with_name("1"), tag_with_name("3")],
           tag_with_name("1") => [nil, tag_with_name("1")]
         }
       end
@@ -130,6 +157,22 @@ describe GitHubChangelogGenerator::Generator do
     end
   end
 
+  describe "#filter_included_tags_regex" do
+    subject { generator.filter_included_tags(tags_from_strings(%w[1 2 3])) }
+
+    context "with matching regex" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(include_tags_regex: "[23]") }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(tags_from_strings(%w[2 3])) }
+    end
+
+    context "with non-matching regex" do
+      let(:generator) { GitHubChangelogGenerator::Generator.new(include_tags_regex: "[45]") }
+      it { is_expected.to be_a Array }
+      it { is_expected.to match_array(tags_from_strings(%w[])) }
+    end
+  end
+
   describe "#filter_excluded_tags" do
     subject { generator.filter_excluded_tags(tags_from_strings(%w[1 2 3])) }
 

data/spec/unit/generator/section_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GitHubChangelogGenerator
+  RSpec.describe Section do
+    let(:options) { {} }
+    subject(:section) { described_class.new(options) }
+
+    describe "#encapsulate_string" do
+      let(:string) { "" }
+
+      context "with the empty string" do
+        it "returns the string" do
+          expect(section.send(:encapsulate_string, string)).to eq string
+        end
+      end
+
+      context "with a string with an escape-needing character in it" do
+        let(:string) { "<Inside> and outside" }
+
+        it "returns the string escaped" do
+          expect(section.send(:encapsulate_string, string)).to eq '\\<Inside\\> and outside'
+        end
+      end
+
+      context "with a backticked string with an escape-needing character in it" do
+        let(:string) { 'back `\` slash' }
+
+        it "returns the string" do
+          expect(section.send(:encapsulate_string, string)).to eq 'back `\` slash'
+        end
+      end
+    end
+  end
+end

data/spec/unit/octo_fetcher_spec.rb

@@ -85,6 +85,49 @@ describe GitHubChangelogGenerator::OctoFetcher do
     end
   end
 
+  describe "#fetch_tag_shas" do
+    let(:commits) do
+      [
+        { sha: "0", parents: [{ sha: "1" }, { sha: "6" }] },
+        { sha: "1", parents: [{ sha: "2" }] },
+        { sha: "2", parents: [{ sha: "3" }] },
+        { sha: "3", parents: [{ sha: "4" }] },
+        { sha: "4", parents: [{ sha: "5" }] },
+        { sha: "5", parents: [] },
+        { sha: "6", parents: [{ sha: "7" }, { sha: "8" }] },
+        { sha: "7", parents: [{ sha: "9" }, { sha: "10" }] },
+        { sha: "8", parents: [{ sha: "11" }, { sha: "12" }] },
+        { sha: "9", parents: [] },
+        { sha: "10", parents: [] },
+        { sha: "11", parents: [] },
+        { sha: "12", parents: [] }
+      ]
+    end
+
+    let(:tag0) { { "name" => "tag-0", "commit" => { "sha" => "0" } } }
+    let(:tag1) { { "name" => "tag-1", "commit" => { "sha" => "1" } } }
+    let(:tag6) { { "name" => "tag-6", "commit" => { "sha" => "6" } } }
+
+    before do
+      allow(fetcher).to receive(:commits).and_return(commits)
+    end
+
+    it "should find all shas with single parents" do
+      fetcher.fetch_tag_shas([tag1])
+      expect(tag1["shas_in_tag"]).to eq(Set.new(%w[1 2 3 4 5]))
+    end
+
+    it "should find all shas with multiple parents" do
+      fetcher.fetch_tag_shas([tag6])
+      expect(tag6["shas_in_tag"]).to eq(Set.new(%w[6 7 8 9 10 11 12]))
+    end
+
+    it "should find all shas with mixed parents" do
+      fetcher.fetch_tag_shas([tag0])
+      expect(tag0["shas_in_tag"]).to eq(Set.new(%w[0 1 2 3 4 5 6 7 8 9 10 11 12]))
+    end
+  end
+
   describe "#github_fetch_tags" do
     context "when wrong token provided", :vcr do
       let(:options) do
@@ -207,7 +250,7 @@ describe GitHubChangelogGenerator::OctoFetcher do
 
         # Convert times to Time
         expected_issue.each_pair do |k, v|
-          expected_issue[k] = Time.parse(v) if v.to_s =~ /^2015-/
+          expected_issue[k] = Time.parse(v) if v.to_s.start_with?("2015-")
         end
 
         expect(issues.first).to eq(expected_issue)
@@ -269,7 +312,7 @@ describe GitHubChangelogGenerator::OctoFetcher do
 
         # Convert times to Time
         expected_pr.each_pair do |k, v|
-          expected_pr[k] = Time.parse(v) if v.to_s =~ /^2016-01/
+          expected_pr[k] = Time.parse(v) if v.to_s.start_with?("2016-01")
         end
 
         expect(pull_requests.first).to eq(expected_pr)

data/spec/unit/parser_spec.rb

@@ -1,4 +1,54 @@
 # frozen_string_literal: true
 
 describe GitHubChangelogGenerator::Parser do
+  let(:argv) { [] }
+
+  before do
+    # Calling abort will abort the test run, allow calls to abort to not accidentaly get positive falses
+    allow(Kernel).to receive(:abort)
+  end
+
+  describe ".parse_options" do
+    context "when required arguments are given" do
+      let(:argv) { ["--user", "the user", "--project", "the_project"] }
+
+      it "executes and prints the configuration" do
+        expect { described_class.parse_options(argv) }.to output(/config_file=>".github_changelog_generator"/).to_stdout
+      end
+    end
+
+    context "when --config-file is overridden to something that is not there" do
+      let(:argv) { ["--config-file", "does_not_exist"] }
+
+      it "aborts the execution" do
+        expect(Kernel).to receive(:abort)
+        expect { described_class.parse_options(argv) }.to output(/Configure which user and project to work on./).to_stderr
+      end
+    end
+
+    context "when an option with incorrect type is given" do
+      let(:argv) { ["--max-issues", "X"] }
+
+      it "aborts the execution with error message from parser" do
+        expect(Kernel).to receive(:abort)
+        expect { described_class.parse_options(argv) }.to output(/invalid argument: --max-issues X/).to_stderr
+      end
+    end
+
+    context "when path to configuration file is given" do
+      let(:argv) { ["--config-file", File.join(__dir__, "..", "files", "config_example")] }
+
+      it "uses the values from the configuration file" do
+        expect { described_class.parse_options(argv) }.to output(/spec_project/).to_stdout
+      end
+    end
+
+    context "when configuration file and parameters are given" do
+      let(:argv) { ["--project", "stronger_project", "--config-file", File.join(__dir__, "..", "files", "config_example")] }
+
+      it "uses the values from the arguments" do
+        expect { described_class.parse_options(argv) }.to output(/stronger_project/).to_stdout
+      end
+    end
+  end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: github_changelog_generator
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.3
 platform: ruby
 authors:
 - Petr Korolev
 - Olle Jonsson
-autorequire: 
+- Marco Ferrari
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,6 +26,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+- !ruby/object:Gem::Dependency
+  name: async-http-faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +140,7 @@ dependencies:
         version: '3.0'
 description: Changelog generation has never been so easy. Fully automate changelog
   generation - this gem generate changelog file based on tags, issues and merged pull
-  requests from Github issue tracker.
+  requests from GitHub.
 email: sky4winder+github_changelog_generator@gmail.com
 executables:
 - git-generate-changelog
@@ -125,6 +154,7 @@ files:
 - bin/git-generate-changelog
 - bin/github_changelog_generator
 - lib/github_changelog_generator.rb
+- lib/github_changelog_generator/argv_parser.rb
 - lib/github_changelog_generator/generator/entry.rb
 - lib/github_changelog_generator/generator/generator.rb
 - lib/github_changelog_generator/generator/generator_fetcher.rb
@@ -146,12 +176,15 @@ files:
 - man/git-generate-changelog.md
 - spec/files/angular.js.md
 - spec/files/bundler.md
+- spec/files/config_example
 - spec/files/github-changelog-generator.md
 - spec/install_gem_in_bundler.gemfile
 - spec/spec_helper.rb
 - spec/unit/generator/entry_spec.rb
 - spec/unit/generator/generator_processor_spec.rb
+- spec/unit/generator/generator_spec.rb
 - spec/unit/generator/generator_tags_spec.rb
+- spec/unit/generator/section_spec.rb
 - spec/unit/octo_fetcher_spec.rb
 - spec/unit/options_spec.rb
 - spec/unit/parse_file_spec.rb
@@ -183,7 +216,7 @@ homepage: https://github.com/github-changelog-generator/Github-Changelog-Generat
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,27 +224,30 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
-summary: Script, that automatically generate changelog from your tags, issues, labels
+summary: Script that automatically generates a changelog from your tags, issues, labels
   and pull requests.
 test_files:
 - spec/files/angular.js.md
 - spec/files/bundler.md
+- spec/files/config_example
 - spec/files/github-changelog-generator.md
 - spec/install_gem_in_bundler.gemfile
 - spec/spec_helper.rb
 - spec/unit/generator/entry_spec.rb
 - spec/unit/generator/generator_processor_spec.rb
+- spec/unit/generator/generator_spec.rb
 - spec/unit/generator/generator_tags_spec.rb
+- spec/unit/generator/section_spec.rb
 - spec/unit/octo_fetcher_spec.rb
 - spec/unit/options_spec.rb
 - spec/unit/parse_file_spec.rb