either-monad 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f42a1d3e60ecd54825b268c689ee48be2de686f5
-  data.tar.gz: 080abd900338fb3b82b37dcd9b03869f96be3cdb
+  metadata.gz: b16513779903c1bf9334051f5d13e85e08105176
+  data.tar.gz: e62bc45ae20817c744fff565282bef0f513ad4b4
 SHA512:
-  metadata.gz: 19963b9a3f84aed941a21e54fc0ec7e428008da8fc6bb45ef948120f1e4180bee50732760478084f3a30fff8b84e176eda608ca6a4437eefb1c9e05e45335c63
-  data.tar.gz: e59f50faab6fb6cb91a2dc2866062452b0933e43b597bd49ee02667abad01a68724823074d57aaaa05a4994111ed1e9d9b454c41d2627921a02c2e6ef6c723ee
+  metadata.gz: f5c3227da2e5a5cb38630a78b4d182a797339fbe062e3e1b5911e3c9fd944c64b75f3479818e45212dc762926917efe91408558a5e8152c36b0b08c3ab9de378
+  data.tar.gz: ec285cf53f870c470da4270016d2d2b5024ca86d12148cdafd5d01698ccfb5d9f57dd94516082d36e840df73b78a345e7d8499f33005fe5ef6a6c20209d2a900

data/README.md

@@ -1,9 +1,15 @@
 Either
 ======
 
+[![Build Status](https://travis-ci.org/dredozubov/either.svg?branch=master)](https://travis-ci.org/dredozubov/either)
+[![Code Climate](https://codeclimate.com/github/dredozubov/either/badges/gpa.svg)](https://codeclimate.com/github/dredozubov/either)
+
 Dead simple error context framework aka Either monad. Goal of this gem is to
 provide solid ground to control flow without exceptions and allow simple and
-expressive chaining failure context.
+expressive chaining and handling failures gracefully.
+
+Don't fear the "monad" part of the name though, you don't have to know what monad is to understand
+how his gem works and use it with ease!
 
 Installation
 ------------
@@ -19,3 +25,73 @@ or in **Gemfile**
 ``` ruby
 gem 'either-monad'
 ```
+
+
+Examples
+--------
+
+All examples taken from production code.
+
+### Chaining computations
+
+You can chain computations without fear of losing a failure context. For
+example you can validate a request, make some work and serialize the result
+with:
+
+```ruby
+# results in either Success with serialized result or Failure with context.
+validate(request)
+  .bind(->(validated) { search(validated) })
+  .bind(->(search_result) { serialize(search_result) })
+
+```
+
+If `Failure` has been returned from one of the binded methods, the whole
+expression will be evaluated to this this `Failure` value.
+Each of the binded method(to make sense type-wise) must take unwrapped value
+from previous one, do some work and return new value wrapped in `Success`
+or `Failure`.
+
+### Wrapping values into Success or Failure context
+
+```ruby
+Success[value]
+```
+
+or
+
+```ruby
+Failure[failure_context]
+```
+
+### Unwrapping values
+
+It's just an attribute reader!
+
+```ruby
+result = Success[:foo]
+result.value # => :foo
+```
+
+Ruby version support
+--------------------
+
+Gem is supposed to work correctly with the following rubies:
+
+* 2.0.0
+* 2.1.4
+* jruby
+* rbx
+
+Contributing
+-------------
+
+* fork it
+* make some changes and submit a pull request
+* do not make changes to version
+
+Contact info
+------------
+
+If you want to contact me or/and some questions - feel free to write me at
+denis.redozubov at gmail or mention me on [twitter](http://twitter.com/rufuse).

data/Rakefile

@@ -1,5 +1,5 @@
 $LOAD_PATH << File.expand_path('./lib')
-require "rotary"
+require "either"
 
 task :build do
   system "gem build either-monad.gemspec"

data/lib/either.rb

@@ -1,6 +1,6 @@
 # Do not instantiate this class EVER
 class Either
-  attr_accessor :value
+  attr_reader :value
 
   def initialize(value)
     @value = value

data/lib/either/version.rb

@@ -1,4 +1,4 @@
-module Either
-  VERSION = '0.0.1'
+class Either
+  VERSION = '0.0.2'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: either-monad
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Denis Redozubov