hexx 6.0.3 → 7.0.0

data/lib/hexx/service/invalid.rb

@@ -1,76 +0,0 @@
-require_relative "message"
-
-module Hexx
-  class Service
-
-    # The exception to be raised 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::Service::Invalid}.
-    class Invalid < ::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::Service::Invalid.new service
-      #
-      # @param  [Hexx::Service] service The invalid service.
-      # @raise  [ArgumentError] if the argument is not a service object.
-      # @return [Hexx::Service::Invalid] The exception.
-
-      # @api hide
-      def initialize(service)
-        @service = service
-        fail ArgumentError unless self.service.is_a? Hexx::Service
-      end
-
-      # @!attribute [r] message
-      # Returns a default text message for the exception.
-      #
-      # @example
-      #   error = Hexx::Service::Invalid.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::Service::Invalid.new service
-      #   error.messages
-      #   # => [#<Hexx::Service::Message @type="error" @text="some error" >]
-      #
-      # @return [Array<Hexx::Service::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
-end

data/lib/hexx/service/message.rb

@@ -1,81 +0,0 @@
-module Hexx
-  class Service
-
-    # A message to be returned by services.
-    class Message
-      include Comparable
-
-      # @!attribute [r] type
-      # The type of the message
-      #
-      # @example
-      #   message = Message.new type: :error, text: "message"
-      #   message.type = "error"
-      #
-      # @return [String] The type of the message.
-      attr_reader :type
-
-      # @!attribute [r] text
-      # The text of the message
-      #
-      # @example
-      #   message = Message.new type: :error, text: "message"
-      #   message.text = "message"
-      #
-      # @return [String] The text of the message.
-      attr_reader :text
-
-      # @!scope class
-      # @!method new(options)
-      # Constructs the message with type and text.
-      #
-      # @example
-      #   Message.new type: "success", text: "Object created."
-      #
-      # @param  [Hash] options The list of the message attributes.
-      # @option options [String, Symbol] :type The type of the message.
-      # @option options [String, Symbol] :text The text of the message.
-      # @return [Hexx::Service::Message] The message.
-
-      # @api hide
-      def initialize(type:, text:)
-        @type, @text = type.to_s, text.to_s
-      end
-
-      # Distinguishes two messages by type and text.
-      #
-      # @example
-      #   a = Message.new(type: "a", text: "a")
-      #   b = Message.new(type: "a", text: "a")
-      #   c = Message.new(type: "b", text: "a")
-      #   d = Message.new(type: "a", text: "b")
-      #
-      #   a == b # => true
-      #   a == c # => false
-      #   a == d # => false
-      #
-      # @param [Object] other The object for the comparison.
-      # @return [Boolean] The result of the comparison.
-      def ==(other)
-        return false unless other.is_a? self.class
-        [type, text] == [other.type, other.text]
-      end
-
-      # Compares messages by type and text.
-      #
-      # @example
-      #   ab = Message.new(type: "a", text: "b")
-      #   ba = Message.new(type: "b", text: "a")
-      #   ab < ba # => true
-      #
-      # @param [Object] other The object for the comparison.
-      # @return [-1, 0, 1] The result of the comparison if the argument is
-      #   comparable with the message.
-      # @return [nil] if the result is incomparable with the message.
-      def <=>(other)
-        fail ArgumentError unless other.is_a? self.class
-        [type, text] <=> [other.type, other.text]
-      end
-    end
-  end
-end

data/spec/hexx/service/invalid_spec.rb

@@ -1,52 +0,0 @@
-require "spec_helper"
-
-module Hexx
-  class Service
-    describe Invalid do
-
-      describe ".new" do
-
-        subject { Invalid }
-
-        it "fails if no arguments given" do
-          expect { subject.new }.to raise_error { ArgumentError }
-        end
-
-        it "fails unless given argument is a service" do
-          expect { subject.new "wrong" }.to raise_error { ArgumentError }
-        end
-
-        it "initializes the #service" do
-          expect { subject.new Service.new }.not_to raise_error
-        end
-      end
-
-      describe "#messages" do
-
-        let(:service) { Service.new }
-        subject { Invalid.new(service).messages }
-        let(:message) { subject.first }
-
-        it "returns an array" do
-          expect(subject).to be_kind_of Array
-        end
-
-        it "returns error messages" do
-          service.errors.send :add, :base, "some error"
-          expected = Service::Message.new(type: "error", text: "some error")
-          expect(message).to eq expected
-        end
-      end
-
-      describe "#message" do
-
-        let(:service) { Service.new }
-        subject       { Invalid.new(service).message }
-
-        it "returns a proper message" do
-          expect(subject).to eq "Service invalid: #{ service.inspect }"
-        end
-      end
-    end
-  end
-end

data/spec/hexx/service/message_spec.rb

@@ -1,85 +0,0 @@
-require "spec_helper"
-
-module Hexx
-  class Service
-    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
-end