reportinator 0.2.0 → 0.3.3

data/lib/reportinator/functions/array/string.rb

@@ -0,0 +1,10 @@
+module Reportinator
+  class StringArrayFunction < ArrayFunction
+    PREFIXES = [">string"]
+
+    def output
+      values.prepend target
+      values.map { |value| parse_value(value).to_s }.join
+    end
+  end
+end

data/lib/reportinator/functions/string/number.rb

@@ -1,11 +1,33 @@
 module Reportinator
   class NumberStringFunction < StringFunction
-    PREFIXES = ["!n"]
+    PREFIXES = ["!n", "!nf", "!ni"]
+
+    attr_writer :parsed_body
 
     def output
-      float = (body =~ /\d\.\d/)
-      return body.to_f if float.present?
-      body.to_i
+      return parse_float if prefix == "!nf"
+      return parse_integer if prefix == "!ni"
+      parse_number
+    end
+
+    def parsed_body
+      to_parse = body
+      to_parse.strip! if to_parse.instance_of? String
+      @parsed_body ||= parse_value(body).to_s
+    end
+
+    def parse_float
+      parsed_body.to_f
+    end
+
+    def parse_integer
+      parsed_body.to_i
+    end
+
+    def parse_number
+      float = (parsed_body =~ /\d\.\d/)
+      return parse_float if float.present?
+      parse_integer
     end
   end
 end

data/lib/reportinator/functions/string/variable.rb

@@ -3,8 +3,10 @@ module Reportinator
     PREFIXES = ["$"]
 
     def output
-      return element unless variables.include? body.to_sym
-      variables[body.to_sym]
+      variables = metadata[:variables]
+      variable = body.to_sym
+      return element unless variables.present? && variables.include?(variable)
+      variables[variable]
     end
   end
 end

data/lib/reportinator/helpers.rb

@@ -0,0 +1,29 @@
+module Reportinator
+  module Helpers
+    def merge_hash(target, source)
+      target = target.present? ? target : {}
+      source = source.present? ? source : {}
+      merge_hash!(target, source)
+    end
+
+    def merge_hash!(target, source)
+      raise "Target: #{target} is not a hash" unless target.instance_of?(Hash)
+      raise "Source: #{source} is not a hash" unless source.instance_of?(Hash)
+      target.merge(source) do |key, old_value, new_value|
+        if old_value.instance_of?(Hash) && new_value.instance_of?(Hash)
+          merge_hash!(old_value, new_value)
+        elsif new_value.present?
+          new_value
+        else
+          old_value
+        end
+      end
+    end
+
+    def symbolize_attributes(target)
+      raise "Missing attributes" unless target.respond_to? :attributes
+      raise "Invalid attributes" unless target.attributes.instance_of? Hash
+      target.attributes.transform_keys { |key| key.to_sym }
+    end
+  end
+end

data/lib/reportinator/parsers/method.rb

@@ -5,6 +5,9 @@ module Reportinator
 
     def self.parse(target, method)
       new(target: target, method: method).output
+    rescue => e
+      logger.error "[ERROR] #{e.class}: #{e}"
+      "Method Error"
     end
 
     def output
@@ -45,15 +48,15 @@ module Reportinator
     private
 
     def send_value(target, method, value = nil)
-      method = method.to_s
       return nil unless target_has_method?(target, method)
+      method = method.to_s
       return target.send(method) unless value.present?
       return target.send(method, *value) if value.instance_of?(Array)
       target.send(method, value)
     end
 
     def target_has_method?(target, method)
-      target.methods.include?(method.to_sym)
+      target.respond_to?(method)
     end
 
     def parse_method(target, method)

data/lib/reportinator/parsers/value.rb

@@ -1,25 +1,26 @@
 module Reportinator
-  class ValueParser < Parser
+  class ValueParser < Parser    
     attribute :element
-    attribute :variables, default: {}
+    attribute :metadata, default: {}
 
-    def self.parse(element, variables = {})
-      variables = variables.present? ? variables : {}
-      new(element: element, variables: variables).output
+    def self.parse(element, metadata = {}, dup = true)
+      metadata = metadata.present? ? metadata : {}
+      input_element = (dup ? element.dup : element)
+      new(element: input_element, metadata: metadata).output
+    rescue => e
+      logger.error "[ERROR] #{e.class}: #{e}"
+      "Parsing Error"
     end
 
-    def self.parse_and_execute(target, values, variables = {})
-      parsed_target = target
-      if target.instance_of?(String)
-        parsed_target = parse(target, variables)
-      end
-      parsed_values = parse(values, variables)
+    def self.parse_and_execute(target, values, metadata = {})
+      parsed_target = parse(target, metadata, false)
+      parsed_values = parse(values, metadata)
       MethodParser.parse(parsed_target, parsed_values)
     end
 
     def output
       config.configured_functions.each do |function|
-        return function.parse(element, variables) if function.accepts? element
+        return function.parse(element, metadata) if function.accepts? element
       end
       return parse_array if element_class == Array
       return parse_hash if element_class == Hash
@@ -41,7 +42,7 @@ module Reportinator
     end
 
     def parse_value(value)
-      self.class.parse(value, variables)
+      self.class.parse(value, metadata)
     end
   end
 end

data/lib/reportinator/report/column.rb

@@ -0,0 +1,25 @@
+module Reportinator
+  class Column < Base
+    OUTPUT_TYPES = {
+      numeric: [Numeric],
+      date: [Date, Time],
+      string: [String],
+      hash: [Hash],
+      array: [Array]
+    }
+
+    attribute :data
+    attr_writer :output
+
+    def output
+      @output ||= ReportParser.parse(data)
+    end
+
+    OUTPUT_TYPES.each do |type, classes|
+      define_method(:"#{type}?") {
+        classes.each { |c| return true if output.is_a? c }
+        false
+      }
+    end
+  end
+end

data/lib/reportinator/report/loader.rb

@@ -0,0 +1,71 @@
+module Reportinator
+  class ReportLoader < Base
+    attribute :template
+    attribute :metadata
+
+    def self.load(template, metadata = {})
+      loader = new(metadata: metadata)
+      loader.template = Template.load(template: template, metadata: metadata)
+      loader
+    end
+
+    def get_metadata
+      report_metadata = {}
+      template.parse(metadata) do |data, old_meta, new_meta|
+        meta = ValueParser.parse(new_meta, metadata)
+        report_metadata = merge_hash(meta, report_metadata) if meta.present?
+      end
+      report_metadata
+    end
+
+    def report
+      report = Report.new
+      reports = template.parse(metadata) do |data, old_meta, new_meta|
+        parse_metadata(data, old_meta, new_meta)
+      end
+      reports.compact.each do |report_template|
+        output = report_template.data
+        report.insert(output)
+      end
+      report
+    end
+
+    def parse_metadata(data, old_meta, new_meta)
+      meta = ValueParser.parse(old_meta, metadata)
+      if new_meta.instance_of? Hash
+        unparsed_meta = new_meta.select { |key| config.configured_metadata.include? key }
+        meta_to_parse = new_meta.reject { |key| config.configured_metadata.include? key }
+        parsing_meta = merge_hash(meta, unparsed_meta)
+        parsed_meta = ValueParser.parse(meta_to_parse, parsing_meta)
+        remerged_meta = merge_hash(parsed_meta, unparsed_meta)
+      else
+        remerged_meta = {}
+      end
+      report_meta = merge_hash(remerged_meta, meta)
+      report_from_data(data, report_meta)
+    end
+
+    private
+
+    def report_from_data(data, meta)
+      report_type = report_class_from_data(data, meta)
+      return nil unless report_type.present?
+      return report_type.new(ValueParser.parse(data[:params], meta)) if report_type::PARSE_PARAMS
+      report = report_type.new(data[:params])
+      report.metadata = meta
+      report
+    end
+
+    def report_class_from_data(data, meta)
+      type = ValueParser.parse(data[:type], meta)
+      return false unless type.present?
+      report_class_from_type(type)
+    end
+
+    def report_class_from_type(type)
+      types = config.configured_types
+      raise "Invalid type: #{type}" unless types.include? type
+      types[type].constantize
+    end
+  end
+end

