optional 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    optional (0.0.1)
+    optional (0.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,2 +1,30 @@
 # optional
-### option types to make nils say bye bye
+### option types to make nils a thing of the past
+
+Tony Hoare, inventor of the null reference, calls it his "billion-dollar mistake". You will be no stranger to the ubiquitous `NoMethodError: undefined method 'foo' for nil:NilClass`. But it doesn't have to be this way.
+
+There are, crucially, two distinct types of values (or rather lack of values) that are usually, in Ruby, represented as `nil`. There are values that should always be present - and here the fact that they are `nil` actually indicates that an error has occurred somewhere else in your program - and those values that *may or may not be set* - where each case is valid. For example, a person may or may not be wearing a hat.
+    
+    class Hat
+      def doff
+        …
+      end
+    end
+    
+    gwen    = Person.create(name: "Gwen", hat: Some[:fedora])
+    charlie = Person.create(name: "Charlie", hat: None)
+    
+    class Person
+    
+      def greet
+        puts "hello!"
+        hat.do { |h| doff h }
+      end
+      
+    end
+
+    gwen.hat.match do |m|
+      m.some (:flat_cap) { puts "Hey up!" }
+      m.some (:fedora)   { |h| puts "*touches brim of #{h} respectfully*" }
+      m.none             { puts "Hello!" }
+    end  

data/lib/optional/none.rb

@@ -17,8 +17,8 @@ module None
     raise Option::ValueOfNoneError
   end
 
-  def value_or
-    yield
+  def value_or(default=nil, &block)
+    block.nil? ? default : block.call
   end
 
   def & other

data/lib/optional/option/enumerable.rb

@@ -2,6 +2,11 @@ module Option
   module Enumerable
     include ::Enumerable
 
+    def do &block
+      each &block
+      self
+    end
+
     def map
       from_array super
     end

data/lib/optional/some.rb

@@ -15,7 +15,7 @@ class Some
     block.nil? ? false : super
   end
 
-  def value_or
+  def value_or(default=nil)
     value
   end
 
@@ -28,7 +28,7 @@ class Some
   end
 
   def == other
-    other.some? && value == other.value
+    other.is_a?(Some) && value == other.value
   end
 
   def | other

data/optional.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'optional'
-  s.version       = '0.0.2'
+  s.version       = '0.0.3'
   s.date          = '2013-04-19'
   s.summary       = "Optional values with pattern matching"
   s.description   = "Make nils go bye bye with Options!"

data/spec/lib/optional/none_spec.rb

@@ -19,6 +19,7 @@ describe None do
 
   it "does, however, allow you to supply a default in place of a value" do
     subject.value_or { cat }.should eq cat
+    subject.value_or(cat).should eq cat
   end
 
   it "can be anded with another none, yielding none" do

data/spec/lib/optional/option/enumerable_spec.rb

@@ -4,6 +4,14 @@ describe Option::Enumerable do
 
   let (:cat) { Cat.new("MOGGIE!") }
 
+  describe "#do" do
+    it "allows ops with side effects to be performed using the value as part of a method chain" do
+      names = ""
+      Some[cat].do { |c| names << c.name }.map(&:name).should eq Some["MOGGIE!"]
+      names.should eq "MOGGIE!"
+    end
+  end
+
   describe "#map" do
 
     it "maps a some to a some" do

data/spec/lib/optional/some_spec.rb

@@ -23,6 +23,7 @@ describe Some do
 
   it "can be passed a default value but won't use it" do
     Some[cat].value_or { dog }.should eq cat
+    Some[cat].value_or(dog).should eq cat
   end
 
   it "can be anded with another some" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optional
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: