smart_types 0.1.0 → 0.6.0

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.3.0
+class SmartCore::Types::Primitive::RuntimeAttributesChecker
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.3.0
+  ATTRIBUTES_IS_NOT_ALLOWED_CHECKER = proc do |attrs|
+    attrs.empty? || raise(SmartCore::Types::RuntimeAttriburtesUnsupportedError, <<~ERROR_MESSAGE)
+      This type has no support for runtime attributes.
+    ERROR_MESSAGE
+  end.freeze
+
+  # @param attributes_checker [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.3.0
+  def initialize(attributes_checker)
+    @type = nil
+    @attributes_checker = attributes_checker || ATTRIBUTES_IS_NOT_ALLOWED_CHECKER
+  end
+
+  # @param type [SmartCore::Types::Primitive]
+  # @return [SmartCore::Types::Primitive::RuntimeAttributesChecker]
+  #
+  # @api private
+  # @since 0.3.0
+  def ___copy_for___(type)
+    self.class.new(attributes_checker).tap do |instance_copy|
+      instance_copy.___assign_type___(type)
+    end
+  end
+
+  # @param type [SmartCore::Types::Primitive]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.3.0
+  def ___assign_type___(type)
+    @type = type
+  end
+
+  # @param runtime_attributes [Array<Any>]
+  # @return [void]
+  #
+  # @raise [SmartCore::Types::IncorrectRuntimeAttributesError]
+  #
+  # @api private
+  # @since 0.3.0
+  def check!(runtime_attributes)
+    unless !!attributes_checker.call(runtime_attributes)
+      # TODO (0.x.0):
+      #   Full type name (with type category; and delegated to the type object).
+      #   (main problem: sum and mult types has no type name and type category)
+      raise(SmartCore::Types::IncorrectRuntimeAttributesError, <<~ERROR_MESSAGE)
+        Incorrect runtime attributes for #{type.name}.
+      ERROR_MESSAGE
+    end
+  end
+
+  private
+
+  # @return [SmartCore::Types::Primitive]
+  #
+  # @api private
+  # @since 0.3.0
+  attr_reader :type
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.3.0
+  attr_reader :attributes_checker
+end

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::SumFactory::DefinitionContext
   # @return [Proc, NilClass]
   #
@@ -9,12 +10,20 @@ class SmartCore::Types::Primitive::SumFactory::DefinitionContext
   # @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::SumFactory::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/sum_factory.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 module SmartCore::Types::Primitive::SumFactory
   require_relative 'sum_factory/definition_context'
 
@@ -12,11 +13,20 @@ module SmartCore::Types::Primitive::SumFactory
     #
     # @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::SumFactory
       end
     end
 
+    # @param type_definitions [SmartCore::Types::Primitive::SumFactory::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::SumFactory::DefinitionContext]
-    # @return [SmartCore::Types::Primitive::SumChecker]
+    # @return [SmartCore::Types::Primitive::SumValidator]
     #
     # @api private
-    # @since 0.1.0
-    def build_type_checker(types, type_definitions)
-      SmartCore::Types::Primitive::SumChecker.new(*types.map(&:checker))
+    # @since 0.2.0
+    def build_type_validator(types, type_definitions)
+      SmartCore::Types::Primitive::SumValidator.new(*types.map(&:validator))
     end
 
     # @param types [Array<SmartCore::Types::Primtive>]
@@ -49,21 +70,49 @@ module SmartCore::Types::Primitive::SumFactory
     # @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::SumChecker]
+    # @param type [SmartCore::Types::Primitive]
+    # @param type_validator [SmartCore::Types::Primitive::SumValidator]
+    # @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::SumValidator)]
     # @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/sum_validator/result.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::SumValidator::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 concrete_validation_result [
+  #   SmartCore::Types::Primitive::Validator::Result,
+  #   SmartCore::Types::Primitive::SumValidator::Result,
+  #   SmartCore::Types::Primitive::MultValidator::Result,
+  #   SmartCore::Types::Primitive::NilableValidator::Result
+  # ]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :concrete_validation_result
+
+  # @return [Array<String>]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :invariant_errors
+  alias_method :errors, :invariant_errors
+  alias_method :error_codes, :invariant_errors
+
+  # @param type [SmartCore::Types::Primitive]
+  # @param concrete_validation_result [
+  #   Boolean, (TEMPORARY)
+  #   SmartCore::Types::Primitive::Validator::Result,
+  #   SmartCore::Types::Primitive::SumValidator::Result,
+  #   SmartCore::Types::Primitive::MultValidator::Result,
+  #   SmartCore::Types::Primitive::NilableValidator::Result
+  # ]
+  # @param invariant_errors [Array<String>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(type, concrete_validation_result, invariant_errors = NO_INVARIANT_ERRORS.dup)
+    @type = type
+    @concrete_validation_result = concrete_validation_result
+    @invariant_errors = invariant_errors.dup.tap(&:freeze)
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def valid_invariants?
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   concrete_validation_result.valid_invariants?
+    true
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def is_valid_check
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   concrete_validation_result.is_valid_check
+    concrete_validation_result
+  end
+  alias_method :valid_check?, :is_valid_check
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def success?
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   concrete_validation_result.success?
+    concrete_validation_result
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def failure?
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   concrete_validation_result.failure?
+    !success?
+  end
+end

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+# @version 0.3.0
+class SmartCore::Types::Primitive::SumValidator
+  require_relative 'sum_validator/result'
+
+  # @param validators [Array<SmartCore::Types::Primitive::Validator>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(*validators)
+    @type = nil
+    @validators = validators
+  end
+
+  # @param type [SmartCore::Types::Primitive]
+  # @return [SmartCore::Types::Primitive::SumValidator]
+  #
+  # @api private
+  # @since 0.3.0
+  def ___copy_for___(type)
+    self.class.new(type_checker, invariant_control).tap do |instance_copy|
+      instance_copy.___assign_type___(type)
+    end
+  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
+  # @version 0.3.0
+  def valid?(value)
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   validators.any? { |validator| validator.valid?(value) }
+    validators.any? do |validator|
+      validator.type_checker.call(value, type.runtime_attributes)
+    end
+  end
+
+  # @param value [Any]
+  # @return [SmartCore::Types::Primitive::SumValidator::Result]
+  #
+  # @api private
+  # @since 0.2.0
+  # @version 0.3.0
+  def validate(value)
+    compile_validation_result do
+      SmartCore::Engine::Atom.new.tap do |result|
+        validators.each do |validator|
+          # NOTE: at this moment type sum does not support invariant checking
+          # TODO (0.x.0):
+          #   result.swap { validator.validate(value) }
+          #   break if result.value.success?
+          result.swap { validator.type_checker.call(value, type.runtime_attributes) }
+          break if result.value # => boolean
+        end
+      end
+    end
+  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 [Array<SmartCore::Types::Primitive::Validator>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :validators
+
+  # @param validation [Block]
+  # @yieldparam [void]
+  # @yieldreturn [SmartCore::Engine::Atom]
+  # @return [SmartCore::Types::Primitive::SumValidator::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::SumValidator::Result.new(
+    #     type, final_result.value, final_result.value.invariant_errors
+    #   )
+    SmartCore::Types::Primitive::SumValidator::Result.new(type, yield.value)
+  end
+end