hexx 6.0.2 → 6.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5363a542691cf187bc33c6af98944fddd629b593
-  data.tar.gz: b86bd725ce6048ddb028316b574918980b844012
+  metadata.gz: 861d8373aad89fc2f9409572c87782223dd042e4
+  data.tar.gz: 40061fbf81bdf2ff8f57679e328d71c944260a71
 SHA512:
-  metadata.gz: e451529cfaecd38210afa3d8e4206d23fbce09a1f966a8da564f20959eac30fc96c47e15ecf595ff7fd8b32ff818e5e06523e67b1f0d047f7fe678efddea4525
-  data.tar.gz: cb9ad8b597a55ce3f10c8c0246bb4e439489f528dd5806ced91a4547bfb1dc57fee7bf6a86ab5197feb9309ec5155c97b1912a15bdc8ae275d153e2bd791cede
+  metadata.gz: 509e8e294856e4f6509c0d68a188533f33646152b1567114d60943fe84e3ab98ec5d21d55aad33e8a3c38706fd875fef57ff0eb9e37605727e3f0d1d3f081896
+  data.tar.gz: b3f38e5997f22130d83050d1a137110424a4dfee5d7544311f0ec75c9fb8524accb0566bc8d99fe2f780f06443b9f915bab6b845fd55c27888c550873c354015

data/README.rdoc

@@ -258,7 +258,7 @@ The class implements the {Null object}[http://robots.thoughtbot.com/rails-refact
   +to_i+, +to_f+, +to_c+, +to_r+, +to_nil+
 * responds with +self+ to any other method call
 
-Providing {this problem}[http://devblog.avdi.org/2011/05/30/null-objects-and-falsiness/],  use double bang in logical expressions:
+Providing {this problem}[http://devblog.avdi.org/2011/05/30/null-objects-and-falsiness/],  use double negation in logical expressions:
 
   # Though:
   Hexx::Null && true   # => true

data/lib/hexx/helpers/base.rb

@@ -74,15 +74,11 @@ module Hexx
       private
 
       # @abstract
-      # @return [String] the getter definition
       def getter
-        ""
       end
 
       # @abstract
-      # @return [String] the setter definition
       def setter
-        ""
       end
 
       # @api hide

data/lib/hexx/helpers/parameter.rb

@@ -28,12 +28,12 @@ module Hexx
 
       # @api hide
       def setter
-        "def #{ name }; params[\"#{ name }\"]; end"
+        "private def #{ name }; params[\"#{ name }\"]; end"
       end
 
       # @api hide
       def getter
-        "def #{ name }=(value); params[\"#{ name }\"] = value; end"
+        "private def #{ name }=(value); params[\"#{ name }\"] = value; end"
       end
     end
   end

data/lib/hexx/service.rb

@@ -24,22 +24,39 @@ module Hexx
     include Wisper::Publisher
     include ActiveModel::Validations
 
-    # @api hide
-    # Returns the list of allowed parameters for service objects.
-    #
-    # The parameters are added to the list by the {.allow_params} private
-    # helper method.
-    #
-    # @example
-    #   class Service < Hexx::Service
-    #     allow_params :name
-    #   end
-    #
-    #   Service.params # => "name"
-    #
-    # @return [Array<String>] The list of allowed instance parameters.
-    def self.params
-      @params ||= []
+    # Class helper methods
+    class << self
+
+      private
+
+      # @api hide
+      # Returns the list of allowed parameters for service objects.
+      #
+      # The parameters are added to the list by the {.allow_params} private
+      # helper method.
+      #
+      # @example
+      #   class Service < Hexx::Service
+      #     allow_params :name
+      #   end
+      #
+      #   Service.params # => "name"
+      #
+      # @return [Array<String>] Whitelist of parameters.
+      def params
+        @params ||= []
+      end
+
+      # 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.flatten.map(&:to_s)
+        fail ArgumentError if @params == []
+        params.each { |name| Helpers::Parameter.add self, name }
+      end
     end
 
     # @!scope class
@@ -72,7 +89,7 @@ module Hexx
     # @param  (see Hexx::Service.new)
     # @return (see Hexx::Service.new)
     def initialize(params = {})
-      @params = params.dup.stringify_keys.slice(*(self.class.params))
+      @params = params.dup.stringify_keys.slice(*class_params)
       @messages = []
     end
 
@@ -111,7 +128,7 @@ module Hexx
     #
     # @return [Array<Hexx::Service::Message>] The array of messages.
 
-    attr_reader :params, :messages
+    attr_reader :messages
 
     # @!scope class
     # @!visibility private
@@ -175,14 +192,12 @@ module Hexx
 
     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 self.allow_params(*keys)
-      @params = keys.map(&:to_s)
-      params.each { |name| Helpers::Parameter.add self, name }
+    attr_reader :params
+
+    # @api hide
+    # @return [Array<String>] Whitelist of parameters.
+    def class_params
+      self.class.send :params
     end
 
     # The helper runs another service object and subscribes +self+ for the

data/lib/hexx/service/with_callbacks.rb

@@ -20,15 +20,13 @@ module Hexx
     #   wrapper.respond_to? :something    # => false
     class WithCallbacks
 
+      # @api hide
       # @!scope class
       # @!method new(object, prefix: nil)
       # Constructs the decorator.
-      #
       # @example (see Hexx::Service::WithCallbacks)
-      #
       # @param [Hexx::Service] object The service object to be decorated.
-      # @param [Symbol, nil] prefix (nil) The prefix for private methods
-      #   to be accessible.
+      # @param [Symbol, nil] prefix (nil) The prefix for accessible methods.
       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 = "6.0.2"
+  VERSION = "6.0.3"
 end

data/spec/hexx/coercible_spec.rb

@@ -25,12 +25,47 @@ module Hexx
 
     describe ".attr_coerced" do
 
-      before  { test_model.send :attr_coerced, :name, type: test_coercion }
-      subject { test_model.new }
+      context "when the name is neither type nor symbol" do
 
-      it "coerces an attribute with given type" do
-        subject.name = "some name"
-        expect(subject.name).to be_kind_of test_coercion
+        it "fails with TypeError" do
+          expect { test_model.send :attr_coerced, 1, type: test_coercion }
+            .to raise_error(TypeError)
+        end
+      end
+
+      context "when the name is empty" do
+
+        it "fails with ArgumentError" do
+          expect { test_model.send :attr_coerced, "", type: test_coercion }
+            .to raise_error(ArgumentError)
+        end
+      end
+
+      context "when no type is set" do
+
+        it "fails with ArgumentError" do
+          expect { test_model.send :attr_coerced, :name }
+            .to raise_error(ArgumentError)
+        end
+      end
+
+      context "when a type is not a class" do
+
+        it "fails with TypeError" do
+          expect { test_model.send :attr_coerced, :name, type: test_module }
+            .to raise_error(TypeError)
+        end
+      end
+
+      context "with valid arguments" do
+
+        before  { test_model.send :attr_coerced, :name, type: test_coercion }
+        subject { test_model.new }
+
+        it "coerces an attribute with given type" do
+          subject.name = "some name"
+          expect(subject.name).to be_kind_of test_coercion
+        end
       end
     end
   end

data/spec/hexx/null_spec.rb

@@ -48,7 +48,8 @@ module Hexx
 
     it "is falsey" do
       expect(Null).to be_falsey
-      expect(Null).not_to be_truthy
+      expect(Null.true?).to be_falsey
+      expect(Null.false?).to be_truthy
       expect(!Null).to eq true
     end
 

data/spec/hexx/service_spec.rb

@@ -26,10 +26,65 @@ module Hexx
       expect(subject).to be_kind_of Wisper::Publisher
     end
 
-    describe ".params" do
+    describe "class helpers" do
 
-      it "returns an array" do
-        expect(described_class.params).to be_kind_of Array
+      describe ".allow_params" do
+
+        it "accepts one argument" do
+          expect { described_class.send :allow_params, :name }
+            .not_to raise_error
+        end
+
+        it "accepts a list of arguments" do
+          expect { described_class.send :allow_params, :name, :type }
+            .not_to raise_error
+        end
+
+        it "accepts an array of arguments" do
+          expect { described_class.send :allow_params, %w(name type) }
+            .not_to raise_error
+        end
+
+        it "requires strings or symbols" do
+          expect { described_class.send :allow_params, 1 }
+            .to raise_error SyntaxError
+        end
+
+        it "requires non-empty values" do
+          expect { described_class.send :allow_params, "" }
+            .to raise_error ArgumentError
+        end
+
+        it "requires values" do
+          expect { described_class.send :allow_params }
+            .to raise_error ArgumentError
+        end
+
+        context "with valid argument" do
+
+          before  { described_class.send :allow_params, :name }
+          subject do
+            described_class.new(name: "name", wrong: "wrong").with_callbacks
+          end
+
+          it "allows initialization of the parameter" do
+            expect(subject.params).to eq("name" => "name")
+          end
+
+          it "defines private getter for the parameter" do
+            expect(described_class.private_instance_methods)
+              .to be_include :name
+            expect { subject.params["name"] = "new" }
+              .to change { subject.name }.to "new"
+          end
+
+          it "defines private setter for the parameter" do
+            expect(described_class.private_instance_methods)
+              .to be_include :name=
+            expect { subject.name = "new" }
+              .to change { subject.params["name"] }.to "new"
+          end
+        end
       end
     end
 
@@ -37,30 +92,15 @@ module Hexx
 
       let(:value) { "text" }
       before      { described_class.send :allow_params, :name }
-      subject do
-        described_class.new(name: value, wrong: "wrong").with_callbacks
-      end
+      subject     { described_class.new(name: value).with_callbacks }
 
-      it "stringifies params' keys" do
+      it "stringifies params keys" do
         expect(subject.params["name"]).to eq value
         expect(subject.params[:name]).to be_nil
       end
-
-      it "whitelists params" do
-        expect(subject.params["wrong"]).to be_nil
-      end
-
-      it "define individual params' getters" do
-        expect(subject.name).to eq value
-      end
-
-      it "defines individual params' setters" do
-        subject.name = :another_name
-        expect(subject.name).to eq :another_name
-        expect(subject.params["name"]).to eq :another_name
-      end
     end
 
+    # TODO: move this to private helpers
     describe "#with_callbacks" do
 
       context "without a prefix" do
@@ -98,13 +138,6 @@ module Hexx
       end
     end
 
-    describe "#params" do
-
-      it "exists" do
-        expect { subject.params }.not_to raise_error
-      end
-    end
-
     describe "#messages" do
 
       it "returns an array" do
@@ -112,25 +145,11 @@ module Hexx
       end
     end
 
-    describe "helpers" do
+    describe "instance helpers" do
 
-      let!(:service) { Service.new }
+      let(:service) { Service.new name: "name" }
       subject { service.with_callbacks }
 
-      describe ".allow_params" do
-
-        before { described_class.send :allow_params, :name }
-
-        it "sets class params" do
-          expect(described_class.params).to eq %w(name)
-        end
-
-        it "defines instance attributes" do
-          expect(described_class.instance_methods).to be_include :name
-          expect(described_class.instance_methods).to be_include :name=
-        end
-      end
-
       describe "#validate!" do
 
         it "passes when service is valid" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.0.3
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-24 00:00:00.000000000 Z
+date: 2014-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel