smart_types 0.1.0 → 0.6.0

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+# @version 0.3.0
+class SmartCore::Types::Primitive::InvariantControl
+  require_relative 'invariant_control/result'
+  require_relative 'invariant_control/single'
+  require_relative 'invariant_control/chain'
+  require_relative 'invariant_control/factory'
+
+  class << self
+    # @param invariant_chains [Hash<String,Array<Proc>>]
+    # @param invariants [Hash<String,Proc>]
+    # @return [SmartCore::Types::Primitive::InvariantControl]
+    #
+    # @api private
+    # @since 0.2.0
+    def create(invariant_chains, invariants)
+      Factory.create(invariant_chains, invariants)
+    end
+  end
+
+  # @param invariant_chains [Array<SmartCore::Types::Primitive::InvariantControl::Chain>]
+  # @param invariants [Array<SmartCore::Types::Primitive::InvariantControl::Single>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(invariant_chains, invariants)
+    @invariant_chains = invariant_chains
+    @invariants = invariants
+  end
+
+  # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
+  # @return [SmartCore::Types::Primitive::InvariantControl::Result]
+  #
+  # @api private
+  # @since 0.2.0
+  # @version 0.3.0
+  def check(value, runtime_attributes)
+    Result.new(self, value).tap do |result|
+      invariant_chains.each do |chain|
+        result.add_chain_result(chain.check(value, runtime_attributes))
+      end
+
+      invariants.each do |invariant|
+        result.add_single_result(invariant.check(value, runtime_attributes))
+      end
+    end
+  end
+
+  private
+
+  # @return [Array<SmartCore::Types::Primitive::InvariantControl::Chain>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant_chains
+
+  # @return [Array<SmartCore::Types::Primitive::InvariantControl::Single>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariants
+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
+# @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(SmartCore::ArgumentError, '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_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_validator/result.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class SmartCore::Types::Primitive::MultValidator
+  # @api private
+  # @since 0.2.0
+  class Result < SmartCore::Types::Primitive::SumValidator::Result
+  end
+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

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 module SmartCore::Types::Primitive::NilableFactory
   class << self
     # @param type [SmartCore::Types::Primitive]
@@ -9,21 +10,24 @@ module SmartCore::Types::Primitive::NilableFactory
     #
     # @api private
     # @since 0.1.0
+    # @version 0.2.0
     def create_type(type)
-      type_checker = build_type_checker(type)
+      type_validator = build_type_validator(type)
       type_caster = build_type_caster(type)
-      build_type(type, type_checker, type_caster)
+      build_type(type, type_validator, type_caster).tap do |new_type|
+        assign_type_validator(new_type, type_validator)
+      end
     end
 
     private
 
     # @param type [SmartCore::Types::Primitive]
-    # @return [SmartCore::Types::Primitive::NilableChecker]
+    # @return [SmartCore::Types::Primitive::NilableValidator]
     #
     # @api private
-    # @since 0.1.0
-    def build_type_checker(type)
-      SmartCore::Types::Primitive::NilableChecker.new(type.checker)
+    # @since 0.2.0
+    def build_type_validator(type)
+      SmartCore::Types::Primitive::NilableValidator.new(type.validator)
     end
 
     # @param type [SmartCore::Types::Primitive]
@@ -36,14 +40,32 @@ module SmartCore::Types::Primitive::NilableFactory
     end
 
     # @param type [SmartCore::Types::Primitive]
-    # @param type_checker [SmartCore::Types::Primitive::NilableChecker]
+    # @param type_validator [SmartCore::Types::Primitive::NilableValidator]
+    # @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_validator [SmartCore::Types::Primitive::NilableValidator]
     # @param type_caster [SmartCore::Types::Caster]
     # @return [SmartCore::Type::Primitive]
     #
     # @api private
     # @since 0.1.0
-    def build_type(type, type_checker, type_caster)
-      Class.new(type.class).new(type_checker, type_caster)
+    # @version 0.3.0
+    def build_type(type, type_validator, type_caster)
+      Class.new(type.class).new(
+        type.name,
+        type.category,
+        type_validator,
+        type_caster,
+        type.runtime_attributes_checker,
+        *type.runtime_attributes
+      )
     end
   end
 end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::NilableValidator::Result
+  # @return [Array]
+  #
+  # @api private
+  # @since 0.2.0
+  NO_INVARIANT_ERRORS = [].freeze
+
+  # @return [SmartCore::Types::Primitive]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :type
+
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :checked_value
+  alias_method :value, :checked_value
+
+  # @param type [SmartCore::Types::Primitive]
+  # @param checked_value [Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(type, checked_value)
+    @type = type
+    @checked_value = checked_value
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def is_valid_check
+    true
+  end
+  alias_method :valid_check?, :is_valid_check
+
+  # @return [Array]
+  #
+  # @api public
+  # @since 0.2.0
+  def invariant_errors
+    NO_INVARIANT_ERRORS
+  end
+  alias_method :errors, :invariant_errors
+  alias_method :error_codes, :invariant_errors
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def valid_invariants?
+    true
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def success?
+    true
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def failure?
+    false
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::NilableValidator
+  require_relative 'nilable_validator/result'
+
+  # @param validator [
+  #   SmartCore::Types::Primitive::Validator,
+  #   SmartCore::Types::Primitive::SumValidator,
+  #   SmartCore::Types::Primitive::MultValidator,
+  #   SmartCore::Types::Primitive::NilableValidator
+  # ]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(validator)
+    @type = nil
+    @validator = validator
+  end
+
+  # @param type [SmartCore::Types::Primitive]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def ___assign_type___(type)
+    @type = type
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def valid?(value)
+    value == nil ? true : validator.valid?(value)
+  end
+
+  # @param value [Any]
+  # @return [SmartCore::Types::Primitive::Validator::Result]
+  # @return [SmartCore::Types::Primitive::SumValidator::Result]
+  # @return [SmartCore::Types::Primitive::MultValidator::Result]
+  # @return [SmartCore::Types::Primitive::NilableValidator::Result]
+  #
+  # @api private
+  # @since 0.2.0
+  def validate(value)
+    return Result.new(type, value) if value == nil
+    validator.validate(value)
+  end
+
+  # @param value [Any]
+  # @return [void]
+  #
+  # @raise [SmartCore::Types::TypeError]
+  #
+  # @api private
+  # @since 0.2.0
+  def validate!(value)
+    return if valid?(value)
+    raise(SmartCore::Types::TypeError, 'Invalid type')
+  end
+
+  private
+
+  # @return [SmartCore::Types::Primitive]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :type
+
+  # @return [
+  #   SmartCore::Types::Primitive::Validator,
+  #   SmartCore::Types::Primitive::SumValidator,
+  #   SmartCore::Types::Primitive::MultValidator,
+  #   SmartCore::Types::Primitive::NilableValidator
+  # ]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :validator
+end