result-monad 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c05cfa053dac07865ae813bb39039e9b49f7770
-  data.tar.gz: 3fce9ed465b28e57f3b5b9658d4d9bf8d822978e
+  metadata.gz: 06e97a1d838923904e635d8db6d4a2d1aaa408fb
+  data.tar.gz: 664c8d07c7c60c78c4a420cd5d1a96a94794bda0
 SHA512:
-  metadata.gz: e2c779b1cb7c203d0c0ea6d699db28b167844ab126d27815696171a9422813b22025aa8c355e5a1d952e4c35e636cbe89528cfb307ee0a4ae74f095c07cf756a
-  data.tar.gz: 64069199a99ca580c78c4623984268d071fcc953c7e0be26833c497682c1fe075ad396c56279d6bdbef33bb9acb6afa00e44a6720b879c2699f5773bbbcf52cb
+  metadata.gz: 9fb60c7bd5f36285a4d4ab4f10970698cb82b40bf4e60b09f94d13095a6be1f944ee8a70ad4bdc695cbbe20b01e643976028fa4a7d029e472f22394fa542cf07
+  data.tar.gz: 6cf9622293538460ce6760b9d5a1538263e51adcf135c95601a5822f94f19e4ec39a8330eecd68a9831f69a3dab2d944a2f552dc3b5f8c0244a9175c10e66a1a

data/README.md

@@ -109,6 +109,9 @@ write it to a local file, and then delete the file on the FTP server.  Some thin
 * Every call to any outside library, even standard library functions are either in a `map` block which
   gets Captured or they are themselves Captured
 * No independent action (as in someone calling `copy_file` directly) will execute without its requirements being met.
+* A shortcut to creating an Error value based on some condition, as well as capturing errors generated from testing the
+  condition can be seen in `ensure_file`.  Any exceptions raised by File.exist?, as well as our condition not being met
+  are captured as Error
 
 ```ruby
 require 'net/ftp'
@@ -157,6 +160,23 @@ ftp.transfer_and_delete("5MB.zip")
 `transfer_and_delete` can return numerous errors but there is no way for this code to raise an exception.  Exceptions
 raised in `map` or `map!` are caught and expressed as `Error`.
 
+#### Conditionally executing code
+
+Using the example above, say we wanted to find and delete the file if we may have accidentally created it.
+This wouldn't be a sensible way of solving this problem, but this illustrates a use case for result base conditionals.
+
+```ruby
+ftp = SensitiveFileFTP.new('speedtest.tele2.net')
+ftp.transfer_and_delete("5MB.zip").or_else do
+  ftp.delete_local_file("5MB.zip")
+end
+
+# or lets say we wanted to log a success if it worked
+
+ftp.transfer_and_delete("5MB.zip").and_then do
+  log "Did the thing!"
+end
+```
 
 
 ## What's next
@@ -186,5 +206,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/result-monad/version.rb

@@ -1,3 +1,3 @@
 class Result
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/result-monad.rb

@@ -11,15 +11,15 @@ end
 
 def Capture
   begin
-    Ok(yield)
+    Ok(yield).join!
   rescue StandardError => e
-    Error(e)
+    Error(e).join!
   end
 end
 
 class Result
-  require 'result/error'
-  require 'result/ok'
+  require 'result-monad/error'
+  require 'result-monad/ok'
 
   def initialize(m)
     @m = m

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: result-monad
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Zachary Daniel
@@ -89,7 +89,7 @@ files:
 - lib/result-monad/error.rb
 - lib/result-monad/ok.rb
 - lib/result-monad/version.rb
-- result.gemspec
+- result-monad.gemspec
 homepage: http://gitlab.com/zachdaniel/result-monad
 licenses:
 - MIT