hexx 7.1.0 → 8.0.0

data/lib/hexx/coercible.rb

@@ -1,43 +0,0 @@
-# encoding: utf-8
-
-module Hexx
-
-  # Declares the +attr_coerced+ private class method.
-  #
-  # @example
-  #
-  #   require "hexx"
-  #   require_relative "attributes/string"
-  #
-  #   class User
-  #     extend Hexx::Coercible
-  #     attr_coerced :name, type: ActiveSupport::Multibyte::Chars
-  #   end
-  #
-  #   # This will coerce user name with mb chars:
-  #   user = User.new name: "Иоанн"
-  #   user.name
-  #   # => #<ActiveSupport::Multibyte::Chars @wrapped_string = "Иоанн">
-  module Coercible
-
-    private
-
-    # @!method attr_coerced(*names, options)
-    # Coerced the attribute(s) with given type.
-    # @example (see Hexx::Coercible)
-    # @param [Array<Symbol, String>] names The list of attributes to be coerced.
-    # @param [Hash] options The coercion options.
-    # @option options [Class] :type The class for coercion.
-    def attr_coerced(*names, type:)
-      names.flatten.each { |name| coercion.add self, name, type }
-    end
-
-    # @api hide
-    # The method returns a coercion creator for PORO object only.
-    # To be reloaded for ActiveRecord models
-    # @return [Class] attribute coercion (Hexx::Creators::Coercion by default)
-    def coercion
-      Hexx::Creators::Coercion
-    end
-  end
-end

data/lib/hexx/configurable.rb

@@ -1,101 +0,0 @@
-# encoding: utf-8
-
-module Hexx
-
-  # Contains methods to declare and inject module dependencies.
-  #
-  # Allows to provide DJ framework for the gem.
-  #
-  # @example
-  #   # Declare the dependencies for the gem root module
-  #
-  #   # lib/my_gem.rb
-  #   module MyGem
-  #     extend Hexx::Configurable
-  #     self.depends_on :get_item, :add_item
-  #     self.depends_on :delete_item, default: DeleteItem
-  #   end
-  #
-  #   # Inject dependencies (as a constant or its name)
-  #
-  #   # config/my_gem.rb
-  #   MyGem.configure do |config|
-  #     config.get_item = AnotherGem::Services::Get
-  #     config.add_item
-  #   end
-  #
-  #   # Use dependency in the module code (models, services, etc.)
-  #   # When the dependency hasn't been set, fails with +NotImplementedError+
-  #
-  #   MyGem.get_item # => AnotherGem::Services::Get
-  #   MyGem.get_item # => DeleteItem
-  #   MyGem.add_item # fails with a NotImplementedError
-  module Configurable
-
-    # Yields a block and gives it self
-    #
-    # @example
-    #   module MyGem
-    #     extend Hexx::Configurable
-    #   end
-    #
-    #   MyGem.configure do |config|
-    #     c # => MyGem
-    #   end
-    #
-    # @yield The block.
-    # @yieldparam [Hexx::Configurable] +self+.
-    def configure
-      yield(self)
-    end
-
-    # @!method depends_on(*names, options)
-    # Declares a dependency getter and setter.
-    #
-    # @example
-    #   module MyGem
-    #     extend Hexx::Configurable
-    #     self.depends_on :some_class
-    #   end
-    #
-    #   MyGem.some_class = String
-    #   # => "String"
-    #   MyGem.some_class # => String
-    #
-    #   MyGem.some_class = "String"
-    #   # => "String"
-    #   MyGem.some_class # => String
-    #
-    #   MyGem.some_class = :String
-    #   # => "String"
-    #   MyGem.some_class # => String
-    #
-    # @example Dependencies can be declared by a plain list of names
-    #   module MyGem
-    #     extend Hexx::Configurable
-    #     self.depends_on :some_class, "another_class"
-    #   end
-    #
-    # @example Dependencies can be declared by an array of names
-    #   module MyGem
-    #     extend Hexx::Configurable
-    #     self.depends_on %w(some_class another_class)
-    #   end
-    #
-    # @example A dependency can have default implementation
-    #   module MyGem
-    #     extend Hexx::Configurable
-    #     self.depends_on :item, default: Item
-    #   end
-    #
-    # @param [Array<String, Symbol>] names The list of names for dependencies.
-    # @param [Hash] options The list of options for dependency declaration.
-    # @option options [Module, nil] :default (nil) The default implementation
-    #   for the dependency.
-    def depends_on(*names, default: nil)
-      names.flatten.each do |name|
-        Creators::ModuleDependency.add self, name, default
-      end
-    end
-  end
-end

data/lib/hexx/creators/base.rb

@@ -1,103 +0,0 @@
-# encoding: utf-8
-
-module Hexx
-
-  # @api hide
-  # The module contains classes that adds specific attributes
-  # to given classes or modules.
-  module Creators
-
-    # @api hide
-    # @abstract
-    # The base class for attribute injection.
-    #
-    # The objects of the class validates its parameters and adds
-    # attribute's getter and setter into the target class or module.
-    class Base < Struct.new(:target, :name)
-
-      # @api hide
-      # @!method add(target, name)
-      # Injects an attribute to the target class.
-      #
-      # @param  [Module] target The class or module to inject the attribute to.
-      # @param  [String, Symbol] name The name of the attribute.
-      # @raise  (see Hexx::Creators::Base#validate)
-      # @return [Hexx::Creators::Base] the base class object.
-      def self.add(*args)
-        new(*args).validate.add_getter.add_setter
-      end
-
-      # @api hide
-      # @!attribute target
-      # The class to inject the attribute to
-      # @return [Class] the target for the injection
-
-      # @api hide
-      # @!attribute name
-      # The name of the attribute to be created in a target class
-      # @return [Class] the name of the attribute
-
-      # @api hide
-      # Validates parameters of the dependency declaration.
-      #
-      # @raise  (see Hexx::Creators::Base#check_target)
-      # @raise  (see Hexx::Creators::Base#check_name_type)
-      # @raise  (see Hexx::Creators::Base#check_name_value)
-      # @return [Hexx::Creators::Base] +self+
-      def validate
-        check_target
-        check_name_type
-        check_name_value
-        self
-      end
-
-      # @api hide
-      # Adds the parameter getter to the +target+ instance
-      # @return [Hexx::Creators::Base] +self+
-      def add_getter
-        target.class_eval getter
-        self
-      end
-
-      # @api hide
-      # Adds the parameter setter to the +target+ instance
-      # @return [Hexx::Creators::Base] +self+
-      def add_setter
-        target.class_eval setter
-        self
-      end
-
-      private
-
-      # @abstract
-      def getter
-      end
-
-      # @abstract
-      def setter
-      end
-
-      # @api hide
-      # @raise [TypeError] if a target to add the instance parameter to
-      #   is not a class.
-      def check_target
-        return if target.is_a? Class
-        fail TypeError.new "#{ target.inspect } is not a class"
-      end
-
-      # @api hide
-      # @raise [TypeError] if the attribute name is neither a string nor symbol.
-      def check_name_type
-        return if name.is_a?(String) || name.is_a?(Symbol)
-        fail TypeError.new "#{ name.inspect } is neither string nor symbol"
-      end
-
-      # @api hide
-      # @raise [AttributeError] it the name is blank.
-      def check_name_value
-        return unless name.to_s == ""
-        fail ArgumentError.new "Dependency should have a name"
-      end
-    end
-  end
-end

data/lib/hexx/creators/coercion.rb

@@ -1,82 +0,0 @@
-# encoding: utf-8
-require_relative "base"
-
-module Hexx
-  module Creators
-
-    # @api hide
-    # Coerces class attribute getter and setter with given type.
-    #
-    # @example
-    #   Coercion.add MyClass, :name, Multibyte::Chars
-    #   object = MyClass.new
-    #
-    #   object.name = "Ivo"
-    #   object.name
-    #   # => #<Multibyte::Chars @wrapped_string="Ivo" >
-    class Coercion < Base
-
-      # @api hide
-      # @!scope class
-      # @!method add(target, name, type)
-      # Reloads the Base class initializer by adding the type of the attribute
-      # to coerce with.
-      #
-      # @example (see Hexx::Creators::Coercion)
-      # @param  (see Hexx::Creators::Base.add)
-      # @param  [Module] type The type of the attribute.
-      # @raise  (see Hexx::Creators::Coercion#validate)
-      # @return [Hexx::Creators::Coercion] the coercion object.
-      def initialize(target, name, type)
-        super target, name
-        @type = type
-      end
-
-      # @!attribute type
-      # The type to coerce the attribute with
-      # @return [Class] the type of the attribute
-      attr_accessor :type
-
-      # @api hide
-      # Validates parameters of the coercion declaration.
-      #
-      # Adds validation of the coercion type to the
-      # {Hexx::Helper::Base#validate}.
-      #
-      # @raise  (see Hexx::Creators::Base.validate)
-      # @raise  (see Hexx::Creators::Coercion#check_type)
-      # @return [Hexx::Creators::Coercion] +self+
-      def validate
-        check_type
-        super
-      end
-
-      private
-
-      # @api hide
-      # The definition of the coerced attribute getter.
-      # To be reloaded for ActiveRecord models.
-      def getter
-        "def #{ name }=(value);
-           @#{ name } = #{ type.name }.new(value);
-         end"
-      end
-
-      # @api hide
-      # The definition of the coerced attribute setter.
-      # To be reloaded for ActiveRecord models.
-      def setter
-        "def #{ name };
-           #{ type.name }.new(@#{ name });
-         end"
-      end
-
-      # @api hide
-      # @raise [TypeError] if type is not a class
-      def check_type
-        return if type.is_a? Class
-        fail TypeError.new "#{ type.inspect } is not a class"
-      end
-    end
-  end
-end

