smart_types 0.1.0 → 0.6.0

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,13 +14,15 @@ class SmartCore::Types::Primitive::UndefinedCaster < SmartCore::Types::Primitive
   end
 
   # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
   # @return [void]
   #
   # @raise [SmartCore::Types::TypeCastingUnsupportedError]
   #
   # @pai private
   # @since 0.1.0
-  def call(value)
+  # @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

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

@@ -2,21 +2,28 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Types::Primitive
+  require_relative 'primitive/checker'
   require_relative 'primitive/caster'
+  require_relative 'primitive/runtime_attributes_checker'
   require_relative 'primitive/undefined_caster'
-  require_relative 'primitive/checker'
-  require_relative 'primitive/nilable_checker'
-  require_relative 'primitive/sum_checker'
-  require_relative 'primitive/mult_checker'
+  require_relative 'primitive/invariant_control'
+  require_relative 'primitive/validator'
   require_relative 'primitive/factory'
+  require_relative 'primitive/sum_validator'
   require_relative 'primitive/sum_factory'
+  require_relative 'primitive/mult_validator'
   require_relative 'primitive/mult_factory'
+  require_relative 'primitive/nilable_validator'
   require_relative 'primitive/nilable_factory'
 
   class << self
     # @param type_name [String, Symbol]
     # @param type_definition [Block]
+    # @yield [type]
+    # @yieldparam type [SmartCore::Types::Primitive::DefinitionContext]
+    # @yieldreturn [void]
     # @return [SmartCore::Types::Primitive]
     #
     # @api public
@@ -26,11 +33,30 @@ class SmartCore::Types::Primitive
     end
   end
 
-  # @return [SmartCore::Types::Primitive::Checker]
+  # @note NilClass is suitable for sum-types, mult-types and nilable types.
+  # @return [String, NilClass]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :name
+
+  # @return [Class<SmartCore::Types::Primitive>]
   #
   # @api private
-  # @since 0.1.0
-  attr_reader :checker
+  # @since 0.3.0
+  attr_reader :category
+
+  # @return [Array<Any>]
+  #
+  # @api private
+  # @since 0.3.0
+  attr_reader :runtime_attributes
+
+  # @return [SmartCore::Types::Primitive::RuntimeAttributesChecker]
+  #
+  # @api private
+  # @since 0.3.0
+  attr_reader :runtime_attributes_checker
 
   # @return [SmartCore::Types::Primitive::Caster]
   #
@@ -38,17 +64,53 @@ class SmartCore::Types::Primitive
   # @since 0.1.0
   attr_reader :caster
 
-  # @param checker [SmartCore::Types::Primitive::Checker]
+  # @return [SmartCore::Types::Primitive::Validator]
+  # @return [SmartCore::Types::Primitive::SumValidator]
+  # @return [SmartCore::Types::Primitive::MultValidator]
+  # @return [SmartCore::Types::primitive::NilableValidator]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :validator
+
+  # @param name [String, NilClass] NilClass is suitable for sum-types, mult-types and nilable types.
+  # @param category [Class<SmartCore::Types::Primitive>, NilClass]
+  # @param validator [
+  #   SmartCore::Types::Primitive::Validator,
+  #   SmartCore::Types::Primitive::SumValidator,
+  #   SmartCore::Types::Primitive::MultValidator,
+  #   SmartCore::Types::Primitive::NilableValidator
+  # ]
   # @param caster [SmartCore::Types::Primitive::Caster]
+  # @param runtime_attributes_checker [SmartCore::Types::Primitive::RuntimeAttributesChecker]
+  # @param runtime_attributes [Array<Any>]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def initialize(checker, caster)
-    @lock = SmartCore::Engine::Lock.new
-    @checker = checker
+  # @version 0.3.0
+  # rubocop:disable Metrics/ParameterLists
+  def initialize(name, category, validator, caster, runtime_attributes_checker, *runtime_attributes)
+    @name = name
+    @category = category
+    @validator = validator
     @caster = caster
     @nilable = nil
+    @runtime_attributes_checker = runtime_attributes_checker
+    @runtime_attributes = runtime_attributes
+    @lock = SmartCore::Engine::Lock.new
+  end
+  # rubocop:enable Metrics/ParameterLists
+
+  # @param cloneable_instance [SmartCore::Types::Primitive]
+  # @return [SmartCore::Types::Primitive]
+  #
+  # @api private
+  # @since 0.3.0
+  def initialize_copy(cloneable_instance)
+    lock.synchronize do
+      self.class::Factory::RuntimeTypeBuilder.initialize_clone(self, cloneable_instance)
+    end
   end
 
   # @param value [Any]
@@ -56,20 +118,38 @@ class SmartCore::Types::Primitive
   #
   # @api public
   # @since 0.1.0
+  # @since 0.2.0
   def valid?(value)
-    checker.call(value)
+    validator.valid?(value)
   end
 
   # @param value [Any]
   # @return [void]
   #
   # @raise [SmartCore::Types::TypeError]
+  # @see SmartCore::Primitive::Validator
+  # @see SmartCore::Primitive::MultValidator
+  # @see SmartCore::Primitive::SumValidator
+  # @see SmartCore::Primitive::NilableValidator
   #
   # @api public
   # @since 0.1.0
+  # @version 0.2.0
   def validate!(value)
-    return if valid?(value)
-    raise(SmartCore::Types::TypeError, 'Invalid type')
+    validator.validate!(value)
+  end
+
+  # @return [SmartCore::Types::Primitive::Validator::Result]
+  #
+  # @see SmartCore::Primitive::Validator
+  # @see SmartCore::Primitive::MultValidator
+  # @see SmartCore::Primitive::SumValidator
+  # @see SmartCore::Primitive::NilableValidator
+  #
+  # @api public
+  # @since 0.2.0
+  def validate(value)
+    validator.validate(value)
   end
 
   # @param value [Any]
@@ -77,8 +157,12 @@ class SmartCore::Types::Primitive
   #
   # @api public
   # @since 0.1.0
+  # @version 0.3.0
   def cast(value)
-    caster.call(value)
+    # TODO (0.x.0):
+    #   refactor with ValueTransformer with internal reference to the type object
+    #   in Validator manner (in order to avoid explicit #runtime_attributes passing)
+    caster.call(value, runtime_attributes)
   end
 
   # @return [SmartCore::Types::Primitive]

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

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/value/array.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+using SmartCore::Ext::BasicObjectAsObject
+
 # @api public
 # @since 0.1.0
+# @version 0.3.0
 SmartCore::Types::Value.define_type(:Array) do |type|
   type.define_checker do |value|
     value.is_a?(::Array)

data/lib/smart_core/types/value/big_decimal.rb

@@ -3,15 +3,18 @@
 require 'bigdecimal'
 require 'bigdecimal/util'
 
+using SmartCore::Ext::BasicObjectAsObject
+
 # @api public
 # @since 0.1.0
+# @version 0.3.0
 SmartCore::Types::Value.define_type(:BigDecimal) do |type|
   type.define_checker do |value|
     value.is_a?(::BigDecimal)
   end
 
   type.define_caster do |value|
-    if SmartCore::Types::Value::Float.valid?(value)
+    if SmartCore::Types::Value::Numeric.valid?(value)
       value = SmartCore::Types::Value::String.cast(value)
     end
 

data/lib/smart_core/types/value/boolean.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+using SmartCore::Ext::BasicObjectAsObject
+
 # @api public
 # @since 0.1.0
+# @version 0.3.0
 SmartCore::Types::Value.define_type(:Boolean) do |type|
   type.define_checker do |value|
     value.is_a?(::TrueClass) || value.is_a?(::FalseClass)