hexx 5.4.0 → 6.0.0

data/lib/hexx/service/with_callbacks.rb

@@ -1,7 +1,9 @@
 module Hexx
   class Service
 
-    # Wraps the service object and grants access to its private methods.
+    # @api hide
+    # Service object decorator that grants access to its private methods
+    # whose names begins from given prefix.
     #
     # @example
     #   class GetItem < Hexx::Service
@@ -19,17 +21,14 @@ module Hexx
     class WithCallbacks
 
       # @!scope class
-      # @!method new(object, options)
-      # Initializes the decorator of given object.
+      # @!method new(object, prefix: nil)
+      # Constructs the decorator.
       #
       # @example (see Hexx::Service::WithCallbacks)
       #
       # @param [Hexx::Service] object The service object to be decorated.
-      # @param [Hash] options The list of wrapper options.
-      # @option options [Symbol] :prefix (nil) The prefix for private methods
+      # @param [Symbol, nil] prefix (nil) The prefix for private methods
       #   to be accessible.
-
-      # @api hide
       def initialize(object, prefix: nil)
         @object = object
         @prefix = Regexp.new(prefix ? "^#{ prefix }_" : "")

data/lib/hexx/version.rb

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

data/spec/hexx/coercible_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+module Hexx
+  describe Coercible do
+
+    # ==========================================================================
+    # Prepare environment
+    # ==========================================================================
+
+    before { class  TestModel; extend Coercible; end }
+    before { module TestModule;  end }
+    before { class  TestCoersion < Struct.new(:string); end }
+
+    let(:test_model)    { TestModel   }
+    let(:test_module)   { TestModule  }
+    let(:test_coersion) { TestCoersion }
+
+    after { Hexx.send :remove_const, :TestCoersion }
+    after { Hexx.send :remove_const, :TestModule  }
+    after { Hexx.send :remove_const, :TestModel   }
+
+    # ==========================================================================
+    # Run tests
+    # ==========================================================================
+
+    describe ".coersion" do
+
+      it "is defined" do
+        expect(test_model).to respond_to :coersion
+      end
+
+      it "is set by default" do
+        expect(test_model.coersion).to be_kind_of Module
+      end
+    end
+
+    describe ".coersion=" do
+
+      it "sets the .coersion" do
+        expect { test_model.coersion = test_module }
+          .to change { test_model.coersion }.to test_module
+      end
+    end
+
+    describe ".attr_coerced" do
+
+      before  { test_model.send :attr_coerced, :name, type: test_coersion }
+      subject { test_model.new }
+
+      it "coerces an attribute with given type" do
+        subject.name = "some name"
+        expect(subject.name).to be_kind_of test_coersion
+      end
+    end
+  end
+end

data/spec/hexx/{dependencies_spec.rb → configurable_spec.rb}

@@ -1,11 +1,12 @@
 require "spec_helper"
 
 module Hexx
-  describe Dependencies do
+  describe Configurable do
 
     # Mocks gem core module to test dependencies from
-    before { module Test; extend Dependencies; end }
+    before { module Test; extend Configurable; end }
     after  { Hexx.send :remove_const, :Test }
+
     let(:described_module) { Test }
 
     describe ".configure" do
@@ -69,33 +70,19 @@ module Hexx
 
         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
+        it "makes a setter to allow modules" 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
+        it "makes a setter to require modules" do
+          expect { described_module.item = :String }.to raise_error TypeError
         end
       end
 
       context ":item, default: Hexx::Service" do
 
-        before { described_module.depends_on :item, default: "Hexx::Service"  }
+        before { described_module.depends_on :item, default: Hexx::Service  }
 
         it "sets default value for the item" do
           expect(described_module.item).to eq Hexx::Service

data/spec/hexx/dependable_spec.rb

@@ -0,0 +1,125 @@
+require "spec_helper"
+
+module Hexx
+  describe Dependable do
+
+    # ==========================================================================
+    # Prepare environment
+    # ==========================================================================
+
+    before { class Test; extend Dependable; end }
+    before { module TestModule; end }
+    before { class TestClass; end }
+
+    let(:described_class) { Test }
+    let(:test_module)     { TestModule }
+    let(:test_class)      { TestModule }
+
+    after  { Hexx.send :remove_const, :TestClass }
+    after  { Hexx.send :remove_const, :TestModule }
+    after  { Hexx.send :remove_const, :Test }
+
+    # ==========================================================================
+    # Run tests
+    # ==========================================================================
+
+    describe ".depends_on" do
+
+      it "is private" do
+        expect { described_class.depends_on :item }.to raise_error
+        expect { described_class.send :depends_on, :item }.not_to raise_error
+      end
+
+      it "accepts string argument" do
+        expect { described_class.send :depends_on, "item" }.not_to raise_error
+      end
+
+      it "requires non-empty argument" do
+        expect { described_class.send :depends_on, "" }
+          .to raise_error(ArgumentError)
+      end
+
+      it "requires string or symbol" do
+        expect { described_class.send :depends_on, 1 }
+          .to raise_error(TypeError)
+      end
+
+      it "accepts the :default option with class value" do
+        expect { described_class.send :depends_on, :item, default: test_class }
+          .not_to raise_error
+      end
+
+      it "accepts the :default option with module value" do
+        expect { described_class.send :depends_on, :item, default: test_module }
+          .not_to raise_error
+      end
+
+      it "accepts the :default option with nil" do
+        expect { described_class.send :depends_on, :item, default: nil }
+          .not_to raise_error
+      end
+
+      it "requires the :default option to be nil, class or module" do
+        expect { described_class.send :depends_on, :item, default: 1 }
+          .to raise_error { TypeError }
+      end
+
+      context "with a default implementation" do
+
+        before  { described_class.send :depends_on, :item, default: test_class }
+        subject { described_class.new }
+
+        it "declares a getter" do
+          expect(subject).to respond_to :item
+        end
+
+        it "declares a setter" do
+          expect(subject).to respond_to :item=
+          expect { subject.item = described_class }
+            .to change { subject.item }.to described_class
+        end
+
+        it "makes a setter to require module or class" do
+          expect { subject.item = 1 }.to raise_error { TypeError }
+        end
+
+        it "sets implementation by default" do
+          expect(subject.item).to eq test_class
+        end
+
+        it "resets implementation to default" do
+          expect { subject.item = nil }.not_to change { subject.item }
+        end
+      end
+
+      context "without a default implementation" do
+
+        before  { described_class.send :depends_on, :item }
+        subject { described_class.new }
+
+        it "declares a getter" do
+          expect(subject).to respond_to :item
+        end
+
+        it "declares a setter" do
+          expect(subject).to respond_to :item=
+          subject.item = test_class
+          expect(subject.item).to be test_class
+        end
+
+        it "makes a setter to require module or class" do
+          expect { subject.item = 1 }.to raise_error(TypeError)
+        end
+
+        it "fails before the dependency not implemented" do
+          expect { subject.item }.to raise_error(NotImplementedError)
+        end
+
+        it "fails when the dependency implementation resets" do
+          subject.item = test_class
+          expect { subject.item = nil }.to raise_error(NotImplementedError)
+        end
+      end
+    end
+  end
+end

data/spec/hexx/service_spec.rb

@@ -12,26 +12,34 @@ module Hexx
       Hexx.send :remove_const, :Test
     end
 
+    let!(:described_class) { Test }
+
+    it "extends Hexx::Dependable" do
+      expect(described_class).to be_kind_of Hexx::Dependable
+    end
+
     it "includes ActiveModel::Validations" do
-      expect(Service.ancestors).to be_include ActiveModel::Validations
+      expect(subject).to be_kind_of ActiveModel::Validations
     end
 
     it "includes Whisper::Publisher" do
-      expect(Service.ancestors).to be_include Wisper::Publisher
+      expect(subject).to be_kind_of Wisper::Publisher
     end
 
     describe ".params" do
 
       it "returns an array" do
-        expect(Test.params).to be_kind_of Array
+        expect(described_class.params).to be_kind_of Array
       end
     end
 
     describe ".new" do
 
       let(:value) { "text" }
-      before      { Test.send :allow_params, :name }
-      subject     { Test.new(name: value, wrong: "wrong").with_callbacks }
+      before      { described_class.send :allow_params, :name }
+      subject do
+        described_class.new(name: value, wrong: "wrong").with_callbacks
+      end
 
       it "stringifies params' keys" do
         expect(subject.params["name"]).to eq value
@@ -57,7 +65,7 @@ module Hexx
 
       context "without a prefix" do
 
-        subject { Test.new.with_callbacks }
+        subject { described_class.new.with_callbacks }
 
         it "makes all private methods public" do
           expect(subject.respond_to? :something).to be_truthy
@@ -69,7 +77,7 @@ module Hexx
 
       context "with a prefix" do
 
-        subject { Test.new.with_callbacks prefix: :on }
+        subject { described_class.new.with_callbacks prefix: :on }
 
         it "makes prefixed private methods public" do
           expect(subject.respond_to? :on_something).to be_truthy
@@ -111,15 +119,15 @@ module Hexx
 
       describe ".allow_params" do
 
-        before { Test.send :allow_params, :name }
+        before { described_class.send :allow_params, :name }
 
         it "sets class params" do
-          expect(Test.params).to eq %w(name)
+          expect(described_class.params).to eq %w(name)
         end
 
         it "defines instance attributes" do
-          expect(Test.instance_methods).to be_include :name
-          expect(Test.instance_methods).to be_include :name=
+          expect(described_class.instance_methods).to be_include :name
+          expect(described_class.instance_methods).to be_include :name=
         end
       end
 
@@ -232,7 +240,7 @@ module Hexx
       describe "#run_service" do
 
         let!(:other) { double "other", subscribe: nil, run: nil }
-        before { allow(Test).to receive(:new).and_return other }
+        before { allow(described_class).to receive(:new).and_return other }
 
         it "if wrong class given it fails with TypeError" do
           expect { subject.run_service String, :on_string }
@@ -241,8 +249,8 @@ module Hexx
 
         it "creates a service object" do
           options = { "name" => "some name" }
-          expect(Test).to receive(:new).with options
-          subject.run_service Test, :on_service, options
+          expect(described_class).to receive(:new).with options
+          subject.run_service described_class, :on_service, options
         end
 
         it "subscribes self for the service notifications" do
@@ -250,13 +258,13 @@ module Hexx
             expect(listener).to eq subject.with_callbacks
             expect(params).to eq(prefix: :on_service)
           end
-          subject.run_service Test, :on_service
+          subject.run_service described_class, :on_service
         end
 
         it "runs the service object after subscriptions" do
           expect(other).to receive(:subscribe).ordered
           expect(other).to receive(:run).ordered
-          subject.run_service Test, :on_service
+          subject.run_service described_class, :on_service
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-23 00:00:00.000000000 Z
+date: 2014-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -149,18 +149,23 @@ files:
 - README.rdoc
 - Rakefile
 - lib/hexx.rb
-- lib/hexx/dependencies.rb
-- lib/hexx/models.rb
-- lib/hexx/models/base_coercer.rb
+- lib/hexx/coercible.rb
+- lib/hexx/configurable.rb
+- lib/hexx/dependable.rb
+- lib/hexx/helpers/base.rb
+- lib/hexx/helpers/coersion.rb
+- lib/hexx/helpers/dependency.rb
+- lib/hexx/helpers/module_dependency.rb
+- lib/hexx/helpers/parameter.rb
 - lib/hexx/null.rb
 - lib/hexx/service.rb
 - lib/hexx/service/invalid.rb
 - lib/hexx/service/message.rb
-- 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/coercible_spec.rb
+- spec/hexx/configurable_spec.rb
+- spec/hexx/dependable_spec.rb
 - spec/hexx/null_spec.rb
 - spec/hexx/service/invalid_spec.rb
 - spec/hexx/service/message_spec.rb
@@ -198,11 +203,12 @@ 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
-- spec/hexx/models_spec.rb
+- spec/hexx/coercible_spec.rb
+- spec/hexx/dependable_spec.rb
+- spec/hexx/configurable_spec.rb
 - spec/initializers/garbage_collection.rb
 - spec/initializers/i18n.rb
 - spec/initializers/focus.rb