ruby-maybe 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9211030f655e23153727e36d2a68d930b54593e
-  data.tar.gz: 5c6cd1eb7a99765baa024d45de70d928f9ba88c8
+  metadata.gz: c83820565d7167780e0d0d9a58a5f71fc91488ce
+  data.tar.gz: aac84db4cf46cfeae3a3df738962347e2cc65a58
 SHA512:
-  metadata.gz: 31eafb9088606234257ed2d151cb3f78712f57ddee187b74f58d1a02a8f185a6ea40efd5e37cf07586a51f57e9dcea5fe8c4023af4b297956500ed3f50d950a1
-  data.tar.gz: fbc6e39d5d9cef5c25a515c1a99948b4d1cec192192670ddd60d96a479d0db77dbef4f4dfeb8487b2ce681a88152f2aeb31f522998828026533677e5b11147d0
+  metadata.gz: cfa21d65a6ffda9aa908ad01593ed4ba705f706292b4b5721e129aec1765874e8013894a1767e472c6c3521eab86539559967d91c18cdd0e8f670015b290e5d7
+  data.tar.gz: ef8ea4a3bac49820d5ac6089193dbb6ed687151fa3a1efb897be1cc31e62fb08cfb9f98b55b0f34032f14db96e7a3f70f7dc11efb0fdad3a3c982b9882ecef2d

data/.gitignore

@@ -1 +1,2 @@
 .DS_Store
+coverage

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
     - 1.9.3
-    - ruby-head
-    - jruby-head
+    - 2.0.0
+    - jruby-19mode

data/Gemfile

@@ -1,4 +1,6 @@
-source :rubygems
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
 
 group :test do
   gem 'rake'

data/Gemfile.lock

@@ -1,10 +1,27 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    mime-types (1.23)
+    multi_json (1.7.3)
     rake (10.0.3)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.18.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls
   rake

data/README.md

@@ -4,7 +4,17 @@
 
 ![](http://f.cl.ly/items/2o2A3k1N2d3a1b0V3V0T/maybe.png)
 
-## Description
+## Installation
+
+Either include in your Gemfile:
+
+    gem 'ruby-maybe'
+
+Or, install for your system:
+
+    > gem install ruby-maybe
+
+## Usage
 
 ### The Basics
 
@@ -83,20 +93,3 @@ 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
-
-Either include in your Gemfile:
-
-    gem 'ruby-maybe'
-
-Or, install for your system:
-
-    > gem install ruby-maybe

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake/testtask'
 task :default => :test
 
 Rake::TestTask.new do |t|
-  t.libs.push "lib"
+  t.libs << "spec"
   t.test_files = FileList['spec/*_spec.rb']
   t.verbose = true
 end

data/lib/ruby-maybe.rb

@@ -1,69 +1,3 @@
-class Maybe
-end
-
-class Just < Maybe
-  def method_missing(method_name, *args, &block)
-    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)
-    @value = value
-  end
-
-  def bind(&block)
-    computed = block.call(@value)
-    warn("Not returning a Maybe from #bind is really bad form...") unless computed.kind_of?(Maybe)
-    computed
-  end
-
-  def ==(object)
-    if object.class == Just
-      object.value == self.value
-    else
-      false
-    end
-  end
-
-  def _extract!
-    value
-  end
-
-  protected
-
-  def value
-    @value
-  end
-end
-
-class Nothing < Maybe
-  def method_missing(method_name, *args, &block)
-    Nothing.new
-  end
-
-  def bind
-    Nothing.new
-  end
-
-  def ==(object)
-    if object.class == Nothing
-      true
-    else
-      false
-    end
-  end
-
-  def _extract!
-    raise AttemptedExtract.new
-  end
-
-  class AttemptedExtract < Exception
-    def initialize
-      super("Attempted to extract value from Nothing")
-    end
-  end
-end
+require 'ruby-maybe/maybe'
+require 'ruby-maybe/just'
+require 'ruby-maybe/nothing'

data/lib/ruby-maybe/just.rb

@@ -0,0 +1,46 @@
+class Just < Maybe
+  def method_missing(method_name, *args, &block)
+    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)
+    @value = value
+  end
+
+  def bind(&block)
+    computed = block.call(@value)
+    warn("Not returning a Maybe from #bind is really bad form...") unless computed.kind_of?(Maybe)
+    computed
+  end
+
+  def map(&block)
+    Just.new(block.call(@value))
+  end
+
+  def or(&block)
+    self
+  end
+
+  def get(&block)
+    @value
+  end
+
+  def ==(object)
+    if object.class == Just
+      object.value == self.value
+    else
+      false
+    end
+  end
+
+  protected
+
+  def value
+    @value
+  end
+end

