renogen 1.2.1 → 1.3.0

data/lib/renogen/exceptions.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 module Renogen
   # Custom exceptions throw by the libary
   module Exceptions
     require_relative 'exceptions/base'
     require_relative 'exceptions/stratagy_not_found'
+    require_relative 'exceptions/invalid_item_found'
+    require_relative 'exceptions/yaml_file_blank'
+    require_relative 'exceptions/yaml_file_invalid'
   end
 end

data/lib/renogen/exceptions/invalid_item_found.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Renogen
+  module Exceptions
+    # Raised when change log contains invalid items.
+    class InvalidItemFound < Base
+      attr_reader :invalid_items
+
+      def initialize(invalid_items)
+        @invalid_items = invalid_items
+        super
+      end
+
+      # Friendly error message
+      #
+      # @return [String]
+      def message
+        messages = ['Invalid items:']
+        invalid_items.each do |item|
+          invalid_value = item[:invalid_value]
+
+          messages << if item[:valid_values].is_a?(Regexp)
+            "Group: #{item[:group_name]}, Content: #{invalid_value}, Pattern: #{item[:valid_values].inspect}"
+          else
+            "Group: #{item[:group_name]}, Content: #{invalid_value}, Valid Values: #{item[:valid_values]}"
+          end
+        end
+        messages.join("\n")
+      end
+    end
+  end
+end

data/lib/renogen/exceptions/yaml_file_blank.rb

@@ -0,0 +1,21 @@
+module Renogen
+  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
+

data/lib/renogen/exceptions/yaml_file_invalid.rb

@@ -0,0 +1,20 @@
+module Renogen
+  module Exceptions
+    # This is raised when a yaml file change is found but has invalid contents
+    class YamlFileInvalid < 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 invalid '#{file_path}'"
+      end
+    end
+  end
+end

data/lib/renogen/extraction_stratagies.rb

@@ -36,7 +36,5 @@ module Renogen
 
     require_relative 'extraction_stratagies/base'
     require_relative 'extraction_stratagies/yaml_file'
-    # require_relative 'extraction_stratagies/github'
-    # require_relative 'extraction_stratagies/gitlog'
   end
 end

data/lib/renogen/extraction_stratagies/yaml_file.rb

@@ -5,7 +5,6 @@ module Renogen
       require_relative 'yaml_file/reader'
       require_relative 'yaml_file/parser'
       require_relative 'yaml_file/provider'
-      require_relative 'yaml_file/exceptions'
     end
   end
 end

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

@@ -13,8 +13,8 @@ module Renogen
 
         # @return [ChangeLog::Model]
         def parse!
-          yaml_file_reader.each_yaml_file do |file|
-            parse_file(file)
+          yaml_file_reader.each_yaml_file do |file, index|
+            parse_file(index, file)
           end
           changelog
         end
@@ -23,9 +23,10 @@ module Renogen
 
         attr_reader :yaml_file_reader
 
-        def parse_file(file)
+        # @param [Hash] data
+        def parse_file(id, file)
           file.each do |group_name, content|
-            changelog.add_change(ChangeLog::Item.new(group_name, content))
+            changelog.add_change(ChangeLog::Item.new(id, group_name, content))
           end
         end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module Renogen
@@ -7,23 +9,28 @@ module Renogen
       class Reader
         attr_accessor :directory_path, :legacy_version
 
-        def initialize(directory_path, options={})
+        def initialize(directory_path, options = {})
           @legacy_version = options['legacy_version']
           @directory_path = directory_path
           @directory_path ||= './change_log/'
         end
 
         # Iterates thorugh each change file and yields the contents.
-        # 
-        # an exception is thrown if the contents are blank
+        #
+        # an exception is thrown if the contents are blank or invalid
         #
         # @yield [Hash] yaml_file
         def each_yaml_file
-          change_directories.each do |file_path|
+          path = ''
+          change_directories.each_with_index do |file_path, i|
+            path = file_path
             content = ::YAML.load_file(file_path)
