reflekt 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 457006f1c0a4fbe9a1ce47684aeeec980852cd966f29d07ac57751161f314d52
-  data.tar.gz: ca01fd9306ece9e1698aab0dcb4945a848a5a910625f8b9394b4f26aa7819514
+  metadata.gz: fdefbebdb9516a1fdd8b20c2a5239ae9e2dcc1cb27e5a430589a155a80ccde55
+  data.tar.gz: 1c7e77b9ab430f971d9d69332161647762f9065bd73ef4440da0c588520cdd1d
 SHA512:
-  metadata.gz: 1de336f083b2e90230453d3ce07cfb36981998587de2e126c88948da75a618ee57a68b32b9869865fb9353b45e85fadc293d98afc2c4669afe8fadc9761fda93
-  data.tar.gz: 0b00aa43ef7763bc11e93697446ca0e86114818f3e6238d28711d1038eef0c4bc58dc43b1f1f901ec58a4cdf6c9138493e63572a7d33a0363a591e908b38e751
+  metadata.gz: 854ac0d582aef56603e8edae7d11371de656cdb044cf6d94a7d6359c440bfd2430ff8eb4456dcc882bf299be681d82735000062decc1274a36e91d6c269afa4a
+  data.tar.gz: '05850d0849fbd0e74026e40497761c3355ea67fedc00cb7c2918362d2250b328dd36887a1ffbc2af83bc54787a0a482b258e6eedf66465abbdf6e2df04a604c7'

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

@@ -19,7 +19,7 @@ class Action
   attr_accessor :parent
   attr_accessor :child
   attr_accessor :control
-  attr_accessor :reflections
+  attr_accessor :experiments
   attr_accessor :is_reflecting
   attr_accessor :is_base
 
@@ -28,7 +28,7 @@ class Action
   #
   # @param object [Object] The calling object.
   # @param method [Symbol] The calling method.
-  # @param reflect_amount [Integer] The number of reflections to create per action.
+  # @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 Action
 
     # Reflections.
     @control = nil
-    @reflections = Array.new(reflect_amount)
+    @experiments = Array.new(reflect_amount)
 
     # State.
     if @stack.peek() == nil
@@ -64,8 +64,8 @@ class Action
 
   end
 
-  def has_empty_reflections?
-    @reflections.include? nil
+  def has_empty_experiments?
+    @experiments.include? nil
   end
 
   ##
@@ -79,7 +79,7 @@ class Action
     if is_reflecting?
       return false
     end
-    if has_empty_reflections?
+    if has_empty_experiments?
       return false
     end
     return true

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

@@ -18,15 +18,15 @@
 #   - :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 action.
+  # Create a shadow action.
   # @param *args [Dynamic] The method's arguments.
   ##
   def reflect(*args)

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/{ArrayMeta.rb → array_meta.rb}

@@ -1,4 +1,4 @@
-require 'Meta'
+require_relative '../meta'
 
 class ArrayMeta < Meta
 

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

@@ -1,4 +1,4 @@
-require 'Meta'
+require_relative '../meta'
 
 class BooleanMeta < Meta
 

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

@@ -1,4 +1,4 @@
-require 'Meta'
+require_relative '../meta'
 
 class FloatMeta < Meta
 

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

@@ -1,4 +1,4 @@
-require 'Meta'
+require_relative '../meta'
 
 class IntegerMeta < Meta
 

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

@@ -10,7 +10,7 @@
 #   3. Meta <- YOU ARE HERE
 ################################################################################
 
-require 'Meta'
+require_relative '../meta'
 
 class NullMeta < Meta
 

data/lib/meta/{StringMeta.rb → string_meta.rb}

@@ -1,4 +1,4 @@
-require 'Meta'
+require_relative '../meta'
 
 class StringMeta < Meta
 

data/lib/{MetaBuilder.rb → meta_builder.rb}

@@ -5,9 +5,9 @@
 # @see lib/meta for each meta.
 ################################################################################
 
-require 'Meta'
+require_relative 'meta'
 # Require all meta.
-Dir[File.join(__dir__, 'meta', '*.rb')].each { |file| require file }
+Dir[File.join(__dir__, 'meta', '*.rb')].each { |file| require_relative file }
 
 class MetaBuilder
 

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

@@ -1,9 +1,7 @@
 ################################################################################
