nullobject 0.0.1 → 0.0.2

data/.travis.yml

@@ -2,3 +2,5 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 1.8.7
+  - rbx
+  - jruby

data/README.md

@@ -1,8 +1,58 @@
-# NullObject[![travis-ci](https://secure.travis-ci.org/martinciu/nullobject.png?branch=master)](http://travis-ci.org/martinciu/nullobject)
-### Intent
+# NullObject
+#### Null Object Design Pattern Ruby implementation
+[![travis-ci](https://secure.travis-ci.org/martinciu/nullobject.png?branch=master)](http://travis-ci.org/martinciu/nullobject)
+## Intent
 
 The intent of a Null Object is to encapsulate the absence of an object by providing a substitutable alternative that offers suitable default do nothing behavior. In short, a design where “nothing will come of nothing”
 
+More about Null Object Pattern you can find here:  
+[http://en.wikipedia.org/wiki/Null_Object_pattern](http://en.wikipedia.org/wiki/Null_Object_pattern)  
+[http://sourcemaking.com/design_patterns/null_object](http://sourcemaking.com/design_patterns/null_object)  
+[http://avdi.org/devblog/2011/05/30/null-objects-and-falsiness](http://avdi.org/devblog/2011/05/30/null-objects-and-falsiness/)  
+
+## Usage
+
+    # examples from http://avdi.org/devblog/2011/05/30/null-objects-and-falsiness/
+
+    Null::Object.instance.foobar.baz.buz
+
+    def Maybe(value)
+      case value
+      when nil then Null::Object.instance
+      else value
+      end
+    end
+
+    def slug(title)
+      Maybe(title).strip.downcase.tr('^[0-9a-z]', '-')
+    end
+
+    h = {}
+    
+    slug(h[:missing_key]) # => ""
+
+    foo = Null::Object.instance
+
+    foo.to_s # => ""
+    foo.to_a # => []
+    foo.to_i # => 0
+    foo.to_f # => 0.0
+    foo.nil? # => true
+
+    # Custom Null Object
+
+    class FooNullObject
+      include Null
+
+      def to_bar
+        "nothing here"
+      end
+    end
+
+    foo = FooNullObject.instance
+    foo.to_bar # => "nothing here"
+    foo.to_s   # => ""
+        
 ## Setup
 
 If you are using bundler add nullobject to your Gemfile:
@@ -21,10 +71,6 @@ and require it in your project:
 
     require 'nullobject'
 
-## Usage
-
-[TODO]
-
 ## Development
 
 Source hosted at [GitHub](http://github.com/martinciu/nullobject).

data/lib/nullobject/version.rb

@@ -1,3 +1,3 @@
 module Nullobject
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/nullobject.rb

@@ -1,39 +1,23 @@
 require "singleton"
 
-class NullObject
-  include Singleton
-  
-  def self.maybe(value)
-    value.nil? ? instance : value
+module Null
+
+  def self.included(base)
+    base.send(:include, Singleton)
   end
 
   def to_a; []; end
-  alias :to_ary :to_a
   def to_s; ""; end
-  alias :to_str :to_s
   def to_f; 0.0; end
   def to_i; 0; end
   def nil?; true; end
-  def +(other); other; end
-  def -(other); coerced(other) - other; end
-  
-  def coerce(other)
-    [other, coerced(other)]
-  end
 
   def method_missing(*args, &block)
     self
   end
 
-  private
-    def coerced(other)
-      send({
-        Integer => :to_i,
-        Fixnum  => :to_i,
-        String  => :to_s,
-        Float   => :to_f,
-        Array   => :to_a
-      }[other.class])
-    end
+  class Object
+    include Null
+  end
 
 end

data/spec/lib/nullobject_spec.rb

@@ -1,20 +1,16 @@
 require 'spec_helper'
 
-describe "NullObject" do
+describe "Null::Object" do
   
   describe "instance methods" do
     before do
-      @it = NullObject.instance
+      @it = Null::Object.instance
     end
 
     it "#to_s return empty string" do
       @it.to_s.must_equal ""
     end
 
-    it "#to_str return empty string" do
-      @it.to_str.must_equal ""
-    end
-
     it "#to_a return empty array" do
       @it.to_a.must_equal []
     end
@@ -30,55 +26,45 @@ describe "NullObject" do
     it "#nil? return true" do
       @it.nil?.must_equal true
     end
-  
-    describe "#+" do
-      it "does not modify integer" do
-        (@it + 5).must_equal 5
-        (5 + @it).must_equal 5
-      end
-      
-      it "does not modify float" do
-        (@it + 5.0).must_equal 5.0
-        (5.0 + @it).must_equal 5.0
-      end
-      
-      it "does not modify string" do
-        (@it + "foo").must_equal "foo"
-        ("foo" + @it).must_equal "foo"
-      end
+  end
+
+  describe "custom null" do
+    class FooNullObject
+      include Null
 
-      it "does not modify array" do
-        (@it + [1, 3, "foo"]).must_equal [1, 3, "foo"]
-        ([1, 3, "foo"] + @it).must_equal [1, 3, "foo"]
+      def to_bar
+        "nothing here"
       end
     end
 
-    describe "#-" do
-      it "does not modify integer" do
-        (5 - @it).must_equal 5
-      end
+    before do
+      @it = FooNullObject.instance
+    end
 
-      it "acts as empty if other substracts from" do
-        (@it - 5).must_equal -5
-        (@it - [5]).must_equal []
-      end
+    it "#to_s return empty string" do
+      @it.to_s.must_equal ""
+    end
 
-      it "does not modify array" do
-        ([1, 3, "foo"] - @it).must_equal [1, 3, "foo"]
-      end
+    it "#to_a return empty array" do
+      @it.to_a.must_equal []
     end
 
-  end
+    it "#to_f return 0.0" do
+      @it.to_f.must_equal 0.0
+    end
 
-  describe "#maybe" do
-    it "returns NullObject if value is nil" do
-      NullObject.maybe(nil).must_be_kind_of NullObject
+    it "#to_i return 0" do
+      @it.to_i.must_equal 0
     end
 
-    it "returns value if it is not nil" do
-      val = "foo"
-      NullObject.maybe(val).must_equal val
+    it "#nil? return true" do
+      @it.nil?.must_equal true
     end
+
+    it "#to_bar returns 'nothing_here'" do
+      @it.to_bar.must_equal "nothing here"
+    end
+  
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nullobject
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-18 00:00:00.000000000 Z
+date: 2011-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70204139217140 !ruby/object:Gem::Requirement
+  requirement: &70328215374680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70204139217140
+  version_requirements: *70328215374680
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70204139215840 !ruby/object:Gem::Requirement
+  requirement: &70328215372580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70204139215840
+  version_requirements: *70328215372580
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70204139214100 !ruby/object:Gem::Requirement
+  requirement: &70328215370540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 0.8.3
   type: :development
   prerelease: false
-  version_requirements: *70204139214100
+  version_requirements: *70328215370540
 description: Null Object Design Pattern Ruby implementation
 email:
 - marcin.ciunelis@gmail.com
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1565268376526755474
+      hash: -3175962028283363154
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1565268376526755474
+      hash: -3175962028283363154
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10