cuprum 0.8.0 → 0.9.0.beta.0

data/lib/cuprum/version.rb

@@ -8,13 +8,13 @@ module Cuprum
     # Major version.
     MAJOR = 0
     # Minor version.
-    MINOR = 8
+    MINOR = 9
     # Patch version.
     PATCH = 0
     # Prerelease version.
-    PRERELEASE = nil
+    PRERELEASE = :beta
     # Build metadata.
-    BUILD = nil
+    BUILD = 0
 
     class << self
       # Generates the gem version string from the Version constants.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuprum
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0.beta.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2019-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sleeping_king_studios-tools
@@ -116,15 +116,18 @@ files:
 - lib/cuprum/chaining.rb
 - lib/cuprum/command.rb
 - lib/cuprum/command_factory.rb
+- lib/cuprum/error.rb
 - lib/cuprum/errors.rb
-- lib/cuprum/errors/process_not_implemented_error.rb
+- lib/cuprum/errors/command_not_implemented.rb
+- lib/cuprum/errors/operation_not_called.rb
 - lib/cuprum/operation.rb
 - lib/cuprum/processing.rb
 - lib/cuprum/result.rb
-- lib/cuprum/result_helpers.rb
+- lib/cuprum/rspec.rb
+- lib/cuprum/rspec/be_a_result.rb
+- lib/cuprum/rspec/be_a_result_matcher.rb
 - lib/cuprum/utils.rb
 - lib/cuprum/utils/instance_spy.rb
-- lib/cuprum/utils/result_not_empty_warning.rb
 - lib/cuprum/version.rb
 homepage: http://sleepingkingstudios.com
 licenses:
@@ -141,12 +144,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An opinionated implementation of the Command pattern.

data/lib/cuprum/errors/process_not_implemented_error.rb

@@ -1,14 +0,0 @@
-require 'cuprum/errors'
-
-module Cuprum::Errors
-  # Error class for calling a Command that was not given a definition block
-  # or have a #process method defined.
-  class ProcessNotImplementedError < StandardError
-    # Error message for a ProcessNotImplementedError.
-    DEFAULT_MESSAGE = 'no implementation defined for command'.freeze
-
-    def initialize message = nil
-      super(message || DEFAULT_MESSAGE)
-    end
-  end
-end

data/lib/cuprum/result_helpers.rb

@@ -1,113 +0,0 @@
-require 'cuprum'
-
-module Cuprum
-  # Helper methods that delegate result methods to the currently processed
-  # result.
-  #
-  # @example
-  #   class LogCommand
-  #     include Cuprum::Processing
-  #     include Cuprum::ResultHelpers
-  #
-  #     private
-  #
-  #     def process log
-  #       case log[:level]
-  #       when 'fatal'
-  #         halt!
-  #
-  #         'error'
-  #       when 'error' && log[:message]
-  #         errors << message
-  #
-  #         'error'
-  #       when 'error'
-  #         failure!
-  #
-  #         'error'
-  #       else
-  #         'ok'
-  #       end # case
-  #     end # method process
-  #   end # class
-  #
-  #   result = LogCommand.new.call(:level => 'info')
-  #   result.success? #=> true
-  #
-  #   string = 'something went wrong'
-  #   result = LogCommand.new.call(:level => 'error', :message => string)
-  #   result.success? #=> false
-  #   result.errors   #=> ['something went wrong']
-  #
-  #   result = LogCommand.new.call(:level => 'error')
-  #   result.success? #=> false
-  #   result.errors   #=> []
-  #
-  #   result = LogCommand.new.call(:level => 'fatal')
-  #   result.halted? #=> true
-  #
-  # @see Cuprum::Command
-  module ResultHelpers
-    private
-
-    # @!visibility public
-    #
-    # Provides a reference to the current result's errors object. Messages or
-    # error objects added to this will be included in the #errors method of the
-    # returned result object.
-    #
-    # @return [Array, Object] The errors object.
-    #
-    # @see Cuprum::Result#errors.
-    #
-    # @note This is a private method, and only available when executing the
-    #   command implementation as defined in the constructor block or the
-    #   #process method.
-    def errors
-      result&.errors
-    end # method errors
-
-    # @!visibility public
-    #
-    # Marks the current result as failed. Calling #failure? on the returned
-    # result object will evaluate to true, whether or not the result has any
-    # errors.
-    #
-    # @see Cuprum::Result#failure!.
-    #
-    # @note This is a private method, and only available when executing the
-    #   command implementation as defined in the constructor block or the
-    #   #process method.
-    def failure!
-      result&.failure!
-    end # method failure!
-
-    # @!visibility public
-    #
-    # Marks the current result as halted.
-    #
-    # @see Cuprum::Result#halt!.
-    #
-    # @note This is a private method, and only available when executing the
-    #   command implementation as defined in the constructor block or the
-    #   #process method.
-    def halt!
-      result&.halt!
-    end # method halt!
-
-    # @!visibility public
-    #
-    # Marks the current result as passing. Calling #success? on the returned
-    # result object will evaluate to true, whether or not the result has any
-    # errors.
-    #
-    # @see Cuprum::Result#success!.
-    #
-    # @note This is a private method, and only available when executing the
-    #   command implementation as defined in the constructor block or the
-    #   #process method.
-    def success!
-      result&.success!
-    end # method success!
-  end # module
-end # module

data/lib/cuprum/utils/result_not_empty_warning.rb

@@ -1,72 +0,0 @@
-require 'cuprum/utils'
-
-module Cuprum::Utils
-  # Helper class for building a warning message when a command returns a result,
-  # but the command's current result already has errors, a set status, or is
-  # halted.
-  class ResultNotEmptyWarning
-    MESSAGE = '#process returned a result, but '.freeze
-    private_constant :MESSAGE
-
-    # @param result [Cuprum::Result] The result for which to generate the
-    #   warning message.
-    def initialize result
-      @result = result
-    end # constructor
-
-    # @return [String] The warning message for the given result.
-    def message
-      return ''.freeze if warnings.empty?
-
-      MESSAGE + humanize_list(warnings).freeze
-    end # method message
-
-    # @return [Boolean] True if a warning is generated, otherwise false.
-    def warning?
-      !warnings.empty?
-    end # method warning?
-
-    private
-
-    attr_reader :result
-
-    def errors_not_empty_warning
-      return nil if result.errors.empty?
-
-      "there were already errors #{@result.errors.inspect}".freeze
-    end # method errors_not_empty_warning
-
-    def halted_warning
-      return nil unless result.halted?
-
-      'the command was halted'.freeze
-    end # method halted_warning
-
-    def humanize_list list, empty_value: ''
-      return empty_value if list.size.zero?
-
-      return list.first.to_s if list.size == 1
-
-      return "#{list.first} and #{list.last}" if list.size == 2
-
-      "#{list[0...-1].join ', '}, and #{list.last}"
-    end # method humanize_list
-
-    def status_set_warning
-      status = result.send(:status)
-
-      return nil if status.nil?
-
-      "the status was set to #{status.inspect}".freeze
-    end # method status_set_warning
-
-    def warnings
-      @warnings ||=
-        [
-          errors_not_empty_warning,
-          status_set_warning,
-          halted_warning
-        ].compact
-    end # method warnings
-  end # class
-end # module