hexx 6.0.3 → 7.0.0

data/lib/hexx/service_invalid.rb

@@ -0,0 +1,73 @@
+require_relative "message"
+
+module Hexx
+
+  # The exception to be risen by invalid services.
+  #
+  # @example
+  #   service GetItem < Hexx::Service
+  #     allow_params :uuid
+  #     validates :uuid, presence: true
+  #     def run
+  #       validate!
+  #     end
+  #   end
+  #
+  #   service = GetItem.new
+  #   service.run # => fails with the {Hexx::ServiceInvalid}.
+  class ServiceInvalid < ::RuntimeError
+
+    # @!attribute [r] service
+    # @return [Hexx::Service] The invalid service object.
+    attr_reader :service
+
+    # @!scope class
+    # @!method new(service)
+    # Initializes the exception.
+    #
+    # @example
+    #   fail Hexx::ServiceInvalid.new service
+    #
+    # @param  [Hexx::Service] service The invalid service.
+    # @raise  [ArgumentError] if the argument is not a service object.
+    # @return [Hexx::ServiceInvalid] The exception.
+
+    # @api hide
+    def initialize(service)
+      @service = service
+    end
+
+    # @!attribute [r] message
+    # Returns a default text message for the exception.
+    #
+    # @example
+    #   error = Hexx::ServiceInvalid.new service
+    #   error.message # => "Service invalid: #<Hexx::Service... >"
+    #
+    # @return [String] The message.
+    def message
+      "Service invalid: #{ service.inspect }"
+    end
+
+    # @!attribute [r] messages
+    # Returns a list of error messages from the service.
+    #
+    # @example
+    #   service.errors.add :base, "some error"
+    #
+    #   error = Hexx::ServiceInvalid.new service
+    #   error.messages
+    #   # => [#<Hexx::Message @type="error" @text="some error" >]
+    #
+    # @return [Array<Hexx::Message>] The list of error messages.
+    def messages
+      errors.map { |text| Message.new type: "error", text: text }
+    end
+
+    private
+
+    def errors
+      service.errors.messages.values.flatten
+    end
+  end
+end

data/lib/hexx/version.rb

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

data/spec/hexx/helpers/exceptions_spec.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+require "spec_helper"
+
+module Hexx
+  describe Helpers::Exceptions do
+
+    before { class Test; include Helpers::Exceptions; end }
+    after  { Hexx.send :remove_const, :Test }
+
+    let(:service_invalid) { Hexx::ServiceInvalid }
+    let(:message)         { Hexx::Message.new type: "error", text: "text" }
+    let(:described_class) { Test }
+    subject { described_class.new }
+
+    it "includes Messages" do
+      expect(described_class).to include Helpers::Messages
+    end
+
+    describe ".raises" do
+
+      it "declares the specific StandardError exception(s)" do
+        described_class.send :raises, :TestException
+        exception = described_class.const_get :TestException
+        expect(exception.new).to be_kind_of StandardError
+      end
+
+      it "accepts a list of values" do
+        expect { described_class.send :raises, :One, :Two }.not_to raise_error
+        expect(described_class.const_defined? :One).to be_truthy
+        expect(described_class.const_defined? :Two).to be_truthy
+      end
+
+      it "accepts an array of values" do
+        expect { described_class.send :raises, %w(One Two) }.not_to raise_error
+        expect(described_class.const_defined? :One).to be_truthy
+        expect(described_class.const_defined? :Two).to be_truthy
+      end
+
+      it "requires value" do
+        expect { described_class.send :raises }.to raise_error ArgumentError
+      end
+
+      it "fails if non-string or non-symbol value given" do
+        expect { described_class.send :raises, 1 }.to raise_error TypeError
+      end
+    end
+
+    describe "#on_error" do
+
+      it "fails with ServiceInvalid" do
+        expect { subject.on_error [message] }.to raise_error service_invalid
+      end
+
+      it "adds errors to the service" do
+        begin; subject.on_error [message]; rescue; end
+        expect(subject.errors.messages).to eq(base: ["text"])
+      end
+    end
+
+    describe "#escape" do
+
+      it "yields a block" do
+        value  = "Hello!"
+        result = subject.escape { value }
+        expect(result).to eq value
+      end
+
+      context "when a block raises ServiceInvalid error" do
+
+        let!(:exception) { service_invalid.new(subject) }
+
+        it "re-raises the exception" do
+          expect { subject.escape { fail exception } }
+            .to raise_error { exception }
+        end
+      end
+
+      context "when a block raises StandardError" do
+
+        let(:run)     { subject.escape { fail "text" } }
+
+        it "re-raises the ServiceInvalid" do
+          expect { run }.to raise_error service_invalid
+        end
+
+        it "adds error to the messages" do
+          begin
+            run
+          rescue => err
+            expect(err.messages).to contain_exactly message
+          end
+        end
+      end
+    end
+  end
+end

data/spec/hexx/helpers/messages_spec.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+require "spec_helper"
+
+module Hexx
+  describe Helpers::Messages do
+
+    before  { class Test; include Helpers::Messages; end }
+    subject { Test.new }
+    after   { Hexx.send :remove_const, :Test }
+
+    describe "#t" do
+
+      let(:scope)      { %w(activemodel messages models hexx/test) }
+      let(:traslation) { I18n.t(:text, scope: scope, name: "name") }
+
+      it "translates symbols in the service scope" do
+        expect(subject.t(:text, name: "name")).to eq traslation
+      end
+
+      it "doesn't translate the string" do
+        expect(subject.t("text")).to eq "text"
+      end
+    end
+
+    describe "#messages" do
+
+      it "returns an array" do
+        expect(subject.messages).to be_kind_of Array
+      end
+    end
+
+    describe "#messages=" do
+
+      it "sets #messages" do
+        expect { subject.messages = ["text"] }
+          .to change { subject.messages }.to ["text"]
+      end
+    end
+
+    describe "#add_message" do
+
+      before        { subject.add_message :info, :text }
+      let(:message) { subject.messages.first }
+
+      it "adds a new message" do
+        expect(message).to be_kind_of Hexx::Message
+        expect(message.type).to eq "info"
+      end
+
+      it "translates a symbol" do
+        translation = subject.t :text
+        expect(message.text).to eq translation
+      end
+    end
+  end
+end

data/spec/hexx/helpers/parameters_spec.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+require "spec_helper"
+
+module Hexx
+  describe Helpers::Parameters do
+
+    before { class Test; include Helpers::Parameters; end }
+    let(:described_class) { Test }
+    after  { Hexx.send :remove_const, :Test }
+
+    describe "#params" do
+
+      subject { described_class.new }
+
+      it "is defined" do
+        expect(subject).to respond_to :params
+      end
+
+      it "has no setter" do
+        expect(subject).not_to respond_to :params=
+      end
+    end
+
+    describe ".new" do
+      
+      it "accepts parameters" do
+        expect { described_class.new name: "name" }.not_to raise_error
+      end
+
+      it "doesn't require parameters" do
+        expect { described_class.new }.not_to raise_error
+      end
+    end
+
+    describe ".allow_params" do
+
+      it "is defined" do
+        expect(described_class).to respond_to(:allow_params)
+      end
+
+      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 { described_class.new name: "name" }
+
+        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.send :name }.to "new"
+        end
+
+        it "defines private setter for the parameter" do
+          expect(described_class.private_instance_methods)
+            .to be_include :name=
+          expect { subject.send :name=, "new" }
+            .to change { subject.params["name"] }.to "new"
+        end
+      end
+    end
+  end
+end

data/spec/hexx/helpers/validations_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require "spec_helper"
+
+module Hexx
+  describe Helpers::Validations do
+
+    before { class Test; include Helpers::Validations; end }
+    after  { Hexx.send :remove_const, :Test }
+
+    let(:service_invalid) { Hexx::ServiceInvalid }
+    let(:message)         { Hexx::Message.new type: "error", text: "text" }
+    let(:described_class) { Test }
+    subject { described_class.new }
+
+    it "includes ActiveModel::Validations" do
+      expect(described_class).to include ActiveModel::Validations
+    end
+
+    describe "#validate!" do
+
+      it "passes when service is valid" do
+        allow(subject).to receive(:valud?).and_return true
+        expect { subject.validate! }.not_to raise_error
+      end
+
+      it "fails when service is invalid" do
+        allow(subject).to receive(:valid?).and_return false
+        expect { subject.validate! }.to raise_error service_invalid
+      end
+    end
+  end
+end

data/spec/hexx/message_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+
+module Hexx
+  describe Message do
+
+    describe ".new" do
+
+      subject { Message }
+
+      it "requires type" do
+        expect { subject.new text: "" }.to raise_error
+      end
+
+      it "requires text" do
+        expect { subject.new type: "" }.to raise_error
+      end
+    end
+
+    describe "#type" do
+
+      subject { Message.new type: "info", text: "text" }
+
+      it "returns message type" do
+        expect(subject.type).to eq "info"
+      end
+    end
+
+    describe "#text" do
+
+      subject { Message.new type: "info", text: "text" }
+
+      it "returns message text" do
+        expect(subject.text).to eq "text"
+      end
+    end
+
+    describe "#==" do
+
+      let!(:params) { { type: "info", text: "text" } }
+
+      it "returns true if type and text of two messages are the same" do
+        expect(Message.new params).to eq(Message.new params)
+      end
+
+      it "returns false if types of two messages are different" do
+        expect(Message.new params)
+          .not_to eq(Message.new params.merge(type: "error"))
+      end
+
+      it "returns false if texts of two messages are different" do
+        expect(Message.new params)
+          .not_to eq(Message.new params.merge(text: "another"))
+      end
+
+      it "returns false when a message compares to non-message" do
+        expect(Message.new params).not_to eq("text")
+      end
+    end
+
+    describe "#<=>" do
+
+      let!(:aa) { Message.new type: "a", text: "a" }
+      let!(:ab) { Message.new type: "a", text: "b" }
+      let!(:ba) { Message.new type: "b", text: "a" }
+
+      it "orders messages by type" do
+        expect(aa < ba).to be_truthy
+      end
+
+      it "orders messages by text" do
+        expect(aa < ab).to be_truthy
+      end
+
+      it "orders messages first by type" do
+        expect(ab < ba).to be_truthy
+      end
+
+      it "fails when compared with non-message" do
+        expect { ab < "" }.to raise_error
+      end
+    end
+  end
+end