consequence 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cdcccf4da40e5989a2efb8bb5bf8d74d3a3a24f
-  data.tar.gz: df4593261d32a4e41a7cbf741b80a59395b1b55d
+  metadata.gz: 6cdf2c9dad1c8995f8853db69da3d6804daf2029
+  data.tar.gz: bfc2e9093a371c54ee2c39c273c2c5ffea14ba18
 SHA512:
-  metadata.gz: 1f964a3833b3393c21f9aa8d4c7be8631885488967b44e4e2ffd832a80f0b24cbfb93e008afeb5a63c19defc9a6f4abdea7859375d558a22e4d7ec60142e3146
-  data.tar.gz: 899f36b13722699b98b811c48b1b9887744afbebe0f94ea85af59c74c535900c180742fe34cfea70ac1f60206dbf9aa83dbd19ee596207b87dd2259bda9d6c81
+  metadata.gz: 3066cbf8aa5a1415c37788e81f550c9ad96cc6b4a69604c26a2bc2ac8936e9ee610edc20b49bb694f37082b8cc8a084c0e9660f9e4bfb0085a00622550c0014b
+  data.tar.gz: 845c28a333e1ef7676cba5bbb6af7846eed3af5495e184b64a60f64adc7ebf3e128684886f59122d9bc804874f196154f77664cf5d0a1cc91622c3f56dbb6f71

data/README.md

@@ -1,5 +1,7 @@
 # Consequence
 
+[![Gem Version](https://badge.fury.io/rb/consequence.svg)](http://badge.fury.io/rb/consequence)
+
 Monad implementation to be used with [contracts.ruby](https://github.com/egonSchiele/contracts.ruby)
 
 ## Example Usage
@@ -7,14 +9,12 @@ Monad implementation to be used with [contracts.ruby](https://github.com/egonSch
 ``` ruby
 require 'consequence'
 
-class LicensePirate
+class HirePirate
   include Consequence
   alias_method :m, :method
 
   def apply(applicant)
-    Success[applicant] >> m(:eye_patch_check)
-                       << m(:log)
-                       >> :sign_and_date
+    Success[applicant] >> m(:eye_patch_check) << m(:log) >> :sign_and_date
   end
 
   private
@@ -56,7 +56,56 @@ If called with a Symbol instead of a method, it is sent as a message to the valu
 
 A Success Monad wraps up all exceptions in a Failed Monad and a Failed Monad ignores all chained methods. This allows all possible failures in a long process to be dealt with at the end.
 
-### Others to be implemented shortly.
+### Option
+
+A Option Monad only applies a method if it's value is not nil, otherwise it ignores them. This prevents MissingMethod errors from methods trying to be applied to nil.
+
+## Example Implementation of Left and Right
+
+``` ruby
+require 'consequence'
+
+class Crab
+  include Consequence
+  alias_method :m, :method
+
+  Contract Monad => Monad
+  def begin(direction = Left[0])
+    direction >> m(:turn) >> m(:move) << m(:log) >> m(:continue?)
+  end
+
+  private
+
+  Left = Class.new(Monad)
+  Right = Class.new(Monad)
+
+  Contract Left => Num
+  def move(monad)
+    monad.value + 5
+  end
+
+  Contract Right => Num
+  def move(monad)
+    monad.value - 5
+  end
+
+  Contract Num => Monad
+  def turn(value)
+    rand > 0.5 ? Left[value] : Right[value]
+  end
+
+  def log(value)
+    puts value
+  end
+
+  Contract Monad => Monad
+  def continue?(monad)
+    monad.value.abs > 25 ? monad : monad >> m(:begin)
+  end
+end
+
+Crab.new.begin
+```
 
 ## Installation
 

data/lib/consequence.rb

@@ -9,3 +9,4 @@ end
 require 'consequence/monad'
 require 'consequence/failure'
 require 'consequence/success'
+require 'consequence/option'

data/lib/consequence/monad.rb

@@ -44,6 +44,14 @@ module Consequence
       self.class == other.class && value == other.value
     end
 
+    def to_s
+      "#{self.class}[#{value}]"
+    end
+
+    def inspect
+        to_s
+    end
+
     private
 
     def bind(proc)

data/lib/consequence/option.rb

@@ -0,0 +1,13 @@
+module Consequence
+  class Option < Monad
+    def >>(proc)
+      value ? super : self
+    end
+
+    def <<(proc)
+      super if value
+    end
+
+    def nil?; value.nil? end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: consequence
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Max White
@@ -61,6 +61,7 @@ files:
 - lib/consequence.rb
 - lib/consequence/failure.rb
 - lib/consequence/monad.rb
+- lib/consequence/option.rb
 - lib/consequence/success.rb
 homepage: 
 licenses: