renogen 1.1.1 → 1.4.0

data/lib/renogen/cli/param_parser.rb

@@ -44,6 +44,18 @@ module Renogen
             args['legacy_version'] = n
           end
 
+          opts.on("-rDATE", "--release-date=DATE", "Release date") do |n|
+            args['release_date'] = n
+          end
+
+          opts.on("-IPATH", "--include=PATH", "Add a path to the load path") do |n|
+            $LOAD_PATH << n
+          end
+
+          opts.on("-RFILE", "--require=FILE", "Require a file from the load path") do |n|
+            require n
+          end
+
           opts.on_tail("-h", "--help", "Show this message") do
             puts opts
             exit

data/lib/renogen/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require 'yaml'
 
@@ -5,19 +7,21 @@ module Renogen
   # Stores configuratin values to be used by the libary
   class Config
     include Singleton
-    attr_accessor :single_line_format, :input_source, :output_format, :supported_keys, :changelog_path, :default_headings
+    attr_accessor :single_line_format, :input_source, :output_format, :supported_keys, :changelog_path,
+                  :default_headings, :validations, :remove_duplicates
 
     def initialize
       config_file = load_yaml_config
-      self.single_line_format = config_file['single_line_format'] || 'summary (see link)'.freeze
-      self.supported_keys = config_file['supported_keys'] || ['identifier', 'link', 'summary'].freeze
-      self.input_source = config_file['input_source'] || 'yaml'.freeze
-      self.output_format = config_file['output_format'] || 'markdown'.freeze
-      self.changelog_path = config_file['changelog_path'] || './change_log'.freeze
-      self.default_headings = config_file['default_headings'] || %w(Summary Detailed Tasks).freeze
+      self.single_line_format = config_file['single_line_format'] || 'summary (see link)'
+      self.supported_keys = config_file['supported_keys'] || %w(identifier link summary)
+      self.input_source = config_file['input_source'] || 'yaml'
+      self.output_format = config_file['output_format'] || 'markdown'
+      self.changelog_path = config_file['changelog_path'] || './change_log'
+      self.default_headings = config_file['default_headings'] || %w(Summary Detailed Tasks)
+      self.validations = config_file['allowed_values']
+      self.remove_duplicates = config_file['remove_duplicates'] || false
     end
 
-
     # Renogen configuration extension
     # a block can be provided to programatily setup configuration values
     def self.configure
@@ -26,13 +30,10 @@ module Renogen
 
     private
 
-    def load_yaml_config(config_file_path='.renogen')
-      begin
-        YAML.load_file(config_file_path)
-      rescue
-        {}
-      end
+    def load_yaml_config(config_file_path = '.renogen')
+      YAML.load_file(config_file_path)
+    rescue StandardError
+      {}
     end
   end
 end
-

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
@@ -13,20 +25,31 @@ module Renogen
         Renogen::Formatters.add(identifier.to_sym, self)
       end
 
+      # Generate a header for a given changelog
+      #
+      # @param changelog [Renogen::ChangeLog::Model]
+      #
+      # return [String]
+      def header(changelog)
+        "#{changelog.version} (#{changelog.date})"
+      end
+
       # Outputs a line or block of text appearing at the top of the change log.
       #
+      # @abstract
+      #
       # @param header [String]
-      # @return [NotImplementedError]
+      # @raise NotImplementedError
       def write_header(header)
-        raise NotImplementedError
       end
 
       # Outputs a line or block as a header for a group.
       #
+      # @abstract
+      #
       # @param group [String]
-      # @return [NotImplementedError]
+      # @raise NotImplementedError
       def write_group(group)
-        raise NotImplementedError
       end
 
       # Outputs a line or block of text appearing after a group.
@@ -37,8 +60,10 @@ module Renogen
 
       # Outputs a line or block as the body for a change.
       #
+      # @abstract
+      #
       # @param change [String]
-      # @return [NotImplementedError]
+      # @raise NotImplementedError
       def write_change(change)
         raise NotImplementedError
       end

data/lib/renogen/formatters/csv.rb

@@ -0,0 +1,42 @@
+# 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 = parsed_line.chomp
+          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/html.rb

@@ -9,7 +9,7 @@ module Renogen
       # @param header [String]
       # @return [String]
       def write_header(header)
-        "<html>\n<h1>#{header}</h1>"
+        "<html>\n<h1>#{header}</h1>\n"
       end
 
       # Outputs a line or block as a header for a group.

data/lib/renogen/formatters/markdown.rb

@@ -10,7 +10,7 @@ module Renogen
       # @param header [String]
       # @return [String]
       def write_header(header)
-        "# #{header}"
+        "# #{header}\n\n"
       end
 
       # Outputs a line or block as a header for a group.
@@ -18,7 +18,7 @@ module Renogen
       # @param group [String]
       # @return [String]
       def write_group(group)
-        "### #{group}"
+        "## #{group}\n\n"
       end
 
       # Outputs a line or block as the body for a change.

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