smart_types 0.2.0 → 0.3.0

data/lib/smart_core/types.rb

@@ -10,4 +10,6 @@ module SmartCore::Types
   require_relative 'types/system'
   require_relative 'types/primitive'
   require_relative 'types/value'
+  require_relative 'types/protocol'
+  require_relative 'types/variadic'
 end

data/lib/smart_core/types/errors.rb

@@ -13,6 +13,18 @@ module SmartCore::Types
   # @since 0.1.0
   NameError = Class.new(SmartCore::NameError)
 
+  # @api public
+  # @since 0.3.0
+  TypeDefinitionError = Class.new(ArgumentError)
+
+  # @api public
+  # @since 0.3.0
+  IncorrectRuntimeAttributesError = Class.new(TypeDefinitionError)
+
+  # @api public
+  # @since 0.3.0
+  RuntimeAttriburtesUnsupportedError = Class.new(TypeDefinitionError)
+
   # @api public
   # @since 0.1.0
   TypeError = Class.new(SmartCore::TypeError)

data/lib/smart_core/types/primitive.rb

@@ -2,10 +2,11 @@
 
 # @api private
 # @since 0.1.0
-# @version 0.2.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/invariant_control'
   require_relative 'primitive/validator'
@@ -20,6 +21,9 @@ class SmartCore::Types::Primitive
   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
@@ -36,6 +40,24 @@ class SmartCore::Types::Primitive
   # @since 0.2.0
   attr_reader :name
 
+  # @return [Class<SmartCore::Types::Primitive>]
+  #
+  # @api private
+  # @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]
   #
   # @api private
@@ -52,6 +74,7 @@ class SmartCore::Types::Primitive
   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,
@@ -59,18 +82,36 @@ class SmartCore::Types::Primitive
   #   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
-  # @version 0.2.0
-  def initialize(name, validator, caster)
+  # @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]
   # @return [Boolean]
@@ -116,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/primitive/caster.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::Caster
   # @param expression [Proc]
   # @return [void]
@@ -13,12 +14,14 @@ class SmartCore::Types::Primitive::Caster
   end
 
   # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
   # @return [Any]
   #
   # @api private
   # @since 0.1.0
-  def call(value)
-    expression.call(value)
+  # @version 0.3.0
+  def call(value, runtime_attributes)
+    expression.call(value, runtime_attributes)
   end
 
   private

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::Checker
   # @param expression [Proc]
   # @return [void]
@@ -13,12 +14,14 @@ class SmartCore::Types::Primitive::Checker
   end
 
   # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
   # @return [Boolean]
   #
   # @api private
   # @since 0.1.0
-  def call(value)
-    !!expression.call(value)
+  # @version 0.3.0
+  def call(value, runtime_attributes)
+    !!expression.call(value, runtime_attributes)
   end
 
   private

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

@@ -2,9 +2,10 @@
 
 # @api private
 # @since 0.1.0
-# @version 0.2.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::Factory
   require_relative 'factory/definition_context'
+  require_relative 'factory/runtime_type_builder'
 
   class << self
     # @param type_category [Class<SmartCore::Types::Primitive>]
@@ -14,16 +15,25 @@ class SmartCore::Types::Primitive::Factory
     #
     # @api private
     # @since 0.1.0
-    # @version 0.2.0
+    # @version 0.3.0
     def create_type(type_category, type_name, type_definition)
       type_definitions = build_type_definitions(type_definition)
+      type_runtime_attributes_checker = build_type_runtime_attributes_checker(type_definitions)
       type_checker = build_type_checker(type_definitions)
       type_caster = build_type_caster(type_definitions)
       type_invariant_control = build_type_invariant_control(type_definitions)
       type_validator = build_type_validator(type_checker, type_invariant_control)
-      build_type(type_category, type_name, type_validator, type_caster).tap do |type|
+      build_type(
+        type_category,
+        type_name,
+        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)
         register_new_type(type_category, type_name, type)
+        register_runtime_type_builder(type_category, type_name)
       end
     end
 
@@ -48,6 +58,17 @@ class SmartCore::Types::Primitive::Factory
       end
     end
 
