renogen 1.0.1 → 1.3.1

data/lib/renogen/formatters/markdown_table.rb

@@ -0,0 +1,58 @@
+module Renogen
+  module Formatters
+    # For formatting a change into markdown format
+    class MarkdownTable < Markdown
+      register :markdown_table
+      register :md_table
+
+      attr_reader :headings
+
+      def table_formatter?
+        true
+      end
+
+      # Generate header
+      #
+      # @param changelog [Renogen::ChangeLog::Model]
+      #
+      # return [String]
+      def header(changelog)
+        @headings = changelog.groups.keys
+        [
+          "# #{changelog.version} (#{changelog.date})",
+          "",
+          "| #{headings.join(' | ')} |",
+          "| #{headings.map{|_| '-' }.join(' | ')} |"
+        ].join("\n")
+      end
+
+      # Outputs a line or block of text appearing at the top of the change log.
+      #
+      # @param header [String]
+      # @return [String]
+      def write_header(header)
+        "#{header}\n"
+      end
+
+      # Outputs a line or block as a header for a group.
+      #
+      # @param group [String]
+      # @return [String]
+      def write_group(group)
+        "## #{group}\n\n"
+      end
+
+      # Outputs a line or block as the body for a change in a group.
+      #
+      # @param ticket [Hash<group: string>]
+      # @return [String]
+      def write_change(ticket)
+        "| "+ @headings.map do |heading|
+          value = ticket.fetch(heading, '-')
+          value = value.join("\n") if value.is_a?(Array)
+          value.gsub("\n", "<br>")
+        end.join(' | ') + " |"
+      end
+    end
+  end
+end

data/lib/renogen/generator.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Renogen
   # This is the conductor of the application
   class Generator
     attr_accessor :source, :version, :output_format, :options
 
-    def initialize(version, source, output_format, options={})
+    def initialize(version, source, output_format, options = {})
       @version = version
       @source = source
       @output_format = output_format
@@ -14,7 +16,9 @@ module Renogen
     def generate!
       changelog = extraction_stratagy.extract
       changelog.version = version
+      changelog.date = options['release_date']
 
+      validator.validate!(changelog) if options['allowed_values']&.any?
       writer.write!(changelog)
     end
 
@@ -31,5 +35,9 @@ module Renogen
     def formatter
       Renogen::Formatters.obtain(output_format, options)
     end
+
+    def validator
+      Renogen::ChangeLog::Validator.new(formatter)
+    end
   end
 end

data/lib/renogen/version.rb

@@ -1,3 +1,3 @@
 module Renogen
-  VERSION='1.0.1'.freeze # :nodoc:
+  VERSION = '1.3.1'.freeze # :nodoc:
 end

data/lib/renogen/writers/csv.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Renogen
+  module Writers
+    # Writes out the change log in CSV format
+    class Csv < Base
+      register :csv
+
+      def write!(changelog)
+        puts formatter.write_headings(changelog)
+        output_files(changelog)
+      end
+
+      private
+
+      def output_files(changelog)
+        changelog.files.each do |file|
+          puts formatter.write_file(file, changelog)
+        end
+      end
+    end
+  end
+end

data/spec/lib/renogen/change_log/item_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Renogen::ChangeLog::Item do
   let(:change) { Array.new }
-  subject { described_class.new('foo', change) }
+  subject { described_class.new(1, 'foo', change) }
 
   describe '#to_s' do
     context "when change type is nil" do

data/spec/lib/renogen/change_log/model_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Renogen::ChangeLog::Model do
-  let(:change_item) { Renogen::ChangeLog::Item.new('foo', 'bar') }
+  let(:change_item) { Renogen::ChangeLog::Item.new(1, 'foo', 'bar') }
 
   describe '#groups' do
     it 'returns an empty hash when no changes' do
@@ -14,13 +14,6 @@ describe Renogen::ChangeLog::Model do
     end
   end
 
-  describe '#header' do
-    it 'returns version and date' do
-      subject.version = '123'
-      expect(subject.header).to eql "123 (#{Date.today})"
-    end
-  end
-
   describe '#add_change' do
     it 'adds change to changes store' do
       subject.add_change(change_item)
