renogen 1.2.1 → 1.3.0

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) }
 

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

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Renogen::Exceptions::YamlFileInvalid do
+  let(:name) { 'foobar' }
+  subject { described_class.new(name) }
+
+  describe '#message' do
+    it 'returns friendly error message' do
+      expect(subject.message).to eql "Error: File contents invalid '#{name}'"
+    end
+  end
+end

data/spec/lib/renogen/extraction_stratagies/yaml_file/parser_spec.rb

@@ -6,13 +6,13 @@ describe Renogen::ExtractionStratagies::YamlFile::Parser do
   describe '#parse!' do
     before :each do
       yaml_file_reader = double(Renogen::ExtractionStratagies::YamlFile::Reader)
-      allow(yaml_file_reader).to receive(:each_yaml_file).and_yield(file_contents)
+      allow(yaml_file_reader).to receive(:each_yaml_file).and_yield(file_contents, 1)
       allow(Renogen::ExtractionStratagies::YamlFile::Reader).to receive(:new).and_return(yaml_file_reader)
     end
 
     it 'extracts contents from file' do
-      changelog_item = Renogen::ChangeLog::Item.new('Foo', 'Bar')
-      allow(Renogen::ChangeLog::Item).to receive(:new).with('Foo', 'Bar').and_return changelog_item
+      changelog_item = Renogen::ChangeLog::Item.new(1, 'Foo', 'Bar')
+      allow(Renogen::ChangeLog::Item).to receive(:new).with(1, 'Foo', 'Bar').and_return changelog_item
 
       changelog = subject.parse!
 

data/spec/lib/renogen/extraction_stratagies/yaml_file/reader_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'json'
 
@@ -6,15 +8,19 @@ describe Renogen::ExtractionStratagies::YamlFile::Reader do
   subject { described_class.new(directory_path) }
 
   describe '#each_yaml_file' do
-    let(:file_contents) { { 'Foo' => 'Bar' }.to_json  }
+    let(:file_contents) { { 'Foo' => 'bar' }.to_json }
 
-    before :each do
-      allow(Dir).to receive(:glob).with([File.join(directory_path, 'next', "*.yml")]).and_return(['foo_file'])
+    it 'yields each yaml file within given directory' do
+      allow(Dir).to receive(:glob).with([File.join(directory_path, 'next', '*.yml')]).and_return(['foo_file'])
       allow(YAML).to receive(:load_file).with('foo_file').and_return(file_contents)
+      expect { |b| subject.each_yaml_file(&b) }.to yield_with_args(file_contents, 0)
     end
 
-    it 'yields each yaml file within given directory' do
-      expect{ |b| subject.each_yaml_file(&b) }.to yield_with_args(file_contents)
+    it 'throws invalid yaml file when missing quotes' do
+      allow(subject).to receive(:change_directories).and_return(%w(foo bar))
+      foo = Psych::SyntaxError.new('a', 1, 2, 'd', 'e', 'f')
+      allow(YAML).to receive(:load_file).and_raise(foo)
+      expect { subject.each_yaml_file }.to raise_error(Renogen::Exceptions::YamlFileInvalid)
     end
   end
 end

data/spec/lib/renogen/formatters/base_spec.rb

@@ -1,25 +1,25 @@
 require 'spec_helper'
 
 describe Renogen::Formatters::Base do
+  let(:version) { '1.2.34' }
+  let(:date) { Date.today }
+  let(:changelog) { double(Renogen::ChangeLog::Model, version: version, date: date) }
+
   describe '#header' do
     subject { described_class.new.header(changelog) }
 
-    let(:version) { '1.2.34' }
-    let(:date) { Date.today }
-    let(:changelog) { double(Renogen::ChangeLog::Model, version: version, date: date) }
-
     it { is_expected.to eql "#{version} (#{date})" }
   end
 
   describe '#write_header' do
-    it 'raises an NotImplementedError' do
-      expect{subject.write_header('header')}.to raise_error NotImplementedError
+    it 'does nothing' do
+      expect(subject.write_header(changelog)).to be_nil
     end
   end
 
   describe '#write_group' do
-    it 'raises an NotImplementedError' do
-      expect{subject.write_group('group_name')}.to raise_error NotImplementedError
+    it 'does nothing' do
+      expect(subject.write_group(changelog)).to be_nil
     end
   end
 

data/spec/lib/renogen/formatters/csv_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Renogen::Formatters::Csv do
+  describe 'write_methods' do
+    let(:change_1) { renogen_change(1, 'Group 1', 'Change 1') }
+    let(:change_2) { renogen_change(1, 'Group 2', 'Change 2') }
+    let(:change_3) { renogen_change(2, 'Group 1', 'Change 3') }
+    let(:changelog) { Renogen::ChangeLog::Model.new }
+
+    before do
+      [change_1, change_2, change_3].each { |c| changelog.add_change(c) }
+      subject.header(changelog)
+    end
+
+    it { is_expected.to be_table_formatter }
+    describe '#write_header' do
+      it 'returns a comma separated list of group names' do
+        expect(subject.write_header('Group 1,Group 2')).to eq("Group 1,Group 2\n")
+      end
+    end
+
+    describe '#write_change' do
+      let(:ticket) do
+        {
+          'Group 1' => 'This is a Group 1 change',
+          'Group 2' => 'This is a Group 2 change, with a comma'
+        }
+      end
+
+      context 'when ticket contains same keys as changelog groups' do
+        it 'outputs all values' do
+          expect(subject.write_change(ticket)).to eq(
+            'This is a Group 1 change,"This is a Group 2 change, with a comma"'
+          )
+        end
+      end
+
+      context 'when changelog contains keys missing in ticket' do
+        it 'outputs empty values for missing keys' do
+          expect(subject.write_change(ticket)).to eq(
+            'This is a Group 1 change,"This is a Group 2 change, with a comma"'
+          )
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'renogen'
+require_relative 'support/renogen_helper'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
@@ -40,4 +43,6 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = :random
+
+  config.include Support::RenogenHelper
 end

data/spec/support/renogen_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Support
+  module RenogenHelper
+    def renogen_change(ticket_id, group_name, change)
+      Renogen::ChangeLog::Item.new(ticket_id, group_name, change)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: renogen
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Dave Elliott
@@ -39,45 +39,54 @@ files:
 - lib/renogen/change_log/group.rb
 - lib/renogen/change_log/item.rb
 - lib/renogen/change_log/model.rb
+- lib/renogen/change_log/validator.rb
 - lib/renogen/change_log/writer.rb
 - lib/renogen/cli.rb
 - lib/renogen/cli/param_parser.rb
 - lib/renogen/config.rb
 - lib/renogen/exceptions.rb
 - lib/renogen/exceptions/base.rb
+- lib/renogen/exceptions/invalid_item_found.rb
 - lib/renogen/exceptions/stratagy_not_found.rb
+- lib/renogen/exceptions/yaml_file_blank.rb
+- lib/renogen/exceptions/yaml_file_invalid.rb
 - lib/renogen/extraction_stratagies.rb
 - lib/renogen/extraction_stratagies/base.rb
 - lib/renogen/extraction_stratagies/yaml_file.rb
-- lib/renogen/extraction_stratagies/yaml_file/exceptions.rb
-- lib/renogen/extraction_stratagies/yaml_file/exceptions/yaml_file_blank.rb
 - lib/renogen/extraction_stratagies/yaml_file/parser.rb
 - lib/renogen/extraction_stratagies/yaml_file/provider.rb
 - lib/renogen/extraction_stratagies/yaml_file/reader.rb
 - lib/renogen/formatters.rb
 - lib/renogen/formatters/base.rb
+- lib/renogen/formatters/csv.rb
 - lib/renogen/formatters/html.rb
 - lib/renogen/formatters/markdown.rb
+- lib/renogen/formatters/markdown_table.rb
 - lib/renogen/formatters/plain_text.rb
 - lib/renogen/generator.rb
 - lib/renogen/version.rb
+- lib/renogen/writers/csv.rb
 - spec/lib/renogen/change_log/group_spec.rb
 - spec/lib/renogen/change_log/item_spec.rb
 - spec/lib/renogen/change_log/model_spec.rb
-- spec/lib/renogen/change_log/writer_spec.rb
+- spec/lib/renogen/change_log/validator_spec.rb
 - spec/lib/renogen/config_spec.rb
+- spec/lib/renogen/exceptions/invalid_item_found_spec.rb
 - spec/lib/renogen/exceptions/stratagy_not_found_spec.rb
+- spec/lib/renogen/exceptions/yaml_file_blank_spec.rb
+- spec/lib/renogen/exceptions/yaml_file_invalid_spec.rb
 - spec/lib/renogen/extraction_stratagies/base_spec.rb
-- spec/lib/renogen/extraction_stratagies/yaml_file/exceptions/yaml_file_blank_spec.rb
 - spec/lib/renogen/extraction_stratagies/yaml_file/parser_spec.rb
 - spec/lib/renogen/extraction_stratagies/yaml_file/provider_spec.rb
 - spec/lib/renogen/extraction_stratagies/yaml_file/reader_spec.rb
 - spec/lib/renogen/formatters/base_spec.rb
+- spec/lib/renogen/formatters/csv_spec.rb
 - spec/lib/renogen/formatters/html_spec.rb
 - spec/lib/renogen/formatters/markdown_spec.rb
 - spec/lib/renogen/formatters/plain_text_spec.rb
 - spec/lib/renogen_spec.rb
 - spec/spec_helper.rb
+- spec/support/renogen_helper.rb
 homepage: https://github.com/DDAZZA/renogen
 licenses:
 - GPL-3.0
@@ -98,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Release Notes/changelog Generator

data/lib/renogen/extraction_stratagies/yaml_file/exceptions.rb

@@ -1,12 +0,0 @@
-
-module Renogen
-  module ExtractionStratagies
-    module YamlFile
-      # Exceptions thrown by YAML file extraction stratagy
-      module Exceptions
-        require_relative 'exceptions/yaml_file_blank'
-      end
-    end
-  end
-end
-

data/lib/renogen/extraction_stratagies/yaml_file/exceptions/yaml_file_blank.rb

@@ -1,25 +0,0 @@
-module Renogen
-  module ExtractionStratagies
-    module YamlFile
-      module Exceptions
-        # This is raised when a yaml file change is found but has not contents
-        class YamlFileBlank < Renogen::Exceptions::Base
-          attr_reader :file_path
-
-          def initialize(file_path)
-            @file_path = file_path
-            super
-          end
-
-          # Friendly error message
-          #
-          # @return [String]
-          def message
-            "Error: File contents blank '#{file_path}'"
-          end
-        end
-      end
-    end
-  end
-end
-

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

@@ -1,8 +0,0 @@
-require 'spec_helper'
-
-describe Renogen::ChangeLog::Writer do
-
-  describe '#write!' do
-  end
-end
-