+    # @param type_definitions [SmartCore::Types::Primitive::Factory::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 type_definitions [SmartCore::Types::Primitive::Factory::DefinitionContext]
     # @return [SmartCore::Types::Primitive::InvariantControl]
     #
@@ -96,13 +117,26 @@ class SmartCore::Types::Primitive::Factory
     # @param type_name [String, Symbol]
     # @param type_validator [SmartCore::Types::Primitive::Validator]
     # @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_category, type_name, type_validator, type_caster)
-      Class.new(type_category).new(type_name, type_validator, type_caster)
+    # @version 0.3.0
+    def build_type(
+      type_category,
+      type_name,
+      type_validator,
+      type_caster,
+      type_runtime_attributes_checker
+    )
+      Class.new(type_category).new(
+        type_name,
+        type_category,
+        type_validator,
+        type_caster,
+        type_runtime_attributes_checker
+      )
     end
 
     # @param type [SmartCore::Types::Primitive]
@@ -115,6 +149,16 @@ class SmartCore::Types::Primitive::Factory
       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_category [Class<SmartCore::Types::Primitive>]
     # @param type_name [String, Symbol]
     # @param type [SmartCore::Types::Primitive]
@@ -132,5 +176,19 @@ class SmartCore::Types::Primitive::Factory
         "Incorrect constant name for new type (#{type_name})"
       )
     end
+
+    # @param type_category [Class<SmartCore::Types::Primitive>]
+    # @param type_name [String, Symbol]
+    # @return [void]
+    #
+    # @raise [SmartCore::Types::IncorrectTypeNameError]
+    #
+    # @api private
+    # @since 0.3.0
+    def register_runtime_type_builder(type_category, type_name)
+      type_category.define_singleton_method(type_name) do |*runtime_attributes|
+        RuntimeTypeBuilder.build_with_runtime(type_name, type_category, runtime_attributes)
+      end
+    end
   end
 end

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

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.1.0
-# @version 0.2.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::Factory::DefinitionContext
   class << self
     # @param name [String, Symbol]
@@ -11,19 +11,20 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
     #
     # @api private
     # @since 0.2.0
+    # @version 0.3.0
     def vaildate_invariant_attributes!(name, &definition)
       unless block_given?
-        raise(SmartCore::Types::ArgumentError, 'No invariant block')
+        raise(SmartCore::Types::TypeDefinitionError, 'No invariant block')
       end
 
       unless name.is_a?(::String) || name.is_a?(::Symbol)
-        raise(SmartCore::Types::ArgumentError, <<~ERROR_MESSAGE)
+        raise(SmartCore::Types::TypeDefinitionError, <<~ERROR_MESSAGE)
           Invariant name should be a type of string or symbol.
         ERROR_MESSAGE
       end
 
       if name == '' || name == :""
-        raise(SmartCore::Types::ArgumentError, <<~ERROR_MESSAGE)
+        raise(SmartCore::Types::TypeDefinitionError, <<~ERROR_MESSAGE)
           Invariant name can not be empty.
         ERROR_MESSAGE
       end
@@ -37,17 +38,17 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
     # @since 0.3.0
     def vaildate_invariant_chain_attributes!(chain_name, &definition)
       unless block_given?
-        raise(SmartCore::Types::ArgumentError, 'No invariant chain block')
+        raise(SmartCore::Types::TypeDefinitionError, 'No invariant chain block')
       end
 
       unless chain_name.is_a?(::String) || chain_name.is_a?(::Symbol)
-        raise(SmartCore::Types::ArgumentError, <<~ERROR_MESSAGE)
+        raise(SmartCore::Types::TypeDefinitionError, <<~ERROR_MESSAGE)
           Invariant chain name should be a type of string or symbol.
         ERROR_MESSAGE
       end
 
       if chain_name == '' || chain_name == :""
-        raise(SmartCore::Types::ArgumentError, <<~ERROR_MESSAGE)
+        raise(SmartCore::Types::TypeDefinitionError, <<~ERROR_MESSAGE)
           Invariant chain name can not be empty.
         ERROR_MESSAGE
       end
@@ -78,6 +79,12 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
   # @since 0.2.0
   attr_reader :type_invariants
 
+  # @return [Proc, NilClass]
+  #
+  # @api private
+  # @since 0.3.0
+  attr_reader :type_runtime_attributes_checker
+
   # @return [void]
   #
   # @api private
@@ -88,6 +95,7 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
     @type_invariants = {}
     @type_checker = nil
     @type_caster = nil
+    @type_runtime_attributes_checker = nil
     @definition_lock = SmartCore::Engine::Lock.new
   end
 
@@ -96,10 +104,12 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
   #
   # @api public
   # @since 0.1.0
-  # @version 0.2.0
+  # @version 0.3.0
   def define_checker(&checker)
     thread_safe do
-      raise(SmartCore::Types::ArgumentError, 'No checker definition block') unless block_given?
+      unless block_given?
+        raise(SmartCore::Types::TypeDefinitionError, 'No checker definition block')
+      end
       @type_checker = checker
     end
   end
@@ -109,10 +119,12 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
   #
   # @api public
   # @since 0.1.0
-  # @version 0.2.0
+  # @version 0.3.0
   def define_caster(&caster)
     thread_safe do
-      raise(SmartCore::Types::ArgumentError, 'No caster definition block') unless block_given?
+      unless block_given?
+        raise(SmartCore::Types::TypeDefinitionError, 'No caster definition block')
+      end
       @type_caster = caster
     end
   end
@@ -143,6 +155,20 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
     end
   end
 
+  # @param definition [Block]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.3.0
+  def runtime_attributes_checker(&definition)
+    thread_safe do
+      unless block_given?
+        raise(SmartCore::Types::TypeDefinitionError, 'No runtime checker definition block')
+      end
+      @type_runtime_attributes_checker = definition
+    end
+  end
+
   private
 
   # @param block [Block]

data/lib/smart_core/types/primitive/factory/runtime_type_builder.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.3.0
+module SmartCore::Types::Primitive::Factory::RuntimeTypeBuilder
+  class << self
+    # @param type_name [String, Symbol]
+    # @param type_category [Class<SmartCore::Types::Primitive>]
+    # @param runtime_attributes [Array<Any>]
+    # @return [SmartCore::Types::Primitive]
+    #
+    # @api private
+    # @since 0.3.0
+    def build_with_runtime(type_name, type_category, runtime_attributes)
+      type = type_category.const_get(type_name)
+      type.runtime_attributes_checker.check!(runtime_attributes)
+
+      type.clone.tap do |type_with_custom_runtime|
+        type_with_custom_runtime.instance_variable_set(
+          :@runtime_attributes, runtime_attributes.freeze
+        )
+      end
+    end
+
+    # @param new_instance [SmartCore::Types::Primitive]
+    # @param cloneable_instance [SmartCore::Types::Primitive]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    # rubocop:disable Metrics/AbcSize, Layout/LineLength
+    def initialize_clone(new_instance, cloneable_instance)
+      name_clone = cloneable_instance.instance_variable_get(:@name)
+      category_clone = cloneable_instance.instance_variable_get(:@category)
+      validator_clone = cloneable_instance.instance_variable_get(:@validator).___copy_for___(new_instance)
+      caster_clone = cloneable_instance.instance_variable_get(:@caster)
+      runtime_attributes_clone = cloneable_instance.instance_variable_get(:@runtime_attributes).clone
+      runtime_attributes_checker_clone = cloneable_instance.instance_variable_get(:@runtime_attributes_checker).___copy_for___(new_instance)
+      lock_clone = SmartCore::Engine::Lock.new
+      nilable_clone = nil
+
+      new_instance.instance_variable_set(:@name, name_clone)
+      new_instance.instance_variable_set(:@category, category_clone)
+      new_instance.instance_variable_set(:@validator, validator_clone)
+      new_instance.instance_variable_set(:@caster, caster_clone)
+      new_instance.instance_variable_set(:@runtime_attributes, runtime_attributes_clone)
+      new_instance.instance_variable_set(:@runtime_attributes_checker, runtime_attributes_checker_clone)
+      new_instance.instance_variable_set(:@lock_clone, lock_clone)
+      new_instance.instance_variable_set(:@nilable, nilable_clone)
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/LineLength
+  end
+end