ruby-maybe 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c18c0a9b1364479ee30af4cd0dd677e6d0d2834
-  data.tar.gz: 645ef3b0d3b468777dc58488c846c1bb1d869958
+  metadata.gz: c9211030f655e23153727e36d2a68d930b54593e
+  data.tar.gz: 5c6cd1eb7a99765baa024d45de70d928f9ba88c8
 SHA512:
-  metadata.gz: c62cb16a1ca0177720af7c3c0e646c5ed80f73612522d9e862616c0282be813a639d6d1e2a1bb17b8f283c141625f331f1a84c8f56f20cc9c0e617c8a58e8b70
-  data.tar.gz: b176635e49c8e5b7e173f636245ccbe939eff8a4add5c3e794d74d777c744d6cb1769085e71c1f727db08e50b393be0504ae2a8e01be93040bb48df01f9b3ea6
+  metadata.gz: 31eafb9088606234257ed2d151cb3f78712f57ddee187b74f58d1a02a8f185a6ea40efd5e37cf07586a51f57e9dcea5fe8c4023af4b297956500ed3f50d950a1
+  data.tar.gz: fbc6e39d5d9cef5c25a515c1a99948b4d1cec192192670ddd60d96a479d0db77dbef4f4dfeb8487b2ce681a88152f2aeb31f522998828026533677e5b11147d0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+    - 1.9.3
+    - ruby-head
+    - jruby-head

data/LICENSE.md

@@ -0,0 +1,7 @@
+The MIT License (MIT) Copyright (c) Callum Stott, http://www.seadowg.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,11 +1,13 @@
 # ruby-maybe
 
-[![Build Status](https://travis-ci.org/oetzi/ruby-maybe.png?branch=master)](https://travis-ci.org/oetzi/ruby-maybe)
+[![Build Status](https://travis-ci.org/seadowg/ruby-maybe.png?branch=master)](https://travis-ci.org/seadowg/ruby-maybe)
 
 ![](http://f.cl.ly/items/2o2A3k1N2d3a1b0V3V0T/maybe.png)
 
 ## Description
 
+### The Basics
+
 'Maybe' not 'Maeby'. This is an implementation of the 'Maybe' or 'Option' monad similar to that used
 [Haskell](http://www.haskell.org/haskellwiki/Maybe). Monads provide a
 safe way to create non deterministic programs (for example, when not all
@@ -53,7 +55,41 @@ 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.
+you might just learn to love it.
+
+### Method Lifting
+
+Ok so using `bind` to operate on Maybe is all well and good, but what if
+you want to add three Maybe's together:
+
+    x.bind { |x_val|
+      y.bind { |y_val|
+        z.bind { |z_val|
+          Just.new(x + y + z)
+        }
+      }
+    }
+
+Yeah... I don't think so. In languages like Haskell we can use [Applicative Functors](http://learnyouahaskell.com/functors-applicative-functors-and-monoids)
+to deal with making expressions like the above less verbose. You can go read about them but that's not really important.
+With ruby-maybe methods on the contained object in a Maybe can be lifted to operate on the Maybe:
+
+    Just.new(5) + Just.new(6) # => Just.new(11)
+    Just.new("OMG").downcase # => Just.new("omg")
+    Just.new([1,2]).inject(Just.new(0), :+) # => Just.new(3)
+
+All operations can be lifted like this and you can mix and match actual values and Maybes in the arguments. This also
+works for Nothing:
+
+    Nothing.new + Just.new(5) # => Nothing.new
+    Just.new(0) * Nothing.new / Just.new(1) # => Nothing.new
+
+### Extracting Values from a Maybe
+
+Try not to do this. Please. Monads are best used when we play nice and let the Monad look after our values. Of course,
+you're thinking "well at some point I have to take it out to write it out or stick it in a web response on something
+right?". Yes, of course. But its best if these cases have abstractions that can receive monads or are structured as
+Monads themselves (some languages like Haskell include Monads for IO, Web request processing [etc](http://learnyouahaskell.com/a-fistful-of-monads)).
 
 ## Installation
 

data/lib/ruby-maybe.rb

@@ -1,17 +1,10 @@
 class Maybe
-  def method_missing(method_name, *args, &block)
-    Maybe.new
-  end
-
-  def bind(&block)
-    Maybe.new
-  end
 end
 
 class Just < Maybe
   def method_missing(method_name, *args, &block)
     values = args.map { |arg|
-    return Nothing.new if arg == Nothing.new
+      return Nothing.new if arg == Nothing.new
       arg.kind_of?(Just) ? arg.value : arg
     }
 
@@ -23,9 +16,9 @@ class Just < Maybe
   end
 
   def bind(&block)
-    value = block.call(@value)
-    warn("Not returning a Maybe from #bind is really bad form...") unless value.kind_of?(Maybe)
-    value
+    computed = block.call(@value)
+    warn("Not returning a Maybe from #bind is really bad form...") unless computed.kind_of?(Maybe)
+    computed
   end
 
   def ==(object)
@@ -36,6 +29,10 @@ class Just < Maybe
     end
   end
 
+  def _extract!
+    value
+  end
+
   protected
 
   def value
@@ -59,4 +56,14 @@ class Nothing < Maybe
       false
     end
   end
+
+  def _extract!
+    raise AttemptedExtract.new
+  end
+
+  class AttemptedExtract < Exception
+    def initialize
+      super("Attempted to extract value from Nothing")
+    end
+  end
 end

data/ruby-maybe.gemspec

@@ -3,11 +3,12 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name = "ruby-maybe"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
   s.platform = Gem::Platform::RUBY
   s.authors = ["Callum Stott"]
-  s.email = ["callum.stott@me.com"]
+  s.email = ["callum@seadowg"]
   s.summary = "Maybe monad implementation for Ruby"
+  s.license = 'MIT'
 
   s.require_paths = ['lib']
   s.files = `git ls-files`.split("\n")

data/spec/ruby-maybe_spec.rb

@@ -41,6 +41,12 @@ describe "Just" do
       count.must_equal(10)
     end
   end
+
+  describe "#_extract!" do
+    it "returns the contained value" do
+      Just.new(5)._extract!.must_equal(5)
+    end
+  end
 end
 
 describe "Nothing" do
@@ -71,24 +77,12 @@ describe "Nothing" do
       Nothing.new.missing.must_equal(Nothing.new)
     end
   end
-end
-
-describe "Maybe" do
-  describe "#bind" do
-    it "does not execute the passed block" do
-      executed = false
-      Maybe.new.bind { |val| executed = true }
-      executed.must_equal false
-    end
-
-    it "returns a Maybe" do
-      Maybe.new.bind { |val| val }.kind_of?(Maybe).must_equal true
-    end
-  end
 
-  describe "method lifting" do
-    it "returns Maybe for any method call" do
-      Maybe.new.missing.kind_of?(Maybe).must_equal(true)
+  describe "#_extract!" do
+    it "raises an exception" do
+      assert_raises(Nothing::AttemptedExtract) {
+        Nothing.new._extract!
+      }
     end
   end
 end

metadata

@@ -1,32 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: ruby-maybe
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Callum Stott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
-- callum.stott@me.com
+- callum@seadowg
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/ruby-maybe.rb
 - ruby-maybe.gemspec
 - spec/ruby-maybe_spec.rb
 homepage: 
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []