service_objects 0.1.0 → 1.0.0

data/lib/service_objects/helpers/validations.rb

@@ -1,54 +0,0 @@
-# encoding: utf-8
-require "active_model"
-
-module ServiceObjects
-
-  module Helpers
-
-    # Features for service attributes validation
-    #
-    # @note
-    #   A target class should **include** the module
-    #
-    # @see http://apidock.com/rails/v4.1.8/ActiveModel/Validations
-    #   ActiveModel::Validations
-    module Validations
-
-      # @!method valid?
-      # Runs validations and checks if the object is valid
-      # @return [Boolean]
-
-      # Raises <tt>ServiceObjects::Invalid</tt> when {#valid?} method fails
-      #
-      # Mutates the current object by populating its messages
-      # with errors, added by {#valid?}
-      #
-      # @raise [ServiceObjects::Invalid]
-      #   when a validation fails
-      #
-      # @return [self] (not changed)
-      #   when a validation passes
-      def validate!
-        return self if valid?
-        __errors__.each { |text| add_message text: text, type: "error" }
-        fail Invalid.new(self)
-      end
-
-      private
-
-      # @!parse include ServiceObjects::Helpers::Messages
-      # @!parse include ActiveModel::Validations
-      def self.included(klass)
-        klass.include ActiveModel::Validations, Messages
-        super
-      end
-
-      def __errors__
-        errors.messages.values.flatten
-      end
-
-    end # module Validations
-
-  end # module Helpers
-
-end # module ServiceObjects

data/lib/service_objects/invalid.rb

@@ -1,55 +0,0 @@
-# encoding: utf-8
-
-module ServiceObjects
-
-  # The exception to be risen by invalid services
-  #
-  # @example
-  #   object = ServiceObjects::Base.new
-  #   fail ServiceObjects::Invalid.new object
-  class Invalid < ::RuntimeError
-
-    # @!scope class
-    # @!method new(object)
-    #
-    # Constructs the exception for given service object
-    #
-    # @example (see ServiceObjects::Invalid)
-    #
-    # @param  [#messages] object
-    #
-    # @return [ServiceObjects::Invalid]
-    def initialize(object)
-      @object = object
-      validate
-    end
-
-    # @!attribute [r] object
-    # Invalid service object
-    #
-    # @return [#messages]
-    attr_reader :object
-
-    # The array of messages from the invalid {#object}
-    #
-    # @return [Array<ServiceObjects::Message>]
-    def messages
-      Array(object.messages).flatten
-    end
-
-    private
-
-    # Checks if the {#object} respond to {#messages}
-    #
-    # @raise [TypeError]
-    #   when the validation fails
-    #
-    # @return [undefined]
-    def validate
-      return if object.respond_to? :messages
-      fail TypeError.new "#{ object.inspect } doesn't respond to #messages"
-    end
-
-  end # class Invalid
-
-end # module ServiceObjects

data/lib/service_objects/null.rb

@@ -1,26 +0,0 @@
-# encoding: utf-8
-require "naught"
-
-module ServiceObjects #:nodoc:
-
-  # Implements Null Object pattern
-  #
-  # @note
-  #   The constant is a singleton black hole object that returns
-  #   itself to any method call
-  #
-  # @example
-  #   ServiceObjects::NULL.respond_to? :arbitrary_method
-  #   # => true
-  #
-  #   ServiceObjects::NULL.arbitrary_method
-  #   # => ServiceObjects::NULL
-  #
-  # @see https://github.com/avdi/naught
-  #   documentation for the 'naught' gem by Avdi Grimm
-  NULL = Naught.build do |config|
-    config.black_hole
-    config.singleton
-  end.instance
-
-end # module ServiceObjects

data/lib/service_objects/parsers.rb

@@ -1,13 +0,0 @@
-# encoding: utf-8
-
-module ServiceObjects
-
-  # Collection of CLI arguments parsers
-  module Parsers
-
-    require_relative "parsers/dependency"
-    require_relative "parsers/notification"
-
-  end # module ServiceObjects
-
-end # module Parsers

data/lib/service_objects/parsers/dependency.rb

@@ -1,69 +0,0 @@
-# encoding: utf-8
-require "hexx-cli"
-
-module ServiceObjects
-
-  module Parsers
-
-    # Parses and decorates a string, describing a notification
-    #
-    # @example
-    #   result = ServiceObjects::Parsers::Dependency.new "add_item{get_item}"
-    #   result.name     # => add_item
-    #   result.type     # => GetItem
-    #   result.listener # => AddItemListener
-    class Dependency
-
-      # @!scope class
-      # @!method new(source)
-      # Constructs the object from source
-      #
-      # @param  [#to_s] source
-      #
-      # @return [Hexx::Services::Parsers::Dependency]
-      def initialize(source)
-        @source = source.to_s
-      end
-
-      # The name for the dependency default implementation
-      #
-      # @return [String]
-      def name
-        @name ||= injector.item
-      end
-
-      # The type for the dependency default implementation
-      #
-      # @return [String]
-      def type
-        @type ||= injection.type
-      end
-
-      # The listener name for the dependency
-      #
-      # @return [String]
-      def listener
-        @listener ||= "#{ injector.const }Listener"
-      end
-
-      private
-
-      attr_reader :source
-
-      def matcher
-        @matcher ||= source.match(/^(.+){(.+)}$/)
-      end
-
-      def injector
-        @injector ||= Hexx::CLI::Name.new matcher[1]
-      end
-
-      def injection
-        @injection ||= Hexx::CLI::Name.new matcher[2]
-      end
-
-    end # class Dependency
-
-  end # module Parsers
-
-end # module ServiceObjects

data/lib/service_objects/parsers/notification.rb

@@ -1,85 +0,0 @@
-# encoding: utf-8
-require "extlib"
-
-module ServiceObjects
-
-  module Parsers
-
-    # Parses and decorates a string, describing a notification
-    #
-    # @example
-    #   result = ServiceObjects::Parsers::Notification.new "FOund:iTem:messages"
-    #   result.name               # => found
-    #   result.arguments          # => ["item", "messages"]
-    #   result.non_messages       # => ["item"]
-    #   result.error?             # => false
-    #   result.publish_messages?  # => true
-    class Notification
-
-      # @!scope class
-      # @!method new(source)
-      # Initializes the object from source string
-      #
-      # @param [#to_s] source
-      #
-      # @return [ServiceObjects::Parsers::Notification]
-      def initialize(source)
-        @source = source.to_s
-      end
-
-      # The name for the parsed value
-      # @return [String]
-      def name
-        @name ||= list.first
-      end
-
-      # The type of exception to be raised and catched by service object
-      # @return [String]
-      def exception
-        @exception ||= name.camel_case
-      end
-
-      # The list of published values
-      # @return [Array<String>]
-      def args
-        @args ||= Array(list[1..-1])
-      end
-
-      # The list of pulished values except for messages
-      # @return [Array<String>]
-      def non_messages
-        @non_messages ||= args.reject { |item| item == "messages" }
-      end
-
-      # Checks whether a notification reports an error
-      # @return [Boolean]
-      def error?
-        name == "error"
-      end
-
-      # Checks whether a notification publishes messages
-      # @return [Boolean]
-      def publish_messages?
-        args.include? "messages"
-      end
-
-      # Returns value to order notifications by
-      # @return [0] if a notification is successful
-      # @return [1] if a notification is an error
-      def order
-        @order = error? ? 1 : 0
-      end
-
-      private
-
-      attr_reader :source
-
-      def list
-        @list ||= source.scan(/\w+/).map(&:snake_case)
-      end
-
-    end # module ServiceObjects
-
-  end # module Parsers
-
-end # class Notification

data/lib/service_objects/rspec.rb

@@ -1,75 +0,0 @@
-# encoding: utf-8
-require "rspec/mocks"
-
-module ServiceObjects
-
-  # Collection of helpers and matchers for testing services
-  #
-  # @example
-  #   require "service_objects/rspec"
-  #   describe MyService do
-  #     include ServiceObjects::RSpec
-  #   end
-  module RSpec
-    include ::RSpec::Mocks::ExampleMethods
-
-    # Params to be given to service object constructor
-    #
-    # @return [Hash]
-    def params
-      @params ||= {}
-    end
-
-    # The service object of described_class, that subscribed the listener
-    #
-    # @return [ServiceObjects::Base]
-    def service
-      @service ||= described_class.new(params).subscribe(listener)
-    end
-
-    # The spy object to listen a service's notifications
-    #
-    # @return [::RSpec::Mocks::Double]
-    def listener
-      spy
-    end
-
-    # Makes given dependency to construct object when called with params
-    #
-    # @example
-    #   before { inject(:get_item, with: { name: :foo }, constructs: foo) }
-    #   service.get_item.new(name: :foo) # => foo
-    #
-    # @return [undefined]
-    def inject(dependency, with: {}, constructs: service_double)
-      klass = Class.new ServiceObjects::Base
-      allow(klass).to receive(:new).with(with).and_return constructs
-      allow(service).to receive(dependency).and_return klass
-    end
-
-    # Mock for another services, the service under test depends from
-    #
-    # The block contains the code to be executed on service #run.
-    #
-    # @example
-    #   let(:another_service) { service_double(:foo) { |name| publish name } }
-    #   another_service.run
-    #   # another_service sends :foo to its listeners
-    #
-    # @param [Array<Object>] args
-    #   the list of arguments for the block
-    # @param [Proc] block
-    #   the block to be yielded by #run method
-    #
-    # @return [ServiceObjects::Base]
-    def service_double(*args, &block)
-      object = ServiceObjects::Base.new
-      allow(object).to receive(:run) do
-        object.instance_exec(*args, &block) if block_given?
-      end
-      object
-    end
-
-  end
-
-end # module ServiceObjects

data/lib/service_objects/utils/normal_hash.rb

@@ -1,34 +0,0 @@
-# encoding: utf-8
-
-module ServiceObjects
-
-  # Utilitites for ServiceObjects module
-  module Utils
-
-    # Constructor of hash with keys, symbolized at any level
-    #
-    # @example
-    #   NormalHash.from { "foo" => "bar", "bar" => { "baz", "bar" => "baz" } }
-    #   # => { foo: "baz", bar: { "baz", bar: "baz" } }
-    #
-    # @api private
-    module NormalHash
-
-      # Recursively symbolizes keys of hash at any level
-      #
-      # @param [Hash] hash
-      #
-      # @return [Hash]
-      def self.from(hash)
-        return {} unless hash.is_a? Hash
-
-        hash.inject({}) do |out, (key, val)|
-          out.merge(key.to_sym => (val.is_a?(Hash) ? from(val) : val))
-        end
-      end
-
-    end # class NormalHash
-
-  end # module Utils
-
-end # module ServiceObjects

data/spec/tests/base_spec.rb

@@ -1,43 +0,0 @@
-# encoding: utf-8
-
-describe ServiceObjects::Base do
-
-  let(:publisher) { Wisper::Publisher }
-  let(:helpers)   { ServiceObjects::Helpers   }
-
-  it "is Dependable" do
-    expect(described_class).to be_kind_of helpers::Dependable
-  end
-
-  it "is Parameterized" do
-    expect(described_class).to be_kind_of helpers::Parameterized
-  end
-
-  it "includes Messages helper" do
-    expect(described_class).to include helpers::Messages
-  end
-
-  it "includes Parameters helper" do
-    expect(described_class).to include helpers::Parameters
-  end
-
-  it "includes Validations helper" do
-    expect(described_class).to include helpers::Validations
-  end
-
-  it "includes Exceptions helper" do
-    expect(described_class).to include helpers::Exceptions
-  end
-
-  it "includes Wisper::Publisher" do
-    expect(described_class).to include publisher
-  end
-
-  describe "#run" do
-
-    it "is defined" do
-      expect(subject).to respond_to(:run).with(0).arguments
-    end
-  end
-
-end # describe ServiceObjects::Base