hexx 7.1.0 → 8.0.0

data/lib/hexx/creators/parameter.rb

@@ -1,40 +0,0 @@
-# encoding: utf-8
-require_relative "base"
-
-module Hexx
-  module Creators
-
-    # @api hide
-    # Adds setter and getter for the instance parameter.
-    #
-    # @example
-    #   # Providing that MyClass#params returns a hash
-    #   Parameter.add MyClass, :name
-    #   object = MyClass.new
-    #
-    #   object.params["name"] # => nil
-    #   object.name           # => nil
-    #
-    #   object.params["name"] = "Ivan"
-    #   object.params["name"] # => "Ivan"
-    #   object.name           # => "Ivan"
-    #
-    #   object.name = "Ivo"
-    #   object.params["name"] # => "Ivo"
-    #   object.name           # => "Ivo"
-    class Parameter < Base
-
-      private
-
-      # @api hide
-      def setter
-        "private def #{ name }; params[\"#{ name }\"]; end"
-      end
-
-      # @api hide
-      def getter
-        "private def #{ name }=(value); params[\"#{ name }\"] = value; end"
-      end
-    end
-  end
-end

data/lib/hexx/dependable.rb

@@ -1,51 +0,0 @@
-# encoding: utf-8
-
-module Hexx
-
-  # Makes the class dependable from implementations through setter injections.
-  #
-  # Adds the private {#depends_on} helper method to the class.
-  # Basically the method is similar to the +attr_accessor+ with the following
-  # differencies:
-  #
-  # * it adds a semantics to the declaration.
-  # * it allows setting the default implementation.
-  # * dependency setters accepts classes and modules only and fails with
-  #   the +TypeError+ otherwise.
-  # * dependency getters fails with the +NotImplemented+ error if the
-  #   implementation hasn't been set.
-  # * if a default implementation is defined, the dependency cannot be
-  #   set to +nil+.
-  #
-  # @example
-  #   class MyClass
-  #     extend Hexx::Dependable
-  #
-  #     depends_on :another_class, default: AnotherClass
-  #     depends_on :looks_for_implementation
-  #   end
-  #
-  #   object = MyClass.new
-  #   object.another_class # => AnotherClass
-  #
-  #   object.looks_for_implementation
-  #   # => fails with NotImplementedError
-  #
-  #   object.looks_for_implementation = SomeInjection
-  #   object.looks_for_implementation # => SomeInjection
-  module Dependable
-
-    private
-
-    # @!method depends_on(name, options = {})
-    # Declares the dependency with its default implementation.
-    # @example (see Hexx::Dependable)
-    # @param   [String, Symbol] name The name of the dependency.
-    # @param   [Hash] options ({}) The dependency declaration options.
-    # @option  options [String, Symbol, Class] :default (nil) Optional default
-    #   implementation for the dependency.
-    def depends_on(name, default: nil)
-      Creators::Dependency.add self, name, default
-    end
-  end
-end

data/lib/hexx/helpers/exceptions.rb

@@ -1,53 +0,0 @@
-# encoding: utf-8
-require_relative "messages"
-
-module Hexx
-  module Helpers
-
-    # @api hide
-    # The module declares instance helper methods to provide validations
-    module Exceptions
-      extend ActiveSupport::Concern
-      include ActiveModel::Validations
-      include Messages
-
-      # @api hide
-      # Class helper methods
-      module ClassMethods
-
-        def raises(*names)
-          fail ArgumentError if (types = names.flatten.map(&:to_s)) == []
-          types.each { |type| add_exception(type) }
-        end
-
-        private
-
-        def add_exception(type)
-          check type
-          class_eval "class #{ type } < StandardError; end"
-        end
-
-        def check(type)
-          return if type[/([A-Z][a-z]+)+/]
-          fail TypeError.new(
-            %(Wrong exception name "#{ type }". Use words in camel-case only.)
-          )
-        end
-      end
-
-      def on_error(messages)
-        messages.map(&:text).each { |text| errors.add :base, text }
-        fail Hexx::ServiceInvalid.new(self)
-      end
-
-      def escape
-        yield
-      rescue Hexx::ServiceInvalid => err
-        raise err
-      rescue => err
-        errors.add :base, err.message
-        raise Hexx::ServiceInvalid.new(self)
-      end
-    end
-  end
-end

data/lib/hexx/helpers/messages.rb

@@ -1,26 +0,0 @@
-# encoding: utf-8
-
-module Hexx
-  module Helpers
-
-    # @api hide
-    # The module provides helper methods to add and return service messages.
-    module Messages
-      extend ActiveSupport::Concern
-
-      def t(text, options = {})
-        return text unless text.is_a? Symbol
-        scope = %w(activemodel messages models) << self.class.name.underscore
-        I18n.t text, options.merge(scope: scope)
-      end
-
-      def messages
-        @messages ||= []
-      end
-
-      def add_message(type, text, options = {})
-        messages << Hexx::Message.new(type: type, text: t(text, options))
-      end
-    end
-  end
-end

data/lib/hexx/helpers/parameters.rb

@@ -1,47 +0,0 @@
-# encoding: utf-8
-
-module Hexx
-
-  # @api hide
-  # The module contains classes that defines helper methods for the service.
-  #
-  # Basically those methods are private inside the service. In the helper
-  # they are public, allowing them to be testable as a part of the gem's API.
-  module Helpers
-
-    # @api hide
-    # The module declares helper methods for managing service object's params.
-    module Parameters
-      extend ActiveSupport::Concern
-
-      # @api hide
-      # Class helper methods
-      module ClassMethods
-
-        def allow_params(*keys)
-          @params = keys.flatten.map(&:to_s)
-          fail ArgumentError if @params == []
-          params.each { |name| Creators::Parameter.add self, name }
-        end
-
-        private
-
-        def params
-          @params ||= []
-        end
-      end
-
-      attr_reader :params
-
-      def initialize(params = {})
-        @params = params.stringify_keys.slice(*class_params)
-      end
-
-      private
-
-      def class_params
-        @class_params ||= self.class.send :params
-      end
-    end
-  end
-end

data/lib/hexx/helpers/validations.rb

@@ -1,21 +0,0 @@
-# encoding: utf-8
-require_relative "messages"
-
-module Hexx
-  module Helpers
-
-    # @api hide
-    # The module declares instance helper methods to provide validations
-    module Validations
-      extend ActiveSupport::Concern
-
-      def validate!
-        fail Hexx::ServiceInvalid.new(self) unless valid?
-      end
-
-      def self.included(klass)
-        klass.send :include, ActiveModel::Validations
-      end
-    end
-  end
-end

data/lib/hexx/message.rb

@@ -1,79 +0,0 @@
-module Hexx
-
-  # 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::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

data/lib/hexx/null.rb

@@ -1,218 +0,0 @@
-# encoding: utf-8
-
-module Hexx
-
-  # The Null object class.
-  #
-  # Except for some special cases (see examples below) calling any method
-  # returns the +Null+ itself.
-  #
-  # @note (see Hexx::Null.!)
-  # @example (see Hexx::Null.method_missing)
-  # @example (see Hexx::Null.new)
-  # @example (see Hexx::Null.nil?)
-  # @example (see Hexx::Null.eq?)
-  # @example (see Hexx::Null.<=>)
-  # @example (see Hexx::Null.false?)
-  # @example (see Hexx::Null.true?)
-  # @example (see Hexx::Null.!)
-  # @example (see Hexx::Null.to_a)
-  # @example (see Hexx::Null.to_h)
-  # @example (see Hexx::Null.to_s)
-  # @example (see Hexx::Null.to_i)
-  # @example (see Hexx::Null.to_f)
-  # @example (see Hexx::Null.to_c)
-  # @example (see Hexx::Null.to_r)
-  # @example (see Hexx::Null.to_nil)
-  class Null
-    class << self
-      include Comparable
-
-      # The constructor constructs itself.
-      #
-      # @example The +Null+ object constructs itself.
-      #   Null.new
-      #   # => Null
-      #
-      # @return [Class] +Null+.
-      def new
-        self
-      end
-
-      # Checks if +Null+ is equal to other object.
-      #
-      # @example The +Null+ is equal to +nil+.
-      #   Null.eq? nil  # => true
-      #   Null.eq? Null # => true
-      #
-      # @example The +Null+ differs from non-nil
-      #   Null.eq? 0     # => false
-      #   Null.eq? false # => false
-      #
-      # @param [Object] other The other object to compare to Null.
-      # @return [Boolean] The result of comparison.
-      def eq?(other)
-        other.nil?
-      end
-
-      # Compares the +Null+ to other object.
-      #
-      # @example The +Null+ is less than non-nil object:
-      #   Null < 0     # => true
-      #   Null < ""    # => true
-      #   Null < false # => true
-      #
-      # @param [Object] other The other object to compare to Null.
-      # @return [-1, 0] The result of comparison.
-      def <=>(other)
-        other.nil? ? 0 : -1
-      end
-
-      # Checks if the +Null+ is nil.
-      #
-      # @example The +Null+ is nil.
-      #   Null.nil? # => true
-      #
-      # @return [Boolean] +true+.
-      def nil?
-        true
-      end
-
-      # Checks if the +Null+ is falseу.
-      #
-      # @example The +Null+ is falseу.
-      #   Null.false?  # => true
-      #
-      # @example The +Null+ isn't false in logical operations
-      #   false || Null # => Null
-      #
-      # @return [Boolean] +true+.
-      def false?
-        true
-      end
-
-      # Converts nil to true.
-      #
-      # @note In Ruby the only objects that are +false+ are +nil+ and +false+.
-      #   Use the double bang before any object that may be the +Null+.
-      #
-      # @example The +Null+ is convertible to +true+.
-      #   !Null  # => true
-      #
-      # @example Use a double bang before objects that may be the +Null+.
-      #   Null && true   # => true
-      #   !!Null && true # => false
-      #
-      # @return [Boolean] +true+.
-      def !
-        true
-      end
-
-      # Checks if the +Null+ is truthy.
-      #
-      # @example The +Null+ isn't truthy.
-      #   Null.true?  # => false
-      #
-      # @example The +Null+ is truthy in logical operations.
-      #   true && Null # => Null
-      #
-      # @return [Boolean] +false+.
-      def true?
-        false
-      end
-
-      # Converts the +Null+ to the empty string.
-      #
-      # @example The +Null+ is convertible to the empty string.
-      #   Null.to_s # => ""
-      #
-      # @return [String] The empty string.
-      def to_s
-        ""
-      end
-
-      # Converts the +Null+ to +nil+.
-      #
-      # @example The +Null+ is convertible to +nil+.
-      #   Null.to_nil # => nil
-      #
-      # @return [NilClass] +nil+.
-      def to_nil
-        nil
-      end
-
-      # @!method to_a
-      # Converts the +Null+ to the empty array.
-      # @example The +Null+ is convertible to the empty array.
-      #   Null.to_a # => []
-      # @return [Array] the empty array.
-
-      # @!method to_i
-      # Converts the +Null+ to zero as an integer.
-      # @example The +Null+ is convertible to zero as an integer.
-      #   Null.to_i # => 0
-      # @return [Integer] zero.
-
-      # @!method to_f
-      # Converts the +Null+ to zero as a float.
-      # @example The +Null+ is convertible to zero as a float.
-      #   Null.to_f # => 0.0
-      # @return [Float] zero.
-
-      # @!method to_c
-      # Converts the +Null+ to zero as a complex.
-      # @example The +Null+ is convertible to zero as a complex.
-      #   Null.to_c # => (0+0i)
-      # @return [Complex] zero.
-
-      # @!method to_r
-      # Converts the +Null+ to zero as a rational.
-      # @example The +Null+ is convertible to zero as a rational.
-      #   Null.to_c # => (0/1)
-      # @return [Rational] zero.
-
-      # Checks if a method defined.
-      #
-      # @example The +Null+ responds to any object.
-      #   Null.respond_to? arbitrary_method
-      #   # => true
-      #
-      # @return [Boolean] +true+.
-      def respond_to?(*)
-        true
-      end
-
-      # @return [false] for +Null+, +nil+ or +false+
-      # @return [true] otherwise.
-      def ^(other)
-        ![self, nil, false].include? other
-      end
-
-      # @return [false] for +Null+, +nil+ or +false+
-      # @return [true] otherwise.
-      def |(other)
-        self.^(other)
-      end
-
-      private
-
-      # @api hide
-      # @example An arbitrary method returns the +Null+ itself.
-      #   Null.is_an_eagle_owl?  # => Null
-      #   Null.is_an_elk?        # => Null
-      #   Null.fly               # => Null
-      #   # ... etc.
-      #
-      # @example An arbitrary method called with a block yields the block.
-      #   Null.when_fishing { p "I've got it!" }
-      #   # => "I've got it!"
-      #   # => Null
-      #
-      def method_missing(name, *args, &block)
-        return nil.send(name, *args, &block) if nil.respond_to?(name)
-        block.call if block_given?
-        self
-      end
-    end
-  end
-end