hexx 5.4.0 → 6.0.0

data/lib/hexx/dependencies.rb

@@ -1,182 +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::Dependencies
-  #     self.depends_on :get_item, :add_item, :delete_item
-  #   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 = "AnotherGem::Services::Add"
-  #   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.add_item     # => AnotherGem::Services::Add
-  #   MyGem.delete_item  # raises #<NotImplementedError ... >
-  module Dependencies
-
-    # Yields a block and gives it self
-    #
-    # @example
-    #   module MyGem
-    #     extend Hexx::Dependencies
-    #   end
-    #
-    #   MyGem.configure do |config|
-    #     c # => MyGem
-    #   end
-    #
-    # @yield The block.
-    # @yieldparam [Dependencies] +self+.
-    def configure
-      yield(self)
-    end
-
-    # Declares dependency getter and setter.
-    #
-    # The getter constants, strings and symbols. The setter constantize the
-    # assigned value.
-    #
-    # This allows setting dependency before definition of a corresponding
-    # constant.
-    #
-    # @example
-    #   module MyGem
-    #     extend Hexx::Dependencies
-    #     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 set as a plain list of names
-    #   module MyGem
-    #     extend Hexx::Dependencies
-    #     self.depends_on :some_class, "another_class"
-    #   end
-    #
-    # @example Dependencies can be set as an array of names
-    #   module MyGem
-    #     extend Hexx::Dependencies
-    #     self.depends_on %w(some_class another_class)
-    #   end
-    #
-    # @param  [Array<String, Symbol>] names The list of names for dependencies.
-    def depends_on(*names, default: nil)
-      names.flatten.each do |name|
-        DependencyName.new(name).validate
-        add_dependency_setter name
-        add_dependency_getter name, default
-      end
-    end
-
-    private
-
-    # @api hide
-    # Checks the name of the dependency.
-    class DependencyName < Struct.new(:name)
-
-      # @api hide
-      # Runs validations and fails in case of any error.
-      # @raise [TypeError] if the name has a wrong type.
-      # @raise [ArgumentError] if the name is blank.
-      def validate
-        check_type
-        check_value
-      end
-
-      private
-
-      def check_type
-        return if [String, Symbol].include? name.class
-        fail TypeError.new "#{ name.inspect } is neither a string nor symbol."
-      end
-
-      def check_value
-        return unless name.to_s == ""
-        fail ArgumentError.new "The dependency name should not be blank."
-      end
-    end
-
-    # @api hide
-    # Checks the value of the dependency.
-    class Dependency < Struct.new(:name, :value)
-
-      # @api hide
-      # Runs validations and fails in case of any error.
-      # @raise [TypeError] if the value has a wrong type.
-      # @raise [ArgumentError] if the value name is blank.
-      def validate
-        check_type
-        check_value
-      end
-
-      private
-
-      def check_type
-        return if value.is_a? String
-        return if value.is_a? Symbol
-        return if value.is_a? Module
-        fail TypeError.new "#{ inspect } is not a string, symbol or module."
-      end
-
-      def check_value
-        return unless value.to_s == ""
-        fail ArgumentError.new "The dependency #{ name } should not be blank."
-      end
-
-      def inspect
-        value.inspect
-      end
-    end
-
-    def add_dependency_setter(name)
-      instance_eval "
-        def #{ name }=(value);
-          Dependency.new(:#{ name }, value).validate;
-          @#{ name }= value.to_s;
-        end"
-    end
-
-    def add_dependency_getter(name, default)
-      instance_eval "
-        def #{ name };
-          value = @#{ default_name name, default };
-          constantize(value);
-        end"
-    end
-
-    def constantize(value)
-      value.is_a?(Module) ? value : Kernel.const_get(value.to_s)
-    end
-
-    def default_name(name, default)
-      [name, default].compact.map(&:to_s).join " || "
-    end
-  end
-end

data/lib/hexx/models/base_coercer.rb

@@ -1,44 +0,0 @@
-module Hexx
-  module Models
-
-    # @api hide
-    # Coerces class attribute getter and setter with given type.
-    class BaseCoercer < Struct.new(:klass, :name, :type)
-
-      # Coerces class attribute's getter and setter.
-      #
-      # @example
-      #   BaseCoercer.new SomeModel, :name, StrippedString
-      #   BaseCoercer.coerce
-      #
-      #   model = SomeModel.new name: "string"
-      #   model.name.class # => StrippedString
-      def coerce
-        coerce_setter
-        coerce_getter
-      end
-
-      private
-
-      def coerce_setter
-        klass.class_eval(
-          "def #{ name };
-            #{ type_name }.new(@#{ name });
-          end"
-        )
-      end
-
-      def coerce_getter
-        klass.class_eval(
-          "def #{ name }=(value);
-            @#{ name } = #{ type_name }.new(value);
-          end"
-        )
-      end
-
-      def type_name
-        @type_name ||= type.name
-      end
-    end
-  end
-end

data/lib/hexx/service/parameters.rb

@@ -1,81 +0,0 @@
-module Hexx
-  class Service
-
-    # @api hide
-    # Contains methods to declare parameters and set their values.
-    module Parameters
-      extend ActiveSupport::Concern
-
-      # Methods to declare and allow services params.
-      module ClassMethods
-
-        # @!attribute [r] params
-        # The list of allowed instance parameters. The parameters are added
-        # to the list by the {.allow_params} method.
-        #
-        # @example
-        #   class Service
-        #     include Parameters
-        #     allow_params :name
-        #   end
-        #
-        #   Service.params # => "name"
-        #
-        # @return [Array<String>] The list of allowed instance parameters.
-        def params
-          @params ||= []
-        end
-
-        private
-
-        # Sets a list of allowed parameters for the class constructor and
-        # defines the corresponding instance attributes.
-        #
-        # @example (see Hexx::Service::Parameters.params)
-        # @param [Array<Symbol, String>] keys The list of allowed parameters.
-        def allow_params(*keys)
-          @params = keys.map(&:to_s)
-          define_individual_params
-        end
-
-        def define_individual_params
-          params.each do |name|
-            add_getter(name)
-            add_setter(name)
-          end
-        end
-
-        def add_getter(name)
-          define_method(name) { params[name] }
-        end
-
-        def add_setter(name)
-          define_method("#{name}=") { |value| params[name] = value }
-        end
-      end
-
-      # @!method new(params)
-      # Constructs a service object with a hash of parameters.
-      #
-      # @example
-      #   Service.new name: "name"
-      #
-      # @param [Hash] params ({}) The parameters of the service object.
-      def initialize(params = {})
-        extract_params_from params
-      end
-
-      # @!attribute [r] params
-      # The parameters of the service objects. The parameters are set on
-      # the object initialization, then are stringified and whitelisted.
-      # @return [Hash] the service object parameters.
-      attr_reader :params
-
-      private
-
-      def extract_params_from(hash)
-        @params = hash.stringify_keys.slice(*(self.class.params))
-      end
-    end
-  end
-end

data/spec/hexx/models_spec.rb

@@ -1,40 +0,0 @@
-require "spec_helper"
-
-module Hexx
-  describe Models do
-
-    # ==========================================================================
-    # Prepare environment
-    # ==========================================================================
-
-    around do |example|
-      class TestModel; extend Models; end
-      class TestAttribute; end
-      example.run
-      Hexx.send :remove_const, :TestAttribute
-      Hexx.send :remove_const, :TestModel
-    end
-
-    let!(:coerced_attribute) { double "coerced attribute" }
-    before do
-      allow(TestAttribute).to receive(:new) { |val| coerced_attribute if val }
-    end
-
-    # ==========================================================================
-    # Run tests
-    # ==========================================================================
-
-    describe ".attr_coerced" do
-
-      subject      { TestModel }
-      before       { subject.send :attr_coerced, :name, type: TestAttribute }
-      let(:object) { TestModel.new }
-
-      it "coerces an attribute with given type" do
-        expect { object.name = "some name" }
-          .to change { object.name }
-          .from(nil).to coerced_attribute
-      end
-    end
-  end
-end