cuprum 0.8.0 → 0.10.0

data/lib/cuprum/errors/operation_not_called.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'cuprum/error'
+require 'cuprum/errors'
+
+module Cuprum::Errors
+  # Error class to be used when trying to access the result of an uncalled
+  # Operation.
+  class OperationNotCalled < Cuprum::Error
+    COMPARABLE_PROPERTIES = %i[operation].freeze
+    private_constant :COMPARABLE_PROPERTIES
+
+    # Format for generating error message.
+    MESSAGE_FORMAT = '%s was not called and does not have a result'
+
+    # @param operation [Cuprum::Operation] The uncalled operation.
+    def initialize(operation:)
+      @operation = operation
+
+      class_name = operation&.class&.name || 'operation'
+      message    = MESSAGE_FORMAT % class_name
+
+      super(message: message)
+    end
+
+    # @return [Cuprum::Operation] The uncalled operation.
+    attr_reader :operation
+
+    private
+
+    def comparable_properties
+      COMPARABLE_PROPERTIES
+    end
+  end
+end

data/lib/cuprum/operation.rb

@@ -1,4 +1,5 @@
 require 'cuprum/command'
+require 'cuprum/errors/operation_not_called'
 
 module Cuprum
   # Functional object with syntactic sugar for tracking the last result.
@@ -45,7 +46,6 @@ module Cuprum
       # @return [Cuprum::Result] The result from the most recent call of the
       #   operation.
       attr_reader :result
-      alias_method :to_result, :result
 
       # @overload call(*arguments, **keywords, &block)
       #   Executes the logic encoded in the constructor block, or the #process
@@ -61,12 +61,8 @@ module Cuprum
       #   @yield If a block argument is given, it will be passed to the
       #     implementation.
       #
-      #   @raise [Cuprum::Errors::ProcessNotImplementedError] Unless a block was
-      #     passed to the constructor or the #process method was overriden by a
-      #     Command subclass.
-      #
       # @see Cuprum::Command#call
-      def call *args, &block
+      def call *args, **kwargs, &block
         reset! if called? # Clear reference to most recent result.
 
         @result = super
@@ -80,23 +76,18 @@ module Cuprum
         !result.nil?
       end # method called?
 
-      # @return [Array] the errors from the most recent result, or nil if the
-      #   operation has not been called.
-      def errors
-        called? ? result.errors : nil
-      end # method errors
+      # @return [Object] the error (if any) from the most recent result, or nil
+      #   if the operation has not been called.
+      def error
+        called? ? result.error : nil
+      end # method error
 
-      # @return [Boolean] true if the most recent result had errors, or false if
-      #   the most recent result had no errors or if the operation has not been
-      #   called.
+      # @return [Boolean] true if the most recent result had an error, or false
+      #   if the most recent result had no error or if the operation has not
+      #   been called.
       def failure?
         called? ? result.failure? : false
-      end # method success?
-
-      # @return [Boolean] true if the most recent was halted, otherwise false.
-      def halted?
-        called? ? result.halted? : false
-      end # method halted?
+      end # method failure?
 
       # Clears the reference to the most recent call of the operation, if any.
       # This allows the result and any referenced data to be garbage collected.
@@ -110,13 +101,31 @@ module Cuprum
         @result = nil
       end # method reset
 
-      # @return [Boolean] true if the most recent result had no errors, or false
-      #   if the most recent result had errors or if the operation has not been
-      #   called.
+      # @return [Symbol, nil] the status of the most recent result, or nil if
+      #   the operation has not been called.
+      def status
+        called? ? result.status : nil
+      end
+
+      # @return [Boolean] true if the most recent result had no error, or false
+      #   if the most recent result had an error or if the operation has not
+      #   been called.
       def success?
         called? ? result.success? : false
       end # method success?
 
+      # Returns the most result if the operation was previously called.
+      # Otherwise, returns a failing result.
+      #
+      # @return [Cuprum::Result] the most recent result or failing result.
+      def to_cuprum_result
+        return result if result
+
+        error = Cuprum::Errors::OperationNotCalled.new(operation: self)
+
+        Cuprum::Result.new(error: error)
+      end
+
       # @return [Object] the value of the most recent result, or nil if the
       #   operation has not been called.
       def value
@@ -131,15 +140,12 @@ module Cuprum
     # @!method called?
     #   (see Cuprum::Operation::Mixin#called?)
 