-            raise Exceptions::YamlFileBlank.new(file_path) unless content
-            yield content
+            raise Exceptions::YamlFileBlank, file_path unless content
+
+            yield content, i
           end
+        rescue Psych::SyntaxError
+          raise Exceptions::YamlFileInvalid, path
         end
 
         private
@@ -31,20 +38,22 @@ module Renogen
         # @return [Array]
         def change_directories
           upgrade_versions = legacy_versions.map do |path|
-            File.join(path, "*.yml")
+            File.join(path, '*.yml')
           end
-          upgrade_versions << File.join(directory_path, 'next', "*.yml")
+          upgrade_versions << File.join(directory_path, 'next', '*.yml')
 
           Dir.glob(upgrade_versions)
         end
 
-        # @return [Array] 
+        # @return [Array]
         def legacy_versions
           return [] unless legacy_version
-          legacy_version.gsub!('v','')
+
+          legacy_version.gsub!('v', '')
           Dir.glob(File.join(directory_path, '*')).select do |dir|
-            dir = dir.split('/').last.gsub('v','').gsub('_','.')
+            dir = dir.split('/').last.gsub('v', '').gsub('_', '.')
             next if dir == 'next'
+
             Gem::Version.new(dir) > Gem::Version.new(legacy_version)
           end
         end

data/lib/renogen/formatters.rb

@@ -37,7 +37,9 @@ module Renogen
   end
 
   require_relative 'formatters/base'
+  require_relative 'formatters/csv'
   require_relative 'formatters/plain_text'
   require_relative 'formatters/markdown'
+  require_relative 'formatters/markdown_table'
   require_relative 'formatters/html'
 end

data/lib/renogen/formatters/base.rb

@@ -1,9 +1,21 @@
+# frozen_string_literal: true
+
 module Renogen
   module Formatters
-    # Implements a template pattern that forces the implemention of required 
+    # Implements a template pattern that forces the implemention of required
     # methods in sub classes
     class Base
-      def initialize(options={})
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      # Switch to determine if the formatter is in table format(instead of group format)
+      #
+      # return [Boolean] (default: false)
+      def table_formatter?
+        false # for backward compatibility
       end
 
       # Adds class with identifier to formatters
@@ -29,7 +41,6 @@ module Renogen
       # @param header [String]
       # @raise NotImplementedError
       def write_header(header)
-        raise NotImplementedError
       end
 
       # Outputs a line or block as a header for a group.
@@ -39,7 +50,6 @@ module Renogen
       # @param group [String]
       # @raise NotImplementedError
       def write_group(group)
-        raise NotImplementedError
       end
 
       # Outputs a line or block of text appearing after a group.

data/lib/renogen/formatters/csv.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Renogen
+  module Formatters
+    # For formatting a change into CSV output
+    class Csv < Base
+      register :csv
+
+      attr_reader :headings
+
+      def table_formatter?
+        true
+      end
+
+      def write_header(header)
+        "#{header}\n"
+      end
+
+      def write_change(ticket)
+        headings.map do |header|
+          raw_line = ticket[header]
+          next if raw_line.nil?
+
+          parsed_line = raw_line.is_a?(Array) ? raw_line.join(',') : raw_line
+          parsed_line.gsub!("\n", '\n') if parsed_line.include?("\n")
+
+          if parsed_line.include?(',')
+            "\"#{parsed_line}\""
+          else
+            parsed_line
+          end
+        end.join(',')
+      end
+
+      def header(changelog)
+        @headings = changelog.groups.keys
+        @headings.join(',')
+      end
+    end
+  end
+end

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
@@ -16,6 +18,7 @@ module Renogen
       changelog.version = version
       changelog.date = options['release_date']
 
+      validator.validate!(changelog) if options['allowed_values']&.any?
       writer.write!(changelog)
     end
 
@@ -32,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.2.1'.freeze # :nodoc:
+  VERSION = '1.3.0'.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

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