reportinator 0.1.1 → 0.3.2

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

@@ -0,0 +1,14 @@
+module Reportinator
+  class LogicalStringFunction < StringFunction
+    PREFIXES = ["@true", "@false", "@nil", "@null"]
+
+    def output
+      case prefix
+      when "@true" then true
+      when "@false" then false
+      when "@nil", "@null" then nil
+      else element
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Reportinator
+  class NumberStringFunction < StringFunction
+    PREFIXES = ["!n", "!nf", "!ni"]
+
+    attr_writer :parsed_body
+
+    def output
+      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/range.rb

@@ -0,0 +1,14 @@
+module Reportinator
+  class RangeStringFunction < StringFunction
+    PREFIXES = ["!r", "!rd", "!rn"]
+
+    def output
+      values = body.split(",").map { |value| parse_value(value.strip) }
+      case prefix
+      when "!rn" then values.map! { |subvalue| NumberStringFunction.parse("!n #{subvalue}") }
+      when "!rd" then values.map! { |subvalue| DateStringFunction.parse("!d #{subvalue}") }
+      end
+      Range.new(*values)
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Reportinator
+  class SymbolStringFunction < StringFunction
+    PREFIXES = [":"]
+
+    def output
+      body.to_sym
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Reportinator
+  class VariableStringFunction < StringFunction
+    PREFIXES = ["$"]
+
+    def output
+      variables = metadata[:variables]
+      variable = body.to_sym
+      return element unless variables.present? && variables.include?(variable)
+      variables[variable]
+    end
+  end
+end

data/lib/reportinator/functions/string.rb

@@ -0,0 +1,29 @@
+module Reportinator
+  class StringFunction < Function
+    PREFIXES = []
+
+    attribute :prefix
+    attribute :body
+
+    def self.accepts? input
+      return false unless input.instance_of? String
+      return false if self::PREFIXES.empty?
+      self::PREFIXES.each do |prefix|
+        return true if input.start_with? prefix
+      end
+      false
+    end
+
+    def get
+      raise "Function missing output!" unless respond_to? :output
+      set_attributes
+      output
+    end
+
+    def set_attributes
+      prefix = get_prefix(element)
+      self.prefix = prefix
+      self.body = element.sub(prefix, "")
+    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/parser.rb

@@ -0,0 +1,25 @@
+module Reportinator
+  class Parser < Base
+    cattr_writer :prefix_list
+
+    def self.get_prefix_list
+      config.configured_functions.map { |function| function::PREFIXES }.flatten
+    end
+
+    def self.prefix_list
+      @prefix_list ||= get_prefix_list
+    end
+
+    def prefix_list
+      self.class.prefix_list
+    end
+
+    def escape_value(value)
+      return value unless value.is_a? String
+      prefix_list.each do |escape|
+        return value.prepend("?/") if value.strip.start_with?(escape)
+      end
+      value
+    end
+  end
+end

data/lib/reportinator/parsers/method.rb

@@ -1,14 +1,20 @@
 module Reportinator
-  class MethodParser < Base
+  class MethodParser < Parser
     attribute :target
     attribute :method
 
     def self.parse(target, method)
       new(target: target, method: method).output
+    rescue => e
+      logger.error "[ERROR] #{e.class}: #{e}"
+      "Method Error"
     end
 
     def output
-      return send_value(target, method) if method_class == Symbol
+      if method_class == Symbol
+        value = send_value(target, method)
+        return escape_value(value)
+      end
       return parse_array_method if method_class == Array
       return parse_hash_method if method_class == Hash
       nil
@@ -24,7 +30,6 @@ module Reportinator
       output = target
       method.each do |m|
         value = parse_method(output, m)
-        next unless value.present?
         valid = true
         output = value
       end

data/lib/reportinator/parsers/report.rb

@@ -0,0 +1,47 @@
+module Reportinator
+  class ReportParser < Parser
+    attribute :element
+    attribute :data
+
+    def self.parse(element, data = nil)
+      set_data = (data.present? ? data : element)
+      new(element: element, data: set_data).output
+    end
+
+    def output
+      return parse_array if element_class == Array
+      return parse_hash if element_class == Hash
+      return parse_string if element_class == String
+      element
+    end
+
+    def parse_array
+      raise "Not an array" unless element_class == Array
+      element.map { |value| parse_value(value) }
+    end
+
+    def parse_hash
+      raise "Not a hash" unless element_class == Hash
+      element.transform_values { |value| parse_value(value) }
+    end
+
+    def parse_string
+      raise "Not a string" unless element_class == String
+      return element unless element.strip.start_with?("?")
+      return element.sub("?/", "") if element.strip.start_with?("?/")
+      # return parse_row_total if element.start_with?("?tr")
+      # return parse_column_total if element.start_with?("?tc")
+      element
+    end
+
+    def element_class
+      element.class
+    end
+
+    private
+
+    def parse_value(value)
+      self.class.parse(value, data)
+    end
+  end
+end

data/lib/reportinator/parsers/value.rb

@@ -1,144 +1,47 @@
 module Reportinator
-  class ValueParser < Base
-    VALUE_FUNCTIONS = %i[a d n rn rd r]
-
+  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 = {})
+      metadata = metadata.present? ? metadata : {}
+      new(element: element.dup, 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 = new(element: target, variables: variables).parse_string
-      end
-      parsed_values = parse(values, variables)
+    def self.parse_and_execute(target, values, metadata = {})
+      parsed_target = parse(target, metadata)
+      parsed_values = parse(values, metadata)
       MethodParser.parse(parsed_target, parsed_values)
     end
 
     def output
+      config.configured_functions.each do |function|
+        return function.parse(element, metadata) if function.accepts? element
+      end
       return parse_array if element_class == Array
       return parse_hash if element_class == Hash
-      return parse_string if element_class == String
       element
     end
 
     def parse_array
       raise "Not an array" unless element_class == Array
-      front = element[0]
-      return parse_executed_array if front.instance_of?(String) && front.start_with?("#")
       element.map { |value| parse_value(value) }
     end
 
-    def parse_executed_array
-      raise "Not an executable array" unless element[0].start_with?("#")
-      values = element
-      target = values.delete_at(0).sub("#", "")
-      parse_and_execute_value(target, values)
-    end
-
     def parse_hash
       raise "Not a hash" unless element_class == Hash
       element.transform_values { |value| parse_value(value) }
     end
 
-    def parse_string
-      raise "Not a string" unless element_class == String
-      return element.sub(":", "").to_sym if element.start_with?(":")
-      return element.sub("&", "").constantize if element.start_with?("&")
-      return parse_variable(element) if element.start_with?("$")
-      return parse_function(element) if element.start_with?("!")
-      element
-    end
-
     def element_class
       element.class
     end
 
-    private
-
-    def parse_variable(value)
-      key = value.sub("$", "").to_sym
-      variables[key]
-    end
-
-    def parse_function(value)
-      input = value.strip
-      function = function_type(input)
-      return value unless function.present?
-      input.sub!(function_prefix(function), "")
-      output = run_function(function, input)
-      output.nil? ? value : output
-    end
-
-    def run_function(function, input)
-      case function
-      when :a then addition_function(input)
-      when :d then date_function(input)
-      when :n then number_function(input)
-      when :r then range_function(input)
-      when :rn then range_function(input, :number)
-      when :rd then range_function(input, :date)
-      end
-    end
-
-    def function_type(value)
-      VALUE_FUNCTIONS.each do |function|
-        return function if value.start_with?(function_prefix(function))
-      end
-      false
-    end
-
-    def function_prefix(function)
-      "!#{function}"
-    end
-
-    def addition_function(value)
-      values = parse_function_array(value)
-      values.map! { |value| number_function(value) }
-      values.sum(0)
-    rescue
-      0
-    end
-
-    def date_function(value)
-      Time.parse(value)
-    rescue
-      Time.now
-    end
-
-    def number_function(value)
-      float = (value =~ /\d\.\d/)
-      return value.to_f if float.present?
-      value.to_i
-    rescue
-      0
-    end
-
-    def range_function(value, type = :any)
-      values = parse_function_array(value)
-      case type
-      when :number then values.map! { |subvalue| number_function(subvalue) }
-      when :date then values.map! { |subvalue| date_function(subvalue) }
-      end
-      Range.new(*values)
-    rescue
-      Range(0..1)
-    end
-
-    def parse_function_array(value)
-      value.split(",").map { |value| parse_value(value.strip) }
-    end
-
     def parse_value(value)
-      self.class.parse(value, variables)
-    end
-
-    def parse_and_execute_value(target, value)
-      self.class.parse_and_execute(target, 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