-    # @!method errors
-    #   (see Cuprum::Operation::Mixin#errors)
+    # @!method error
+    #   (see Cuprum::Operation::Mixin#error)
 
     # @!method failure?
     #   (see Cuprum::Operation::Mixin#failure?)
 
-    # @!method halted?
-    #   (see Cuprum::Operation::Mixin#halted?)
-
     # @!method reset!
     #   (see Cuprum::Operation::Mixin#reset!)
 
@@ -149,6 +155,9 @@ module Cuprum
     # @!method success?
     #   (see Cuprum::Operation::Mixin#success?)
 
+    # @!method to_cuprum_result
+    #   (see Cuprum::Operation::Mixin#to_cuprum_result?)
+
     # @!method value
     #   (see Cuprum::Operation::Mixin#value)
   end # class

data/lib/cuprum/processing.rb

@@ -1,5 +1,7 @@
-require 'cuprum/errors/process_not_implemented_error'
-require 'cuprum/utils/result_not_empty_warning'
+# frozen_string_literal: true
+
+require 'cuprum/errors/command_not_implemented'
+require 'cuprum/result_helpers'
 
 module Cuprum
   # Functional implementation for creating a command object. Cuprum::Processing
@@ -12,14 +14,14 @@ module Cuprum
   #
   #     def initialize addend
   #       @addend = addend
-  #     end # constructor
+  #     end
   #
   #     private
   #
   #     def process int
   #       int + addend
-  #     end # method process
-  #   end # class AdderCommand
+  #     end
+  #   end
   #
   #   adder  = AdderCommand.new(2)
   #   result = adder.call(3)
@@ -35,31 +37,28 @@ module Cuprum
   #
   #     def process value
   #       if value.negative?
-  #         result.errors << 'value cannot be negative'
-  #
-  #         return nil
-  #       end # if
+  #         return Cuprum::Result.new(error: 'value cannot be negative')
+  #       end
   #
   #       Math.sqrt(value)
-  #     end # method process
-  #   end # class
+  #     end
+  #   end
   #
   #   result = SquareRootCommand.new.call(2)
   #   result.value    #=> 1.414
   #   result.success? #=> true
   #   result.failure? #=> false
-  #   result.errors   #=> []
+  #   result.error    #=> nil
   #
   #   result = SquareRootCommand.new.call(-1)
   #   result.value    #=> nil
   #   result.success? #=> false
   #   result.failure? #=> true
-  #   result.errors   #=> ['value cannot be negative']
+  #   result.error    #=> 'value cannot be negative'
   #
   # @see Cuprum::Command
   module Processing
-    VALUE_METHODS = %i[to_result value success?].freeze
-    private_constant :VALUE_METHODS
+    include Cuprum::ResultHelpers
 
     # Returns a nonnegative integer for commands that take a fixed number of
     # arguments. For commands that take a variable number of arguments, returns
@@ -68,7 +67,7 @@ module Cuprum
     # @return [Integer] The number of arguments.
     def arity
       method(:process).arity
-    end # method arity
+    end
 
     # @overload call(*arguments, **keywords, &block)
     #   Executes the command implementation and returns a Cuprum::Result or
@@ -76,14 +75,12 @@ module Cuprum
     #
     #   Each time #call is invoked, the object performs the following steps:
     #
-    #   1. Creates a result object, typically an instance of Cuprum::Result.
-    #      The result is assigned to the command as the private #result reader.
-    #   2. The #process method is called, passing the arguments, keywords, and
-    #      block that were passed to #call. The #process method can set errors,
-    #      set the status, or halt the result via the #result reader method.
-    #   3. If #process returns a result, that result is returned by #call.
-    #      Otherwise, the return value of #process is assigned to the #value
-    #      property of the result, and the result is returned by #call.
+    #   1. The #process method is called, passing the arguments, keywords, and
+    #      block that were passed to #call.
+    #   2. If the value returned by #process is a Cuprum::Result or compatible
+    #      object, that result is directly returned by #call.
+    #   3. Otherwise, the value returned by #process will be wrapped in a
+    #      successful result, which will be returned by #call.
     #
     #   @param arguments [Array] Arguments to be passed to the implementation.
     #
@@ -93,43 +90,28 @@ module Cuprum
     #
     #   @yield If a block argument is given, it will be passed to the
     #     implementation.
