smart_initializer 0.1.0.alpha4 → 0.1.0

data/lib/smart_core/initializer/plugins/access_mixin.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SmartCore::Initializer::Plugins::AccessMixin
+  # @param plugin_name [Symbol, String]
+  # @return [void]
+  #
+  # @see SmartCore::Initializer::Plugins
+  #
+  # @api public
+  # @since 0.1.0
+  def plugin(plugin_name)
+    SmartCore::Initializer::Plugins.load(plugin_name)
+  end
+
+  # @return [Array<String>]
+  #
+  # @see SmartCore::Initializer::Plugins
+  #
+  # @api public
+  # @since 0.1.0
+  def plugins
+    SmartCore::Initializer::Plugins.names
+  end
+
+  # @return [Hash<String,Class<SmartCore::Initializer::Plugins::Abstract>>]
+  #
+  # @api private
+  # @since 0.1.0
+  def loaded_plugins
+    SmartCore::Initializer::Plugins.loaded_plugins
+  end
+  alias_method :enabled_plugins, :loaded_plugins
+
+  # @param plugin_name [String, Symbol]
+  # @param plugin_klass [Class<SmartCore::Initializer::Plugins::Abstract>]
+  # @return [void]
+  #
+  # @see SmartCore::Initializer::Plugins
+  #
+  # @api public
+  # @since 0.1.0
+  def register_plugin(plugin_name, plugin_klass)
+    SmartCore::Initializer::Plugins.register_plugin(plugin_name, plugin_klass)
+  end
+end

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

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::Plugins::Registry
+  # @since 0.1.0
+  include Enumerable
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize
+    @plugin_set = {}
+    @access_lock = Mutex.new
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [SmartCore::Initializer::Plugins::Abstract]
+  #
+  # @api private
+  # @since 0.1.0
+  def [](plugin_name)
+    thread_safe { fetch(plugin_name) }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [SmartCore::Initializer::Plugins::Abstract]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def register(plugin_name, plugin_module)
+    thread_safe { apply(plugin_name, plugin_module) }
+  end
+  alias_method :[]=, :register
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.1.0
+  def names
+    thread_safe { plugin_names }
+  end
+
+  # @return [Hash<String,Class<SmartCore::Initializer::Plugins::Abstract>>]
+  #
+  # @api private
+  # @since 0.1.0
+  def loaded
+    thread_safe { loaded_plugins }
+  end
+
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.1.0
+  def each(&block)
+    thread_safe { iterate(&block) }
+  end
+
+  private
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :plugin_set
+
+  # @return [Mutex]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :access_lock
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def thread_safe
+    access_lock.synchronize { yield if block_given? }
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.1.0
+  def plugin_names
+    plugin_set.keys
+  end
+
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.1.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.1.0
+  def registered?(plugin_name)
+    plugin_set.key?(plugin_name)
+  end
+
+  # @return [Array<SmartCore::Initializer::Plugins::Abstract>]
+  #
+  # @api private
+  # @since 0.1.0
+  def loaded_plugins
+    plugin_set.select { |_plugin_name, plugin_module| plugin_module.loaded? }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [SmartCore::Initializer::Plugins::Abstract]
+  # @return [void]
+  #
+  # @raise [SmartCore::Initializer::AlreadyRegisteredPluginError]
+  #
+  # @api private
+  # @since 0.1.0
+  def apply(plugin_name, plugin_module)
+    plugin_name = indifferently_accessible_plugin_name(plugin_name)
+
+    if registered?(plugin_name)
+      raise(SmartCore::Initializer::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::Initializer::Plugins::Abstract]
+  #
+  # @raise [SmartCore::Initializer::UnregisteredPluginError]
+  #
+  # @api private
+  # @since 0.1.0
+  def fetch(plugin_name)
+    plugin_name = indifferently_accessible_plugin_name(plugin_name)
+
+    unless registered?(plugin_name)
+      raise(SmartCore::Initializer::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.1.0
+  def indifferently_accessible_plugin_name(plugin_name)
+    plugin_name.to_s
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SmartCore::Initializer::Plugins::RegistryInterface
+  class << self
+    # @param base_module [Class, Module]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def extended(base_module)
+      base_module.instance_variable_set(
+        :@plugin_registry, SmartCore::Initializer::Plugins::Registry.new
+      )
+      base_module.instance_variable_set(
+        :@access_lock, SmartCore::Engine::Lock.new
+      )
+    end
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.1.0
+  def load(plugin_name)
+    thread_safe { plugin_registry[plugin_name].load! }
+  end
+
+  # @return [Array<String>]
+  #
+  # @api public
+  # @since 0.1.0
+  def loaded_plugins
+    thread_safe { plugin_registry.loaded.keys }
+  end
+
+  # @return [Array<String>]
+  #
+  # @api public
+  # @since 0.1.0
+  def names
+    thread_safe { plugin_registry.names }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def register_plugin(plugin_name, plugin_module)
+    thread_safe { plugin_registry[plugin_name] = plugin_module }
+  end
+
+  private
+
+  # @return [SmartCore::Initializer::Plugins::Registry]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :plugin_registry
+
+  # @return [SmartCore::Engine::Lock]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :access_lock
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def thread_safe
+    access_lock.synchronize { yield if block_given? }
+  end
+end

data/lib/smart_core/initializer/plugins/thy_types.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Initializer::Plugins::ThyTypes < SmartCore::Initializer::Plugins::Abstract
+  class << self
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def install!
+      raise(
+        SmartCore::Initializer::UnresolvedPluginDependencyError,
+        '::Thy does not exist or "thy" gem is not loaded'
+      ) unless const_defined?('::Thy')
+
+      # NOTE: require necessary dependencies
+      require 'date'
+
+      # NOTE: add thy-types type system implementation
+      require_relative 'thy_types/errors'
+      require_relative 'thy_types/thy_types'
+
+      # NOTE: register thy-types type system
+      SmartCore::Initializer::TypeSystem.register(
+        :thy_types, SmartCore::Initializer::TypeSystem::ThyTypes
+      )
+    end
+  end
+end

data/lib/smart_core/initializer/plugins/thy_types/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SmartCore::Initializer
+  # @api public
+  # @since 0.1.0
+  ThyTypesError = Class.new(SmartCore::Initializer::Error)
+
+  # @api public
+  # @since 0.1.0
+  ThyTypeValidationError = Class.new(ThyTypesError)
+end

data/lib/smart_core/initializer/plugins/thy_types/thy_types.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SmartCore::Initializer::TypeSystem
+  # @api public
+  # @since 0.1.0
+  class ThyTypes < Interop
+    require_relative 'thy_types/abstract_factory'
+    require_relative 'thy_types/operation'
+
+    type_alias(:any, AbstractFactory.generic_type_object)
+    type_alias(:nil, ::Thy::Types::Nil)
+    type_alias(:string, ::Thy::Types::String)
+    type_alias(:symbol, ::Thy::Types::Symbol)
+    type_alias(:integer, ::Thy::Types::Integer)
+    type_alias(:float, ::Thy::Types::Float)
+    type_alias(:numeric, ::Thy::Types::Numeric)
+    type_alias(:boolean, ::Thy::Types::Boolean)
+    type_alias(:time, ::Thy::Types::Time)
+    type_alias(:date_time, ::Thy::Types::DateTime)
+    type_alias(:untyped_array, ::Thy::Types::UntypedArray)
+    type_alias(:untyped_hash, ::Thy::Types::UntypedHash)
+  end
+end

data/lib/smart_core/initializer/plugins/thy_types/thy_types/abstract_factory.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module SmartCore::Initializer::TypeSystem
+  # @api private
+  # @since 0.1.0
+  class ThyTypes::AbstractFactory < Interop::AbstractFactory
+    # @return [Thy::Type]
+    #
+    # @api private
+    # @since 0.1.0
+    GENERIC_TYPE = ::Thy::Type.new { true }
+
+    class << self
+      # @param type [Thy::Type, #check]
+      # @return [void]
+      #
+      # @raise [SmartCore::Initializer::IncorrectTypeObjectError]
+      #
+      # @api private
+      # @since 0.1.0
+      def prevent_incompatible_type!(type)
+        unless type.respond_to?(:check) || type.is_a?(::Thy::Type)
+          raise(
+            SmartCore::Initializer::IncorrectTypeObjectError,
+            'Incorrect Thy::Type primitive ' \
+            '(type object should respond to :check method)'
+          )
+        end
+      end
+
+      # @param type [Thy::Type, #check]
+      # @return [SmartCore::Initializer::TypeSystem::ThyTypes::Operation::Valid]
+      #
+      # @api private
+      # @since 0.1.0
+      def build_valid_operation(type)
+        ThyTypes::Operation::Valid.new(type)
+      end
+
+      # @return [Thy::Type, #check]
+      #
+      # @api private
+      # @since 0.1.0
+      def generic_type_object
+        GENERIC_TYPE
+      end
+
+      # @param type [Thy::Type, #check]
+      # @return [SmartCore::Initializer::TypeSystem::ThyTypes::Operation::Validate]
+      #
+      # @api private
+      # @since 0.1.0
+      def build_validate_operation(type)
+        ThyTypes::Operation::Validate.new(type)
+      end
+
+      # @param type [Thy::Type, #check]
+      # @return [SmartCore::Initializer::TypeSystem::ThyTypes::Operation::Cast]
+      #
+      # @api private
+      # @since 0.1.0
+      def build_cast_operation(type)
+        ThyTypes::Operation::Cast.new(type)
+      end
+
+      # @param valid_op [SmartCore::Initializer::TypeSystem::ThyTypes::Operation::Valid]
+      # @param valid_op [SmartCore::Initializer::TypeSystem::ThyTypes::Operation::Validate]
+      # @param valid_op [SmartCore::Initializer::TypeSystem::ThyTypes::Operation::Cast]
+      # @return [SmartCore::Initializer::TypeSystem::ThyTypes]
+      #
+      # @api private
+      # @since 0.1.0
+      def build_interop(valid_op, validate_op, cast_op)
+        ThyTypes.new(valid_op, validate_op, cast_op)
+      end
+    end
+  end
+end

data/lib/smart_core/initializer/plugins/thy_types/thy_types/operation.rb

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