cuprum 0.6.0 → 0.7.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c749e3c0c387227604f9ca4be639d3cabf06dcc
-  data.tar.gz: 779b36680827fb53d901fbe44436e679cf703cfd
+  metadata.gz: 42f7f2e7dafb202aa6ccef0b4f11972a70ba1206
+  data.tar.gz: 920ad2c0c2ef8916faf1696d0c17abb040d5e8b4
 SHA512:
-  metadata.gz: 95cb4d600263513ef199f4c578f45569eb62052fcd9806fe3f8195ee707fa8fddbaf3704b136192e66186751febefac90050deb51cfaeb502c39eecc75817ea4
-  data.tar.gz: c4571461ea2b47e78598fa46ae21273d439ea8c3b06bb1129b54135850197d5fbc80dc583547464b4d1fcbef89333dc1a042d3aba9c5323887c8abcedef6b05b
+  metadata.gz: 68ce14ebada98c8a1fb6e0b3f3fc0e0c8cadbc3e487b6661c82f144927c1aef2a8dd8e392217e419f25b47db1f133a1eda2b0440a75004390066a509e5cd40c3
+  data.tar.gz: 4238932688704262a554d90483bb3642ee3d84c13b31a7db35e64d6a1a8496db4abb0b95bbdd5c1b84df50d5893579500fb1673268226140d9774795327e1a13

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.7.0
+
+The "To Strive, To Seek, To Find, And Not To Yield" Update.
+
+### Commands
+
+Refactored the `#chain` method. If given a block, will create an anonymous command. The command will be called with the value of the previous result, and additionally the previous result errors, success/failure status, and halted status will be available in the command.
+
+Implemented the `#yield_result` method, which takes a block, yields the previous result, and wraps the return value of the block in a result.
+
+Implemented the `#tap_result` method, which functions as `#yield_result` but always returns the previous result.
+
+Renamed the `#else` method to `#failure`, and the `#then` method to `#success` to avoid overloading reserved words.
+
+Implemented the `#arity` method, which returns an indication of the number of arguments accepted by the command.
+
+Refactored internal logic for returning result objects.
+
 ## 0.6.0
 
 The "By Your Command" Update.

data/DEVELOPMENT.md

@@ -1,58 +1,63 @@
 # Development
 
-- Update documentation.
-
-## Core
-
-## Command
-
-- Chaining Methods:
-  - #chain:
-    - with a command, sets the command's #result to the last result and calls
-      #process with the last result's #value; returns result of calling chained
-      command.
-    - with a block creates anonymous command, then see above
-    - if the command does not accept any arguments (or keywords if #value is a
-      Hash), does not pass #value. Requires #arity, #apply_chained?
-    - one argument (on), values nil (default), :success, :failure, :always
-  - #success - as chain(:success)
-  - #failure - as chain(:failure)
-  - #tap_result:
-    - block form only, block is yielded and returns the last result
-    - same argument as #chain
-  - #yield_result:
-    - block form only, block is yielded the last result, returns the return
-      value of the block (wrapped in a result if needed)
-    - same argument as #chain
+## Version 1.0.0+
+
+'The "Look On My Works, Ye Mighty, and Despair" Update'
+
+- Integration specs.
+- Configuration option to raise, warn, ignore discarded results.
+
+### Commands
+
 - Protected Chaining Methods:
   - #chain!, #success!, #failure!, #tap_chain!, #yield_result!
   - adds chained command to current command instead of a clone.
-- private #build_result
-
-### Built In
-
-- MapCommand - wraps a command (or proc) and returns Result with value, errors
-  as array
-- RetryCommand
+- Command#to_proc
+- :clear_errors => true option on #chain
+- #context object
 
-### DSL
+#### Cuprum::DSL
 
-- class-level methods
+- ::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.
-  - ::process - shortcut for defining #process
-  - ::rescue - `rescue StandardError do ... end`, rescues matched errors in #process
-
-### Hooks
+- constructor methods:
+  - Programmatically generate a constructor method. Raises an error if
+    #initialize is defined. Automatically sets instance variables on initialize,
+    and defines reader methods.
+  - ::arguments - sets all positional arguments in the constructor. Takes 0 or
+    more String or Symbol arguments representing required arguments. Takes an
+    optional hash with String/Symbol keys and arbitrary values, representing
+    optional arguments and their default values.
+  - ::keywords - sets keyword arguments; same arguments as ::arguments.
+
+#### Hooks
 
 - :before, :around, :after hooks
 
-## Operation
+### Commands - Built In
+
+- MapCommand - wraps a command (or proc) and returns Result with value, errors
+  as array
+- RetryCommand
+
+### CommandFactory
 
-## Result
+- builder/aggregator for command objects, esp. with shared
+  initializers/parameters, e.g. actions for a resource
+- Syntax: |
 
-## Documentation
+  actions = ResourceCommandFactory.new(Book)
+  command = actions::Build.new        #=> returns a book builder command
+  result  = command.call(attributes)  #=> returns a result with value => a Book
+  # OR
+  result  = actions.build(attributes) #=> returns a result with value => a Book
+  book    = result.value
+
+### Documentation
 
 Chaining Case Study: |
 
@@ -67,5 +72,3 @@ Chaining Case Study: |
   Create Content
   Create ContentVersion
   Tags.each { FindOrCreate Tag }
-
-## Testing

data/README.md

@@ -17,7 +17,7 @@ Traditional frameworks such as Rails focus on the objects of your application -
 - **Consistency:** Use the same Commands to underlie controller actions, worker processes and test factories.
 - **Encapsulation:** Each Command is defined and run in isolation, and dependencies must be explicitly provided to the command when it is initialized or run. This makes it easier to reason about the command's behavior and keep it insulated from changes elsewhere in the code.
 - **Testability:** Because the logic is extracted from unnecessary context, testing its behavior is much cleaner and easier.
