smart_types 0.1.0 → 0.2.0

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

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.1.0
-class SmartCore::Types::Primitive::Factory::DefinitionContext
+class SmartCore::Types::Primitive::MultFactory::DefinitionContext
   # @return [Proc, NilClass]
   #
   # @api private
@@ -23,7 +23,9 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
   # @api public
   # @since 0.1.0
   def define_caster(&caster)
-    raise(SmartCore::ArgumentError, 'No caster definition block') unless block_given?
+    raise(SmartCore::Types::ArgumentError, 'No caster definition block') unless block_given?
     @type_caster = caster
   end
+
+  # TODO (0.x.0): invariant API
 end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.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
+
+  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/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/nilable_factory.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.2.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,25 @@ 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.2.0
+    def build_type(type, type_validator, type_caster)
+      Class.new(type.class).new(type.name, type_validator, type_caster)
     end
   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

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/sum_factory.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.2.0
 module SmartCore::Types::Primitive::SumFactory
   require_relative 'sum_factory/definition_context'
 
@@ -12,11 +13,14 @@ module SmartCore::Types::Primitive::SumFactory
     #
     # @api private
     # @since 0.1.0
+    # @version 0.2.0
     def create_type(types, type_definition)
       type_definitions = build_type_definitions(type_definition)
-      type_checker = build_type_checker(types, 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).tap do |type|
+        assign_type_validator(type, type_validator)
+      end
     end
 
     private
@@ -34,12 +38,12 @@ module SmartCore::Types::Primitive::SumFactory
 
     # @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 +53,32 @@ 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_validator [SmartCore::Types::Primitive::SumValidator)]
     # @param type_caster [SmartCore::Types::Primitive::Caster]
     # @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.2.0
+    def build_type(type_validator, type_caster)
+      SmartCore::Types::Primitive.new(nil, type_validator, type_caster)
     end
   end
 end

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

@@ -23,7 +23,9 @@ class SmartCore::Types::Primitive::SumFactory::DefinitionContext
   # @api public
   # @since 0.1.0
   def define_caster(&caster)
-    raise(SmartCore::ArgumentError, 'No caster definition block') unless block_given?
+    raise(SmartCore::Types::ArgumentError, 'No caster definition block') unless block_given?
     @type_caster = caster
   end
+
+  # TODO (0.x.0): invariant API
 end

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.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 [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)
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   validators.any? { |validator| validator.valid?(value) }
+    validators.any? { |validator| validator.type_checker.call(value) }
+  end
+
+  # @param value [Any]
+  # @return [SmartCore::Types::Primitive::SumValidator::Result]
+  #
+  # @api private
+  # @since 0.2.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) }
+          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