maybe 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ben Brinckerhoff
+
+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.rdoc

@@ -0,0 +1,72 @@
+= maybe
+
+A library for treating nil and non-nil objects in a similar manner. Technically speaking, Maybe is an implemenation of the maybe monad.
+
+== Synopsis
+
+The Maybe class wraps any value (nil or non-nil) and lets you treat it as non-nil.
+
+   "hello".upcase                     #=> "HELLO"
+   nil.upcase                         #=> NoMethodError: undefined method `upcase' for nil:NilClass
+   Maybe.new("hello").upcase.value    #=> "HELLO"
+   Maybe.new(nil).upcase.value        #=> nil
+
+You can also use the method Maybe for convenience. The following are equivalent:
+
+   Maybe.new("hello").value          #=> "hello"
+   Maybe("hello").value              #=> "hello"
+   
+When you call Maybe.new with a value, that value is wrapped in a Maybe object. Whenever you call methods on that object, it does a simple check: if the wrapped value is nil, then it returns another Maybe object that wraps nil. If the wrapped object is not nil, it calls the method on that object, then wraps it back up in a Maybe object. 
+
+This is especially handy for long chains of method calls, any of which could return nil.
+
+   # foo, bar, and/or baz could return nil, but this will still work
+   Maybe.new(foo).bar(1).baz(:x)
+
+Here's a real world example. Instead of writing this:
+
+  if(customer && customer.order && customer.order.id==newest_customer_id)
+    # ... do something with customer
+  end
+
+just write this:
+
+  if(Maybe.new(customer).order.id.value==newest_customer_id)
+    # ... do something with customer
+  end
+
+== Examples
+
+  Maybe.new("10")            #=> A Maybe object, wrapping "10"
+
+  Maybe.new("10").to_i       #=> A Maybe object, wrapping 10
+
+  Maybe.new("10").to_i.value #=> 10
+
+  Maybe.new(nil)             #=> A Maybe object, wrapping nil 
+
+  Maybe.new(nil).to_i        #=> A Maybe object, still wrapping nil
+
+  Maybe.new(nil).to_i.value  #=> nil
+
+== Related Reading
+
+* {MenTaLguY has a great tutorial on Monads in Ruby over at Moonbase}[http://moonbase.rydia.net/mental/writings/programming/monads-in-ruby/00introduction.html]
+* {Oliver Steele explores the problem in depth and looks at a number of different solutions}[http://osteele.com/archives/2007/12/cheap-monads]
+* {Reg Braithwaite explores this same problem and comes up with a different, but very cool solution in Ruby}[http://weblog.raganwald.com/2008/01/objectandand-objectme-in-ruby.html]
+* {Weave Jester has another solution, inspired by the Maybe monad}[http://weavejester.com/node/10]
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ben Brinckerhoff. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "maybe"
+    gem.summary = %Q{A library for treating nil and non-nil objects in a similar manner.}
+    gem.description = %Q{A library for treating nil and non-nil objects in a similar manner. Technically speaking, Maybe is an implemenation of the maybe monad. The Maybe class wraps any value (nil or non-nil) and lets you treat it as non-nil.}
+    gem.email = "ben@devver.net"
+    gem.homepage = "http://github.com/bhb/maybe"
+    gem.authors = ["Ben Brinckerhoff"]
+    gem.add_development_dependency("mocha", "~> 0.9.8")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "maybe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/maybe.rb

@@ -0,0 +1,64 @@
+def Maybe(value)
+  Maybe.new(value)
+end
+
+class Maybe
+
+  instance_methods.reject { |method_name| method_name =~ /^__/ }.each { |method_name| undef_method method_name }
+
+  def initialize(value)
+    @value = value
+    self.join
+  end
+
+  def method_missing(method_name, *args)
+    self.fmap do |value|
+      value.send(method_name,*args) do |*block_args|
+        yield(*block_args) if block_given?
+      end
+    end
+  end
+  
+  def value(value_if_nil=nil)
+    if(value_if_nil!=nil && @value==nil)
+      value_if_nil
+    else
+      @value
+    end
+  end
+  
+  # Given that the value is of type A
+  # takes a function from A->M[B] and returns
+  # M[B] (a monad with a value of type B)
+  def pass
+    fmap {|*block_args| yield(*block_args)}.join
+  end
+
+  # Given that the value is of type A
+  # takes a function from A->B and returns
+  # M[B] (a monad with a value of type B)
+  def fmap
+    if(@value==nil)
+      self
+    else
+      Maybe.new(yield(@value))
+    end
+  end
+  
+  def nil?
+    @value==nil
+  end
+
+  def join
+    if(@value.is_a?(Maybe))
+      @value = value.value
+    end
+    self
+  end
+
+  # for testing purposes
+  def value=(value)
+    @value = value
+  end
+
+end

data/test/maybe_test.rb

@@ -0,0 +1,122 @@
+require File.expand_path("test_helper", File.dirname(__FILE__))
+require 'cgi'
+
+class MaybeTest < Test::Unit::TestCase
+
+  def test_initialize__performs_join
+    assert_equal 1, Maybe.new(Maybe.new(1)).value
+  end
+
+   def test_initialize__never_calls_pass_on_nested_maybe
+     Maybe.any_instance.expects(:pass).never
+     Maybe.new(Maybe.new(1)).value
+   end
+
+  def test_call_match_operator
+    assert_equal nil, (Maybe.new(nil)=~/b/).value
+    assert_equal 1, (Maybe.new('abc')=~/b/).value
+  end
+
+  def test_call_method_defined_on_object
+    assert_equal nil, (Maybe.new(nil).to_s).value
+    assert_equal "1", (Maybe.new(1).to_s).value
+  end
+
+  def test_method
+    assert_equal nil, Maybe.new(nil).to_int.value
+    assert_equal 2, Maybe.new(2.3).to_int.value
+  end
+  
+  def test_method_with_block
+    assert_equal nil, Maybe.new(nil).map{|x|x*2}.value
+    assert_equal [2,4,6], Maybe.new([1,2,3]).map{|x|x*2}.value
+  end
+
+  def test_method__calling_method_doesnt_change_value
+    x = Maybe.new(1)
+    x.to_s
+    assert_equal 1, x.value
+  end
+
+  def test_method_with_arg_and_block
+    assert_equal nil, Maybe.new(nil).gsub(/x/) {|m| m.upcase}.value
+    str = Maybe.new('x').gsub(/x/) do |m| 
+      m.upcase
+    end
+    assert_equal 'X', str.value
+  end
+
+  def test_join__doesnt_call_pass
+    Maybe.any_instance.expects(:pass).never
+    m = Maybe.new(nil)
+    m.value = Maybe.new(1)
+    m.join
+  end
+
+  def test_pass__with_cgi_unescape
+    # using CGI::unescape because that's the first function I had problems with 
+    # when implementing Maybe
+    assert_equal nil, Maybe.new(nil).pass {|v|CGI.unescapeHTML(v)}.value
+    assert_equal '&', Maybe.new('&amp;').pass {|v|CGI.unescapeHTML(v)}.value
+  end
+
+  def test_nil
+    assert_equal true, Maybe.new(nil).nil?
+    assert_equal false, Maybe.new(1).nil?
+  end
+
+  def test_value__returns_value_with_no_params
+    assert_equal nil, Maybe.new(nil).value
+    assert_equal 1, Maybe.new(1).value
+  end
+
+  def test_value__with_default
+    assert_equal "", Maybe.new(nil).value("")
+    assert_equal 1, Maybe.new(1).value("1")
+    assert_equal nil, Maybe.new(nil).value(nil)
+    assert_equal true, Maybe.new(true).value(nil)
+    assert_equal false, Maybe.new(nil).value(false)
+    assert_equal 1, Maybe.new(1).value(false)
+  end
+
+  # the connection between fmap and pass (translated from)
+  # http://james-iry.blogspot.com/2007/10/monads-are-elephants-part-3.html
+  # scala version: m map f ≡ m flatMap {x => unit(f(x))}
+  # note that in my code map == fmap && unit==Maybe.new && flatMap==pass
+  def test_monad_rule_0
+    f = lambda {|x| x*2}
+    m = Maybe.new(5)
+    assert_equal m.fmap(&f), m.pass {|x| Maybe.new(f[x])}
+  end
+
+  # monad rules taken from http://moonbase.rydia.net/mental/writings/programming/monads-in-ruby/01identity
+  # and http://james-iry.blogspot.com/2007_10_01_archive.html
+  
+  #1. Calling pass on a newly-wrapped value should have the same effect as giving that value directly to the block.
+  # (this is actually the second law at http://james-iry.blogspot.com/2007/10/monads-are-elephants-part-3.html)
+  # scala version: unit(x) flatMap f ≡ f(x)
+  def test_monad_rule_1
+    f = lambda {|y| Maybe.new(y.to_s)}
+    x = 1
+    assert_equal f[x], Maybe.new(x).pass {|y| f[y]}.value
+  end
+  
+  #2. pass with a block that simply calls wrap on its value should produce the exact same values, wrapped up again.
+  # (this is actually the first law at http://james-iry.blogspot.com/2007/10/monads-are-elephants-part-3.html)
+  # scala version: m flatMap unit ≡ m
+  def test_monad_rule_2
+    x = Maybe.new(1)
+    assert_equal x.value, x.pass {|y| Maybe.new(y)}.value
+  end
+
+  #3. nesting pass blocks should be equivalent to calling them sequentially
+  def test_monad_rule_3
+    f = lambda {|x| Maybe.new(x*2)}
+    g = lambda {|x| Maybe.new(x+1)}
+    m = Maybe.new(3)
+    n = Maybe.new(3)
+    assert_equal m.pass{|x| f[x]}.pass{|x|g[x]}.value, n.pass{|x| f[x].pass{|y|g[y]}}.value
+  end
+
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'maybe'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: maybe
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Brinckerhoff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+description: A library for treating nil and non-nil objects in a similar manner. Technically speaking, Maybe is an implemenation of the maybe monad. The Maybe class wraps any value (nil or non-nil) and lets you treat it as non-nil.
+email: ben@devver.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/maybe.rb
+- test/maybe_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bhb/maybe
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A library for treating nil and non-nil objects in a similar manner.
+test_files: 
+- test/maybe_test.rb
+- test/test_helper.rb