unexceptional 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 843955cd99c06a932f0594cc96ffa64488cd596a
-  data.tar.gz: 38523fd3cd5282fa9bcd44ad8dd6048ed4f94089
+  metadata.gz: 2a58647357380db24012ea25d40324d424945a1b
+  data.tar.gz: 4bf5b4de747ad3997d294bed098d50ef93edf01b
 SHA512:
-  metadata.gz: 4188134219b235eba0f0dc541adc67b360ac723f31d8be8e945202cb1afa9d4f088f3e2a760272da71be0b624fae767a7704995d580dc578441feb6865e085b1
-  data.tar.gz: fd32c477e1a02bb7317fb51e87d1b9cc00cf956ab4cc3479bac8a93689968d07bf7ab75c351d65033e86a4534ab37b1eea97973276eff4d773eed19b69ac8c8c
+  metadata.gz: 81babf8e262b1eb60f465c1fc448b92743078ec02906926c8ac4d8b920151d9710d9b51118fc66c075b835d536f9562f837ca6aa83b41e008e57c48ed5759389
+  data.tar.gz: 4c98a50902b60294a98dd1b2b33bddd37c443c6bb42038ab6bd268849f439cb8503b5615c6163c89dcde189aa33cb7dab1f67432f185b0dbbbdadafa5f5e6e43

data/lib/unexceptional.rb

@@ -1,21 +1,21 @@
 module Unexceptional
   class Result
-    # Pass true or false and an error value. If the first argument is true, returns an ok
-    # Result. If the first argument is false, returns an err Result wrapping the error
-    # value.
+    # Pass true or false and an error value. If the first argument is `true`, returns an
+    # ok `Result`. If the first argument is false, returns an err `Result` wrapping the
+    # error value.
     def self.check(condition, error)
       condition ? ok : err(error)
     end
   
-    # Returns a new Result respresenting failure. Optionally pass a wrapped result value.
+    # Returns a new `Result` respresenting failure. Accepts an optional error value.
     def self.err(err)
       new false, nil, err
     end
   
     # Pass a block and a collection. The block must accept a member of the collection and
-    # return a Result.
+    # return a `Result`.
     # 
-    # If all members succeed, returns a Result wrapping all the mapped members:
+    # If all members succeed, returns a `Result` wrapping all the mapped members:
     #
     #     Result.map([1, 2]) do |i|
     #       Result.ok i * 2
@@ -47,14 +47,14 @@ module Unexceptional
       )
     end
     
-    # Returns a new Result respresenting success. Optionally pass a wrapped result value.
+    # Returns a new `Result` respresenting success. Accepts an optional result value.
     def self.ok(val = nil)
       new true, val, nil
     end
   
-    # Given a block, runs an ActiveRecord transaction. The block must return a Result. If
-    # the Result is an error, rolls back the transaction. Either way, returns the Result.
-    # You must call `require 'active_record` before you call this method.
+    # Given a block, runs an ActiveRecord transaction. The block must return a `Result`.
+    # If the `Result` is an error, rolls back the transaction. Either way, returns the
+    # `Result`. You must call `require 'active_record'` before you call this method.
     def self.transaction
       unless defined?(ActiveRecord)
         raise 'ActiveRecord is not defined'
@@ -70,8 +70,8 @@ module Unexceptional
     end
     
     # Tries to run a list of procs, aborting on the first failure, if any. Each proc must
-    # return a Result--either ok or err. Aborts on the first err, if any, returning the
-    # failed Result. If all procs return ok, returns the last Result.
+    # return a `Result`--either ok or err. Aborts on the first err, if any, returning the
+    # failed `Result`. If all procs return ok, returns the last `Result`.
     # 
     #    Result.try(
     #      ->    { Result.ok 2 },
@@ -93,18 +93,32 @@ module Unexceptional
     #      ->((a, b)) { Result.ok a + b }
     #    )
     #    # => Result.ok(3)
+    # 
+    # If you need to initialize a lot of objects along the way, passing them through the
+    # various procs via pattern-matching can be unwieldy. In that case, you can use the
+    # `#set` method along with instance variables:
+    # 
+    #     Result.try(
+    #       -> { @a = Result.ok 2 },
+    #       -> { @b = Result.ok @a * 3 },
+    #       -> { Result.ok(@b * 4) }
+    #     )
+    #     # => Result.ok(24)
     def self.try(*procs)
       if procs.empty?
         raise 'Must past at least one proc to Result.try'
       end
+      ctx = TryContext.new
       procs.inject(nil) do |last_result, proc|
         if last_result.nil?
-          proc.call
+          ctx.instance_exec(&proc)
+        elsif !last_result.is_a?(Result)
+          raise "Each proc in Result.try must return a Result, but proc returned #{last_result.inspect}"
         elsif last_result.ok?
           if proc.parameters.length == 0
-            proc.call
+            ctx.instance_exec(&proc)
           else
-            proc.call last_result.unwrap
+            ctx.instance_exec(last_result.unwrap, &proc)
           end
         else
           last_result
@@ -112,14 +126,14 @@ module Unexceptional
       end
     end
     
-    # If this Result is an err, returns self:
+    # If this `Result` is an err, returns self:
     #
     #     Result
     #       .err(:uh_oh)
     #       .and_then { 'This block never executes' }
     #     # => Result.err(:uh_oh)
     # 
-    # If this Result is ok, then the behavior depends on what you passed to `and_then`:
+    # If this `Result` is ok, then the behavior depends on what you passed to `and_then`:
     # 
     #     # Passing a single argument:
     #     Result
@@ -152,19 +166,19 @@ module Unexceptional
       end
     end
     
-    # Yields this Result if this Result is an err.
+    # Yields this `Result` if this `Result` is an err.
     def if_err
       yield self.err if !@ok
       self
     end
     
-    # Yields this Result if this Result is ok.
+    # Yields this `Result` if this Result is ok.
     def if_ok
       yield self.val if @ok
       self
     end
     
-    # Returns the wrapped err value. Raises if this Result is ok.
+    # Returns the inner err value. Raises if this `Result` is ok.
     def err
       if !@ok
         @err
@@ -183,13 +197,13 @@ module Unexceptional
       @val = val
       @err = err
     end
-  
+    
     # Returns true if this Result is ok, false if this Result is an err.
     def ok?
       @ok
     end
     
-    # Returns the wrapped success value. Raises if this Result is an err.
+    # Returns the inner success value. Raises if this Result is an err.
     def unwrap
       if @ok
         @val
@@ -197,5 +211,15 @@ module Unexceptional
         raise "Called #unwrap on error: #{@err.inspect}"
       end
     end
+    alias_method :ok, :unwrap
+  end
+  
+  class TryContext #:nodoc:
+    def set(var, result)
+      if result.ok?
+        instance_variable_set '@' + var.to_s, result.unwrap
+      end
+      result
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unexceptional
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Jarrett Colby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest