reflekt 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfaf70b43c12867f93934b6b1f2e0d672486b3331369c9c85c0646e54bfc18d2
-  data.tar.gz: 437bbcdd66ae77ec202360255386edc10d69bcfb2da5b41816b0aed3c3151285
+  metadata.gz: fdefbebdb9516a1fdd8b20c2a5239ae9e2dcc1cb27e5a430589a155a80ccde55
+  data.tar.gz: 1c7e77b9ab430f971d9d69332161647762f9065bd73ef4440da0c588520cdd1d
 SHA512:
-  metadata.gz: 789f134df80a4cb9455274cd36d968f83903f6c474b6974d451ecfea1910799121f815eeecb9162a3b0ea2417f52983f1bb4557a5dd9b729fbdfa3e7325a6b99
-  data.tar.gz: 3bfb838fb97dda4989fba353db654b9498ce2ff8112f880d0bb5c926ae58865e05916701ec81cf393486b0b279af308a349245c970242879774c172bf12e2e7c
+  metadata.gz: 854ac0d582aef56603e8edae7d11371de656cdb044cf6d94a7d6359c440bfd2430ff8eb4456dcc882bf299be681d82735000062decc1274a36e91d6c269afa4a
+  data.tar.gz: '05850d0849fbd0e74026e40497761c3355ea67fedc00cb7c2918362d2250b328dd36887a1ffbc2af83bc54787a0a482b258e6eedf66465abbdf6e2df04a604c7'

data/lib/{Execution.rb → action.rb}

@@ -1,13 +1,13 @@
 ################################################################################
-# A shadow execution.
+# A shadow action.
 #
 # @hierachy
-#   1. Execution <- YOU ARE HERE
+#   1. Action <- YOU ARE HERE
 #   2. Reflection
 #   3. Meta
 ################################################################################
 
-class Execution
+class Action
 
   attr_accessor :unique_id
   attr_accessor :caller_object
@@ -19,17 +19,17 @@ class Execution
   attr_accessor :parent
   attr_accessor :child
   attr_accessor :control
-  attr_accessor :reflections
+  attr_accessor :experiments
   attr_accessor :is_reflecting
   attr_accessor :is_base
 
   ##
-  # Create Execution.
+  # Create Action.
   #
   # @param object [Object] The calling object.
   # @param method [Symbol] The calling method.
-  # @param reflect_amount [Integer] The number of reflections to create per execution.
-  # @param stack [ShadowStack] The shadow execution call stack.
+  # @param reflect_amount [Integer] The number of experiments to create per action.
+  # @param stack [ActionStack] The shadow action call stack.
   ##
   def initialize(caller_object, method, reflect_amount, stack)
 
@@ -51,7 +51,7 @@ class Execution
 
     # Reflections.
     @control = nil
-    @reflections = Array.new(reflect_amount)
+    @experiments = Array.new(reflect_amount)
 
     # State.
     if @stack.peek() == nil
@@ -64,12 +64,12 @@ class Execution
 
   end
 
-  def has_empty_reflections?
-    @reflections.include? nil
+  def has_empty_experiments?
+    @experiments.include? nil
   end
 
   ##
-  # Is the Execution currently reflecting methods?
+  # Is the Action currently reflecting methods?
   ##
   def is_reflecting?
     @is_reflecting
@@ -79,7 +79,7 @@ class Execution
     if is_reflecting?
       return false
     end
-    if has_empty_reflections?
+    if has_empty_experiments?
       return false
     end
     return true

data/lib/action_stack.rb

@@ -0,0 +1,44 @@
+################################################################################
+# Track the actions in a shadow call stack.
+#
+# @pattern Stack
+################################################################################
+
+class ActionStack
+
+  def initialize()
+    @bottom = nil
+    @top = nil
+  end
+
+  def peek()
+    @top
+  end
+
+  def base()
+    @bottom
+  end
+
+  ##
+  # Place Action at the top of stack.
+  #
+  # @param action [Action] The action to place.
+  # @return [Action] The placed action.
+  ##
+  def push(action)
+
+    # Place first action at bottom of stack.
+    if @bottom.nil?
+      @bottom = action
+    # Connect subsequent actions to each other.
+    else
+      @top.parent = action
+      action.child = @top
+    end
+
+    # Place action at top of stack.
+    @top = action
+
+  end
+
+end

data/lib/{Clone.rb → clone.rb}

@@ -7,17 +7,17 @@
 #   on object, not indirectly through clone which results in "undefined method".
 #
 # @hierachy
-#   1. Execution
+#   1. Action
 #   2. Reflection
 #   3. Clone <- YOU ARE HERE
 ################################################################################
 
 class Clone
 
-  def initialize(execution)
+  def initialize(action)
 
-    # Clone the execution's calling object.
-    @caller_object_clone = execution.caller_object.clone
+    # Clone the action's calling object.
+    @caller_object_clone = action.caller_object.clone
 
     # TODO: Clone any other instances that this clone references.
     # TODO: Replace clone's references to these new instances.

data/lib/{Config.rb → config.rb}

@@ -26,11 +26,12 @@ class Config
       :bool   => [BooleanRule],
       :int    => [IntegerRule],
       :float  => [FloatRule],
+      :null   => [NullRule],
       :string => [StringRule]
     }
 
     # An absolute path to the directory that contains the output directory.
-    # Defaults to current execution path.
+    # Defaults to current action path.
     @output_path = nil
 
     # Name of output directory.

data/lib/{Control.rb → control.rb}

@@ -1,51 +1,62 @@
 ################################################################################
 # A shapshot of real data.
 #
-# A control's @number property will always be zero.
+# @note
+#   A control's @number will always be 0.
+#
+# @nomenclature
+#   args, inputs/output and meta represent different stages of a value.
 #
 # @hierachy
-#   1. Execution
+#   1. Action
 #   2. Control <- 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 'Reflection'
-require 'MetaBuilder'
+require_relative 'reflection'
+require_relative 'meta_builder'
 
 class Control < Reflection
 
   ##
   # Reflect on a method.
   #
-  # Creates a shadow execution.
+  # Create a shadow action.
   # @param *args [Dynamic] The method's arguments.
   ##
   def reflect(*args)
 
-    # Get aggregated rule sets.
+    # Get trained rule sets.
     input_rule_sets = @aggregator.get_input_rule_sets(@klass, @method)
     output_rule_set = @aggregator.get_output_rule_set(@klass, @method)
 
+    # Fail when no trained rule sets.
+    if input_rule_sets.nil?
+      @status = :fail
+    end
+
     # When arguments exist.
     unless args.size == 0
 
-      # When aggregated rule sets exist.
+      # Validate arguments against trained rule sets.
       unless input_rule_sets.nil?
-
-        # Validate arguments against aggregated rule sets.
         unless @aggregator.test_inputs(args, input_rule_sets)
           @status = :fail
         end
-
       end
 
       # Create metadata for each argument.
-      # TODO: Create metadata for other inputs such as properties on the instance.
+      # TODO: Create metadata for other inputs such as instance variables.
       @inputs = MetaBuilder.create_many(args)
 
     end
 
-    # Action method with new/old arguments.
+    # Action method with real arguments.
     begin
 
       # Run reflection.

data/lib/experiment.rb

@@ -0,0 +1,81 @@
+################################################################################
+# A snapshot of random data.
+#
+# @note
+#   A reflection's random values are generated from aggregated control rule sets.
+#
+# @nomenclature
+#   args, inputs/output and meta represent different stages of a value.
+#
+# @hierachy
+#   1. Action
+#   2. Experiment <- 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 'reflection'
+require_relative 'meta_builder'
+
+class Experiment < Reflection
+
+  ##
+  # Reflect on a method.
+  #
+  # Create a shadow action.
+  # @param *args [Dynamic] The method's arguments.
+  ##
+  def reflect(*args)
+
+    # Get aggregated rule sets.
+    input_rule_sets = @aggregator.get_input_rule_sets(@klass, @method)
+    output_rule_set = @aggregator.get_output_rule_set(@klass, @method)
+
+    # Fail when no trained rule sets.
+    if input_rule_sets.nil?
+      @status = :fail
+    end
+
+    # When arguments exist.
+    unless args.size == 0
+
+      # Create random arguments from aggregated rule sets.
+      unless input_rule_sets.nil?
+        args = randomize(args, input_rule_sets)
+      end
+
+      # Create metadata for each argument.
+      # TODO: Create metadata for other inputs such as instance variables.
+      @inputs = MetaBuilder.create_many(args)
+
+    end
+
+    # Action method with random arguments.
+    begin
+
+      # Run reflection.
+      output = @clone.send(@method, *args)
+      @output = MetaBuilder.create(output)
+
+      # Validate output against aggregated control rule sets.
+      unless output_rule_set.nil?
+        unless @aggregator.test_output(output, output_rule_set)
+          @status = :fail
+        end
+      end
+
+    # When a system error occurs.
+    rescue StandardError => message
+
+      @status = :fail
+      @message = message
+
+    end
+
+  end
+
+end

data/lib/meta.rb

@@ -0,0 +1,71 @@
+################################################################################
+# Metadata for input and output.
+#
+# @pattern Abstract class
+# @see lib/meta for each meta.
+#
+# @hierachy
+#   1. Action
+#   2. Reflection
+#   3. Meta <- YOU ARE HERE
+################################################################################
+
+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
+
+end

data/lib/meta/{ArrayMeta.rb → array_meta.rb}

@@ -1,4 +1,4 @@
-require 'Meta'
+require_relative '../meta'
 
 class ArrayMeta < Meta
 
@@ -22,7 +22,7 @@ class ArrayMeta < Meta
 
   end
 
-  def result()
+  def serialize()
     {
       :type => @type,
       :max => @max,

data/lib/meta/{BooleanMeta.rb → boolean_meta.rb}

@@ -1,4 +1,4 @@
-require 'Meta'
+require_relative '../meta'
 
 class BooleanMeta < Meta
 
@@ -16,7 +16,7 @@ class BooleanMeta < Meta
     @value = value.to_s
   end
 
-  def result()
+  def serialize()
     {
       :type => @type,
       :value => @value

data/lib/meta/{FloatMeta.rb → float_meta.rb}

@@ -1,4 +1,4 @@
-require 'Meta'
+require_relative '../meta'
 
 class FloatMeta < Meta
 
@@ -16,7 +16,7 @@ class FloatMeta < Meta
     @value = value
   end
 
-  def result()
+  def serialize()
     {
       :type => @type,
       :value => @value

data/lib/meta/{IntegerMeta.rb → integer_meta.rb}

@@ -1,4 +1,4 @@
-require 'Meta'
+require_relative '../meta'
 
 class IntegerMeta < Meta
 
@@ -16,7 +16,7 @@ class IntegerMeta < Meta
     @value = value
   end
 
-  def result()
+  def serialize()
     {
       :type => @type,
       :value => @value