smart_schema 0.12.1 → 0.12.2

data/lib/smart_core/schema/plugins/dry_types/dry_types/abstract_factory.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module SmartCore::Schema::TypeSystem
+  # @api private
+  # @since 0.12.0
+  class DryTypes::AbstractFactory < Interop::AbstractFactory
+    class << self
+      # @param type [::Dry::Types::Type]
+      # @return [void]
+      #
+      # @raise [SmartCore::Schema::IncorrectTypeObjectError]
+      #
+      # @api private
+      # @since 0.12.0
+      def prevent_incompatible_type!(type)
+        unless type.is_a?(::Dry::Types::Type)
+          raise(
+            SmartCore::Schema::IncorrectTypeObjectError,
+            'Incorrect Dry::Types primitive ' \
+            '(type object should be an object of Dry::Types::Type)'
+          )
+        end
+      end
+
+      # @param type [Any]
+      # @return [String]
+      #
+      # @api private
+      # @since 0.12.0
+      def build_identifier(type)
+        type.name
+      end
+
+      # @param type [::Dry::Types::Type]
+      # @return [SmartCore::Schema::TypeSystem::DryTypes::Operation::Valid]
+      #
+      # @api private
+      # @since 0.12.0
+      def build_valid_operation(type)
+        DryTypes::Operation::Valid.new(type)
+      end
+
+      # @return [::Dry::Types::Any]
+      #
+      # @api private
+      # @since 0.12.0
+      def generic_type_object
+        ::Dry::Types::Any
+      end
+
+      # @return [Class<::Dry::Types::Type>]
+      #
+      # @api private
+      # @since 0.12.0
+      def primitive_type_class
+        ::Dry::Types::Type
+      end
+
+      # @return [::Dry::Types::Type]
+      #
+      # @api private
+      # @since 0.12.1
+      def hash_type_object_for_nested_schemas
+        ::Dry::Types['hash']
+      end
+
+      # @param type [::Dry::Types::Type]
+      # @return [SmartCore::Schema::TypeSystem::DryTypes::Operation::Validate]
+      #
+      # @api private
+      # @since 0.12.0
+      def build_validate_operation(type)
+        DryTypes::Operation::Validate.new(type)
+      end
+
+      # @param type [::Dry::Types::Type]
+      # @return [SmartCore::Schema::TypeSystem::DryTypes::Operation::Cast]
+      #
+      # @api private
+      # @since 0.12.0
+      def build_cast_operation(type)
+        DryTypes::Operation::Cast.new(type)
+      end
+
+      # @param identifier [String]
+      # @param valid_op [SmartCore::Schema::TypeSystem::DryTypes::Operation::Valid]
+      # @param valid_op [SmartCore::Schema::TypeSystem::DryTypes::Operation::Validate]
+      # @param valid_op [SmartCore::Schema::TypeSystem::DryTypes::Operation::Cast]
+      # @return [SmartCore::Schema::TypeSystem::DryTypes]
+      #
+      # @api private
+      # @since 0.12.0
+      # @version 0.5.1
+      def build_interop(identifier, valid_op, validate_op, cast_op)
+        DryTypes.new(identifier, valid_op, validate_op, cast_op)
+      end
+    end
+  end
+end

data/lib/smart_core/schema/plugins/dry_types/dry_types/operation/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SmartCore::Schema::TypeSystem
+  # @abstract
+  # @api private
+  # @since 0.12.0
+  class DryTypes::Operation::Base < Interop::Operation
+  end
+end

data/lib/smart_core/schema/plugins/dry_types/dry_types/operation/cast.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SmartCore::Schema::TypeSystem::DryTypes::Operation
+  # @api private
+  # @since 0.12.0
+  class Cast < Base
+    # @param value [Any]
+    # @return [void]
+    #
+    # @raise [SmartCore::Schema::TypeCastingUnsupportedError]
+    #
+    # @api private
+    # @since 0.12.0
+    def call(value)
+      raise(
+        SmartCore::Schema::TypeCastingUnsupportedError,
+        'DryTypes type system has no support for type casting at the moment.'
+      )
+    end
+  end
+end

data/lib/smart_core/schema/plugins/dry_types/dry_types/operation/valid.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SmartCore::Schema::TypeSystem::DryTypes::Operation
+  # @api private
+  # @since 0.12.0
+  class Valid < Base
+    # @param value [Any]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.12.0
+    def call(value)
+      type.valid?(value)
+    end
+  end
+end

data/lib/smart_core/schema/plugins/dry_types/dry_types/operation/validate.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SmartCore::Schema::TypeSystem::DryTypes::Operation
+  # @api private
+  # @since 0.12.0
+  class Validate < Base
+    # @param value [Any]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.12.0
+    def call(value)
+      raise(
+        SmartCore::Schema::DryTypesValidationError,
+        "Dry::Types validation error: (get #{value.inspect} for type #{type.inspect}"
+      ) unless type.valid?(value)
+    end
+  end
+end

data/lib/smart_core/schema/plugins/dry_types/dry_types/operation.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module SmartCore::Schema::TypeSystem
+  # @api private
+  # @since 0.12.0
+  module DryTypes::Operation
+    require_relative 'operation/base'
+    require_relative 'operation/valid'
+    require_relative 'operation/validate'
+    require_relative 'operation/cast'
+  end
+end

data/lib/smart_core/schema/plugins/dry_types/dry_types.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SmartCore::Schema::TypeSystem
+  # @api public
+  # @since 0.12.0
+  class DryTypes < Interop
+    require_relative 'dry_types/abstract_factory'
+    require_relative 'dry_types/operation'
+  end
+end

data/lib/smart_core/schema/plugins/dry_types/errors.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/StaticClass
+class SmartCore::Schema
+  # @api public
+  # @since 0.12.0
+  DryTypesError = Class.new(SmartCore::Schema::Error)
+
+  # @api public
+  # @since 0.12.0
+  DryTypesValidationError = Class.new(DryTypesError)
+end
+# rubocop:enable Style/StaticClass

data/lib/smart_core/schema/plugins/dry_types.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.12.0
+class SmartCore::Schema::Plugins::DryTypes < SmartCore::Schema::Plugins::Abstract
+  class << self
+    # @return [void]
+    #
+    # @api private
+    # @since 0.12.0
+    def install!
+      raise(
+        SmartCore::Schema::UnresolvedPluginDependencyError,
+        '::Dry::Types does not exist or "dry-types" gem is not loaded'
+      ) unless const_defined?('::Dry::Types')
+
+      # NOTE: add dry-types type system implementation
+      require_relative 'dry_types/errors'
+      require_relative 'dry_types/dry_types'
+
+      # NOTE: register dry-types type system
+      SmartCore::Schema::TypeSystem.register(
+        :dry_types, SmartCore::Schema::TypeSystem::DryTypes
+      )
+    end
+  end
+end

data/lib/smart_core/schema/plugins/registry.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.12.0
+class SmartCore::Schema::Plugins::Registry
+  # @since 0.12.0
+  include Enumerable
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.12.0
+  def initialize
+    @plugin_set = {}
+    @access_lock = SmartCore::Engine::ReadWriteLock.new
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [SmartCore::Schema::Plugins::Abstract]
+  #
+  # @api private
+  # @since 0.12.0
+  def [](plugin_name)
+    @access_lock.read_sync { fetch(plugin_name) }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [SmartCore::Schema::Plugins::Abstract]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.12.0
+  def register(plugin_name, plugin_module)
+    @access_lock.write_sync { apply(plugin_name, plugin_module) }
+  end
+  alias_method :[]=, :register
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.12.0
+  def names
+    @access_lock.read_sync { plugin_names }
+  end
+
+  # @return [Hash<String,Class<SmartCore::Schema::Plugins::Abstract>>]
+  #
+  # @api private
+  # @since 0.12.0
+  def loaded
+    @access_lock.read_sync { loaded_plugins }
+  end
+
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.12.0
+  def each(&block)
+    @access_lock.read_sync { iterate(&block) }
+  end
+
+  private
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.12.0
+  attr_reader :plugin_set
+
+  # @return [Mutex]
+  #
+  # @api private
+  # @since 0.12.0
+  attr_reader :access_lock
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.12.0
+  def plugin_names
+    plugin_set.keys
+  end
+
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.12.0
+  def iterate(&block)
+    block_given? ? plugin_set.each_pair(&block) : plugin_set.each_pair
+  end
+
+  # @param plugin_name [String]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.12.0
+  def registered?(plugin_name)
+    plugin_set.key?(plugin_name)
+  end
+
+  # @return [Array<SmartCore::Schema::Plugins::Abstract>]
+  #
+  # @api private
+  # @since 0.12.0
+  def loaded_plugins
+    plugin_set.select { |_plugin_name, plugin_module| plugin_module.loaded? }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [SmartCore::Schema::Plugins::Abstract]
+  # @return [void]
+  #
+  # @raise [SmartCore::Schema::AlreadyRegisteredPluginError]
+  #
+  # @api private
+  # @since 0.12.0
+  def apply(plugin_name, plugin_module)
+    plugin_name = indifferently_accessible_plugin_name(plugin_name)
+
+    if registered?(plugin_name)
+      raise(SmartCore::Schema::AlreadyRegisteredPluginError, <<~ERROR_MESSAGE)
+        #{plugin_name} plugin already exists
+      ERROR_MESSAGE
+    end
+
+    plugin_set[plugin_name] = plugin_module
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [SmartCore::Schema::Plugins::Abstract]
+  #
+  # @raise [SmartCore::Schema::UnregisteredPluginError]
+  #
+  # @api private
+  # @since 0.12.0
+  def fetch(plugin_name)
+    plugin_name = indifferently_accessible_plugin_name(plugin_name)
+
+    unless registered?(plugin_name)
+      raise(SmartCore::Schema::UnregisteredPluginError, <<~ERROR_MESSAGE)
+        #{plugin_name} plugin is not registered
+      ERROR_MESSAGE
+    end
+
+    plugin_set[plugin_name]
+  end
+
+  # @param key [Symbol, String]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.12.0
+  def indifferently_accessible_plugin_name(plugin_name)
+    plugin_name.to_s
+  end
+end

data/lib/smart_core/schema/plugins/registry_interface.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.12.0
+module SmartCore::Schema::Plugins::RegistryInterface
+  class << self
+    # @param base_module [Class, Module]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.12.0
+    def extended(base_module)
+      base_module.instance_variable_set(
+        :@plugin_registry, SmartCore::Schema::Plugins::Registry.new
+      )
+      base_module.instance_variable_set(
+        :@access_lock, SmartCore::Engine::ReadWriteLock.new
+      )
+    end
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.12.0
+  def load(plugin_name)
+    @access_lock.read_sync { plugin_registry[plugin_name].load! }
+  end
+
+  # @return [Array<String>]
+  #
+  # @api public
+  # @since 0.12.0
+  def loaded_plugins
+    @access_lock.read_sync { plugin_registry.loaded.keys }
+  end
+
+  # @return [Array<String>]
+  #
+  # @api public
+  # @since 0.12.0
+  def names
+    @access_lock.read_sync { plugin_registry.names }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.12.0
+  def register_plugin(plugin_name, plugin_module)
+    @access_lock.write_sync { plugin_registry[plugin_name] = plugin_module }
+  end
+
+  private
+
+  # @return [SmartCore::Schema::Plugins::Registry]
+  #
+  # @api private
+  # @since 0.12.0
+  attr_reader :plugin_registry
+end

data/lib/smart_core/schema/plugins.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.12.0
+module SmartCore::Schema::Plugins
+  require_relative 'plugins/abstract'
+  require_relative 'plugins/registry'
+  require_relative 'plugins/registry_interface'
+  require_relative 'plugins/access_mixin'
+  require_relative 'plugins/dry_types'
+
+  # @since 0.12.0
+  extend SmartCore::Schema::Plugins::RegistryInterface
+
+  # @since 0.12.0
+  register_plugin('dry_types', SmartCore::Schema::Plugins::DryTypes)
+end

