px_github_changelog_generator 0.0.0

data/spec/unit/parser_file_spec.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+describe GitHubChangelogGenerator::ParserFile do
+  describe ".github_changelog_generator" do
+    let(:options) { {} }
+    let(:parser) { described_class.new(options, StringIO.new(file)) }
+
+    context "when the well-known default file does not exist" do
+      let(:parser) { described_class.new(options) }
+
+      subject { parser.parse! }
+
+      it { is_expected.to be_nil }
+    end
+
+    context "when file is empty" do
+      let(:file) { "" }
+
+      it "does not change the options" do
+        expect { parser.parse! }.to_not(change { options })
+      end
+    end
+
+    context "when file is incorrect" do
+      let(:file) do
+        <<~FILE.strip
+          unreleased_label=staging
+          unreleased: false
+        FILE
+      end
+
+      it { expect { parser.parse! }.to raise_error(/line #2/) }
+    end
+
+    context "allows empty lines and comments with semi-colon or pound sign" do
+      let(:file) do
+        "\n   \n#{<<~REMAINING.strip}"
+          # Comment on first line
+          unreleased_label=staging
+          ; Comment on third line
+          unreleased=false
+        REMAINING
+      end
+
+      it { expect { parser.parse! }.not_to raise_error }
+    end
+
+    context "when override default values" do
+      let(:default_options) { GitHubChangelogGenerator::Parser.default_options.merge(verbose: false) }
+      let(:options) { {}.merge(default_options) }
+      let(:options_before_change) { options.dup }
+      let(:file) do
+        <<~FILE.strip
+          unreleased_label=staging
+          unreleased=false
+          header==== Changelog ===
+          max_issues=123
+          simple-list=true
+        FILE
+      end
+
+      it "changes the options" do
+        expect { parser.parse! }.to change { options }
+          .from(options_before_change)
+          .to(options_before_change.merge(unreleased_label: "staging",
+                                          unreleased: false,
+                                          header: "=== Changelog ===",
+                                          max_issues: 123,
+                                          simple_list: true))
+      end
+
+      context "turns exclude-labels into an Array", bug: "#327" do
+        let(:file) do
+          <<~FILE
+            exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
+            header_label=# My changelog
+          FILE
+        end
+
+        it "reads exclude_labels into an Array" do
+          expect { parser.parse! }.to change { options[:exclude_labels] }
+            .from(default_options[:exclude_labels])
+            .to(%w[73a91042-da6f-11e5-9335-1040f38d7f90 7adf83b4-da6f-11e5-ae18-1040f38d7f90])
+        end
+
+        it "translates given header_label into the :header option" do
+          expect { parser.parse! }.to change { options[:header] }
+            .from(default_options[:header])
+            .to("# My changelog")
+        end
+      end
+    end
+  end
+end

data/spec/unit/parser_spec.rb

@@ -0,0 +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

data/spec/unit/reader_spec.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+#
+# Author:: Enrico Stahn <mail@enricostahn.com>
+#
+# Copyright 2014, Zanui, <engineering@zanui.com.au>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+describe GitHubChangelogGenerator::Reader do
+  before(:all) do
+    @reader = GitHubChangelogGenerator::Reader.new
+  end
+
+  describe "#parse_heading" do
+    context "when heading is empty" do
+      subject { @reader.parse_heading("## ") }
+      it { is_expected.to be_a(Hash) }
+      it { is_expected.to include("version", "url", "date") }
+      it { is_expected.to include("version" => nil, "url" => nil, "date" => nil) }
+      # TODO: Doesn't work?
+      # it { is_expected.to have_all_string_keys }
+    end
+    context "when given version, url and date" do
+      subject { @reader.parse_heading("## [1.3.10](https://github.com/github-changelog-generator/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)") }
+      it { is_expected.to include("version" => "1.3.10") }
+      it { is_expected.to include("url" => "https://github.com/github-changelog-generator/Github-Changelog-Generator/tree/1.3.10") }
+      it { is_expected.to include("date" => "2015-03-18") }
+    end
+    context "when given a named link" do
+      subject { @reader.parse_heading("## [1.3.10]") }
+      it { is_expected.to include("version" => "1.3.10") }
+    end
+    context "when given a named link with date" do
+      subject { @reader.parse_heading("## [1.3.10] (2015-03-18)") }
+      it { is_expected.to include("version" => "1.3.10") }
+      it { is_expected.to include("date" => "2015-03-18") }
+    end
+    context "when no url and date is provided" do
+      subject { @reader.parse_heading("## foobar") }
+      it { is_expected.to include("version" => "foobar", "url" => nil, "date" => nil) }
+    end
+  end
+
+  describe "#parse" do
+    context "when file is empty" do
+      subject { @reader.parse("") }
+      it { is_expected.to be_an(Array) }
+      it { is_expected.to be_empty }
+    end
+    context "when file has only the header" do
+      subject { @reader.parse("# Changelog") }
+      it { is_expected.to be_an(Array) }
+      it { is_expected.to be_empty }
+    end
+  end
+
+  describe "example CHANGELOG files" do
+    subject { @reader.read(File.expand_path(File.join(File.dirname(__FILE__), "..", "files", self.class.description))) }
+    context "github-changelog-generator.md" do
+      it { is_expected.to be_an(Array) }
+      it { is_expected.not_to be_empty }
+      it { expect(subject.count).to eq(28) }
+      it { expect(subject.first).to include("version" => "1.3.10") }
+      it { expect(subject.first).to include("url" => "https://github.com/github-changelog-generator/Github-Changelog-Generator/tree/1.3.10") }
+      it { expect(subject.first).to include("date" => "2015-03-18") }
+      it { expect(subject.first).to include("content") }
+      it "content should not be empty" do
+        expect(subject.first["content"]).not_to be_empty
+      end
+    end
+    context "bundler.md" do
+      it { is_expected.to be_an(Array) }
+      it { is_expected.not_to be_empty }
+      it { expect(subject.count).to eq(151) }
+      it { expect(subject.first).to include("version" => "1.9.1") }
+      it { expect(subject.first).to include("url" => nil) }
+      it { expect(subject.first).to include("date" => "2015-03-21") }
+      it { expect(subject.first).to include("content") }
+      it "content should not be empty" do
+        expect(subject.first["content"]).not_to be_empty
+      end
+    end
+    context "angular.js.md" do
+      it { is_expected.to be_an(Array) }
+      it { is_expected.not_to be_empty }
+      # it do
+      #   pending('Implement heading_level for parser.')
+      #   expect(subject.first).to include('version' => '1.4.0-beta.6 cookie-liberation')
+      # end
+      # it do
+      #   pending('Implement heading_level for parser.')
+      #   expect(subject.first).to include('url' => nil)
+      # end
+      # it do
+      #   pending('Implement heading_level for parser.')
+      #   expect(subject.first).to include('date' => '2015-03-17')
+      # end
+      # it do
+      #   pending('Implement heading_level for parser.')
+      #   expect(subject.first).to include('content')
+      # end
+      # it 'content should not be empty' do
+      #   pending('Implement heading_level for parser.')
+      #   expect(subject.first['content']).not_to be_empty
+      # end
+    end
+  end
+end