easy_monads 0.2.0

data/.document

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

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "pry"
+  gem "shoulda", "~> 2.11.3"
+  gem "shared_should", "~> 0.8.1"
+  gem "always_execute", "~> 0.0.2"
+  gem "bundler", "~> 1.0.21"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", "~> 0.9.11"
+  gem "rdoc", ">= 2.4.2"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Stephen Sloan
+
+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/Rakefile

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "easy_monads"
+  gem.homepage = "https://github.com/bkr/easy_monads"
+  gem.license = "MIT"
+  gem.summary = "EasyMonads is a simple implementation of monads for Ruby"
+  gem.description = <<EOS
+EasyMonads is a gem for Ruby that provides a simple implementation of monads.  It also provides a useful example of
+monads in the form of Option (similar to Scala's Option) which provides Some and None classes.
+
+Developement for EasyMonads is sponsored by BookRenter.com and it is released under an MIT-style license
+EOS
+  gem.email = "stephen.sloan@bookrenter.com"
+  gem.authors = ["Stephen Sloan"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "easy_monads #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/easy_monads.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "easy_monads"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Stephen Sloan"]
+  s.date = "2011-12-06"
+  s.description = "EasyMonads is a gem for Ruby that provides a simple implementation of monads.  It also provides a useful example of\nmonads in the form of Option (similar to Scala's Option) which provides Some and None classes.\n\nDevelopement for EasyMonads is sponsored by BookRenter.com and it is released under an MIT-style license\n"
+  s.email = "stephen.sloan@bookrenter.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "easy_monads.gemspec",
+    "lib/easy_monads.rb",
+    "lib/easy_monads/monadic.rb",
+    "lib/easy_monads/option.rb",
+    "lib/easy_monads/option_functions.rb",
+    "test/helper.rb",
+    "test/test_easy_monads.rb"
+  ]
+  s.homepage = "https://github.com/bkr/easy_monads"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "EasyMonads is a simple implementation of monads for Ruby"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_development_dependency(%q<shared_should>, ["~> 0.8.1"])
+      s.add_development_dependency(%q<always_execute>, ["~> 0.0.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.21"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, ["~> 0.9.11"])
+      s.add_development_dependency(%q<rdoc>, [">= 2.4.2"])
+    else
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_dependency(%q<shared_should>, ["~> 0.8.1"])
+      s.add_dependency(%q<always_execute>, ["~> 0.0.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.21"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, ["~> 0.9.11"])
+      s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+    end
+  else
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
+    s.add_dependency(%q<shared_should>, ["~> 0.8.1"])
+    s.add_dependency(%q<always_execute>, ["~> 0.0.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.21"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, ["~> 0.9.11"])
+    s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+  end
+end
+

data/lib/easy_monads/monadic.rb

@@ -0,0 +1,44 @@
+module EasyMonads
+  class Monadic
+    include Enumerable
+    include Comparable
+
+    class << self
+      def unit(*args)
+        new(*args)
+      end
+    end
+
+    def unit(to_wrap)
+      self.class.unit(to_wrap)
+    end
+
+    def bind(&func)
+      result = func.call(data) if defined? @data
+      raise RuntimeError.new("Result of .bind must be a Monadic but was #{result.class.name}") unless result.is_a? Monadic
+      result
+    end
+
+    def bind_unit(&func)
+      self.bind { |*args| self.unit(func.call(*args)) }
+    end
+
+    def data
+      @data
+    end
+
+    def each
+      yield data
+    end
+
+    def ==(other_monad)
+      return false unless other_monad.is_a? EasyMonads::Monadic
+      data == other_monad.data
+    end
+
+    def <=>(other_monad)
+      return RuntimeError.new("Can only compare with other Monadic objects") unless other_monad.is_a? EasyMonads::Monadic
+      data <=> other_monad.data
+    end
+  end
+end

data/lib/easy_monads/option.rb

@@ -0,0 +1,98 @@
+
+module EasyMonads
+  module Option
+    class Option < EasyMonads::Monadic
+      def initialize(*args)
+        raise RuntimeError.new("Attempt to initialize abstract #{self.class.name} class")
+      end
+
+      alias get data
+      alias or_nil data
+    end
+
+    class None < Option
+      def initialize(*args)
+        @data = nil
+      end
+
+      def bind
+        self
+      end
+
+      def each
+      end
+
+      def ==(other_monad)
+        other_monad.is_a? self.class
+      end
+
+      def <=>(other_monad)
+        if self == other_monad
+          0
+        else
+          raise RuntimeError.new("#{self.class.name} is not comparable to other types") # nil <=> ... would raise NoMethodError
+        end
+      end
+
+      def size
+        0
+      end
+
+      def exists?(&pred)
+        false
+      end
+
+      def defined?
+        false
+      end
+
+      def get_or_else(else_val=nil)
+        if block_given?
+          yield
+        else
+          else_val
+        end
+      end
+
+      def empty?
+        true
+      end
+
+      def or_else
+        yield
+      end
+    end
+
+    NONE = None.new.freeze
+
+    class Some < Option
+      def initialize(data)
+        @data = data
+      end
+
+      def size
+        1
+      end
+
+      def exists?(&pred)
+        pred.call(data) ? true : false
+      end
+
+      def defined?
+        true
+      end
+
+      def get_or_else(ignored=nil)
+        data
+      end
+
+      def empty?
+        false
+      end
+
+      def or_else
+        self
+      end
+    end
+  end
+end

data/lib/easy_monads/option_functions.rb

@@ -0,0 +1,15 @@
+
+module EasyMonads
+  module Option
+    module OptionFunctions
+      def self.sum_option_in_hash(hash, key, option)
+        if hash[key].is_a? Some
+          hash[key] = hash[key].bind { |value| Some.unit(value + option.get) }
+        else
+          hash[key] = option
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/easy_monads.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), "easy_monads", "monadic")
+require File.join(File.dirname(__FILE__), "easy_monads", "option")
+require File.join(File.dirname(__FILE__), "easy_monads", "option_functions")
+
+module EasyMonads
+
+  def self.option_everywhere!
+    Object.class_eval("include EasyMonads::Option")
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'shared_should'
+require 'always_execute'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'easy_monads'
+
+class Test::Unit::TestCase
+end

data/test/test_easy_monads.rb

@@ -0,0 +1,196 @@
+require 'helper'
+
+class TestEasyMonads < Test::Unit::TestCase
+  # What the hell is a monad, you ask? Check out
+  # http://www.codecommit.com/blog/ruby/monads-are-not-metaphors
+
+  class TestMonadic < EasyMonads::Monadic
+    def initialize(data)
+      @data = data
+    end
+  end
+
+  context "A monadic Object" do
+    setup do
+      @monad = TestMonadic.new("test")
+    end
+
+    should "be enumerable" do
+      assert @monad.is_a? Enumerable
+      assert defined? @monad.each
+    end
+
+    should "be comparable" do
+      assert @monad.is_a? Comparable
+      assert defined? @monad.<=>
+    end
+
+    should "expose its contained data" do
+      assert_equal "test", @monad.data
+    end
+
+    should "have a fancy bind_unit method that does a bind and a unit in one" do
+      assert_equal TestMonadic.new("TEST"), @monad.bind_unit { |value| value.upcase }
+    end
+
+    # For all this monad identity business, checkout out
+    # http://moonbase.rydia.net/mental/writings/programming/monads-in-ruby/01identity
+    should "be true for identify law one" do
+      f = lambda { |value| TestMonadic.unit("#{value} foo") }
+      assert_equal "test foo", @monad.bind { |value| f.call(value) }.data
+      assert_equal f.call("test"), @monad.bind { |value| f.call(value) }
+    end
+
+    should "be true for identity law two" do
+      assert_equal @monad, @monad.bind { |value| TestMonadic.unit(value) }
+    end
+
+    context "for identity law three" do
+      setup do
+        @f = lambda { |value| TestMonadic.unit(value * 2) }
+        @g = lambda { |value| TestMonadic.unit("#{value} foo") }
+      end
+
+      execute do
+        @monad.bind do |value_a|
+          @f.call(value_a)
+        end.bind do |value_b|
+          @g.call(value_b)
+        end
+      end
+
+      should "be true" do
+        assert_equal "testtest foo", @execute_result.data
+        test_result = @monad.bind do |value_a|
+          @f.call(value_a).bind do |value_b|
+            @g.call(value_b)
+          end
+        end
+        assert_equal @execute_result, test_result
+      end
+    end
+  end
+
+  context "An Option" do
+
+    should "raise an error if used directly" do
+      assert_raises(RuntimeError) { EasyMonads::Option::Option.new("foo") }
+    end
+
+    context "that is a None" do
+      setup do
+        @none = EasyMonads::Option::NONE
+      end
+
+      should "not bind to anything" do
+        assert_equal EasyMonads::Option::NONE, @none.bind { raise RuntimeError.new("Should not have entered block") }
+      end
+
+      should "not enumerate" do
+        count = 0
+        @none.each { count += 1 }
+        assert_equal 0, count
+      end
+
+      should "return nil for .get" do
+        assert_equal nil, @none.get
+      end
+
+      should "return true for .empty?" do
+        assert_equal true, @none.empty?
+      end
+
+      should "return 0 for .size" do
+        assert_equal 0, @none.size
+      end
+
+      should "return false always for .exists? and not call the predicate block" do
+        assert_equal false, @none.exists? { raise RuntimeError.new("Should not enter the block") }
+      end
+
+      should "return the else for .get_or_else" do
+        assert_equal "foo", @none.get_or_else("foo")
+      end
+
+      should "return the evaluated block for .get_or_else when passed a block" do
+        assert_equal "foo", @none.get_or_else { "foo" }
+      end
+
+      should "return false for .defined?" do
+        assert_equal false, @none.defined?
+      end
+
+      should "return nil for .or_nil" do
+        assert_equal nil, @none.or_nil
+      end
+
+      should "execute the block for .or_else" do
+        entered = "grouchy"
+        @none.or_else { entered = "happy" }
+        assert_equal "happy", entered
+      end
+    end
+
+    context "that is a Some" do
+      setup do
+        @some = EasyMonads::Option::Some.new("hello")
+      end
+
+      should "bind to another Some" do
+        assert_equal "hello world", @some.bind { |value| EasyMonads::Option::Some.new("#{value} world") }.data
+      end
+
+      should "enumerate" do
+        count = 0
+        @some.each { count += 1 }
+        assert_equal 1, count
+      end
+
+      should "return its data for .get" do
+        assert_equal "hello", @some.get
+      end
+
+      should "return false for .empty?" do
+        assert_equal false, @some.empty?
+      end
+
+      should "return 1 for its size" do
+        assert_equal 1, @some.size
+        another_some = EasyMonads::Option::Some.new(["hello", "world"])
+        assert_equal 1, another_some.size
+      end
+
+      should "return true when a predicate is true for .exists?" do
+        assert_equal true, @some.exists? { |value| value == "hello" }
+      end
+
+      should "return false when a predicate is false for .exists?" do
+        assert_equal false, @some.exists? { |value| value == "fooie" }
+      end
+
+      should "return its data for .get_or_else" do
+        assert_equal "hello", @some.get_or_else("goodbye")
+      end
+
+      should "return its data and ignore the block for .get_or_else when passed a block" do
+        assert_equal "hello", @some.get_or_else { raise RuntimeError.new("Should not enter the block") }
+      end
+
+      should "return true for .defined?" do
+        assert_equal true, @some.defined?
+      end
+
+      should "return its data for .or_nil" do
+        assert_equal "hello", @some.or_nil
+      end
+
+      should "not enter the block for .or_else" do
+        assert_nothing_raised { @some.or_else { raise RuntimeError.new("Should not enter the block") } }
+      end
+
+      should "return self for .or_else" do
+        assert_equal @some, @some.or_else {}
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification 
+name: easy_monads
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Stephen Sloan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: pry
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  version_requirements: *id002
+  name: shoulda
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 8
+        - 1
+        version: 0.8.1
+  version_requirements: *id003
+  name: shared_should
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 0
+        - 2
+        version: 0.0.2
+  version_requirements: *id004
+  name: always_execute
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 1
+        - 0
+        - 21
+        version: 1.0.21
+  version_requirements: *id005
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id006
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 45
+        segments: 
+        - 0
+        - 9
+        - 11
+        version: 0.9.11
+  version_requirements: *id007
+  name: rcov
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 4
+        - 2
+        version: 2.4.2
+  version_requirements: *id008
+  name: rdoc
+  prerelease: false
+  type: :development
+description: |
+  EasyMonads is a gem for Ruby that provides a simple implementation of monads.  It also provides a useful example of
+  monads in the form of Option (similar to Scala's Option) which provides Some and None classes.
+  
+  Developement for EasyMonads is sponsored by BookRenter.com and it is released under an MIT-style license
+
+email: stephen.sloan@bookrenter.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- easy_monads.gemspec
+- lib/easy_monads.rb
+- lib/easy_monads/monadic.rb
+- lib/easy_monads/option.rb
+- lib/easy_monads/option_functions.rb
+- test/helper.rb
+- test/test_easy_monads.rb
+homepage: https://github.com/bkr/easy_monads
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: EasyMonads is a simple implementation of monads for Ruby
+test_files: []
+