option 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in option.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rob Ares
+
+MIT License
+
+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

@@ -0,0 +1,62 @@
+# Option
+
+A Ruby port os Scala's Option monad. Tries to be faithful
+but also pragmatic in RE: to ducktyping.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'option'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install option
+
+## Usage
+
+Generally, you want to use the Option(A) wrapper method to box
+your value. This will make the right decision as to what your initial
+value should be:
+
+```ruby
+foo = Option("bar")
+```
+
+This will allow you to now manipulate the value in the box via various means:
+
+```ruby
+
+# get the value
+foo.get #=> "bar"
+
+# return a default if the box is None
+None.get_or_else { "default" } #=> "default"
+
+# map the value to another option
+foo.map { |v| v.upcase } #=> Some("BAR")
+
+# does the value meet a requirement?
+foo.exists? { |v| v == "bar" } #=> true
+
+# return the value or nil depending on the state
+foo.or_nil #=> "bar"
+
+# chain values
+foo.map { |v| v * 2 }.map { |v| v.upcase }.get_or_else { "missing" } #=> BARBAR
+
+# attempt to extract a value but default if None
+None.fold(-> { "missing" }) { |v| v.upcase } #=> missing
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |test|
+  test.libs << "lib" << "spec"
+  test.pattern = "spec/**/*_spec.rb"
+end

data/lib/option.rb

@@ -0,0 +1,115 @@
+class Option
+
+  def or_nil
+  end
+
+  def ==(that)
+    or_nil == that.or_nil
+  end
+end
+
+class Some < Option
+
+  def initialize(value)
+    @value = value
+  end
+
+  def to_a
+    [get]
+  end
+
+  def get
+    @value
+  end
+
+  def get_or_else(&blk)
+    get
+  end
+
+  def foreach(&blk)
+    blk.call(get)
+
+    nil
+  end
+
+  def or_nil
+    get
+  end
+
+  def empty?
+    false
+  end
+
+  def map(&blk)
+    Option(blk.call(get))
+  end
+
+  def flat_map(&blk)
+    result = blk.call(get)
+    case result
+      when Option then return result
+      else raise TypeError, "Must be Option"
+    end
+  end
+
+  def fold(if_empty, &blk)
+    blk.call(get)
+  end
+
+  def exists?(&blk)
+    !! blk.call(get)
+  end
+end
+
+class NoneClass < Option
+
+  def to_a
+    []
+  end
+
+  def get
+    raise IndexError, "None.get"
+  end
+
+  def get_or_else(&blk)
+    blk.call
+  end
+
+  def foreach(&blk)
+    nil
+  end
+
+  def or_nil
+    nil
+  end
+
+  def empty?
+    true
+  end
+
+  def map(&blk)
+    flat_map(&blk)
+  end
+
+  def flat_map(&blk)
+    self
+  end
+
+  def fold(if_empty, &blk)
+    if_empty.call
+  end
+
+  def exists?(&blk)
+    false
+  end
+end
+
+None = NoneClass.new
+
+def Some(value)
+  Some.new(value)
+end
+
+def Option(value)
+  value.nil? ? None : Some(value)
+end

data/lib/option/version.rb

@@ -0,0 +1,3 @@
+module Option
+  VERSION = "0.0.1"
+end

data/option.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/option/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rob Ares"]
+  gem.email         = ["rob.ares@gmail.com"]
+  gem.description   = %q{Ruby port of Scala's Option Monad}
+  gem.summary       = %q{Option attempts to be faithful to the useful parts of the scala api. We lose the type safety but still is quite useful when dealing with optional values.}
+  gem.homepage      = "http://www.robares.com/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.name          = "option"
+  gem.require_paths = ["lib"]
+  gem.version       = Option::VERSION
+
+  gem.add_development_dependency "rake",     "= 0.9.2.2"
+  gem.add_development_dependency "rr",       "= 1.0.4"
+  gem.add_development_dependency "minitest", "= 3.4.0"
+end

data/spec/option_spec.rb

@@ -0,0 +1,157 @@
+require "minitest/autorun"
+require "minitest/spec"
+
+require "rr"
+require "rr/adapters/rr_methods"
+
+require "option"
+
+include RR::Adapters::RRMethods
+
+def value
+  12
+end
+
+describe NoneClass do
+
+  it "#to_a returns an empty array" do
+    None.to_a.must_equal([])
+  end
+
+  it "#get raises IndexError" do
+    lambda { None.get }.must_raise IndexError
+  end
+
+  it "#get_or_else executes the block" do
+    None.get_or_else { "Some" }.must_equal "Some"
+  end
+
+  it "#foreach does not execute the block" do
+    blk = proc {}
+    dont_allow(blk).call
+
+    None.foreach(&blk)
+
+    RR.verify
+  end
+
+  it "#or_nil should return nil" do
+    None.or_nil.must_be_nil
+  end
+
+  it "#empty? should be true" do
+    None.empty?.must_equal(true)
+  end
+
+  it "#map should return itself" do
+    None.map {}.must_equal(None)
+  end
+
+  it "#flat_map should return itself" do
+    None.flat_map {}.must_equal(None)
+  end
+
+  it "#exists? should return false" do
+    None.exists? {}.must_equal(false)
+  end
+
+  it "#fold should invoke the default proc" do
+    None.fold(proc { value }) { |v| v.to_f }.must_equal(value)
+  end
+
+  it "should be aliased to None" do
+    None.must_be_instance_of(NoneClass)
+  end
+end
+
+describe Some do
+
+  it "#to_a returns the value wrapped in an array" do
+    Some(value).to_a.must_equal([value])
+  end
+
+  it "#get returns the inner value" do
+    Some(value).get.must_equal(value)
+  end
+
+  it "#get_or_else does not execute the block;" do
+    blk = proc { value }
+    dont_allow(blk).call
+
+    Some(value).get_or_else(&blk)
+
+    RR.verify
+  end
+
+  it "#get_or_else returns the value" do
+    Some(value).get_or_else { }.must_equal(value)
+  end
+
+  it "#foreach executes the block passing the inner value" do
+    blk = proc {}
+    mock(blk).call(value)
+
+    Some(value).foreach(&blk)
+
+    RR.verify
+  end
+
+  it "#or_nil should return the inner value" do
+    Some(value).or_nil.must_equal(value)
+  end
+
+  it "#empty? should be false" do
+    Some(value).empty?.must_equal(false)
+  end
+
+  it "#map should return the result of the proc over the value in an Option" do
+    Some(value).map { |v| v * 2 }.must_equal(Some(24))
+  end
+
+  it "#flat_map should raise TypeError if the returned value is not an Option" do
+    lambda { Some(value).flat_map { |v| v * 2 } }.must_raise TypeError
+  end
+
+  it "#flat_map should return an Option value from the block" do
+    Some(value).flat_map { |v| Option(v * 2) }.must_equal(Some(24))
+  end
+
+  it "#flat_map can return None from the block" do
+    Some(value).flat_map { |_| None }.must_equal(None)
+  end
+
+  it "#exists? should return true when the block evaluates true" do
+    Some(value).exists? { |v| v % 2 == 0 }.must_equal(true)
+  end
+
+  it "#exists? should return false when the block evaluates false" do
+    Some(value).exists? { |v| v % 2 != 0 }.must_equal(false)
+  end
+
+  it "#fold should map the proc over the value and return it" do
+    Some(value).fold(proc { value * 2 }) { |v| v * 3 }.must_equal(36)
+  end
+
+  it "should be aliased to Some" do
+    Some.must_equal(Some)
+  end
+
+  it "should wrap the creation of a Some" do
+    mock(Some).new(value)
+
+    Some(value)
+
+    RR.verify
+  end
+end
+
+describe Option do
+
+  it "must return a some if the passed value is not nil" do
+    Option(value).must_equal(Some(value))
+  end
+
+  it "must return a None if the passed value is nil" do
+    Option(nil).must_equal(None)
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: option
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rob Ares
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70150970015480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70150970015480
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70150970014980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :development
+  prerelease: false
+  version_requirements: *70150970014980
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70150970014520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70150970014520
+description: Ruby port of Scala's Option Monad
+email:
+- rob.ares@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/option.rb
+- lib/option/version.rb
+- option.gemspec
+- spec/option_spec.rb
+homepage: http://www.robares.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Option attempts to be faithful to the useful parts of the scala api. We lose
+  the type safety but still is quite useful when dealing with optional values.
+test_files:
+- spec/option_spec.rb