reflekt 1.0.4 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 862841ab79ef50d5b096398525e0f75014b0204184329f8a6b5e010a70927f4f
-  data.tar.gz: 37797b16ae059518507a1e0ec7a0f1e0678cf78da58f3cbd8fafd27bb349d78b
+  metadata.gz: 8ed0b66e3e9110822e6d14ba1a77fc5627b40edea4223d4252fd30ea4853047c
+  data.tar.gz: 39990e22a2f9ddac9382a8b960b10ead0b81598db3bf86eac4a1c499182e065b
 SHA512:
-  metadata.gz: ae2247c88853aaba496bba94ab7edfa91dfce613ab42f5e33abe4ab43409c2fddb9eb0888ed71668cc49b860dc323e2a4875ee01b82119ba2576aeb925342b09
-  data.tar.gz: 5f30074666b11dbfc6af40a466e15142c4fd2489d3aa445c6d534c78cf620889768d7934be2077ccdb2690a1ebc860c5770ad9c28a6f31c583b815b9f5a4e8f7
+  metadata.gz: 48497c5c451bde6860039fb9570f77a4bd0a9fd4b889d497d9c06079a9e852f3f426e42f01c5480c6bf621f4ba90179e9f95022fcd5e223f3b1da6718936e871
+  data.tar.gz: 4e1f58483092d4f7f626878303060c0527ff0838ab244f4abc9e3f5b5772af19c95a5a5e86e1a2d6361027efa80882ead7dafee544698bf895555a7086a63d97

data/lib/{Accessor.rb → accessor.rb}

@@ -8,6 +8,7 @@
 #   - @@reflekt_skipped_methods on the instance's singleton class
 ################################################################################
 
+module Reflekt
 class Accessor
 
   attr_accessor :config
@@ -35,3 +36,4 @@ class Accessor
   end
 
 end
+end

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

@@ -1,13 +1,14 @@
 ################################################################################
-# A shadow execution.
+# A shadow action.
 #
 # @hierachy
-#   1. Execution <- YOU ARE HERE
+#   1. Action <- YOU ARE HERE
 #   2. Reflection
 #   3. Meta
 ################################################################################
 
-class Execution
+module Reflekt
+class Action
 
   attr_accessor :unique_id
   attr_accessor :caller_object
@@ -19,17 +20,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 +52,7 @@ class Execution
 
     # Reflections.
     @control = nil
-    @reflections = Array.new(reflect_amount)
+    @experiments = Array.new(reflect_amount)
 
     # State.
     if @stack.peek() == nil
@@ -64,12 +65,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,10 +80,11 @@ class Execution
     if is_reflecting?
       return false
     end
-    if has_empty_reflections?
+    if has_empty_experiments?
       return false
     end
     return true
   end
 
 end
+end

data/lib/action_stack.rb

@@ -0,0 +1,46 @@
+################################################################################
+# Track the actions in a shadow call stack.
+#
+# @pattern Stack
+################################################################################
+
+module Reflekt
+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
+end

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

@@ -7,17 +7,18 @@
 #   on object, not indirectly through clone which results in "undefined method".
 #
 # @hierachy
-#   1. Execution
+#   1. Action
 #   2. Reflection
 #   3. Clone <- YOU ARE HERE
 ################################################################################
 
+module Reflekt
 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.
@@ -29,3 +30,4 @@ class Clone
   end
 
 end
+end

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

@@ -1,3 +1,4 @@
+module Reflekt
 class Config
 
   attr_accessor :enabled
@@ -27,6 +28,7 @@ class Config
       :int    => [IntegerRule],
       :float  => [FloatRule],
       :null   => [NullRule],
+      :object => [ObjectRule],
       :string => [StringRule]
     }
 
@@ -40,3 +42,4 @@ class Config
   end
 
 end
+end

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

@@ -2,13 +2,13 @@
 # A shapshot of real data.
 #
 # @note
-#   A control's @number property will always be zero.
+#   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
 #
@@ -18,43 +18,46 @@
 #   - :error [Symbol] The control reflection produces a system error.
 ################################################################################
 
-require 'Reflection'
-require 'MetaBuilder'
+require_relative 'reflection'
+require_relative 'meta_builder'
 
+module Reflekt
 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.
@@ -79,3 +82,4 @@ class Control < Reflection
   end
 
 end
+end

data/lib/{Reflection.rb → experiment.rb}

@@ -2,15 +2,14 @@
 # A snapshot of random data.
 #
 # @note
-#   A reflection's random value is within the bounds of aggregated control rule sets
-#   as well as as the arg type being inputted into the current control reflection.
+#   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. Execution
-#   2. Reflection <- YOU ARE HERE
+#   1. Action
+#   2. Experiment <- YOU ARE HERE
 #   3. Meta
 #
 # @status
@@ -19,52 +18,16 @@
 #   - :error [Symbol] The control reflection produces a system error.
 ################################################################################
 
-require 'Clone'
-require 'MetaBuilder'
+require_relative 'reflection'
+require_relative 'meta_builder'
 
-class Reflection
-
-  attr_reader :status
-
-  ##
-  # Create a Reflection.
-  #
-  # @param execution [Execution] The Execution that created this Reflection.
-  # @param number [Integer] Multiple Reflections can be created per Execution.
-  # @param aggregator [Aggregator] The aggregated RuleSet for this class/method.
-  ##
-  def initialize(execution, number, aggregator)
-
-    @execution = execution
-    @unique_id = execution.unique_id + number
-    @number = number
-
-    # Dependency.
-    @aggregator = aggregator
-
-    # Caller.
-    @klass = execution.klass
-    @method = execution.method
-
-    # Metadata.
-    @inputs = nil
-    @output = nil
-
-    # Clone the execution's calling object.
-    # TODO: Abstract away into Clone class.
-    @clone = execution.caller_object.clone
-
-    # Result.
-    @status = :pass
-    @time = Time.now.to_i
-    @message = nil
-
-  end
+module Reflekt
+class Experiment < Reflection
 
   ##
   # Reflect on a method.
   #
-  # Creates a shadow execution.
+  # Create a shadow action.
   # @param *args [Dynamic] The method's arguments.
   ##
   def reflect(*args)
@@ -73,6 +36,11 @@ class Reflection
     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
 
@@ -82,12 +50,12 @@ class Reflection
       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 random arguments.
     begin
 
       # Run reflection.
@@ -138,47 +106,5 @@ class Reflection
 
   end
 
-  ##
-  # Get the results of the reflection.
-  #
-  # @return [Hash] Reflection metadata.
-  ##
-  def serialize()
-
-    # The ID of the first execution in the ShadowStack.
-    base_id = nil
-    unless @execution.base == nil
-      base_id = @execution.base.unique_id
-    end
-
-    # Build reflection.
-    reflection = {
-      :base_id => base_id,
-      :exe_id => @execution.unique_id,
-      :ref_id => @unique_id,
-      :ref_num => @number,
-      :time => @time,
-      :class => @klass,
-      :method => @method,
-      :status => @status,
-      :message => @message,
-      :inputs => nil,
-      :output => nil,
-    }
-
-    unless @inputs.nil?
-      reflection[:inputs] = []
-      @inputs.each do |meta|
-        reflection[:inputs] << meta.serialize()
-      end
-    end
-
-    unless @output.nil?
-      reflection[:output] = @output.serialize()
-    end
-
-    return reflection
-
-  end
-
+end
 end

data/lib/{Meta.rb → meta.rb}

@@ -5,18 +5,19 @@
 # @see lib/meta for each meta.
 #
 # @hierachy
-#   1. Execution
+#   1. Action
 #   2. Reflection
 #   3. Meta <- YOU ARE HERE
 ################################################################################
 
+module Reflekt
 class Meta
 
   ##
   # Each meta defines its type.
   ##
   def initialize()
-    @type = nil
+    @type = :null
   end
 
   ##
@@ -28,12 +29,12 @@ class Meta
   end
 
   ##
-  # Each meta serializes metadata.
-  #
   # @return [Hash]
   ##
   def serialize()
-    {}
+    {
+      :type => @type
+    }
   end
 
   ##############################################################################
@@ -69,3 +70,4 @@ class Meta
   end
 
 end
+end