cuprum 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efcbe5a6b4ca1b381c726a91e07ddd2bb8dac8c07194ce9f6b9690e86cfdf2d6
-  data.tar.gz: adb0d828d01b2f451b7328e06d660cc69c418cfe9ae42e7187aac8b1ae465c02
+  metadata.gz: f867011719a69bd7080c77d450fedfee736ef6df5be2b8a2d11fe3b1006a3890
+  data.tar.gz: 48109c5460f817fedb8c6a46b84649a87d9c21e2d2dbadba31b31e32bdf20977
 SHA512:
-  metadata.gz: 5fa4192edc22b4f18089aae7195b623b36e81db3fb8d0d4cf3b76d5849023362f55cad5036ea18ac9f972483b4fe5663149075597cd77ab196420d0045ffae74
-  data.tar.gz: 9758bf698c95c686d296e815cd0283da4cbb7d8b4982f1c27f9f2e0114d2e97548fe38ee265ba7fac4a8cff86305918f6d4b830c31488efb78d62dc8fcfc61d6
+  metadata.gz: b272e3d32edf7449a83a8513be56f8e68e2474872621d055f5947b6605ec5c29ecbd4acc7e7155d1efd5ee122689dc564eaab312b499ff129d996c6e6599ff90
+  data.tar.gz: 7ad63c437101991668b8a060fa355633f46b269ad55d609fad81bf5e993b998974f43ae61bc96d2c781a10e29d83178a7b2770ec2540a121f54bf6261530fcce

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.9.1
+
+### Operations
+
+Delegate Operation#status to the most recent result.
+
+### RSpec
+
+The #be_a_passing_result macro now automatically adds a `with_error(nil)` expectation.
+
+- This causes the error (if any) to be displayed when matching a failing result.
+- This may break some cases when expecting a passing result that still has an error; in these cases, add an error expectation to the call, e.g. `expect().to be_a_passing_result.with_error(some_error)`.
+
+Improve failure message of BeAResultMatcher under some circumstances.
+
 ## 0.9.0
 
 The "'Tis Not Too Late To Seek A Newer World" Update
@@ -101,21 +116,21 @@ The "Name Not Found For NullFunction" Update.
 
 Added the `Cuprum::warn` helper, which prints a warning message. By default, `::warn` delegates to `Kernel#warn`, but can be configured (e.g. to call a Logger) by setting `Cuprum::warning_proc=` with a Proc that accepts one argument (the message to display).
 
-## Operations
+### Operations
 
 The implementation of `Cuprum::Operation` has been extracted to a module at `Cuprum::Operation::Mixin`, allowing users to easily convert an existing function class or instance to an operation.
 
-## Results
+### Results
 
 Implemented `Cuprum::Result#==` as a fuzzy comparison, allowing a result to be equal to any object with the same value and status.
 
 Implemented `Cuprum::Result#empty?`, which returns true for a new result and false for a result with a value, with non-empty errors, a result with set status, or a halted result.
 
-## Utilities
+### Utilities
 
 Added the `Cuprum::Utils::InstanceSpy` module to empower testing of code that calls a function without providing a reference, such as some chained functions.
 
-## Built In Functions
+### Built In Functions
 
 Added the `NullFunction` and `NullOperation` predefined classes, which do nothing when called and return a result with no errors and a value of nil.
 
@@ -125,7 +140,7 @@ Added the `IdentityFunction` and `IdentityOperation` predefined classes, which r
 
 The "Halt And Catch Fire" Update.
 
-## Functions
+### Functions
 
 Can now call `#success!` or `#failure!` in a function block or `#process` method to override the default, error-based status for the result. This allows for a passing result that still has errors, or a failing result that does not have explicit errors.
 
@@ -135,11 +150,11 @@ Can now generate results with custom error objects by overriding the `#build_err
 
 Fixed an inconsistency issue when a function block or `#process` method returned an instance of `Cuprum::Result`.
 
-## Operations
+### Operations
 
 Calling `#call` on an operation now returns the operation instance.
 
-## Results
+### Results
 
 Can now call `#success!` or `#failure!` to override the default, error-based status.
 
@@ -149,11 +164,11 @@ Can now call `#halt!` and check the `#halted?` status. A halted result will prev
 
 The "Nothing To Lose But Your Chains" Update.
 
-## Functions
+### Functions
 
 Now support chaining via the `#chain`, `#then`, and `#else` methods.
 
-## Results
+### Results
 
 Can pass a value and/or an errors object to the constructor.
 

data/DEVELOPMENT.md

@@ -17,12 +17,36 @@ The "One Small Step" Update
   - Called with command (block? method?) that returns a Result.
   - Raise (and catch) exception on non-success Result (test custom status?)
   - Otherwise return Result#value.
+- Deprecate #chain and its related methods
+
+### Documentation
+
+Steps Case Study: |
+
+  CMS application - creating a new post.
+  Directory has many Posts
+  Post has a Content
+  Content has many ContentVersions
+  Post has many Tags
+
+  Find Directory
+  Create Post
+  Create Content
+  Create ContentVersion
+  Tags.each { FindOrCreate Tag }
 
 ### Matcher
 
 - Handle success(), failure(), failure(SomeError) cases.
   - Custom matcher to handle additional cases - halted, pending, etc?
 
+### RSpec
+
+- be_callable matcher - delegates to respond_to(), but check arguments of
+  private #process method
+- call_command_step matcher
+- (optionally) alias be_a_result family as have_result for operations
+
 ## Version 1.0.0
 
 'The "Look On My Works, Ye Mighty, and Despair" Update'
@@ -34,7 +58,7 @@ The "One Small Step" Update
 ### Commands
 
 - Command#to_proc
-- :clear_errors => true option on #chain
+- Remove #chain and its related methods
 
 ### Commands - Built In
 
@@ -42,22 +66,6 @@ The "One Small Step" Update
   as array
 - RetryCommand
 
-### Documentation
-
-Chaining Case Study: |
-
-  CMS application - creating a new post.
-  Directory has many Posts
-  Post has a Content
-  Content has many ContentVersions
-  Post has many Tags
-
-  Find Directory
-  Create Post
-  Create Content
-  Create ContentVersion
-  Tags.each { FindOrCreate Tag }
-
 ## Future Versions
 
 ### Commands
@@ -68,10 +76,6 @@ Chaining Case Study: |
 
 - ::process - shortcut for defining #process
 - ::rescue - `rescue StandardError do ... end`, rescues matched errors in #process
-- chaining methods:
-  - ::chain (::success, ::failure):
-    on #initialize, chains the given command. Can be given a command class
-    (if ::new takes no arguments) or a block that returns a command.
 - constructor methods:
   - Programmatically generate a constructor method. Raises an error if
     #initialize is defined. Automatically sets instance variables on initialize,
@@ -82,4 +86,6 @@ Chaining Case Study: |
     optional arguments and their default values.
   - ::keywords - sets keyword arguments; same arguments as ::arguments.
 
-#### Hooks
+#### Dependency Injection
+
+- shorthand for referencing a sequence of operations

data/lib/cuprum/operation.rb

@@ -101,6 +101,12 @@ module Cuprum
         @result = nil
       end # method reset
 
+      # @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.

data/lib/cuprum/rspec/be_a_result.rb

@@ -9,7 +9,7 @@ module RSpec
     end
 
     def be_a_passing_result
-      be_a_result.with_status(:success)
+      be_a_result.with_status(:success).and_error(nil)
     end
 
     def be_a_result

data/lib/cuprum/rspec/be_a_result_matcher.rb

@@ -10,6 +10,9 @@ module Cuprum::RSpec
     DEFAULT_VALUE = Object.new.freeze
     private_constant :DEFAULT_VALUE
 
+    RSPEC_MATCHER_METHODS = %i[description failure_message matches?].freeze
+    private_constant :RSPEC_MATCHER_METHODS
+
     def initialize
       @expected_error = DEFAULT_VALUE
       @expected_value = DEFAULT_VALUE
@@ -151,7 +154,9 @@ module Cuprum::RSpec
     end
 
     def expected_properties?
-      expected_error? || expected_status? || expected_value?
+      (expected_error? && !expected_error.nil?) ||
+        expected_status? ||
+        expected_value?
     end
 
     def expected_error?
@@ -167,7 +172,7 @@ module Cuprum::RSpec
     end
 
     def inspect_expected(expected)
-      return expected.description if expected.respond_to?(:description)
+      return expected.description if rspec_matcher?(expected)
 
       expected.inspect
     end
@@ -177,11 +182,13 @@ module Cuprum::RSpec
       ' positives, since any other result will match.'
     end
 
-    def properties_description # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
+    def properties_description
       msg = ''
       ary = []
       ary << 'value' if expected_value?
-      ary << 'error' if expected_error?
+      ary << 'error' if expected_error? && !expected_error.nil?
 
       unless ary.empty?
         msg = "with the expected #{tools.array.humanize_list(ary)}"
@@ -193,6 +200,8 @@ module Cuprum::RSpec
 
       msg + " and status: #{expected_status.inspect}"
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/AbcSize
 
     def properties_failure_message
       properties_short_message +
@@ -234,6 +243,12 @@ module Cuprum::RSpec
       @result ||= actual.to_cuprum_result
     end
 
+    def rspec_matcher?(value)
+      RSPEC_MATCHER_METHODS.all? do |method_name|
+        value.respond_to?(method_name)
+      end
+    end
+
     def status_failure_message
       return '' if status_matches?
 

data/lib/cuprum/version.rb

@@ -10,7 +10,7 @@ module Cuprum
     # Minor version.
     MINOR = 9
     # Patch version.
-    PATCH = 0
+    PATCH = 1
     # Prerelease version.
     PRERELEASE = nil
     # Build metadata.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuprum
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-15 00:00:00.000000000 Z
+date: 2019-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sleeping_king_studios-tools