data/lib/ruby-maybe/maybe.rb

@@ -0,0 +1,9 @@
+class Maybe
+  def self.from(value)
+    if !value.nil?
+      Just.new(value)
+    else
+      Nothing.new
+    end
+  end
+end

data/lib/ruby-maybe/nothing.rb

@@ -0,0 +1,29 @@
+class Nothing < Maybe
+  def method_missing(method_name, *args, &block)
+    Nothing.new
+  end
+
+  def bind
+    Nothing.new
+  end
+
+  def map
+    Nothing.new
+  end
+
+  def or(&block)
+    block.call
+  end
+
+  def get(&block)
+    block.call
+  end
+
+  def ==(object)
+    if object.class == Nothing
+      true
+    else
+      false
+    end
+  end
+end

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.2.0"
+  s.version = "0.3.0"
   s.platform = Gem::Platform::RUBY
   s.authors = ["Callum Stott"]
   s.email = ["callum@seadowg"]

data/spec/integration_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'ruby-maybe'
+
+describe "Integration Specs" do
+  it "works as expected" do
+    Just.new(5).bind { |val|
+      Just.new(val).map { |val|
+        val * 3
+      }
+    }.bind { |val|
+      if (val > 10)
+        Nothing.new
+      else
+        Just.new(val) + 1
+      end
+    }.must_equal(Nothing.new)
+  end
+
+  it "has the correct interface" do
+    has_method(:bind)
+    has_method(:map)
+    has_method(:or)
+    has_method(:get)
+    has_method(:==)
+  end
+end
+
+def has_method(name)
+  assert(Just.method_defined?(name), "Just does not respond to #{name}")
+  assert(Nothing.method_defined?(name), "Nothing does not respond to #{name}")
+end

data/spec/just_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'ruby-maybe'
+
+describe "Just" do
+  describe "#bind" do
+    it "applys the passed block to its boxed value" do
+      Just.new(5).bind { |val| Just.new(val * 2) }.must_equal Just.new(10)
+    end
+  end
+
+  describe "#or" do
+    it "ignores arg and returns self" do
+      (Just.new(5).or { 0 }).must_equal Just.new(5)
+    end
+  end
+
+  describe "#get" do
+    it "ignores arg and returns value" do
+      (Just.new(5).get { 0 }).must_equal 5
+    end
+  end
+
+  describe "#==" do
+    it "returns false if the passed object is not a Just" do
+      (Just.new(5) == 5).must_equal false
+    end
+
+    it "returns true if the passed object is a Just with the same value" do
+      (Just.new(5) == Just.new(5)).must_equal true
+    end
+  end
+
+  describe "method lifting" do
+    it "allows using a method for the contained type" do
+      just = Just.new(5)
+      just.+(5).must_equal(Just.new(10))
+    end
+
+    it "allows passed arguments to be Maybe instances" do
+      just = Just.new(5)
+      just.+(Just.new(5)).must_equal(Just.new(10))
+    end
+
+    it "returns Nothing if any argument is Nothing" do
+      just = Just.new("Hello")
+      just.slice(Just.new(0), Nothing.new).must_equal(Nothing.new)
+    end
+
+    it "passes blocks correctly" do
+      count = 0
+      just = Just.new(5)
+      just.times { |i| count += i }
+      count.must_equal(10)
+    end
+  end
+end

data/spec/maybe_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'ruby-maybe'
+
+describe "Maybe" do
+  describe "#from" do
+    it "returns Nothing if passed nil" do
+      Maybe.from(nil).must_equal Nothing.new
+    end
+
+    it "returns Just if passed non-nil value" do
+      Maybe.from(false).must_equal Just.new(false)
+      Maybe.from(11).must_equal Just.new(11)
+    end
+  end
+end

data/spec/nothing_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'ruby-maybe'
+
+describe "Nothing" do
+  describe "#bind" do
+    it "does not execute the passed block" do
+      executed = false
+      Nothing.new.bind { |val| executed = true }
+      executed.must_equal false
+    end
+
+    it "returns a Nothing" do
+      Nothing.new.bind { |val| val }.kind_of?(Nothing).must_equal true
+    end
+  end
+
+  describe "#map" do
+    it "returns Nothing" do
+      Nothing.new.map { |val| val }.must_equal Nothing.new
+    end
+  end
+
+  describe "#or" do
+    it "evaluates arg, returning result" do
+      (Nothing.new.or { Just.new(5) }).must_equal Just.new(5)
+    end
+
+    it "chain or calls, returning last value" do
+      (Nothing.new.or { Nothing.new.or { Just.new(10) } }).must_equal Just.new(10)
+    end
+  end
+
+  describe "#get" do
+    it "evaluates arg, returning result" do
+      (Nothing.new.get { 5 }).must_equal 5
+    end
+  end
+
+  describe "#==" do
+    it "returns false if the passed object is not a Nothing" do
+      (Nothing.new == 5).must_equal false
+    end
+
+    it "returns true if the passed object is a Nothing" do
+      (Nothing.new == Nothing.new).must_equal true
+    end
+  end
+
+  describe "method lifting" do
+    it "returns Nothing for any method call" do
+      Nothing.new.missing.must_equal(Nothing.new)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'minitest/autorun'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-maybe
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Callum Stott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -25,8 +25,15 @@ files:
 - README.md
 - Rakefile
 - lib/ruby-maybe.rb
+- lib/ruby-maybe/just.rb
+- lib/ruby-maybe/maybe.rb
+- lib/ruby-maybe/nothing.rb
 - ruby-maybe.gemspec
-- spec/ruby-maybe_spec.rb
+- spec/integration_spec.rb
+- spec/just_spec.rb
+- spec/maybe_spec.rb
+- spec/nothing_spec.rb
+- spec/spec_helper.rb
 homepage: 
 licenses:
 - MIT

data/spec/ruby-maybe_spec.rb

@@ -1,102 +0,0 @@
-require 'minitest/autorun'
-require 'ruby-maybe'
-
-describe "Just" do
-  describe "#bind" do
-    it "applys the passed block to its boxed value" do
-      Just.new(5).bind { |val| Just.new(val * 2) }.must_equal Just.new(10)
-    end
-  end
-
-  describe "#==" do
-    it "returns false if the passed object is not a Just" do
-      (Just.new(5) == 5).must_equal false
-    end
-
-    it "returns true if the passed object is a Just with the same value" do
-      (Just.new(5) == Just.new(5)).must_equal true
-    end
-  end
-
-  describe "method lifting" do
-    it "allows using a method for the contained type" do
-      just = Just.new(5)
-      just.+(5).must_equal(Just.new(10))
-    end
-
-    it "allows passed arguments to be Maybe instances" do
-      just = Just.new(5)
-      just.+(Just.new(5)).must_equal(Just.new(10))
-    end
-
-    it "returns Nothing if any argument is Nothing" do
-      just = Just.new("Hello")
-      just.slice(Just.new(0), Nothing.new).must_equal(Nothing.new)
-    end
-
-    it "passes blocks correctly" do
-      count = 0
-      just = Just.new(5)
-      just.times { |i| count += i }
-      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
-  describe "#bind" do
-    it "does not execute the passed block" do
-      executed = false
-      Nothing.new.bind { |val| executed = true }
-      executed.must_equal false
-    end
-
-    it "returns a Nothing" do
-      Nothing.new.bind { |val| val }.kind_of?(Nothing).must_equal true
-    end
-  end
-
-  describe "#==" do
-    it "returns false if the passed object is not a Nothing" do
-      (Nothing.new == 5).must_equal false
-    end
-
-    it "returns true if the passed object is a Nothing" do
-      (Nothing.new == Nothing.new).must_equal true
-    end
-  end
-
-  describe "method lifting" do
-    it "returns Nothing for any method call" do
-      Nothing.new.missing.must_equal(Nothing.new)
-    end
-  end
-
-  describe "#_extract!" do
-    it "raises an exception" do
-      assert_raises(Nothing::AttemptedExtract) {
-        Nothing.new._extract!
-      }
-    end
-  end
-end
-
-describe "Integration Specs" do
-  it "works as expected" do
-    Just.new(5).bind { |val|
-      Just.new(val * 3)
-    }.bind { |val|
-      if (val > 10)
-        Nothing.new
-      else
-        Just.new(val) + 1
-      end
-    }.must_equal(Nothing.new)
-  end
-end