data/lib/smart_core/schema/result.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+# @version 0.3.0
+class SmartCore::Schema::Result
+  # @return [Hash<String,Any>]
+  #
+  # @api public
+  # @since 0.1.0
+  attr_reader :source
+
+  # @return [Hash<String,Array<Symbol>>]
+  #
+  # @api public
+  # @since 0.1.0
+  attr_reader :errors
+
+  # @return [Set<String>]
+  #
+  # @api public
+  # @since 0.1.0
+  attr_reader :extra_keys
+
+  # @return [Set<String>]
+  #
+  # @api public
+  # @since 0.3.0
+  attr_reader :spread_keys
+
+  # @param source [Hash<String|Symbol,Any>]
+  # @param errors [Hash<String,Array<Symbol>]
+  # @param extra_keys [Set<String>]
+  # @param spread_keys [Set<String>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  # @version 0.3.0
+  def initialize(source, errors, extra_keys, spread_keys)
+    @source = source
+    @errors = errors
+    @extra_keys = extra_keys
+    @spread_keys = spread_keys
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.1.0
+  def success?
+    errors.empty? && extra_keys.empty?
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.1.0
+  def failure?
+    errors.any? || extra_keys.any?
+  end
+end

data/lib/smart_core/schema/type_system/interop/abstract_factory.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# @abstract
+# @api private
+# @since 0.12.0
+class SmartCore::Schema::TypeSystem::Interop::AbstractFactory
+  class << self
+    # @param type [Any]
+    # @return [SmartCore::Schema::TypeSystem::Interop]
+    #
+    # @api private
+    # @since 0.12.0
+    def create(type)
+      prevent_incompatible_type!(type)
+
+      identifier = build_identifier(type)
+      valid_op = build_valid_operation(type)
+      validate_op = build_validate_operation(type)
+      cast_op = build_cast_operation(type)
+
+      build_interop(identifier, valid_op, validate_op, cast_op)
+    end
+
+    # @return [Any]
+    #
+    # @api private
+    # @since 0.12.0
+    def generic_type_object; end
+
+    # @param type [Any]
+    # @return [String]
+    #
+    # @api private
+    # @since 0.5.1
+    def build_identifier(type); end
+
+    # @param type [Any]
+    # @return [void]
+    #
+    # @raise [SmartCore::Schema::IncorrectTypeObjectError]
+    #
+    # @api private
+    # @since 0.12.0
+    def prevent_incompatible_type!(type); end
+
+    # @return [Class]
+    #
+    # @api private
+    # @since 0.12.1
+    def primitive_type_class; end
+
+    # @return [Any]
+    #
+    # @api private
+    # @since 0.12.1
+    def hash_type_object_for_nested_schemas; end
+
+    private
+
+    # @param type [Any]
+    # @return [SmartCore::Schema::TypeSystem::Interop::Operation]
+    #
+    # @api private
+    # @since 0.12.0
+    def build_valid_operation(type); end
+
+    # @param type [Any]
+    # @return [SmartCore::Schema::TypeSystem::Interop::Operation]
+    #
+    # @api private
+    # @since 0.12.0
+    def build_validate_operation(type); end
+
+    # @param type [Any]
+    # @return [SmartCore::Schema::TypeSystem::Interop::Operation]
+    #
+    # @api private
+    # @since 0.12.0
+    def build_cast_operation(type); end
+
+    # @param identifier [String]
+    # @param valid_op [SmartCore::Schema::TypeSystem::Interop::Operation]
+    # @param validate_op [SmartCore::Schema::TypeSystem::Interop::Operation]
+    # @param cast_op [SmartCore::Schema::TypeSystem::Interop::Operation]
+    # @return [SmartCore::Schema::TypeSystem::Interop]
+    #
+    # @api private
+    # @since 0.12.0
+    # @version 0.5.1
+    def build_interop(identifier, valid_op, validate_op, cast_op); end
+  end
+end