ruby-maybe 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cadba4571e8ddf9c546222f3ca6824af468fe7d1
-  data.tar.gz: ddfe8a59d92210e65eab97a25d343affeac30a48
+  metadata.gz: 5c18c0a9b1364479ee30af4cd0dd677e6d0d2834
+  data.tar.gz: 645ef3b0d3b468777dc58488c846c1bb1d869958
 SHA512:
-  metadata.gz: 0e0a29cdbbc478a7f0f1ba59febf81577cffc27803a2d4585c422c3b93bf64475217f339a8da1c8b1847146fd0693a254cef5110b19222c0ee8983eeb5db125e
-  data.tar.gz: 783603c6b507eb8afd188e5ff92c23ff9b2f8dfa31660b8a2d8a9fb2cb090ab715e19968136ca470c724572644cfe37a8a7839b3737bd6f59c73f5469c560e47
+  metadata.gz: c62cb16a1ca0177720af7c3c0e646c5ed80f73612522d9e862616c0282be813a639d6d1e2a1bb17b8f283c141625f331f1a84c8f56f20cc9c0e617c8a58e8b70
+  data.tar.gz: b176635e49c8e5b7e173f636245ccbe939eff8a4add5c3e794d74d777c744d6cb1769085e71c1f727db08e50b393be0504ae2a8e01be93040bb48df01f9b3ea6

data/README.md

@@ -12,6 +12,49 @@ safe way to create non deterministic programs (for example, when not all
 values are known at compile time). The Maybe monad allows programmers to
 deal with values that may or may not be undefined.
 
+Imagine we are access accessing an array via a method:
+
+    array = [1,2,3]
+
+    def access(n)
+      array[n]
+    end
+
+    access(1) # => 2
+    access(5) # => nil
+
+Now what if we want to take some index and add `5` to the array value
+stored there?
+
+    access(5) + 5 # => NoMethodError: undefined method `+' for nil:NilClass
+
+Hmmm, that fails pretty miserably. We can solve this with `Maybe`. Lets
+rewrite `access`:
+
+    def access(n)
+      if array[n]
+        Just.new(array[n])
+      else
+        Nothing
+      end
+    end
+
+`Nothing` and `Just` used here are both instances of `Maybe`. This means
+that they will both respond to the `bind` method:
+
+    access(1).bind { |val| Just.new(val + 5) } # => Just.new(7)
+    access(5).bind { |val| Just.new(val + 5) } # => Nothing.new
+
+For instances of `Just`, `bind` will execute the passed block with
+respect to its contained value and for `Nothing` it will skip the block
+and simply return another instance of `Nothing`. This allows a neat
+mechanism for dealing with non determinitic methods such as `access`
+without having them throw exceptions or simply return `nil`.
+
+`Maybe` is a very basic monad and at first might not seem that powerful
+but after using it instead of the more verbose control flow it replaces
+I think you might learn to love it.
+
 ## Installation
 
 Either include in your Gemfile:

data/lib/ruby-maybe.rb

@@ -1,10 +1,6 @@
 class Maybe
   def method_missing(method_name, *args, &block)
-    if Maybe.method_defined?(method_name)
-      super
-    else
-      Maybe.new
-    end
+    Maybe.new
   end
 
   def bind(&block)
@@ -14,15 +10,12 @@ end
 
 class Just < Maybe
   def method_missing(method_name, *args, &block)
-    if Just.method_defined?(method_name)
-      super
-    else
-      values = args.map { |arg|
-        return Nothing.new if arg == Nothing.new
-        arg.kind_of?(Just) ? arg.value : arg
-      }
-      Just.new(@value.public_send(method_name, *values, &block))
-    end
+    values = args.map { |arg|
+    return Nothing.new if arg == Nothing.new
+      arg.kind_of?(Just) ? arg.value : arg
+    }
+
+    Just.new(@value.public_send(method_name, *values, &block))
   end
 
   def initialize(value)
@@ -52,11 +45,7 @@ end
 
 class Nothing < Maybe
   def method_missing(method_name, *args, &block)
-    if Nothing.method_defined?(method_name)
-      super
-    else
-      Nothing.new
-    end
+    Nothing.new
   end
 
   def bind

data/ruby-maybe.gemspec

@@ -3,7 +3,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name = "ruby-maybe"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
   s.platform = Gem::Platform::RUBY
   s.authors = ["Callum Stott"]
   s.email = ["callum.stott@me.com"]

data/spec/ruby-maybe_spec.rb

@@ -87,7 +87,7 @@ describe "Maybe" do
   end
 
   describe "method lifting" do
-    it "returns Nothing for any method call" do
+    it "returns Maybe for any method call" do
       Maybe.new.missing.kind_of?(Maybe).must_equal(true)
     end
   end
@@ -101,7 +101,7 @@ describe "Integration Specs" do
       if (val > 10)
         Nothing.new
       else
-        Just.new(val)
+        Just.new(val) + 1
       end
     }.must_equal(Nothing.new)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-maybe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Callum Stott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-03 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: