reflekt 1.0.5 → 1.0.10

data/lib/meta.rb

@@ -0,0 +1,75 @@
+################################################################################
+# Metadata for input and output.
+#
+# @pattern Abstract class
+# @see lib/meta for each meta.
+#
+# @hierachy
+#   1. Action
+#   2. Reflection
+#   3. Meta <- YOU ARE HERE
+################################################################################
+
+module Reflekt
+  class Meta
+
+    ##
+    # Each meta defines its type.
+    ##
+    def initialize()
+      @type = :null
+    end
+
+    ##
+    # Each meta loads values.
+    #
+    # @param value [Dynamic]
+    ##
+    def load(value)
+    end
+
+    ##
+    # @return [Hash]
+    ##
+    def serialize()
+      {
+        :type => @type
+      }
+    end
+
+    ############################################################################
+    # CLASS
+    ############################################################################
+
+    ##
+    # Deserialize metadata.
+    #
+    # TODO: Deserialize should create a Meta object.
+    # TODO: Require each Meta type to handle its own deserialization.
+    #
+    # @param meta [Hash] The metadata to deserialize.
+    # @param meta [Hash]
+    ##
+    def self.deserialize(meta)
+      # Convert nil meta into NullMeta.
+      # Meta is nil when there are no @inputs or @output on the method.
+      if meta.nil?
+        return NullMeta.new().serialize()
+      end
+
+      # Symbolize keys.
+      # TODO: Remove once "Fix Rowdb.get(path)" bug fixed.
+      meta = meta.transform_keys(&:to_sym)
+
+      # Symbolize type value.
+      meta[:type] = meta[:type].to_sym
+
+      return meta
+    end
+
+    def self.numeric? value
+      Float(value) != nil rescue false
+    end
+
+  end
+end

data/lib/meta/array_meta.rb

@@ -0,0 +1,32 @@
+require_relative '../meta'
+
+module Reflekt
+  class ArrayMeta < Meta
+
+    def initialize()
+      @type = :array
+      @min = nil
+      @max = nil
+      @length = nil
+    end
+
+    ##
+    # @param value [Array]
+    ##
+    def load(value)
+      @min = value.min()
+      @max = value.max()
+      @length = value.length()
+    end
+
+    def serialize()
+      {
+        :type => @type,
+        :max => @max,
+        :min => @min,
+        :length => @length
+      }
+    end
+
+  end
+end

data/lib/meta/boolean_meta.rb

@@ -0,0 +1,26 @@
+require_relative '../meta'
+
+module Reflekt
+  class BooleanMeta < Meta
+
+    def initialize()
+      @type = :bool
+      @value = nil
+    end
+
+    ##
+    # @param value [Boolean]
+    ##
+    def load(value)
+      @value = value.to_s
+    end
+
+    def serialize()
+      {
+        :type => @type,
+        :value => @value
+      }
+    end
+
+  end
+end

data/lib/meta/float_meta.rb

@@ -0,0 +1,26 @@
+require_relative '../meta'
+
+module Reflekt
+  class FloatMeta < Meta
+
+    def initialize()
+      @type = :float
+      @value = nil
+    end
+
+    ##
+    # @param value [Float]
+    ##
+    def load(value)
+      @value = value
+    end
+
+    def serialize()
+      {
+        :type => @type,
+        :value => @value
+      }
+    end
+
+  end
+end

data/lib/meta/integer_meta.rb

@@ -0,0 +1,26 @@
+require_relative '../meta'
+
+module Reflekt
+  class IntegerMeta < Meta
+
+    def initialize()
+      @type = :int
+      @value = nil
+    end
+
+    ##
+    # @param value [Integer]
+    ##
+    def load(value)
+      @value = value
+    end
+
+    def serialize()
+      {
+        :type => @type,
+        :value => @value
+      }
+    end
+
+  end
+end

data/lib/meta/{NullMeta.rb → null_meta.rb}

@@ -10,25 +10,27 @@
 #   3. Meta <- YOU ARE HERE
 ################################################################################
 
-require 'Meta'
+require_relative '../meta'
 
-class NullMeta < Meta
-
-  def initialize()
-    @type = :null
-  end
-
-  ##
-  # @param value [NilClass]
-  ##
-  def load(value)
-    # No need to load a value for null meta.
+module Reflekt
+  class NullMeta < Meta
+  
+    def initialize()
+      @type = :null
+    end
+  
+    ##
+    # @param value [NilClass]
+    ##
+    def load(value)
+      # No need to load a value for null meta.
+    end
+  
+    def serialize()
+      {
+        :type => @type,
+      }
+    end
+  
   end
-
-  def serialize()
-    {
-      :type => @type,
-    }
-  end
-
 end

data/lib/meta/object_meta.rb

@@ -0,0 +1,35 @@
+################################################################################
+# A reprsentation of a null value.
+#
+# @hierachy
+#   1. Action
+#   2. Reflection
+#   3. Meta <- YOU ARE HERE
+################################################################################
+
+require_relative '../meta'
+
+module Reflekt
+  class ObjectMeta < Meta
+
+    def initialize()
+      @type = :object
+      @class_type = nil
+    end
+
+    ##
+    # @param value [Dynamic] Any custom class.
+    ##
+    def load(value)
+      @class_type = value.class
+    end
+
+    def serialize()
+      {
+        :type => @type,
+        :class_type => @class_type
+      }
+    end
+
+  end
+end

data/lib/meta/string_meta.rb