-    #
-    #   @raise [Cuprum::Errors::ProcessNotImplementedError] Unless the #process
-    #     method was overriden.
-    def call *args, &block
-      process_with_result(build_result, *args, &block)
-    end # method call
-
-    private
-
-    # @return [Cuprum::Result] The current result. Only available while #process
-    #   is being called.
-    attr_reader :result
-
-    def build_result value = nil, **options
-      Cuprum::Result.new(value, options)
-    end # method build_result
+    def call(*args, **kwargs, &block)
+      value =
+        if kwargs.empty?
+          process(*args, &block)
+        else
+          process(*args, **kwargs, &block)
+        end
 
-    def merge_results result, other
-      if value_is_result?(other)
-        return result if result == other
+      return value.to_cuprum_result if value_is_result?(value)
 
-        warn_unless_empty!(result)
+      build_result(value: value)
+    end
 
-        other.to_result
-      else
-        result.value = other
-
-        result
-      end # if-else
-    end # method merge_results
+    private
 
     # @!visibility public
     # @overload process(*arguments, **keywords, &block)
     #   The implementation of the command, to be executed when the #call method
-    #   is called. Can add errors to or set the status of the result, and the
-    #   value of the result will be set to the value returned by #process. Do
-    #   not call this method directly.
+    #   is called. If #process returns a result, that result will be returned by
+    #   #call; otherwise, the value returned by #process will be wrapped in a
+    #   successful Cuprum::Result object. This method should not be called
+    #   directly.
     #
     #   @param arguments [Array] The arguments, if any, passed from #call.
     #
@@ -139,34 +121,15 @@ module Cuprum
     #
     #   @return [Object] the value of the result object to be returned by #call.
     #
-    #   @raise [Cuprum::Errors::ProcessNotImplementedError] Unless a block was
-    #     passed to the constructor or the #process method was overriden by a
-    #     Command subclass.
-    #
     # @note This is a private method.
-    def process *_args
-      raise Cuprum::Errors::ProcessNotImplementedError, nil, caller(1..-1)
-    end # method process
-
-    def process_with_result result, *args, &block
-      @result = result
-      value   = process(*args, &block)
-
-      merge_results(result, value)
-    ensure
-      @result = nil
-    end # method process_with_result
-
-    def value_is_result? value
-      VALUE_METHODS.all? { |method_name| value.respond_to?(method_name) }
-    end # method value
-
-    def warn_unless_empty! result
-      return unless result.respond_to?(:empty?) && !result.empty?
+    def process(*_args)
+      error = Cuprum::Errors::CommandNotImplemented.new(command: self)
 
-      not_empty = Cuprum::Utils::ResultNotEmptyWarning.new(result)
+      build_result(error: error)
+    end
 
-      Cuprum.warn(not_empty.message) if not_empty.warning?
-    end # method warn_unless_empty!
-  end # module
-end # module
+    def value_is_result?(value)
+      value.respond_to?(:to_cuprum_result)
+    end
+  end
+end

data/lib/cuprum/result.rb

@@ -1,166 +1,91 @@
+# frozen_string_literal: true
+
 require 'cuprum'
 
 module Cuprum
   # Data object that encapsulates the result of calling a Cuprum command.
   class Result
+    STATUSES = %i[success failure].freeze
+
     # @param value [Object] The value returned by calling the command.
-    # @param errors [Array] The errors (if any) generated when the command was
-    #   called.
-    def initialize value = nil, errors: nil
+    # @param error [Object] The error (if any) generated when the command was
+    #   called. Can be a Cuprum::Error, a model errors object, etc.
+    # @param status [String, Symbol] The status of the result. Must be :success,
+    #   :failure, or nil.
+    def initialize(value: nil, error: nil, status: nil)
       @value  = value
-      @errors = errors.nil? ? build_errors : errors
-      @status = nil
-      @halted = false
-    end # constructor
+      @error  = error
+      @status = resolve_status(status)
+    end
 
     # @return [Object] the value returned by calling the command.
-    attr_accessor :value
+    attr_reader :value
 
-    # @return [Array] the errors (if any) generated when the command was
+    # @return [Object] the error (if any) generated when the command was
     #   called.
-    attr_accessor :errors
+    attr_reader :error
+
+    # @return [Symbol] the status of the result, either :success or :failure.
+    attr_reader :status
 
-    # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/PerceivedComplexity
 
     # Compares the other object to the result.
     #
     # @param other [#value, #success?] An object responding to, at minimum,
-    #   #value and #success?. If present, the #failure?, #errors and #halted?
-    #   values will also be compared.
+    #   #value and #success?. If present, the #failure? and #error values
+    #   will also be compared.
     #
     # @return [Boolean] True if all present values match the result, otherwise
     #   false.
-    def == other
-      return false unless other.respond_to?(:value) && other.value == value
-
-      unless other.respond_to?(:success?) && other.success? == success?
-        return false
-      end # unless
-
-      if other.respond_to?(:failure?) && other.failure? != failure?
-        return false
-      end # if
-
-      if other.respond_to?(:errors) && other.errors != errors
-        return false
-      end # if
-
-      if other.respond_to?(:halted?) && other.halted? != halted?
-        return false
-      end # if
+    def ==(other)
+      return false unless other.respond_to?(:value)  && other.value  == value
+      return false unless other.respond_to?(:status) && other.status == status
+      return false unless other.respond_to?(:error)  && other.error  == error
 
       true
-    end # method ==
-    # rubocop:enable Metrics/AbcSize
+    end
     # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/PerceivedComplexity
-
-    # @return [Boolean] true if the result is empty, i.e. has no value or errors
-    #   and does not have its status set or is halted.
-    def empty?
-      value.nil? && errors.empty? && @status.nil? && !halted?
-    end # method empty?
 
-    # Marks the result as a failure, whether or not the command generated any
-    # errors.
-    #
-    # @return [Cuprum::Result] The result.
-    def failure!
-      @status = :failure
-
-      self
-    end # method failure!
-
-    # @return [Boolean] false if the command did not generate any errors,
-    #   otherwise true.
+    # @return [Boolean] true if the result status is :failure, otherwise false.
     def failure?
-      @status == :failure || (@status.nil? && !errors.empty?)
-    end # method failure?
+      @status == :failure
+    end
 
-    # Marks the result as halted. Any subsequent chained commands will not be
-    #   run.
-    #
-    # @return [Cuprum::Result] The result.
-    def halt!
-      @halted = true
-
-      self
-    end # method halt!
-
-    # @return [Boolean] true if the command has been halted, and will not run
-    #   any subsequent chained commands.
-    def halted?
-      @halted
-    end # method halted?
-
-    # Marks the result as a success, whether or not the command generated any
-    # errors.
-    #
-    # @return [Cuprum::Result] The result.
-    def success!
-      @status = :success
-
-      self
-    end # method success!
-
-    # @return [Boolean] true if the command did not generate any errors,
-    #   otherwise false.
+    # @return [Boolean] true if the result status is :success, otherwise false.
     def success?
-      @status == :success || (@status.nil? && errors.empty?)
-    end # method success?
+      @status == :success
+    end
 
     # @return [Cuprum::Result] The result.
-    def to_result
+    def to_cuprum_result
       self
-    end # method to_result
-
-    # @api private
-    def update other_result
-      return self if other_result.nil?
-
-      self.value = other_result.value
+    end
 
-      update_status(other_result)
-
-      update_errors(other_result)
+    private
 
-      halt! if other_result.halted?
+    def defined_statuses
+      self.class::STATUSES
+    end
 
-      self
-    end # method update
+    def normalize_status(status)
+      return status unless status.is_a?(String) || status.is_a?(Symbol)
 
-    protected
-
-    attr_reader :status
+      tools.string_tools.underscore(status).intern
+    end
 
-    private
-
-    # @!visibility public
-    #
-    # Generates an empty errors object. When the command is called, the result
-    # will have its #errors property initialized to the value returned by
-    # #build_errors. By default, this is an array. If you want to use a custom
-    # errors object type, override this method in a subclass.
-    #
-    # @return [Array] An empty errors object.
-    def build_errors
-      []
-    end # method build_errors
+    def resolve_status(status)
+      return error.nil? ? :success : :failure if status.nil?
 
-    def update_errors other_result
-      return if other_result.errors.empty?
+      normalized = normalize_status(status)
 
-      @errors += other_result.errors
-    end # method update_errors
+      return normalized if defined_statuses.include?(normalized)
 
-    def update_status other_result
-      return if status || !errors.empty?
+      raise ArgumentError, "invalid status #{status.inspect}"
+    end
 
-      @status = other_result.status
-    end # method update_status
-  end # class
-end # module
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end
+  end
+end