@@ -33,4 +26,25 @@ describe Renogen::ChangeLog::Model do
     end
   end
 
+  describe '#date' do
+    it 'defaults to Date.today' do
+      expect(subject.date).to eql Date.today
+    end
+
+    it 'can be set using an option' do
+      date = Date.parse('2015-12-25')
+      model_instance = described_class.new(date: date)
+
+      expect(model_instance.date).to eql date
+    end
+
+    it 'has a setter' do
+      date = Date.parse('1981-03-20')
+
+      subject.date = date
+
+      expect(subject.date).to eql date
+    end
+  end
+
 end

data/spec/lib/renogen/change_log/validator_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Renogen::ChangeLog::Validator do
+  let(:change_log) { Renogen::ChangeLog::Model.new }
+  let(:validations) { { 'foo' => %w(bar baz) } }
+
+  subject { described_class.new(double('Formatter', options: { 'allowed_values' => validations })) }
+
+  before(:each) { change_log.add_change(Renogen::ChangeLog::Item.new(1, 'foo', 'bar')) }
+
+  describe '#validate!' do
+    context 'when no validations are available' do
+      let(:validations) { nil }
+
+      it 'successfully passes the validation process' do
+        expect { subject.validate!(change_log) }.to_not raise_error
+        subject.validate!(change_log)
+      end
+    end
+
+    context 'when validation is successful' do
+      it 'successfully passes the validation process' do
+        expect { subject.validate!(change_log) }.to_not raise_error
+        subject.validate!(change_log)
+      end
+    end
+
+    context 'when validation has failed' do
+      let(:validations) { { 'foo' => ['baz'] } }
+
+      it 'fails validation' do
+        expect { subject.validate!(change_log) }.to raise_error(Renogen::Exceptions::InvalidItemFound)
+      end
+    end
+  end
+end

data/spec/lib/renogen/change_log/writer_spec.rb

@@ -1,8 +1,147 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Renogen::ChangeLog::Writer do
-
   describe '#write!' do
+    shared_examples 'a valid output format' do
+      let(:changelog) do
+        Renogen::ChangeLog::Model.new(
+          version: 'test',
+          date: Date.new(2020, 7, 8)
+        )
+      end
+
+      let(:changes) do
+        [
+          renogen_change(1, 'Group 1', 'This is a Group 1 change'),
+          renogen_change(1, 'Group 2', 'This is a Group 2 change')
+        ]
+      end
+
+      subject { Renogen::ChangeLog::Writer.new(formatter) }
+
+      before do
+        changes.each { |c| changelog.add_change(c) }
+        $stdout = StringIO.new
+      end
+
+      after do
+        $stdout = STDOUT
+      end
+
+      it 'writes all lines' do
+        subject.write!(changelog)
+        $stdout.rewind
+        expected_output.split("\n").each do |line|
+          expect($stdout.gets.strip).to eq(line)
+        end
+      end
+    end
+
+    context 'when formatter is CSV' do
+      let(:formatter) { Renogen::Formatters::Csv.new }
+      let(:expected_output) do
+        <<~EOS
+          Group 1,Group 2
+          This is a Group 1 change,This is a Group 2 change
+        EOS
+      end
+
+      it_behaves_like 'a valid output format'
+
+      context 'when changes contain commas' do
+        it_behaves_like 'a valid output format' do
+          let(:changes) do
+            [
+              renogen_change(1, 'Group 1', 'This,is,a,Group 1,change'),
+              renogen_change(1, 'Group 2', 'This is a Group 2 change')
+            ]
+          end
+
+          let(:expected_output) do
+            <<~EOS
+              Group 1,Group 2
+              "This,is,a,Group 1,change",This is a Group 2 change
+            EOS
+          end
+        end
+      end
+    end
+
+    context 'when formatter is HTML' do
+      let(:formatter) { Renogen::Formatters::Html.new }
+      let(:expected_output) do
+        <<~EOS
+          <html>
+          <h1>test (2020-07-08)</h1>
+          <h2>Group 1</h2>
+          <ul>
+          <li>This is a Group 1 change
+          </li>
+          </ul>
+          <h2>Group 2</h2>
+          <ul>
+          <li>This is a Group 2 change
+          </li>
+          </ul>
+          </html>
+        EOS
+      end
+
+      it_behaves_like 'a valid output format'
+    end
+
+    context 'when formatter is Markdown' do
+      let(:formatter) { Renogen::Formatters::Markdown.new }
+      let(:expected_output) do
+        <<~EOS
+          # test (2020-07-08)
+
+          ## Group 1
+
+          * This is a Group 1 change
+
+          ## Group 2
+
+          * This is a Group 2 change
+        EOS
+      end
+
+      it_behaves_like 'a valid output format'
+    end
+
+    context 'when formatter is MarkdownTable' do
+      let(:formatter) { Renogen::Formatters::MarkdownTable.new }
+
+      let(:expected_output) do
+        <<~EOS
+          # test (2020-07-08)
+
+          | Group 1 | Group 2 |
+          | - | - |
+          | This is a Group 1 change<br> | This is a Group 2 change<br> |
+        EOS
+      end
+
+      it_behaves_like 'a valid output format'
+    end
+
+    context 'when formatter is PlainText' do
+      let(:formatter) { Renogen::Formatters::PlainText.new }
+      let(:expected_output) do
+        <<~EOS
+          test (2020-07-08)
+
+          Group 1
+          - This is a Group 1 change
+
+          Group 2
+          - This is a Group 2 change
+        EOS
+      end
+
+      it_behaves_like 'a valid output format'
+    end
   end
 end
-

data/spec/lib/renogen/config_spec.rb

@@ -1,19 +1,24 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Renogen::Config do
-
   subject { described_class.instance }
 
   describe '#configure' do
     before :each do
       described_class.configure do |config|
         config.single_line_format = 'bar'
+        config.validations = ['test']
       end
     end
 
     it 'can set value' do
       expect(subject.single_line_format).to eql 'bar'
     end
-  end
 
+    it 'sets the validations value' do
+      expect(subject.validations).to eql ['test']
+    end
+  end
 end

data/spec/lib/renogen/exceptions/invalid_item_found_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Renogen::Exceptions::InvalidItemFound do
+  subject { described_class.new(invalid_items) }
+
+  describe '#message' do
+    context 'valid_values is an array' do
+      let(:invalid_items) do
+        [
+          { group_name: 'Product', invalid_value: 'Foo', valid_values: %w(Bar Baz) },
+          { group_name: 'Country', invalid_value: 'LL', valid_values: %w(UK IE) }
+        ]
+      end
+      let(:expected_error) do
+        "Invalid items:\nGroup: Product, Content: Foo, Valid Values: [\"Bar\", \"Baz\"]" \
+        "\nGroup: Country, Content: LL, Valid Values: [\"UK\", \"IE\"]"
+      end
+
+      it 'returns a user friendly error message' do
+        expect(subject.message).to eql expected_error
+      end
+    end
+
+    context 'valid_values is a RegExp' do
+      let(:invalid_items) { [{ group_name: 'Product', invalid_value: 'Foo', valid_values: /\b(Bar|Baz)\b/ }] }
+      let(:expected_error) { "Invalid items:\nGroup: Product, Content: Foo, Pattern: #{/\b(Bar|Baz)\b/.inspect}" }
+
+      it 'returns a user friendly error message' do
+        expect(subject.message).to eql expected_error
+      end
+    end
+  end
+end

data/spec/lib/renogen/exceptions/stratagy_not_found_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Renogen::Exceptions::StratagyNotFound do
@@ -8,6 +10,5 @@ describe Renogen::Exceptions::StratagyNotFound do
     it 'returns friendly error message' do
       expect(subject.message).to eql "Error: Stratagy type '#{name}' not found"
     end
-
   end
 end

data/spec/lib/renogen/{extraction_stratagies/yaml_file/exceptions → exceptions}/yaml_file_blank_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Renogen::ExtractionStratagies::YamlFile::Exceptions::YamlFileBlank do
+describe Renogen::Exceptions::YamlFileBlank do
   let(:name) { 'foobar' }
   subject { described_class.new(name) }