hexx 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7290018a93943ca2db70630dac37ed9d1b2eabfe
-  data.tar.gz: 04b3a2c21598e88beda09d3f2a8bcee7622ba105
+  metadata.gz: 7a0f508972f47609f09b6b7b303ee55c0268256e
+  data.tar.gz: a3c0760ee8824891234b4b6b0c48d29c47c4eecd
 SHA512:
-  metadata.gz: e93648cc19a96e0dca81731ce200b443a4d10e394356e329f0995061cf5ea9656758f42a382b65d465125baa6bc38013f94f5d39b2d00ffe3c04922c6317c5db
-  data.tar.gz: 4169b5355f71c1a1bb1c431edacb47e68d81990c6b74c6164a71aebc5d0b85c098be054f9f6789239c4c371b26144224e4379e78bc3f36b1b5764af7a909a1fd
+  metadata.gz: fc2de5bffc7cfc7fd0cdfc75b6a3fad2b2f657cfa80e28e1b90980af0d746d244a546a86ef125164001518fd89f30adb1f3023b3dc7cff09a2d0761ab484bf00
+  data.tar.gz: 81442ee8209ef2b7e4c3ac9e5b37f5ff8f94e3a63dbe6dd193dea1d0b9623b2e6f7c90e812a696630cea08f634989a9d154f2c7f822c705cb57be6d572422c08

data/README.rdoc

@@ -139,6 +139,32 @@ preparation:
   user = User.name " Ivan  "
   user.name # => "Ivan"
 
+== Dependencies
+
+The module provides methods +depends_on+ and +config+ to create
+dependency injection framework.
+
+Declare gem dependencies (external classes and modules).
+
+  # lib/my_gem.rb
+  module MyGem
+    extend Hexx::Dependencies
+    depends_on :get_item, :add_item
+  end
+
+Inject gem dependencies:
+
+  # config/my_gem.rb
+  MyGem.configure do |config|
+    config.get_item = AnotherGem::Services::Get   # as a constant
+    config.add_item = "AnotherGem::Services::Add" # as a name of a constant
+  end
+
+Use them somewhere in a code:
+
+  MyGem.get_item # => AnotherGem::Services::Get
+  MyGem.add_item # => AnotherGem::Services::Add   # the name is constantized
+
 == Relevant Links
 
 * Matt Wynne's talk {Hexagonal Rails}[http://www.confreaks.com/videos/977-goruco2012-hexagonal-rails]

data/lib/hexx/dependencies.rb

@@ -0,0 +1,159 @@
+# 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
+    #
+    # @param  [String, Symbol] name The name for dependency.
+    def depends_on(*names)
+      names.each do |name|
+        DependencyName.new(name).validate
+        add_dependency_setter name
+        add_dependency_getter name
+      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.
+      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.
+      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)
+      instance_eval "
+        def #{ name };
+          value = @#{ name };
+          fail NotImplementedError unless value;
+          value.constantize;
+        end"
+    end
+  end
+end

data/lib/hexx/version.rb

@@ -2,5 +2,5 @@
 module Hexx
 
   # Current release.
-  VERSION = "5.0.0"
+  VERSION = "5.1.0"
 end

data/spec/hexx/dependencies_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+module Hexx
+  describe Dependencies do
+
+    # Mocks gem core module to test dependencies from
+    before { module Test; extend Dependencies; end }
+    after  { Hexx.send :remove_const, :Test }
+    let(:described_module) { Test }
+
+    describe ".configure" do
+
+      it "is defined" do
+        expect(described_module).to respond_to :configure
+      end
+
+      it "yields block with self" do
+        described_module.configure do |config|
+          expect(config).to eq described_module
+        end
+      end
+    end
+
+    describe ".depends_on" do
+
+      it "is defined" do
+        expect(described_module).to respond_to :depends_on
+      end
+
+      it "allows symbolic attributes" do
+        expect { described_module.depends_on :item }.not_to raise_error
+      end
+
+      it "allows string attributes" do
+        expect { described_module.depends_on "item" }.not_to raise_error
+      end
+
+      it "fails when wrong object given" do
+        expect { described_module.depends_on 1 }.to raise_error TypeError
+      end
+
+      it "fails when blank object given" do
+        expect { described_module.depends_on "" }.to raise_error ArgumentError
+      end
+
+      it "adds dependencies getters" do
+        described_module.depends_on :item, "user"
+        expect(described_module).to respond_to :item
+        expect(described_module).to respond_to :user
+      end
+
+      it "adds dependencies setters" do
+        described_module.depends_on :item, "user"
+        expect(described_module).to respond_to :item=
+        expect(described_module).to respond_to :user=
+      end
+
+      context ":item" do
+
+        before { described_module.depends_on :item }
+
+        it "allows setting string and constantizes it" do
+          described_module.item = "String"
+          expect(described_module.item).to eq String
+        end
+
+        it "allows setting symbol and constantizes it" do
+          described_module.item = :String
+          expect(described_module.item).to eq String
+        end
+
+        it "allows setting constant" do
+          described_module.item = String
+          expect(described_module.item).to eq String
+        end
+
+        it "fails if wrong value type given" do
+          expect { described_module.item = 1 }.to raise_error TypeError
+        end
+
+        it "fails if blank string given" do
+          expect { described_module.item = "" }.to raise_error ArgumentError
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-20 00:00:00.000000000 Z
+date: 2014-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -149,6 +149,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/hexx.rb
+- lib/hexx/dependencies.rb
 - lib/hexx/models.rb
 - lib/hexx/models/base_coercer.rb
 - lib/hexx/null.rb
@@ -158,6 +159,7 @@ files:
 - lib/hexx/service/parameters.rb
 - lib/hexx/service/with_callbacks.rb
 - lib/hexx/version.rb
+- spec/hexx/dependencies_spec.rb
 - spec/hexx/models_spec.rb
 - spec/hexx/null_spec.rb
 - spec/hexx/service/invalid_spec.rb
@@ -196,6 +198,7 @@ summary: Service objects for Rails.
 test_files:
 - spec/spec_helper.rb
 - spec/hexx/service_spec.rb
+- spec/hexx/dependencies_spec.rb
 - spec/hexx/null_spec.rb
 - spec/hexx/service/message_spec.rb
 - spec/hexx/service/invalid_spec.rb