cuprum 0.7.0 → 0.8.0

data/lib/cuprum/errors.rb

@@ -0,0 +1,6 @@
+require 'cuprum'
+
+module Cuprum
+  # Namespace for custom Cuprum error classes.
+  module Errors; end
+end

data/lib/cuprum/{not_implemented_error.rb → errors/process_not_implemented_error.rb}

@@ -1,14 +1,14 @@
-require 'cuprum'
+require 'cuprum/errors'
 
-module Cuprum
+module Cuprum::Errors
   # Error class for calling a Command that was not given a definition block
   # or have a #process method defined.
-  class NotImplementedError < StandardError
-    # Error message for a NotImplementedError.
+  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 # constructor
-  end # class
-end # module
+    end
+  end
+end

data/lib/cuprum/operation.rb

@@ -61,9 +61,9 @@ module Cuprum
       #   @yield If a block argument is given, it will be passed to the
       #     implementation.
       #
-      #   @raise [Cuprum::NotImplementedError] Unless a block was passed to the
-      #     constructor or the #process method was overriden by a Command
-      #     subclass.
+      #   @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

data/lib/cuprum/processing.rb

@@ -1,4 +1,4 @@
-require 'cuprum/not_implemented_error'
+require 'cuprum/errors/process_not_implemented_error'
 require 'cuprum/utils/result_not_empty_warning'
 
 module Cuprum
@@ -94,12 +94,10 @@ module Cuprum
     #   @yield If a block argument is given, it will be passed to the
     #     implementation.
     #
-    #   @raise [Cuprum::NotImplementedError] Unless the #process method was
-    #     overriden.
+    #   @raise [Cuprum::Errors::ProcessNotImplementedError] Unless the #process
+    #     method was overriden.
     def call *args, &block
-      result = build_result(nil, :errors => build_errors)
-
-      process_with_result(result, *args, &block)
+      process_with_result(build_result, *args, &block)
     end # method call
 
     private
@@ -108,20 +106,8 @@ module Cuprum
     #   is being called.
     attr_reader :result
 
-    # @!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 build_result value, errors:
-      Cuprum::Result.new(value, :errors => errors)
+    def build_result value = nil, **options
+      Cuprum::Result.new(value, options)
     end # method build_result
 
     def merge_results result, other
@@ -153,13 +139,13 @@ module Cuprum
     #
     #   @return [Object] the value of the result object to be returned by #call.
     #
-    #   @raise [Cuprum::NotImplementedError] Unless a block was passed to the
-    #     constructor or the #process method was overriden by a Command
-    #     subclass.
+    #   @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::NotImplementedError, nil, caller(1..-1)
+      raise Cuprum::Errors::ProcessNotImplementedError, nil, caller(1..-1)
     end # method process
 
     def process_with_result result, *args, &block

data/lib/cuprum/result.rb

@@ -6,9 +6,9 @@ module Cuprum
     # @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: []
+    def initialize value = nil, errors: nil
       @value  = value
-      @errors = errors
+      @errors = errors.nil? ? build_errors : errors
       @status = nil
       @halted = false
     end # constructor
@@ -139,6 +139,18 @@ module Cuprum
 
     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 update_errors other_result
       return if other_result.errors.empty?
 

data/lib/cuprum/version.rb

@@ -8,7 +8,7 @@ module Cuprum
     # Major version.
     MAJOR = 0
     # Minor version.
-    MINOR = 7
+    MINOR = 8
     # Patch version.
     PATCH = 0
     # Prerelease version.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cuprum
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-30 00:00:00.000000000 Z
+date: 2018-12-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sleeping_king_studios-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +115,9 @@ files:
 - lib/cuprum/built_in/null_operation.rb
 - lib/cuprum/chaining.rb
 - lib/cuprum/command.rb
-- lib/cuprum/not_implemented_error.rb
+- lib/cuprum/command_factory.rb
+- lib/cuprum/errors.rb
+- lib/cuprum/errors/process_not_implemented_error.rb
 - lib/cuprum/operation.rb
 - lib/cuprum/processing.rb
 - lib/cuprum/result.rb