-- **Composability:** Complex logic such as "find the object with this ID, update it with these attributes, and log the transaction to the reporting service" can be extracted into a series of simple Commands and composed together. The [Chaining](#label-Chaining) feature allows for complex control flows.
+- **Composability:** Complex logic such as "find the object with this ID, update it with these attributes, and log the transaction to the reporting service" can be extracted into a series of simple Commands and composed together. The [Chaining](#label-Chaining+Commands) feature allows for complex control flows.
 - **Reusability:** Logic common to multiple data models or instances in your code, such as "persist an object to the database" or "find all records with a given user and created in a date range" can be refactored into parameterized commands.
 
 ### Alternatives
@@ -81,8 +81,12 @@ class BuildBookCommand < Cuprum::Command
 end # class
 
 command = BuildPostCommand.new
-result  = command.call(:title => 'The Hobbit') # an instance of Cuprum::Result
-result.value #=> an instance of Book with title 'The Hobbit'
+result  = command.call(:title => 'The Hobbit')
+result.class #=> Cuprum::Result
+
+book = result.value
+book.class #=> Book
+book.title #=> 'The Hobbit'
 ```
 
 There are several takeaways from this example. First, we are defining a custom command class that inherits from `Cuprum::Command`. We are defining the `#process` method, which takes a single `attributes` parameter and returns an instance of `Book`. Then, we are creating an instance of the command, and invoking the `#call` method with an attributes hash. These attributes are passed to our `#process` implementation. Invoking `#call` returns a result, and the `#value` of the result is our new Book.
@@ -119,8 +123,67 @@ increment_command = Cuprum::Command.new { |int| int + 1 }
 increment_command.call(2).value #=> 3
 ```
 
+If the command is wrapping a method on the receiver, the syntax is even simpler:
+
+```ruby
+inspect_command = Cuprum::Command.new { |obj| obj.inspect }
+inspect_command = Cuprum::Command.new(&:inspect) # Equivalent to above.
+```
+
 Commands defined using `Cuprum::Command.new` are quick to use, but more difficult to read and to reuse. Defining your own command class is recommended if a command definition takes up more than one line, or if the command will be used in more than one place.
 
+#### Result Values
+
+Calling the `#call` method on a `Cuprum::Command` instance will always return an instance of `Cuprum::Result`. The result's `#value` property is determined by the object returned by the `#process` method (if the command is defined as a class) or the block (if the command is defined by passing a block to `Cuprum::Command.new`).
+
+The `#value` depends on whether or not the returned object is a result or is compatible with the result interface. Specifically, any object that responds to the methods `#to_result`, `#value`, and `#success?` is considered to be a result.
+
+If the object returned is **not** a result, then the `#value` of the returned result is set to the object.
+
+```ruby
+command = Cuprum::Command.new { 'Greetings, programs!' }
+result  = command.call
+result.class #=> Cuprum::Result
+result.value #=> 'Greetings, programs!'
+```
+
+If the object returned is the command's own result object, then the `#value` of the returned result is unchanged. For convenience, methods to set the result status or mark the result as halted will return the result.
+
+```ruby
+command = Cuprum::Command.new { result.failure! }
+result  = command.call
+result.class    #=> Cuprum::Result
+result.value    #=> nil
+result.success? #=> false
+```
+
+If the object returned is another result or compatible object, then `#call` will call the `#to_result` method on the result and return the resulting object.
+
+```ruby
+command = Cuprum::Command.new { |value| Cuprum::Result.new(value) }
+result  = command.call('Greetings, starfighter!')
+result.class #=> Cuprum::Result
+result.value #=> 'Greetings, starfighter!'
+```
+
+In some cases, returning a result directly will discard information on the command's own result object. When this occurs, Cuprum will display a warning.
+
+```ruby
+command =
+  Cuprum::Command.new do
+    result.errors << 'Oops! We are throwing away this result.'
+
+    Cuprum::Result.new
+  end
+
+#=> This calls Kernel#warn with a warning message.
+result = command.call
+result.class    #=> Cuprum::Result
+result.value    #=> nil
+result.success? #=> true
+result.errors   #=> []
+```
+
 #### Success, Failure, and Errors
 
 Whether defined with a block or in the `#process` method, the Command implementation can access an `#errors` object while in the `#call` method. Any errors added to the errors object will be exposed by the `#errors` method on the result object.
@@ -171,95 +234,421 @@ result.value    #=> book
 book.published? #=> false
 ```
 
+#### Composing Commands
+
+Because Cuprum::Command instances are proper objects, they can be composed like any other object. For example, we could define some basic mathematical operations by composing commands:
+
+```ruby
+increment_command = Cuprum::Command.new { |i| i + 1 }
+increment_command.call(1).value #=> 2
+increment_command.call(2).value #=> 3
+increment_command.call(3).value #=> 4
+
+add_command = Cuprum::Command.new do |addend, i|
+  addend.times { i = increment_command(i).value }
+
+  i
+end # command
+
+add_command.call(1, 1).value #=> 2
+add_command.call(1, 2).value #=> 3
+add_command.call(2, 1).value #=> 3
+add_command.call(2, 2).value #=> 4
+```
+
+This can also be done using command classes.
+
+```ruby
+class IncrementCommand < Cuprum::Command
+  private
+
+  def process i
+    i + 1
+  end
+end
+
+class AddCommand < Cuprum::Command
+  def initialize addend
+    @addend = addend
+  end
+
+  private
+
+  def process i
+    addend.times { i = IncrementCommand.new.call(i).value }
+
+    i
+  end
+end
+
+add_two_command = AddCommand.new(2)
+add_two_command.call(0).value #=> 2
+add_two_command.call(1).value #=> 3
+add_two_command.call(8).value #=> 10
+```
+
 ### Chaining Commands
 
-Because Cuprum::Command instances are proper objects, they can be composed like any other object. Cuprum::Command also defines methods for chaining commands together. When a chain of commands is called, each command in the chain is called in sequence and passed the value of the previous command. The result of the last command in the chain is returned from the chained call.
+Cuprum::Command also defines methods for chaining commands together. When a chain of commands is called, each command in the chain is called in sequence and passed the value of the previous command. The result of the last command in the chain is returned from the chained call.
+
+```ruby
+name_command       = Cuprum::Command.new { |klass| klass.name }
+pluralize_command  = Cuprum::Command.new { |str| str.pluralize }
+underscore_command = Cuprum::Command.new { |str| str.underscore }
+
+table_name_command =
+  name_command
+    .chain(pluralize_command)
+    .chain(underscore_command)
+
+result = table_name_command.call(LibraryCard)
+result.class #=> Cuprum::Result
+result.value #=> 'library_cards'
+```
+
+When the `table_name_command` is called, the class (in our case `LibraryCard`) is passed to the first command in the chain, which is the `name_command`. This produces a Result with a value of 'LibraryCard'. This value is then passed to `pluralize_command`, which returns a Result with a value of 'LibraryCards'. Finally, `underscore_command` is called and returns a Result with a value of 'library_cards'. Since there are no more commands in the chain, this final result is then returned.
 
-    class AddCommand < Cuprum::Command
-      def initialize addend
-        @addend = addend
-      end # constructor
+Chained commands can also be defined with a block. This creates an anonymous command, equivalent to `Cuprum::Command.new {}`. Thus, the `table_name_command` could have been defined as either of these:
+
+```ruby
+table_name_command =
+  Cuprum::Command.new { |klass| klass.name }
+    .chain { |str| str.pluralize }
+    .chain { |str| str.underscore }
 
-      private
+table_name_command =
+  Cuprum::Command.new(&:name).chain(&:pluralize).chain(&:underscore)
+```
 
-      def process int
-        int + @addend
-      end # method process
-    end # class
+#### Chaining Details
 
-    double_and_add_one = MultiplyCommand.new(2).chain(AddCommand.new(1))
-    result             = double_and_add_one(5)
+The `#chain` method is defined for instances of `Cuprum::Command` (or object that extend `Cuprum::Chaining`). Calling `#chain` on a command will always create a copy of the command. The given command is then added to the command chain for the copied command. The original command is unchanged. Thus:
 
-    result.value #=> 5
+```ruby
+first_command = Cuprum::Command.new { puts 'First command!' }
+first_command.call #=> Outputs 'First command!' to STDOUT.
 
-For finer control over the returned result, `#chain` can instead be called with a block that yields the most recent result. If the block returns a Cuprum::Result, that result is returned or passed to the next command.
+second_command = first_command.chain { puts 'Second command!' }
+second_command.call #=> Outputs 'First command!' then 'Second command!'.
 
-    MultiplyCommand.new(3).
-      chain { |result| Cuprum::Result.new(result + 1) }.
-      call(3)
-    #=> Returns a Cuprum::Result with a value of 10.
+# The original command is unchanged.
+first_command.call #=> Outputs 'First command!' to STDOUT.
+```
 
-Otherwise, the block is still called but the previous result is returned or passed to the next command in the chain.
+When a chained command is called, the original command is called with whatever parameters are passed in to the `#call` method, and the command executes the `#process` method as normal, generating a `Cuprum::Result` and assigning it a value and optionally errors or a status. Rather than returning this result, however, it is passed on to the next command in the chain. In the context of a chained command, this means two things.
 
-    AddCommand.new(2).
-      chain { |result| puts "There are #{result.value} lights!" }.
-      call(2)
-    #=> Writes "There are 4 lights!" to STDOUT.
-    #=> Returns a Cuprum::Result with a value of 4.
+First, the next command is called. If the next command does not take any arguments, it is not passed any arguments. If the next command takes one or more arguments, it is passed the `#value` of that previous result.
+
+```ruby
+double_command    = Cuprum::Command.new { |i| 2 * i }
+increment_command = Cuprum::Command.new { |i| 1 + i }
+square_command    = Cuprum::Command.new { |i| i * i }
+chained_command   =
+  double_command
+    .chain(increment_command)
+    .chain(square_command)
+
+# First, the double_commmand is called with 2. This returns a Cuprum::Result
+# with a value of 4.
+#
+# Next, the increment_command is called with 4, returning a result with value 5.
+#
+# Finally, the square_command is called with 5, returning a result with a value
+# of 25. This final result is returned by #call.
+result = chained_command.call(2)
+result.class #=> Cuprum::Result
+result.value #=> 25
+```
+
+Second, the previous result is set as the result of the next command (before it is evaluated). This makes it available to the next command during execution as the `#result` method, and makes available the value, errors, and status of the previous command (and avoids unnecessary object allocation). The value of the result will be updated to reflect the return value of the next command execution.
+
+```ruby
+validate_command =
+  Cuprum::Command.new do |object|
+    result.errors << 'Object is invalid!' unless object.valid?
+
+    object
+  end
+persist_command =
+  Cuprum::Command.new do |object|
+    object.save if result.success?
+
+    object
+  end
+chained_command = validate_command.chain(persist_command)
+
+# First, validate_command is called with a valid object. This creates a result
+# with no errors and whose value is the valid object.
+#
+# Then, persist_command is called with the object, and its result is assigned to
+# the previous result. Since there are no errors on the result, the object is
+# saved. Finally, the value of the result is set to the object, and the result
+# is returned.
+result = chained_command.call(a_valid_object) #=> Saves the object.
+result.value              #=> a_valid_object
+result.errors             #=> []
+a_valid_object.persisted? #=> true
+
+# First, validate_command is called with an invalid object. This creates a
+# result whose value is the invalid object, and with errors 'Object is
+# invalid!'.
+#
+# Then, persist_command is called with the object, and its result is assigned to
+# the previous result. Since the result has an error, the object is not saved.
+# Finally, the value of the result is set to the object, and the result
+# is returned.
+result = chained_command.call(an_invalid_object) #=> Does not save the object.
+result.value                 #=> an_invalid_object
+result.errors                #=> ['Object is invalid!']
+an_invalid_object.persisted? #=> false
+```
 
 #### Conditional Chaining
 
-The `#chain` method can be passed an optional `:on` keyword, with values of `:success` and `:failure` accepted. If `#chain` is called with `:on => :success`, then the chained command or block will **only** be called if the previous result `#success?` returns true. Conversely, if `#chain` is called with `:on => :failure`, then the chained command will only be called if the previous result `#failure?` returns true.
+The `#chain` method can be passed an optional `:on => value` keyword. This keyword determines whether or not the chained command will execute, based on the previous result status. Possible values are `:success`, `:failure`, `:always`, or `nil`. The default value is `nil`.
+
+If the `:on` keyword is omitted, the chained command will always be executed after the previous command unless the result is halted (see [Halting A Command Chain](#label-Commands))
+
+If the command is chained with `:on => :success`, then the chained command will only execute if the previous result is passing, e.g. the `#success?` method returns true and the command is not halted. A result is passing if there are no errors, or if the status is set to `:success`.
 
-In either case, execution will then pass to the next command in the chain, which may itself be called or not if it was conditionally chained. Calling a conditional command chain will return the result of the last called command.
+If the command is chained with `:on => :failure`, then the chained command will only execute if the previous result is failing, e.g. the `#success?` method returns false and the command is not halted. A result is failing if the errors object is not empty, or if the status is set to `:failure`.
 
-The methods `#then` and `#else` serve as shortcuts for `#chain` with `:on => :success` and `:on => :failure`, respectively.
+If the command is chained with `:on => always`, then the chained command will always be executed, even if the previous result is halted.
 
-    class EvenCommand < Cuprum::Command
-      private
+```ruby
+find_command =
+  Cuprum::Command.new do |attributes|
+    book = Book.where(:id => attributes[:id]).first
+
+    result.errors << 'Book not found' unless book
 
-      def process int
-        errors << 'errors.messages.not_even' unless int.even?
+    book
+  end
+create_command =
+  Cuprum::Command.new do |attributes|
+    book = Book.new(attributes)
 
-        int
-      end # method process
-    end # class
+    if book.save
+      result.success!
+    else
+      book.errors.full_messages.each { |message| result.errors << message }
+    end
 
-    # The next step in a Collatz sequence is determined as follows:
-    # - If the number is even, divide it by 2.
-    # - If the number is odd, multiply it by 3 and add 1.
-    collatz_command =
-      EvenCommand.new.
-        then(DivideCommand.new(2)).
-        else(MultiplyCommand.new(3).chain(AddCommand.new(1)))
+    book
+  end
+
+find_or_create_command = find_command.chain(create_command, :on => :failure)
+
+# With a book that exists in the database, the find_command is called and
+# returns a result with no errors and a value of the found book. The
+# create_command is not called.
+hsh    = { id: 0, title: 'Journey to the West' }
+result = find_or_create_command.call(hsh)
+book   = result.value
+book.id         #=> 0
+book.title      #=> 'Journey to the West'
+result.success? #=> true
+result.errors   #=> []
 
-    result = collatz_command.new(5)
-    result.value #=> 16
+# With a book that does not exist but with valid attributes, the find command
+# returns a failing result with a value of nil. The create_command is called and
+# creates a new book with the attributes, returning a passing result but
+# preserving the errors.
+hsh    = { id: 1, title: 'The Ramayana' }
+result = find_or_create_command.call(hsh)
+book   = result.value
+book.id         #=> 1
+book.title      #=> 'The Ramayana'
+result.success? #=> true
+result.errors   #=> ['Book not found']
+
+# With a book that does not exist and with invalid attributes, the find command
+# returns a failing result with a value of nil. The create_command is called and
+# is unable to create a new book with the attributes, returning the
+# (non-persisted) book and adding the validation errors.
+hsh    = { id: 2, title: nil }
+result = find_or_create_command.call(hsh)
+book   = result.value
+book.id         #=> 2
+book.title      #=> nil
+result.success? #=> false
+result.errors   #=> ['Book not found', "Title can't be blank"]
+```
 
-    result = collatz_command.new(16)
-    result.value #=> 8
+The `#success` method can be used as shorthand for `chain(command, :on => :success)`. Likewise, the `#failure` method can be used in place of `chain(command, :on => :failure)`.
 
 #### Halting A Command Chain
 
 If the `#halt` method is called as part of a Command block or `#process` method, the command chain is halted. Any subsequent chained commands will not be called unless they were chained with the `:on => :always` option. This allows you to terminate a Command chain early without having to raise and rescue an exception.
 
-    panic_command =
-      Cuprum::Command.new do |value|
-        halt!
+```ruby
+double_command  = Cuprum::Command.new { |i| 2 * i }
+halt_command    = Cuprum::Command.new { |value| value.tap { result.halt! } }
+add_one_command = Cuprum::Command.new { |i| i + 1 }
+
+chained_command =
+  double_command
+    .chain(halt_command)
+    .chain(add_one_command)
+    .chain(:on => :always) { |count| "There are #{count} lights!" }
+
+# First, double_command is called with 2, returning a result with no errors and
+# a value of 4. Then, halt_command is called, which marks the result as halted.
+# Because the result is now halted, the add_one_command is not called. Finally,
+# the last command is called (even though the result is halted, the command is
+# chained :on => :always), which returns a result with the string value. The
+# result is passing, but is still halted.
+result = chained_command.call(2)
+result.value    #=> 'There are 4 lights!'
+result.success? #=> true
+result.halted?  #=> true
+```
+
+### Advanced Chaining
 
-        value
-      end # command
+The `#tap_result` and `#yield_result` methods provide advanced control over the flow of chained commands.
+
+#### Tap Result
+
+The `#tap_result` method allows you to insert arbitrary code into a command chain without affecting later commands. The method takes a block and yields the previous result, which is then returned and passed to the next command, or returned by `#call` if `#tap_result` is the last item in the chain.
 
-    result =
-      double_command.
-        then(panic_command).
-        then(AddCommand.new(1)). #=> This is never executed.
-        chain(:on => :always) { |count| puts "There are #{count} lights!" }.
-        call(2)
-    #=> Writes "There are 4 lights!" to STDOUT.
+```ruby
+command =
+  Cuprum::Command.new do
+    result.errors << 'Example error'
+
+    'Example value'
+  end
+chained_command =
+  command
+    .tap_result do |result|
+      puts "The result value was #{result.inspect}"
+    end
+
+# Prints 'The result value was "Example value"' to STDOUT.
+result = chained_command.call
+result.class    #=> Cuprum::Result
+result.value    #=> 'Example value'
+result.success? #=> false
+result.errors   #=> ['Example error']
+```
+
+Like `#chain`, `#tap_result` can be given an `:on => value` keyword.
 
-    result.value   #= 4
-    result.halted? #=> true
+```ruby
+find_book_command =
+  Cuprum::Command.new do |book_id|
+    book = Book.where(:id => book_id).first
+
+    result.errors << "Unable to find book with id #{book_id}" unless book
+
+    book
+  end
+
+chained_command =
+  find_book_command
+    .tap_result(:on => :success) do |result|
+      render :show, :locals => { :book => result.value }
+    end
+    .tap_result(:on => :failure) do
+      redirect_to books_path
+    end
+
+# Calls find_book_command with the id, which queries for the book and returns a
+# result with a value of the book and no errors. Then, the first tap_result
+# block is evaluated, calling the render method and passing it the book via the
+# result.value method. Because the result is passing, the next block is skipped.
+# Finally, the result of find_book_command is returned unchanged.
+result = chained_command.call(valid_id)
+result.class    #=> Cuprum::Result
+result.value    #=> an instance of Book
+result.success? #=> true
+result.errors   #=> []
+
+# Calls find_book_command with the id, which queries for the book and returns a
+# result with a value of nil and the error message. Because the result is
+# failing, the first block is skipped. The second block is then evaluated,
+# calling the redirect_to method. Finally, the result of find_book_command is
+# returned unchanged.
+result = chained_command.call(invalid_id)
+result.class    #=> Cuprum::Result
+result.value    #=> nil
+result.success? #=> false
+result.errors   #=> ['Unable to find book with id invalid_id']
+```
+
+#### Yield Result
+
+The `#yield_result` method offers advanced control over a chained command step. The method takes a block and yields the previous result. If the object returned by the block is not a result, a new result is created with a value equal to the returned object. In either case, the result is returned and passed to the next command, or returned by `#call` if `#tap_result` is the last item in the chain.
+
+Unlike `#chain`, the block in `#yield_result` yields the previous result, not the previous value. In addition, `#yield_result` does not automatically carry over any errors from the previous result, the result status, or whether the result was marked as halted.
+
+```ruby
+chained_command =
+  Cuprum::Command.new do
+    'Example value'
+  end
+  .yield_result do |result|
+    result.errors << 'Example error'
+
+    result
+  end
+  .yield_result do |result|
+    "The last result was a #{result.success? ? 'success' : 'failure'}."
+  end
+
+# The first command creates a passing result with a value of 'Example value'.
+#
+# This is passed to the first yield_result block, which adds the 'Example error'
+# string to the result errors, and then returns the result. Because the
+# yield_result block returns the previous result, it is then passed to the next
+# item in the chain.
+#
+# Finally, the second yield_result block is called, which checks the status of
+# the passed result. Since the second block does not return the previous result,
+# the previous result is discarded and a new result is created with the string
+# value starting with 'The last result was ...'.
+result = chained_command.call
+result.class    #=> Cuprum::Result
+result.value    #=> 'The last result was a failure.'
+result.success? #=> true
+result.errors   #=> []
+```
+
+Like `#chain`, `#yield_result` can be given an `:on => value` keyword.
+
+```ruby
+# The Collatz conjecture in mathematics concerns a sequence of numbers defined
+# as follows. Start with any positive integer. If the number is even, then
+# divide the number by two. If the number is odd, multiply by three and add one.
+# These steps are repeated until the value is one or the numbers loop.
+step_command =
+  Cuprum::Command.new do |i|
+    result.failure! unless i.even?
+
+    i
+  end
+    .yield_result(:on => :success) { |result| result.value / 2 }
+    .yield_result(:on => :failure) { |result| 1 + 3 * result.value }
+
+# Because the value is even, the first command returns a passing result with a
+# value of 8. The first yield_result block is then called with that result,
+# returning a new result with a value of 4. The result is passing, so the second
+# yield_result block is skipped and the result is returned.
+result = collatz_command.call(8)
+result.value    #=> 4
+result.success? #=> true
+
+# Because the value is odd, the first command returns a failing result with a
+# value of 5. Because the result is failing, the first yield_result block is
+# skipped. The second yield_result block is then called with the result,
+# returning a new (passing) result with a value of 16.
+result = collatz_command.call(5)
+result.value    #=> 16
+result.success? #=> true
+```
+
+Under the hood, both `#chain` and `#tap_result` are implemented on top of `#yield_result`.
 
 ### Results
 
@@ -586,6 +975,14 @@ Only available while the Command is being called. If called, marks the result ob
 
 [Method Documentation](http://www.rubydoc.info/github/sleepingkingstudios/cuprum/master/Cuprum/Command#success!-instance_method)
 
+#### `#tap_result`
+
+    tap_result(on: nil) { |previous_result| } #=> Cuprum::Result
+
+Creates a copy of the command, and then chains the block to execute after the command implementation. When #call is executed, each chained block will be yielded the previous result, and the previous result returned or yielded to the next block. The return value of the block is discarded.
+
+If the `on` parameter is omitted, the block will be called if the last result is not halted. If the `on` parameter is set to `:success`, the block will be called if the last result is successful and not halted. If the `on` parameter is set to `:failure`, the block will be called if the last result is failing and not halted. Finally, if the `on` parameter is set to `:always`, the block will always be called, even if the last result is halted.
+
 #### `#then`
 
     then(command) #=> Cuprum::Command
@@ -602,6 +999,16 @@ If the block returns a Cuprum::Result (or an object responding to #value and #su
 
 [Method Documentation](http://www.rubydoc.info/github/sleepingkingstudios/cuprum/master/Cuprum/Command#then-instance_method)
 
+#### `#yield_result`
+
+    yield_result(on: nil) { |previous_result| } #=> Cuprum::Result
+
+Creates a copy of the command, and then chains the block to execute after the command implementation. When #call is executed, each chained block will be yielded the previous result, and the return value wrapped in a result and returned or yielded to the next block.
+
+If the `on` parameter is omitted, the block will be called if the last result is not halted. If the `on` parameter is set to `:success`, the block will be called if the last result is successful and not halted. If the `on` parameter is set to `:failure`, the block will be called if the last result is failing and not halted. Finally, if the `on` parameter is set to `:always`, the block will always be called, even if the last result is halted.
+
+[Method Documentation](http://www.rubydoc.info/github/sleepingkingstudios/cuprum/master/Cuprum/Command#yield_result-instance_method)
+
 ### Cuprum::Operation
 
     require 'cuprum'