reflekt 0.9.8 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5b9e88d60fea03ebe06c430b489cb1295b8d56ec76f30982721a709a406f0af
-  data.tar.gz: 948f53a8b72f5befda3e175029edfdb017d98b3b8fd41998ab95b5f6b0a6b95e
+  metadata.gz: d09b97f103669d2806a5c6e32da41e978fecff763c558d5aa8fb0739bf8e984a
+  data.tar.gz: 5f40bbfaa6444d452a0f91c1371d0d9aa75a5cd7edd5da8e36ac81d7f0c7532d
 SHA512:
-  metadata.gz: e70f287d10e70e3ac8ab3e01881ed6d8bb79f881c9af5530f39c7dd29997021ddf246d1129467503cfb3c6efb0589604648876c64bda917e8b970cb278a79fb3
-  data.tar.gz: ef005f855d7c3d1002eb059a73ecf742645841d4d3d0bd416a84b549e2e7d5b63a8bc216e8fe1404bf20c383a8e0a10c54740458e40382fa9591f9c67f3a075c
+  metadata.gz: c7198d5f60ee546e1becc9e7e75141705b0f4a01214e70bba2ba597872b2ff7dbd0cd60deb877a18fde3b4c25ba48ce94bede291bd9ddc089c3d195710dd5728
+  data.tar.gz: 23b79441dfa54881f1a537d259f686b8528f950aa1caac960c43403d7f5f24301a903ba99cc84d7bf1e743f6f6e16001141cff40a8c70139bf55032f38193131

data/lib/Accessor.rb

@@ -2,14 +2,15 @@
 # Access variables via one object to avoid polluting the caller class scope.
 #
 # @pattern Singleton
+#
 # @note Some variables are not accessed via Accessor:
 #   - @reflekt_counts on the instance
-#   - @reflekt_enabled on the instance
 #   - @@reflekt_skipped_methods on the instance's singleton class
 ################################################################################
 
 class Accessor
 
+  attr_accessor :config
   attr_accessor :setup
   attr_accessor :db
   attr_accessor :stack
@@ -17,11 +18,11 @@ class Accessor
   attr_accessor :renderer
   attr_accessor :path
   attr_accessor :output_path
-  attr_accessor :reflect_amount
-  attr_accessor :reflect_limit
+  attr_accessor :error
 
   def initialize()
 
+    @config = nil
     @setup = nil
     @db = nil
     @stack = nil
@@ -29,8 +30,7 @@ class Accessor
     @renderer = nil
     @path = nil
     @output_path = nil
-    @reflect_amount = nil
-    @reflect_limit = nil
+    @error = false
 
   end
 

data/lib/Aggregator.rb

@@ -1,11 +1,11 @@
 ################################################################################
-# Aggregate reflection metadata into rule sets.
-# Validate reflection arguments against aggregates.
+# Aggregate control metadata into rule sets.
+# Validate reflections against aggregated controls.
 #
 # @pattern Singleton
 #
 # @hierachy
-#   1. Aggregator
+#   1. Aggregator <- YOU ARE HERE
 #   2. RuleSet
 #   3. Rule
 ################################################################################
@@ -14,102 +14,47 @@ require 'RuleSet'
 
 class Aggregator
 
-  def initialize()
-
-    # Key rule sets by class and method.
-    @rule_sets = {}
-
-  end
-
-  ##
-  # Get aggregated RuleSets for all inputs.
-  #
-  # @param klass [Symbol]
-  # @param method [Symbol]
-  # @return [Array]
-  ##
-  def get_input_rule_sets(klass, method)
-    return @rule_sets.dig(klass, method, :inputs)
-  end
-
-  ##
-  # Get an aggregated RuleSet for an input.
-  #
-  # @param klass [Symbol]
-  # @param method [Symbol]
-  # @return [RuleSet]
   ##
-  def get_input_rule_set(klass, method, arg_num)
-    @rule_sets.dig(klass, method, :inputs, arg_num)
-  end
-
+  # @param meta_map [Hash] The rules that apply to each meta type.
   ##
-  # Get an aggregated RuleSet for an output.
-  #
-  # @param klass [Symbol]
-  # @param method [Symbol]
-  # @return [RuleSet]
-  ##
-  def get_output_rule_set(klass, method)
-    @rule_sets.dig(klass, method, :output)
-  end
+  def initialize(meta_map)
 
-  ##
-  # Set an aggregated RuleSet for an input.
-  #
-  # @param klass [Symbol]
-  # @param method [Symbol]
-  ##
-  def set_input_rule_set(klass, method, arg_num, rule_set)
-    # Set defaults.
-    @rule_sets[klass] = {} unless @rule_sets.key? klass
-    @rule_sets[klass][method] = {} unless @rule_sets[klass].key? method
-    @rule_sets[klass][method][:inputs] = [] unless @rule_sets[klass][method].key? :inputs
-    # Set value.
-    @rule_sets[klass][method][:inputs][arg_num] = rule_set
-  end
+    @meta_map = meta_map
+    # Key rule sets by class and method.
+    @rule_sets = {}
 
-  ##
-  # Set an aggregated RuleSet for an output.
-  #
-  # @param klass [Symbol]
-  # @param method [Symbol]
-  # @param rule_set [RuleSet]
-  ##
-  def set_output_rule_set(klass, method, rule_set)
-    # Set defaults.
-    @rule_sets[klass] = {} unless @rule_sets.key? klass
-    @rule_sets[klass][method] = {} unless @rule_sets[klass].key? method
-    # Set value.
-    @rule_sets[klass][method][:output] = rule_set
   end
 
   ##
-  # Create aggregated rule sets from reflection metadata.
+  # Create aggregated rule sets from control metadata.
   #
-  # @param reflections [Array] Controls with metadata.
+  # @stage Called on setup.
+  # @param controls [Array] Controls with metadata.
+  # @TODO Revert string keys to symbols once "Fix Rowdb.get(path)" bug fixed.
   ##
-  def train(reflections)
+  def train(controls)
 
-    # On first use there are no previous reflections.
-    return if reflections.nil?
+    # On first use there are no previous controls.
+    return if controls.nil?
 
-    reflections.each do |reflection|
+    controls.each do |control|
 
-      klass = reflection[:class]
-      method = reflection[:method]
+      klass = control["class"].to_sym
+      method = control["method"].to_sym
 
       ##
       # INPUT
       ##
 
-      unless reflection[:inputs].nil?
-        reflection[:inputs].each_with_index do |meta, arg_num|
+      unless control["inputs"].nil?
+        control["inputs"].each_with_index do |meta, arg_num|
+
+          meta = Meta.deserialize(meta)
 
           # Get rule set.
           rule_set = get_input_rule_set(klass, method, arg_num)
           if rule_set.nil?
-            rule_set = RuleSet.new()
+            rule_set = RuleSet.new(@meta_map)
             set_input_rule_set(klass, method, arg_num, rule_set)
           end
 
@@ -126,12 +71,12 @@ class Aggregator
       # Get rule set.
       output_rule_set = get_output_rule_set(klass, method)
       if output_rule_set.nil?
-        output_rule_set = RuleSet.new()
+        output_rule_set = RuleSet.new(@meta_map)
         set_output_rule_set(klass, method, output_rule_set)
       end
 
       # Train on metadata.
-      output_rule_set.train(reflection[:output])
+      output_rule_set.train(Meta.deserialize(control["output"]))
 
     end
 
@@ -140,22 +85,23 @@ class Aggregator
   ##
   # Validate inputs.
   #
+  # @stage Called when validating a reflection.
   # @param inputs [Array] The method's arguments.
   # @param input_rule_sets [Array] The RuleSets to validate each input with.
   ##
-  def validate_inputs(inputs, input_rule_sets)
+  def test_inputs(inputs, input_rule_sets)
 
-    # Default to a PASS result.
+    # Default result to PASS.
     result = true
 
-    # Validate each argument against each RuleSet for that argument.
+    # Validate each argument against each rule set for that argument.
     inputs.each_with_index do |input, arg_num|
 
       unless input_rule_sets[arg_num].nil?
 
         rule_set = input_rule_sets[arg_num]
 
-        unless rule_set.validate_rule(input)
+        unless rule_set.test(input)
           result = false
         end
 
@@ -169,10 +115,11 @@ class Aggregator
   ##
   # Validate output.
   #
+  # @stage Called when validating a reflection.
   # @param output [Dynamic] The method's return value.
   # @param output_rule_set [RuleSet] The RuleSet to validate the output with.
   ##
-  def validate_output(output, output_rule_set)
+  def test_output(output, output_rule_set)
 
     # Default to a PASS result.
     result = true
@@ -180,7 +127,7 @@ class Aggregator
     unless output_rule_set.nil?
 
       # Validate output RuleSet for that argument.
-      unless output_rule_set.validate_rule(output)
+      unless output_rule_set.test(output)
         result = false
       end
 
@@ -190,4 +137,115 @@ class Aggregator
 
   end
 
+  ##
+  # Get aggregated RuleSets for all inputs.
+  #
+  # @stage Called when building a reflection.
+  # @param klass [Symbol]
+  # @param method [Symbol]
+  # @return [Array]
+  ##
+  def get_input_rule_sets(klass, method)
+    @rule_sets.dig(klass, method, :inputs)
+  end
+
+  ##
+  # Get an aggregated RuleSet for an output.
+  #
+  # @stage Called when building a reflection.
+  # @param klass [Symbol]
+  # @param method [Symbol]
+  # @return [RuleSet]
+  ##
+  def get_output_rule_set(klass, method)
+    @rule_sets.dig(klass, method, :output)
+  end
+
+  ##
+  # Get the base rule type for a data type.
+  ##
+  def self.value_to_rule_type(value)
+
+    data_type = value.class
+
+    rule_types = {
+      Array      => ArrayRule,
+      TrueClass  => BooleanRule,
+      FalseClass => BooleanRule,
+      Float      => FloatRule,
+      Integer    => IntegerRule,
+      NilClass   => NullRule,
+      String     => StringRule
+    }
+
+    return rule_types[data_type]
+
+  end
+
+  def self.testable?(args, input_rule_sets)
+
+    args.each_with_index do |arg, arg_num|
+
+      rule_type = value_to_rule_type(arg)
+      if input_rule_sets[arg_num].rules[rule_type].nil?
+        return false
+      end
+
+    end
+
+    return true
+
+  end
+
+  ##############################################################################
+  # HELPERS
+  ##############################################################################
+
+  private
+
+  ##
+  # Get an aggregated RuleSet for an input.
+  #
+  # @param klass [Symbol]
+  # @param method [Symbol]
+  # @return [RuleSet]
+  ##
+  def get_input_rule_set(klass, method, arg_num)
+    @rule_sets.dig(klass, method, :inputs, arg_num)
+  end
+
+  ##
+  # Set an aggregated RuleSet for an input.
+  #
+  # @param klass [Symbol]
+  # @param method [Symbol]
+  ##
+  def set_input_rule_set(klass, method, arg_num, rule_set)
+
+    # Set defaults.
+    @rule_sets[klass] = {} unless @rule_sets.key? klass
+    @rule_sets[klass][method] = {} unless @rule_sets[klass].key? method
+    @rule_sets[klass][method][:inputs] = [] unless @rule_sets[klass][method].key? :inputs
+    # Set value.
+    @rule_sets[klass][method][:inputs][arg_num] = rule_set
+
+  end
+
+  ##
+  # Set an aggregated RuleSet for an output.
+  #
+  # @param klass [Symbol]
+  # @param method [Symbol]
+  # @param rule_set [RuleSet]
+  ##
+  def set_output_rule_set(klass, method, rule_set)
+
+    # Set defaults.
+    @rule_sets[klass] = {} unless @rule_sets.key? klass
+    @rule_sets[klass][method] = {} unless @rule_sets[klass].key? method
+    # Set value.
+    @rule_sets[klass][method][:output] = rule_set
+
+  end
+
 end

data/lib/Clone.rb

@@ -0,0 +1,31 @@
+################################################################################
+# A clone of the instance that a reflection calls methods on,
+# as well as any other instances that those methods may lead to.
+#
+# @note
+#   Not currently in use due to bug where "send" needs to be called directly
+#   on object, not indirectly through clone which results in "undefined method".
+#
+# @hierachy
+#   1. Execution
+#   2. Reflection
+#   3. Clone <- YOU ARE HERE
+################################################################################
+
+class Clone
+
+  def initialize(execution)
+
+    # Clone the execution's calling object.
+    @caller_object_clone = execution.caller_object.clone
+
+    # TODO: Clone any other instances that this clone references.
+    # TODO: Replace clone's references to these new instances.
+
+  end
+
+  def action(method, *new_args)
+    @caller_object_clone.send(method, *new_args)
+  end
+
+end

data/lib/Config.rb

@@ -0,0 +1,42 @@
+class Config
+
+  attr_accessor :enabled
+  attr_accessor :reflect_amount
+  attr_accessor :reflect_limit
+  attr_accessor :meta_map
+  attr_accessor :output_path
+  attr_accessor :output_directory
+
+  def initialize()
+
+    # Reflekt is enabled by default and should be disabled on production.
+    @enabled = true
+
+    # The amount of reflections to create per method call.
+    # A control reflection is created in addition to this.
+    @reflect_amount = 5
+
+    # The maximum amount of reflections that can be created per instance/method.
+    # A method called thousands of times doesn't need that many reflections.
+    @reflect_limit = 10
+
+    # The rules that apply to meta types.
+    @meta_map = {
+      :array  => [ArrayRule],
+      :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.
+    @output_path = nil
+
+    # Name of output directory.
+    @output_directory = "reflections"
+
+  end
+
+end

data/lib/Control.rb

@@ -1,10 +1,21 @@
 ################################################################################
 # A shapshot of real data.
 #
+# @note
+#   A control's @number property will always be zero.
+#
+# @nomenclature
+#   args, inputs/output and meta represent different stages of a value.
+#
 # @hierachy
 #   1. Execution
-#   2. Control
-#   3. RuleSet
+#   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'
@@ -15,27 +26,54 @@ class Control < Reflection
   ##
   # Reflect on a method.
   #
-  # Creates a shadow execution stack.
-  #
-  # @param method [Symbol] The name of the method.
-  # @param *args [Args] The method arguments.
-  # @return [Hash] A reflection hash.
+  # Creates a shadow execution.
+  # @param *args [Dynamic] The method's arguments.
   ##
   def reflect(*args)
 
-    # Create metadata for each argument.
-    @inputs = MetaBuilder.create_many(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)
+
+    # When arguments exist.
+    unless args.size == 0
+
+      # When aggregated rule sets exist.
+      unless input_rule_sets.nil?
+
+        # Validate arguments against aggregated rule sets.
+        unless @aggregator.test_inputs(args, input_rule_sets)
+          @status = :fail
+        end
+
+      end
 
-    # Action method with new arguments.
+      # Create metadata for each argument.
+      # TODO: Create metadata for other inputs such as properties on the instance.
+      @inputs = MetaBuilder.create_many(args)
+
+    end
+
+    # Action method with new/old arguments.
     begin
+
+      # Run reflection.
       output = @clone.send(@method, *args)
-    # When fail.
+      @output = MetaBuilder.create(output)
+
+      # Validate output with 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
+
+      @status = :error
       @message = message
-    # When pass.
-    else
-      @status = :pass
+
     end
 
   end