data/lib/reportinator/report/report.rb

@@ -0,0 +1,33 @@
+module Reportinator
+  class Report < Base
+    attr_writer :rows
+
+    def rows
+      @rows ||= []
+    end
+
+    def insert(row, position = :last)
+      return insert_row(row, position) if row.instance_of? Row
+      raise "Invalid row data: #{row}" unless row.instance_of? Array
+      row.each { |r| insert_row(r) }
+    end
+
+    def insert_row(row, position = :last)
+      raise "Not a row" unless row.instance_of? Row
+      return rows.append(row) if position == :last
+      return rows.prepend(row) if position == :first
+      return rows.insert(position, row) if position.is_a? Numeric
+      raise "Invalid Position!"
+    end
+
+    def output
+      rows.map { |r| r.output }
+    end
+
+    def to_csv
+      CSV.generate do |csv|
+        output.each { |row| csv << row }
+      end
+    end
+  end
+end

data/lib/reportinator/report/row.rb

@@ -0,0 +1,42 @@
+module Reportinator
+  class Row < Base
+    attr_writer :columns
+
+    def columns
+      @columns ||= []
+    end
+
+    def self.create(input)
+      row = new
+      if input.instance_of? Array
+        input.each { |value| row.insert value }
+      else
+        row.insert(input)
+      end
+      row
+    end
+
+    def insert(data, position = :last)
+      column = create_column(data)
+      return columns.prepend(column) if position == :first
+      return columns.insert(position, column) if position.is_a? Numeric
+      return columns.append(column) if position == :last
+      raise "Invalid Position!"
+    end
+
+    def total
+      numeric_columns = columns.select { |c| c.numeric? }
+      numeric_columns.sum { |c| c.output }
+    end
+
+    def output
+      columns.map { |c| c.output }
+    end
+
+    private
+
+    def create_column(data)
+      Column.new(data: data)
+    end
+  end
+end

data/lib/reportinator/report/template.rb

@@ -0,0 +1,108 @@
+module Reportinator
+  class Template < Base
+    attr_accessor :children
+    attribute :type
+    attribute :template
+    attribute :params
+    attribute :metadata
+
+    def self.load(params = {})
+      template = new(params)
+      template.register
+    end
+
+    def register
+      return load_template if template.present?
+      self
+    end
+
+    def parse(meta = {}, data = {})
+      output = []
+      new_meta = metadata
+      combine_meta = merge_hash(meta, new_meta)
+      new_data = attributes.transform_keys { |key| key.to_sym }
+      combine_data = merge_hash(new_data, data)
+      if children.present? && children.respond_to?(:to_ary)
+        children.each do |child|
+          output += child.parse(combine_meta, combine_data) do |combine_data, meta, new_meta|
+            yield(combine_data, meta, new_meta)
+          end
+        end
+      else
+        output << yield(combine_data, meta, new_meta)
+      end
+      output
+    end
+
+    private
+
+    def load_template
+      template_data = filter_template
+      data = if template_data.respond_to? :to_ary
+        template_data.map { |template| self.class.load(template) }
+      else
+        self.class.load(template_data)
+      end
+      self.children ||= []
+      if data.respond_to? :to_ary
+        self.children += data
+      else
+        self.children << data
+      end
+      self
+    end
+
+    def filter_template
+      template_data = parse_template
+      if template_data.respond_to? :to_ary
+        template_data.map { |template| filter_params(template) }
+      else
+        filter_params(template_data)
+      end
+    end
+
+    def find_template
+      raise "Template isn't a string" unless template.instance_of? String
+      suffixes = config.configured_suffixes
+      directories = config.configured_directories
+      template_files = suffixes.map { |suffix| (suffix.present? ? "#{template}.#{suffix}" : template) }
+      template_paths = directories.map { |dir| template_files.map { |file| "#{dir}/#{file}" } }
+      template_paths.flatten!
+      template_paths.each do |path|
+        return path if File.exist? path
+      end
+      raise "Missing template: #{template}"
+    end
+
+    def validate_template(json)
+      return true if Reportinator.schema.valid?(json)
+      raise "Template doesn't match schema: #{Reportinator.schema.validate(json).to_a}"
+    end
+
+    def parse_template
+      file = read_template
+      begin
+        plain_json = JSON.parse(file)
+        symbolised_json = JSON.parse(file, symbolize_names: true)
+      rescue
+        raise "Error parsing template file: #{file}"
+      end
+      validate_template(plain_json)
+      symbolised_json
+    end
+
+    def read_template
+      file = find_template
+      File.read(file)
+    end
+
+    def filter_params(params)
+      filtered_params = params.select { |param| attribute_names.include? param.to_s }
+      if params.size > filtered_params.size
+        invalid_params = (params.keys - filtered_params.keys).map { |key| key.to_s }
+        logger.warn "Invalid attributes found: #{invalid_params} Valid attributes are: #{attribute_names}"
+      end
+      filtered_params
+    end
+  end
+end

data/lib/reportinator/{report.rb → report_type.rb}

@@ -1,5 +1,8 @@
 module Reportinator
-  class Report < Base
+  class ReportType < Base
+    PARSE_PARAMS = true
+
+    attr_accessor :metadata
     attribute :title
 
     def self.generate(params)

data/lib/reportinator/types/model.rb

@@ -1,13 +1,16 @@
 module Reportinator
-  class ModelReport < Report
+  class ModelReport < ReportType
+    include Helpers
+    PARSE_PARAMS = false
     attribute :target
     attribute :method_list, default: []
 
     validates :target, presence: true
 
     def data
-      return get_model_data(target) unless target.respond_to? :to_ary
-      records_data
+      self.target = ValueParser.parse(target, metadata, false)
+      return Row.create(get_model_data(target)) unless target.respond_to? :each
+      records_data.map { |data| Row.create(data) }
     end
 
     def records_data
@@ -26,8 +29,10 @@ module Reportinator
     end
 
     def parse_method(target, method)
-      return method if method.instance_of?(String)
-      MethodParser.parse(target, method)
+      parser_metadata = merge_hash(metadata, {variables: {target: target}})
+      parsed_method = ValueParser.parse(method, parser_metadata)
+      return parsed_method if parsed_method.instance_of? String
+      MethodParser.parse(target, parsed_method)
     end
   end
 end

data/lib/reportinator/types/preset.rb

@@ -1,5 +1,26 @@
 module Reportinator
-  class PresetReport < Report
-    attribute :data, default: []
+  class PresetReport < ReportType
+    attribute :values
+
+    def data
+      split_values.map { |row| Row.create(row) }
+    end
+
+    def split_values
+      data = values.instance_of?(Array) ? values : [values]
+      rows = []
+      temp = []
+      data.each do |col|
+        if col.instance_of?(Array)
+          rows << temp unless temp.empty?
+          temp = []
+          rows << col
+        else
+          temp << col
+        end
+      end
+      rows << temp unless temp.empty?
+      rows
+    end
   end
 end

data/lib/reportinator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reportinator
-  VERSION = "0.2.0"
+  VERSION = "0.3.3"
 end

data/lib/reportinator.rb

@@ -6,14 +6,17 @@ require "fileutils"
 require "active_support"
 require "active_model"
 require "require_all"
+require "json_schemer"
 require_relative "reportinator/version"
 require_relative "reportinator/base"
 
 module Reportinator
+  SCHEMA = "#{__dir__}/../data/schema/report_schema.json"
   class Error < StandardError; end
   class << self
     attr_writer :config
     attr_writer :logger
+    attr_writer :schema
   end
 
   def self.config
@@ -24,28 +27,35 @@ module Reportinator
     yield(config)
   end
 
+  def self.schema
+    return @schema if @schema.instance_of? JSONSchemer
+    schema = JSON.parse(File.read(SCHEMA))
+    @schema = JSONSchemer.schema(schema)
+  end
+
   def self.logger
     @logger || ActiveSupport::Logger.new($stdout)
   end
 
-  def self.parse(input, variables = {})
-    ValueParser.parse(input, variables)
+  def self.parse(input, metadata = {})
+    ValueParser.parse(input, metadata)
   end
 
-  def self.report(template, additional_params = {})
-    Loader.data_from_template(template, additional_params)
+  def self.report(template, metadata = {})
+    report = ReportLoader.load(template, metadata).report
+    report.output
   end
 
-  def self.output(template, additional_params = {}, filename = "")
+  def self.output(template, metadata = {}, filename = "")
     filename = (filename.present? ? filename : "#{template}.csv")
     path = "#{config.output_directory}/#{filename}"
     FileUtils.mkdir_p(File.dirname(path))
-    data = Loader.data_from_template(template, additional_params)
-    CSV.open(path, "wb") do |csv|
-      data.each do |row|
-        csv << row
-      end
+    report = ReportLoader.load(template, metadata).report
+    data = report.to_csv
+    if File.write(path, data)
+      path
+    else
+      raise "Error writing to: #{path}"
     end
-    path
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reportinator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Moxvallix
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: Behold! My Reportinator! Reportinator makes reports from JSON files.
 email:
 - dev@moxvallix.com
@@ -56,15 +70,21 @@ files:
 - Rakefile
 - app/reports/example.report.json
 - app/reports/multiplication.report.json
+- app/reports/multiplication_v2.report.json
+- data/schema/report_schema.json
 - docs/0_first_report.md
 - lib/reportinator.rb
 - lib/reportinator/base.rb
 - lib/reportinator/config.rb
 - lib/reportinator/function.rb
 - lib/reportinator/functions/array.rb
+- lib/reportinator/functions/array/flatten.rb
 - lib/reportinator/functions/array/helper.rb
 - lib/reportinator/functions/array/join.rb
 - lib/reportinator/functions/array/method.rb
+- lib/reportinator/functions/array/range.rb
+- lib/reportinator/functions/array/snippet.rb
+- lib/reportinator/functions/array/string.rb
 - lib/reportinator/functions/string.rb
 - lib/reportinator/functions/string/addition.rb
 - lib/reportinator/functions/string/constant.rb
@@ -75,12 +95,17 @@ files:
 - lib/reportinator/functions/string/range.rb
 - lib/reportinator/functions/string/symbol.rb
 - lib/reportinator/functions/string/variable.rb
-- lib/reportinator/loader.rb
+- lib/reportinator/helpers.rb
 - lib/reportinator/parser.rb
 - lib/reportinator/parsers/method.rb
 - lib/reportinator/parsers/report.rb
 - lib/reportinator/parsers/value.rb
-- lib/reportinator/report.rb
+- lib/reportinator/report/column.rb
+- lib/reportinator/report/loader.rb
+- lib/reportinator/report/report.rb
+- lib/reportinator/report/row.rb
+- lib/reportinator/report/template.rb
+- lib/reportinator/report_type.rb
 - lib/reportinator/types/model.rb
 - lib/reportinator/types/preset.rb
 - lib/reportinator/version.rb
@@ -92,7 +117,7 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/moxvallix/reportinator
   source_code_uri: https://github.com/moxvallix/reportinator
-  changelog_uri: https://github.com/moxvallix/reportinator
+  changelog_uri: https://github.com/moxvallix/reportinator/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: