smart_types 0.1.0.alpha5 → 0.4.0

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

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::UndefinedCaster < SmartCore::Types::Primitive::Caster
   # @param expression [NilClass, Any]
   # @return [void]
@@ -13,16 +14,17 @@ class SmartCore::Types::Primitive::UndefinedCaster < SmartCore::Types::Primitive
   end
 
   # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
   # @return [void]
   #
-  # @raise [SmartCore::Types::TypeCastingError]
+  # @raise [SmartCore::Types::TypeCastingUnsupportedError]
   #
   # @pai private
   # @since 0.1.0
-  def call(value)
-    raise(
-      SmartCore::Types::TypeCastingError,
+  # @version 0.3.0
+  def call(value, runtime_attributes)
+    raise(SmartCore::Types::TypeCastingUnsupportedError, <<~ERROR_MESSAGE)
       'This type has no support for type casting'
-    )
+    ERROR_MESSAGE
   end
 end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+# @version 0.3.0
+class SmartCore::Types::Primitive::Validator
+  require_relative 'validator/result'
+
+  # @return [SmartCore::Type::Primitive]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :type
+
+  # @return [SmartCore::Types::Primitive::Checker]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :type_checker
+
+  # @return [SmartCore::Types::Primitive::InvariantControl]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant_control
+
+  # @param type_checker [SmartCore::Types::Primitive::Checker]
+  # @param invariant_control [SmartCore::Types::Primitive::InvariantControl]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(type_checker, invariant_control)
+    @type = nil
+    @type_checker = type_checker
+    @invariant_control = invariant_control
+  end
+
+  # @param type [SmartCore::Types::Primitive]
+  # @return [SmartCore::Types::Primitive::Validator]
+  #
+  # @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
+
+  # @param value [Any]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def valid?(value)
+    validate(value).success?
+  end
+
+  # @param value [Any]
+  # @return [SmartCore::Types::Primitive::Validator::Result]
+  #
+  # @api private
+  # @since 0.2.0
+  # @version 0.3.0
+  def validate(value)
+    checker_result = type_checker.call(value, type.runtime_attributes) # => Boolean
+    return Result.new(type, value, checker_result) unless checker_result
+    invariant_result = invariant_control.check(value, type.runtime_attributes)
+    invariant_errors = invariant_result.invariant_errors.map { |error| "#{type.name}.#{error}" }
+    Result.new(type, value, checker_result, invariant_errors)
+  end
+
+  # @param value [Any]
+  # @return [void]
+  #
+  # @raise [SmartCore::Types::TypeError]
+  #
+  # @api private
+  # @since 0.2.0
+  def validate!(value)
+    return if validate(value).success?
+    raise(SmartCore::Types::TypeError, 'Invalid type')
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::Validator::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 [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :is_valid_check
+  alias_method :valid_check?, :is_valid_check
+
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :checked_value
+  alias_method :value, :checked_value
+
+  # @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 checked_value [Any]
+  # @param is_valid_check [Boolean]
+  # @param invariant_errors [Array<String>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(type, checked_value, is_valid_check, invariant_errors = NO_INVARIANT_ERRORS.dup)
+    @type = type
+    @checked_value = checked_value
+    @is_valid_check = is_valid_check
+    @invariant_errors = invariant_errors.tap(&:freeze)
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def valid_invariants?
+    invariant_errors.empty?
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def success?
+    valid_check? && invariant_errors.empty?
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def failure?
+    !success?
+  end
+end

data/lib/smart_core/types/protocol.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.3.0
+class SmartCore::Types::Protocol < SmartCore::Types::Primitive
+  require_relative 'protocol/instance_of'
+end

data/lib/smart_core/types/protocol/instance_of.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+using SmartCore::Ext::BasicObjectAsObject
+
+# @api public
+# @since 0.3.0
+SmartCore::Types::Protocol.define_type(:InstanceOf) do |type|
+  type.runtime_attributes_checker do |runtime_attrs|
+    runtime_attrs.any? && runtime_attrs.all? do |runtime_attr|
+      runtime_attr.is_a?(::Class)
+    end
+  end
+
+  type.define_checker do |value, expected_types|
+    expected_types.any? && expected_types.any? do |expected_type|
+      value.is_a?(expected_type)
+    end
+  end
+end