@@ -0,0 +1,26 @@
+require_relative '../meta'
+
+module Reflekt
+  class StringMeta < Meta
+
+    def initialize()
+      @type = :string
+      @length = nil
+    end
+
+    ##
+    # @param value [String]
+    ##
+    def load(value)
+      @length = value.length
+    end
+
+    def serialize()
+      {
+        :type => @type,
+        :length => @length
+      }
+    end
+
+  end
+end

data/lib/meta_builder.rb

@@ -0,0 +1,100 @@
+################################################################################
+# Create metadata.
+#
+# @pattern Builder
+# @see lib/meta for each meta.
+################################################################################
+
+require_relative 'meta'
+# Require all meta from the meta directory.
+Dir[File.join(__dir__, 'meta', '*.rb')].each { |file| require_relative file }
+
+module Reflekt
+  class MetaBuilder
+
+    ##
+    # Create meta type for matching data type.
+    #
+    # @logic
+    #   1. First return basic type
+    #   2. Then return custom type
+    #   3. Then return "nil" type
+    #
+    # @param value [Dynamic] Any input or output.
+    ##
+    def self.create(value)
+
+      meta = nil
+      data_type = value.class.to_s
+
+      case data_type
+      when "Array"
+        meta = ArrayMeta.new()
+      when "TrueClass", "FalseClass"
+        meta = BooleanMeta.new()
+      when "Float"
+        meta = FloatMeta.new()
+      when "Integer"
+        meta = IntegerMeta.new()
+      when "String"
+        meta = StringMeta.new()
+      else
+        unless value.nil?
+          meta = ObjectMeta.new()
+        end
+      end
+
+      unless meta.nil?
+        meta.load(value)
+      end
+
+      return meta
+
+    end
+
+    ##
+    # Create meta for multiple values.
+    #
+    # @param values
+    ##
+    def self.create_many(values)
+
+      meta = []
+
+      values.each do |value|
+        meta << self.create(value)
+      end
+
+      return meta
+
+    end
+
+    ##
+    # @param data_type [Type]
+    ##
+    def self.data_type_to_meta_type(value)
+
+      data_type = value.class
+
+      meta_types = {
+        Array      => :array,
+        TrueClass  => :bool,
+        FalseClass => :bool,
+        Float      => :float,
+        Integer    => :int,
+        NilClass   => :null,
+        String     => :string
+      }
+
+      if meta_types.key? data_type
+        return meta_types[data_type]
+      elsif value.nil?
+        return nil
+      else
+        return :object
+      end
+
+    end
+
+  end
+end

data/lib/reflection.rb

@@ -0,0 +1,123 @@
+################################################################################
+# A snapshot of real or random data.
+#
+# @pattern Abstract class
+#
+# @nomenclature
+#   args, inputs/output and meta represent different stages of a value.
+#
+# @hierachy
+#   1. Action
+#   2. Reflection <- YOU ARE HERE
+#   3. Meta
+#
+# @status
+#   - :pass [Symbol] The reflection passes the rules.
+#   - :fail [Symbol] The reflection fails the rules or produces a system error.
+#   - :error [Symbol] The control reflection produces a system error.
+################################################################################
+
+require_relative 'clone'
+require_relative 'meta_builder'
+
+module Reflekt
+  class Reflection
+    include LitCLI
+
+    attr_reader :status
+
+    ##
+    # Create a reflection.
+    #
+    # @param action [Action] The Action that created this Reflection.
+    # @param number [Integer] Multiple Reflections can be created per Action.
+    # @param aggregator [RuleSetAggregator] The aggregated RuleSet for this class/method.
+    ##
+    def initialize(action, number, aggregator)
+      @action = action
+      @reflection_id = action.unique_id + number
+      @number = number
+
+      # Dependency.
+      @aggregator = aggregator
+
+      # Caller.
+      @klass = action.klass
+      @method = action.method
+
+      # Metadata.
+      @inputs = nil
+      @output = nil
+
+      # Clone the action's calling object.
+      # TODO: Abstract away into Clone class.
+      @clone = action.caller_object.clone
+
+      # Result.
+      @status = :pass
+      @time = Time.now.to_i
+      @message = nil
+    end
+
+    ##
+    # Reflect on a method.
+    #
+    # Create a shadow action.
+    # @param *args [Dynamic] The method's arguments.
+    ##
+    def reflect(*args)
+      # Implemented by Control and Experiment.
+    end
+
+    ##
+    # Get the results of the reflection.
+    #
+    # @keys
+    #   - eid [Integer] Execution ID
+    #   - aid [Integer] Action ID
+    #   - rid [Integer] Reflection ID
+    #   - num [Integer] Reflection number
+    #
+    # @return [Hash] Reflection metadata.
+    ##
+    def serialize()
+      # Create execution ID from the ID of the first action in   the ActionStack.
+      execution_id = @action.unique_id
+      unless @action.base.nil?
+        execution_id = @action.base.unique_id
+      end
+
+      # Build reflection.
+      reflection = {
+        :eid => execution_id,
+        :aid => @action.unique_id,
+        :rid => @reflection_id,
+        :num => @number,
+        :time => @time,
+        :class => @klass,
+        :method => @method,
+        :status => @status,
+        :message => @message,
+        :inputs => nil,
+        :output => nil,
+      }
+
+      # TODO: After the last experiment for an action is completed, serialize()
+      #       appears to be called twice. Possibly due to inheritance.
+      🔥"> Save meta for #{@method}()", :save, :meta, @klass
+
+      unless @inputs.nil?
+        reflection[:inputs] = []
+        @inputs.each do |meta|
+          meta.nil? ? nil : reflection[:inputs] << meta.serialize()
+        end
+      end
+
+      unless @output.nil?
+        reflection[:output] = @output.serialize()
+      end
+
+      return reflection
+    end
+  end
+end