smart_types 0.1.0.alpha5 → 0.4.0

data/lib/smart_core/types/primitive/invariant_control/factory/chain_definition_context.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::InvariantControl::Factory::ChainDefinitionContext
+  # @return [SmartCore::Types::Primitive::InvariantControl::Chain]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :___chain___
+
+  # @param chain_name [String]
+  # @return [void]
+  #
+  # @api privae
+  # @since 0.2.0
+  def initialize(chain_name)
+    @___chain___ = SmartCore::Types::Primitive::InvariantControl::Chain.new(chain_name)
+  end
+
+  # @param invariant_name [String, Symbol]
+  # @param invariant_definition [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def invariant(invariant_name, &invariant_definition)
+    SmartCore::Types::Primitive::Factory::DefinitionContext.vaildate_invariant_attributes!(
+      invariant_name,
+      &invariant_definition
+    )
+
+    ___chain___.add_invariant(
+      SmartCore::Types::Primitive::InvariantControl::Single.create(
+        invariant_name, invariant_definition
+      )
+    )
+  end
+end

data/lib/smart_core/types/primitive/invariant_control/result.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::InvariantControl::Result
+  # @return [Array<SmartCore::Types::Primitive::InvariantControl::Chain::Result>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :chain_results
+
+  # @return [Array<SmartCore::Types::Primitive::InvariantControl::Single::Result>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :single_results
+
+  # @param invariant_control [SmartCore::Types::Primitive::InvariantControl]
+  # @param checked_value [Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(invariant_control, checked_value)
+    @invariant_control = invariant_control
+    @checked_value = checked_value
+    @chain_results = []
+    @single_results = []
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.2.0
+  def invariant_errors
+    collect_invariant_errors
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def success?
+    chain_results.all(&:success?) && single_results.all?(&:success?)
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def failure?
+    !success?
+  end
+
+  # @param result [SmartCore::Types::Primitive::InvariantControl::Chain::Result]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def add_chain_result(result)
+    chain_results << result
+  end
+
+  # @param result [SmartCore::Types::Primitive::InvariantControl::Single::Result]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def add_single_result(result)
+    single_results << result
+  end
+
+  private
+
+  # @return [SmartCore::Types::Primitive::InvariantControl]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant_control
+
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :checked_value
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.2.0
+  def collect_invariant_errors
+    [].tap do |invariant_errors|
+      # collect invariant errors from invariant chains
+      chain_results.select(&:failure?).each do |chain_result|
+        invariant_errors.concat(chain_result.error_codes)
+      end
+
+      # collect invariant errors from single invariants
+      single_results.select(&:failure?).each do |single_result|
+        invariant_errors.concat(single_result.error_codes)
+      end
+    end.tap(&:freeze)
+  end
+end

data/lib/smart_core/types/primitive/invariant_control/single.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+# @version 0.3.0
+class SmartCore::Types::Primitive::InvariantControl::Single
+  require_relative 'single/result'
+
+  class << self
+    # @param name [String, Symbol]
+    # @param invariant_checker [Proc]
+    # @return [SmartCore::Types::Primitive::InvariantControl::Single]
+    #
+    # @api private
+    # @since 0.2.0
+    def create(name, invariant_checker)
+      new(name.to_s, invariant_checker)
+    end
+  end
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :name
+
+  # @param name [String]
+  # @param invariant_checker [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(name, invariant_checker)
+    @name = name.dup.tap(&:freeze)
+    @invariant_checker = invariant_checker
+  end
+
+  # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
+  # @return [SmartCore::Types::Primitive::InvariantControl::Single::Result]
+  #
+  # @api private
+  # @since 0.2.0
+  # @version 0.3.0
+  def check(value, runtime_attributes)
+    validation_result = !!invariant_checker.call(value, runtime_attributes)
+    Result.new(self, value, validation_result)
+  end
+
+  private
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant_checker
+end

data/lib/smart_core/types/primitive/invariant_control/single/result.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::InvariantControl::Single::Result
+  # @return [SmartCore::Types::Primitive::InvariantControl::Single]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant
+
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :checked_value
+
+  # @param invariant [SmartCore::Types::Primitive::InvariantControl::Single]
+  # @param checked_value [Any]
+  # @param is_valid_check [Boolean]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(invariant, checked_value, is_valid_check)
+    @invariant = invariant
+    @checked_value = checked_value
+    @is_valid_check = is_valid_check
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def success?
+    is_valid_check
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def failure?
+    !success?
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.2.0
+  def error_codes
+    success? ? [] : [invariant.name]
+  end
+
+  private
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :is_valid_check
+  alias_method :valid_check?, :is_valid_check
+end

data/lib/smart_core/types/primitive/mult_factory.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 module SmartCore::Types::Primitive::MultFactory
   require_relative 'mult_factory/definition_context'
 
@@ -12,11 +13,20 @@ module SmartCore::Types::Primitive::MultFactory
     #
     # @api private
     # @since 0.1.0
+    # @version 0.3.0
     def create_type(types, type_definition)
       type_definitions = build_type_definitions(type_definition)
-      type_checker = build_type_checker(types, type_definitions)
+      type_runtime_attributes_checker = build_type_runtime_attributes_checker(type_definitions)
+      type_validator = build_type_validator(types, type_definitions)
       type_caster = build_type_caster(types, type_definitions)
-      build_type(type_checker, type_caster)
+      build_type(
+        type_validator,
+        type_caster,
+        type_runtime_attributes_checker
+      ).tap do |type|
+        assign_type_validator(type, type_validator)
+        assign_type_runtime_attributes_checker(type, type_runtime_attributes_checker)
+      end
     end
 
     private
@@ -32,14 +42,25 @@ module SmartCore::Types::Primitive::MultFactory
       end
     end
 
+    # @param type_definitions [SmartCore::Types::Primitive::MultFactory::DefinitionContext]
+    # @return [SmartCore::Types::Primitive::RuntimeAttributesChecker]
+    #
+    # @api private
+    # @since 0.3.0
+    def build_type_runtime_attributes_checker(type_definitions)
+      SmartCore::Types::Primitive::RuntimeAttributesChecker.new(
+        type_definitions.type_runtime_attributes_checker
+      )
+    end
+
     # @param types [Array<SmartCore::Types::Primtive>]
     # @param type_definitions [SmartCore::Types::Primitive::MultFactory::DefinitionContext]
-    # @return [SmartCore::Types::Primitive::MultChecker]
+    # @return [SmartCore::Types::Primitive::MultValidator]
     #
     # @api private
-    # @since 0.1.0
-    def build_type_checker(types, type_definitions)
-      SmartCore::Types::Primitive::MultChecker.new(*types.map(&:checker))
+    # @since 0.2.0
+    def build_type_validator(types, type_definitions)
+      SmartCore::Types::Primitive::MultValidator.new(*types.map(&:validator))
     end
 
     # @param types [Array<SmartCore::Types::Primtive>]
@@ -49,21 +70,49 @@ module SmartCore::Types::Primitive::MultFactory
     # @api private
     # @since 0.1.0
     def build_type_caster(types, type_definitions)
-      if type_definitions.type_caster.nil?
+      if type_definitions.type_caster == nil
         SmartCore::Types::Primitive::UndefinedCaster.new
       else
         SmartCore::Types::Primitive::Caster.new(type_definitions.type_caster)
       end
     end
 
-    # @param type_checker [SmartCore::Types::Primitive::MultChecker]
+    # @param type [SmartCore::Types::Primitive]
+    # @param type_validator [SmartCore::Types::Primitive::MultValidator]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.2.0
+    def assign_type_validator(type, type_validator)
+      type_validator.___assign_type___(type)
+    end
+
+    # @param type [SmartCore::Types::Primitive]
+    # @param type_runtime_attributes_checker [SmartCore::Types::Primitive::RuntimeAttributesChecker]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def assign_type_runtime_attributes_checker(type, type_runtime_attributes_checker)
+      type_runtime_attributes_checker.___assign_type___(type)
+    end
+
+    # @param type_validator [SmartCore::Types::Primitive::MultValidator]
     # @param type_caster [SmartCore::Types::Primitive::Caster]
+    # @param type_runtime_attributes_checker [SmartCore::Types::Primitive::RuntimeAttributesChecker]
     # @return [SmartCore::Types::Primitive]
     #
     # @api private
     # @since 0.1.0
-    def build_type(type_checker, type_caster)
-      SmartCore::Types::Primitive.new(type_checker, type_caster)
+    # @version 0.3.0
+    def build_type(type_validator, type_caster, type_runtime_attributes_checker)
+      SmartCore::Types::Primitive.new(
+        nil,
+        nil,
+        type_validator,
+        type_caster,
+        type_runtime_attributes_checker
+      )
     end
   end
 end

data/lib/smart_core/types/primitive/mult_factory/definition_context.rb

@@ -2,19 +2,28 @@
 
 # @api private
 # @since 0.1.0
-class SmartCore::Types::Primitive::Factory::DefinitionContext
-  # @return [Proc]
+# @version 0.3.0
+class SmartCore::Types::Primitive::MultFactory::DefinitionContext
+  # @return [Proc, NilClass]
   #
   # @api private
   # @since 0.1.0
   attr_reader :type_caster
 
+  # @return [Proc, NilClass]
+  #
+  # @api private
+  # @since 0.3.0
+  attr_reader :type_runtime_attributes_checker
+
   # @return [void]
   #
   # @api private
   # @since 0.1.0
+  # @version 0.3.0
   def initialize
     @type_caster = nil
+    @type_runtime_attributes_checker = nil
   end
 
   # @param caster [Block]
@@ -22,8 +31,23 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
   #
   # @api public
   # @since 0.1.0
+  # @version 0.3.0
   def define_caster(&caster)
-    raise 'No caster definition block' unless block_given?
+    raise(SmartCore::Types::TypeDefinitionError, 'No caster definition block') unless block_given?
     @type_caster = caster
   end
+
+  # @param definition [Block]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.3.0
+  def runtime_attributes_checker(&definition)
+    unless block_given?
+      raise(SmartCore::Types::TypeDefinitionError, 'No runtime checker definition block')
+    end
+    @type_runtime_attributes_checker = definition
+  end
+
+  # TODO (0.x.0): invariant API
 end

data/lib/smart_core/types/primitive/mult_validator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+# @version 0.3.0
+class SmartCore::Types::Primitive::MultValidator < SmartCore::Types::Primitive::SumValidator
+  require_relative 'mult_validator/result'
+
+  # @overload validate(value)
+  #   @param value [Any]
+  #   @return [SmartCore::Types::Primitive::MultValidator::Result]
+  #
+  # @api private
+  # @since 0.2.0
+
+  # @overload ___copy_for___(type)
+  #   @param type [SmartCore::Types::Primitive]
+  #   @return [SmartCore::Types::Primitive::MultValidator]
+  #
+  # @api private
+  # @since 0.3.0
+
+  private
+
+  # @param validation [Block]
+  # @yieldparam [void]
+  # @yieldreturn [SmartCore::Engine::Atom]
+  # @return [SmartCore::Types::Primitive::MultValidator::Result]
+  #
+  # @api private
+  # @since 0.2.0
+  def compile_validation_result(&validation)
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   @yieldreturn [SmartCore::Types::Primitive::Validator::Result]
+    #   => and:
+    #   SmartCore::Types::Primitive::MultValidator::Result.new(
+    #     type, final_result.value, final_result.value.invariant_errors
+    #   )
+    SmartCore::Types::Primitive::MultValidator::Result.new(type, yield.value)
+  end
+end