data/lib/hexx/creators/dependency.rb

@@ -1,87 +0,0 @@
-# encoding: utf-8
-require_relative "base"
-
-module Hexx
-  module Creators
-
-    # @api hide
-    # @abstract
-    # The base class for both instance and module dependencies.
-    class Dependency < Base
-
-      # @api hide
-      # @!scope class
-      # @!method add(target, name, default)
-      # Reloads the Base class initializer by adding the default implementation
-      # for the dependency.
-      #
-      # @param  (see Hexx::Creators::Base)
-      # @param  [Module] default The default implementation for the dependency.
-      # @raise  (see Hexx::Creators::Dependency#validate)
-      # @return [Hexx::Creators::Dependency] the dependency object.
-      def initialize(target, name, default)
-        super target, name
-        @default = default
-      end
-
-      # @!attribute default
-      # The default implementation for the dependency
-      # @return [Module] the default implementation
-      attr_accessor :default
-
-      # @api hide
-      # Validates parameters for the dependency declaration.
-      #
-      # Adds validation of the dependency default implementation to the
-      # {Hexx::Helper::Base#validate}.
-      #
-      # @raise  (see Hexx::Creators::Base#validate)
-      # @raise  (see Hexx::Creators::Dependency#check_default)
-      # @return [Hexx::Creators::Dependency] +self+
-      def validate
-        check_default
-        super
-      end
-
-      private
-
-      # @api hide
-      # The dependency getter
-      def getter
-        "def #{ name };
-           @#{ name } ||= #{ default_name };
-           return @#{ name } if @#{ name };
-           fail NotImplementedError
-             .new \"DI: #{ target.name }##{ name } not implemented\";
-         end"
-      end
-
-      # @api hide
-      # The dependency setter
-      def setter
-        "def #{ name }=(value);
-           if value.nil? || value.is_a?(Module);
-             @#{ name } = value;
-             #{ name };
-           else;
-             fail TypeError.new \"DI: \#{ value.inspect } is not a module\";
-           end;
-         end"
-      end
-
-      # @api hide
-      # @raise [TypeError] if the default implementation is neither a class,
-      #   nor module
-      def check_default
-        return if default.nil? || default.is_a?(Module)
-        fail TypeError.new "#{ default.inspect } is neither a class nor module"
-      end
-
-      # @api hide
-      # Returns the name of the default implementation of the dependency.
-      def default_name
-        @default_name ||= default ? default.name : "nil"
-      end
-    end
-  end
-end

data/lib/hexx/creators/module_dependency.rb

@@ -1,57 +0,0 @@
-# encoding: utf-8
-require_relative "dependency"
-
-module Hexx
-  module Creators
-
-    # @api hide
-    # Module dependency constructor.
-    #
-    # Adds the dependency to selected module.
-    #
-    # @example
-    #   ModuleDependency.add(MyModule, :some_module, DefaultImplementation)
-    #
-    #   MyModule.some_module
-    #   # => DefaultImplementation
-    #
-    #   MyModule.some_module = AnotherImplementation
-    #   # => AnotherImplementation
-    #
-    #   MyModule.some_module = 1
-    #   # fails with #<TypeError @message="1 is not a module" >
-    class ModuleDependency < Dependency
-
-      # @api hide
-      # Adds the dependency to given module
-      # @example (see Hexx::Creators::ModuleDependency)
-      # @param [Module] target The module to declare the dependency of.
-      # @param [String, Symbol] name The name of the dependency.
-      # @param [Module] default The default implementation of the dependency.
-
-      # @api hide
-      # Adds the module dependency getter
-      # @return [ModuleDependency] +self+.
-      def add_getter
-        target.instance_eval getter
-        self
-      end
-
-      # @api hide
-      # Adds the module dependency setter
-      # @return [ModuleDependency] +self+.
-      def add_setter
-        target.instance_eval setter
-        self
-      end
-
-      private
-
-      # @raise [TypeError] if a target to add the dependency is not a module.
-      def check_target
-        return if target.is_a? Module
-        fail TypeError.new "#{ target.inspect } is not a module"
-      end
-    end
-  end
-end