smart_types 0.2.0 → 0.3.0

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

@@ -2,6 +2,7 @@
 
 # @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'
@@ -32,18 +33,20 @@ class SmartCore::Types::Primitive::InvariantControl
   end
 
   # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
   # @return [SmartCore::Types::Primitive::InvariantControl::Result]
   #
   # @api private
   # @since 0.2.0
-  def check(value)
+  # @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))
+        result.add_chain_result(chain.check(value, runtime_attributes))
       end
 
       invariants.each do |invariant|
-        result.add_single_result(invariant.check(value))
+        result.add_single_result(invariant.check(value, runtime_attributes))
       end
     end
   end

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.2.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::InvariantControl::Chain
   require_relative 'chain/result'
 
@@ -31,14 +32,16 @@ class SmartCore::Types::Primitive::InvariantControl::Chain
   end
 
   # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
   # @return [SmartCore::Types::Primitive::InvariantControl::Chain::Result]
   #
   # @api private
   # @since 0.2.0
-  def check(value)
+  # @version 0.3.0
+  def check(value, runtime_attributes)
     invariant_results = [].tap do |results|
       invariants.each do |invariant|
-        result = invariant.check(value).tap { |res| results << res }
+        result = invariant.check(value, runtime_attributes).tap { |res| results << res }
         break if result.failure?
       end
     end

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.2.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::InvariantControl::Single
   require_relative 'single/result'
 
@@ -35,12 +36,14 @@ class SmartCore::Types::Primitive::InvariantControl::Single
   end
 
   # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
   # @return [SmartCore::Types::Primitive::InvariantControl::Single::Result]
   #
   # @api private
   # @since 0.2.0
-  def check(value)
-    validation_result = !!invariant_checker.call(value)
+  # @version 0.3.0
+  def check(value, runtime_attributes)
+    validation_result = !!invariant_checker.call(value, runtime_attributes)
     Result.new(self, value, validation_result)
   end
 

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

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.1.0
-# @version 0.2.0
+# @version 0.3.0
 module SmartCore::Types::Primitive::MultFactory
   require_relative 'mult_factory/definition_context'
 
@@ -13,13 +13,19 @@ module SmartCore::Types::Primitive::MultFactory
     #
     # @api private
     # @since 0.1.0
-    # @version 0.2.0
+    # @version 0.3.0
     def create_type(types, type_definition)
       type_definitions = build_type_definitions(type_definition)
+      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_validator, type_caster).tap do |type|
+      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
 
@@ -36,6 +42,17 @@ 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::MultValidator]
@@ -70,15 +87,32 @@ module SmartCore::Types::Primitive::MultFactory
       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
-    # @version 0.2.0
-    def build_type(type_validator, type_caster)
-      SmartCore::Types::Primitive.new(nil, type_validator, 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_factory/definition_context.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::MultFactory::DefinitionContext
   # @return [Proc, NilClass]
   #
@@ -9,12 +10,20 @@ class SmartCore::Types::Primitive::MultFactory::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,10 +31,23 @@ class SmartCore::Types::Primitive::MultFactory::DefinitionContext
   #
   # @api public
   # @since 0.1.0
+  # @version 0.3.0
   def define_caster(&caster)
-    raise(SmartCore::Types::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_validator.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.2.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::MultValidator < SmartCore::Types::Primitive::SumValidator
   require_relative 'mult_validator/result'
 
@@ -12,6 +13,13 @@ class SmartCore::Types::Primitive::MultValidator < SmartCore::Types::Primitive::
   # @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]

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

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.1.0
-# @version 0.2.0
+# @version 0.3.0
 module SmartCore::Types::Primitive::NilableFactory
   class << self
     # @param type [SmartCore::Types::Primitive]
@@ -56,9 +56,16 @@ module SmartCore::Types::Primitive::NilableFactory
     #
     # @api private
     # @since 0.1.0
-    # @version 0.2.0
+    # @version 0.3.0
     def build_type(type, type_validator, type_caster)
-      Class.new(type.class).new(type.name, 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/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.rb

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.1.0
-# @version 0.2.0
+# @version 0.3.0
 module SmartCore::Types::Primitive::SumFactory
   require_relative 'sum_factory/definition_context'
 
@@ -13,13 +13,19 @@ module SmartCore::Types::Primitive::SumFactory
     #
     # @api private
     # @since 0.1.0
-    # @version 0.2.0
+    # @version 0.3.0
     def create_type(types, type_definition)
       type_definitions = build_type_definitions(type_definition)
+      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_validator, type_caster).tap do |type|
+      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
 
@@ -36,6 +42,17 @@ 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::SumValidator]
@@ -70,15 +87,32 @@ module SmartCore::Types::Primitive::SumFactory
       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
-    # @version 0.2.0
-    def build_type(type_validator, type_caster)
-      SmartCore::Types::Primitive.new(nil, type_validator, 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_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,10 +31,23 @@ class SmartCore::Types::Primitive::SumFactory::DefinitionContext
   #
   # @api public
   # @since 0.1.0
+  # @version 0.3.0
   def define_caster(&caster)
-    raise(SmartCore::Types::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