-# A snapshot of random data.
+# A snapshot of real or 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.
+# @pattern Abstract class
 #
 # @nomenclature
 #   args, inputs/output and meta represent different stages of a value.
@@ -19,19 +17,19 @@
 #   - :error [Symbol] The control reflection produces a system error.
 ################################################################################
 
-require 'Clone'
-require 'MetaBuilder'
+require_relative 'clone'
+require_relative 'meta_builder'
 
 class Reflection
 
   attr_reader :status
 
   ##
-  # Create a Reflection.
+  # Create a reflection.
   #
   # @param action [Action] The Action that created this Reflection.
   # @param number [Integer] Multiple Reflections can be created per Action.
-  # @param aggregator [Aggregator] The aggregated RuleSet for this class/method.
+  # @param aggregator [RuleSetAggregator] The aggregated RuleSet for this class/method.
   ##
   def initialize(action, number, aggregator)
 
@@ -64,56 +62,11 @@ class Reflection
   ##
   # Reflect on a method.
   #
-  # Creates a shadow action.
+  # 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
-
+    # Implemented by Control and Experiment.
   end
 
   ##

data/lib/{Reflekt.rb → reflekt.rb}

@@ -19,16 +19,16 @@
 require 'set'
 require 'erb'
 require 'rowdb'
-require 'Accessor'
-require 'Action'
-require 'ActionStack'
-require 'Aggregator'
-require 'Config'
-require 'Control'
-require 'Reflection'
-require 'Renderer'
+require_relative 'accessor'
+require_relative 'action'
+require_relative 'action_stack'
+require_relative 'config'
+require_relative 'control'
+require_relative 'experiment'
+require_relative 'renderer'
+require_relative 'rule_set_aggregator'
 # Require all rules.
-Dir[File.join(__dir__, 'rules', '*.rb')].each { |file| require file }
+Dir[File.join(__dir__, 'rules', '*.rb')].each { |file| require_relative file }
 
 module Reflekt
 
@@ -75,7 +75,7 @@ module Reflekt
             # The first method call in the action creates a reflection.
             # Then method calls are shadow actions which return to the reflection.
             ##
-            if action.has_empty_reflections? && !action.is_reflecting?
+            if action.has_empty_experiments? && !action.is_reflecting?
               action.is_reflecting = true
 
               # Create control.
@@ -94,19 +94,19 @@ module Reflekt
                 # Save control as a reflection.
                 @@reflekt.db.get("reflections").push(control.serialize())
 
-                # Multiple reflections per action.
-                action.reflections.each_with_index do |value, index|
+                # Multiple experiments per action.
+                action.experiments.each_with_index do |value, index|
 
-                  # Create reflection.
-                  reflection = Reflection.new(action, index + 1, @@reflekt.aggregator)
-                  action.reflections[index] = reflection
+                  # Create experiment.
+                  experiment = Experiment.new(action, index + 1, @@reflekt.aggregator)
+                  action.experiments[index] = experiment
 
-                  # Execute reflection.
-                  reflection.reflect(*args)
+                  # Execute experiment.
+                  experiment.reflect(*args)
                   @reflekt_counts[method] = @reflekt_counts[method] + 1
 
-                  # Save reflection.
-                  @@reflekt.db.get("reflections").push(reflection.serialize())
+                  # Save experiment.
+                  @@reflekt.db.get("reflections").push(experiment.serialize())
 
                 end
 
@@ -202,7 +202,7 @@ module Reflekt
     @@reflekt.stack = ActionStack.new()
 
     # Create aggregated rule sets.
-    @@reflekt.aggregator = Aggregator.new(@@reflekt.config.meta_map)
+    @@reflekt.aggregator = RuleSetAggregator.new(@@reflekt.config.meta_map)
     @@reflekt.aggregator.train(db[:controls])
 
     # Create renderer.

data/lib/{Rule.rb → rule.rb}

@@ -4,7 +4,7 @@
 # @pattern Abstract class
 #
 # @hierachy
-#   1. Aggregator
+#   1. RuleSetAggregator
 #   2. RuleSet
 #   3. Rule <- YOU ARE HERE
 #

data/lib/{RuleSet.rb → rule_set.rb}

@@ -6,14 +6,14 @@
 #   - Builder
 #
 # @hierachy
-#   1. Aggregator
+#   1. RuleSetAggregator
 #   2. RuleSet <- YOU ARE HERE
 #   3. Rule
 ################################################################################
 
 require 'set'
-require 'MetaBuilder'
-require_relative './meta/NullMeta.rb'
+require_relative 'meta_builder'
+require_relative 'meta/null_meta.rb'
 
 class RuleSet
 

data/lib/{Aggregator.rb → rule_set_aggregator.rb}

@@ -5,14 +5,14 @@
 # @pattern Singleton
 #
 # @hierachy
-#   1. Aggregator <- YOU ARE HERE
+#   1. RuleSetAggregator <- YOU ARE HERE
 #   2. RuleSet
 #   3. Rule
 ################################################################################
 
-require 'RuleSet'
+require_relative 'rule_set'
 
-class Aggregator
+class RuleSetAggregator
 
   ##
   # @param meta_map [Hash] The rules that apply to each meta type.

data/lib/rules/{ArrayRule.rb → array_rule.rb}

@@ -1,4 +1,4 @@
-require 'Rule'
+require_relative '../rule'
 
 class ArrayRule < Rule
 

data/lib/rules/{BooleanRule.rb → boolean_rule.rb}

@@ -1,5 +1,5 @@
 require 'set'
-require 'Rule'
+require_relative '../rule'
 
 class BooleanRule < Rule
 

data/lib/rules/{FloatRule.rb → float_rule.rb}

@@ -1,4 +1,4 @@
-require 'Rule'
+require_relative '../rule'
 
 class FloatRule < Rule
 

data/lib/rules/{IntegerRule.rb → integer_rule.rb}

@@ -1,4 +1,4 @@
-require 'Rule'
+require_relative '../rule'
 
 class IntegerRule < Rule
 

data/lib/rules/{NullRule.rb → null_rule.rb}

@@ -1,4 +1,4 @@
-require 'Rule'
+require_relative '../rule'
 
 class NullRule < Rule
 

data/lib/rules/{StringRule.rb → string_rule.rb}

@@ -1,4 +1,4 @@
-require 'Rule'
+require_relative '../rule'
 
 class StringRule < Rule
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reflekt
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Maedi Prichard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rowdb
@@ -30,32 +30,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/Accessor.rb
-- lib/Action.rb
-- lib/ActionStack.rb
-- lib/Aggregator.rb
-- lib/Clone.rb
-- lib/Config.rb
-- lib/Control.rb
-- lib/Meta.rb
-- lib/MetaBuilder.rb
-- lib/Reflection.rb
-- lib/Reflekt.rb
-- lib/Renderer.rb
-- lib/Rule.rb
-- lib/RuleSet.rb
-- lib/meta/ArrayMeta.rb
-- lib/meta/BooleanMeta.rb
-- lib/meta/FloatMeta.rb
-- lib/meta/IntegerMeta.rb
-- lib/meta/NullMeta.rb
-- lib/meta/StringMeta.rb
-- lib/rules/ArrayRule.rb
-- lib/rules/BooleanRule.rb
-- lib/rules/FloatRule.rb
-- lib/rules/IntegerRule.rb
-- lib/rules/NullRule.rb
-- lib/rules/StringRule.rb
+- lib/accessor.rb
+- lib/action.rb
+- lib/action_stack.rb
+- lib/clone.rb
+- lib/config.rb
+- lib/control.rb
+- lib/experiment.rb
+- lib/meta.rb
+- lib/meta/array_meta.rb
+- lib/meta/boolean_meta.rb
+- lib/meta/float_meta.rb
+- lib/meta/integer_meta.rb
+- lib/meta/null_meta.rb
+- lib/meta/string_meta.rb
+- lib/meta_builder.rb
+- lib/reflection.rb
+- lib/reflekt.rb
+- lib/renderer.rb
+- lib/rule.rb
+- lib/rule_set.rb
+- lib/rule_set_aggregator.rb
+- lib/rules/array_rule.rb
+- lib/rules/boolean_rule.rb
+- lib/rules/float_rule.rb
+- lib/rules/integer_rule.rb
+- lib/rules/null_rule.rb
+- lib/rules/string_rule.rb
 - lib/web/README.md
 - lib/web/bundle.js
 - lib/web/gitignore.txt