object-let 0.0.1 → 0.1.0

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.rspec
 .bundle
 .config
 .yardoc

data/README.rdoc

@@ -1,6 +1,8 @@
 = object-let
 
-Defines Object#let, which simply yields the object and returns the result.
+{<img src="https://gemnasium.com/ronen/object-let.png" alt="Dependency Status" />}[https://gemnasium.com/ronen/object-let]
+
+Defines <tt>Object#let</tt>, which simply yields the object and returns the result.
 This idiom, familiar to Lisp programmers, can be handy to eliminate the need
 for an intermediate variable when you need to use the result of a
 computation multiple times.
@@ -21,6 +23,23 @@ Stylistically, as well in terms of lexical scoping (for ruby 1.9), this
 idiom can make clear that the intermediate result is of no importance outside the
 block.
 
+You can also think of this as analogous to "map" in a method chain, but for a single value
+rather than for an enumerable.  Compare:
+
+        array_of_items = thingy.item_names.map{ |name| Item.new(:name => name) }
+        just_one_item  = thingy.item_name.let { |name| Item.new(:name => name) }
+
+
+<tt>Object#let_if</tt> behaves like <tt>Object#let</tt> except that it only yields if the
+object is truthy; otherwise it returns nil.  So, modifying the above
+example:
+
+    bounds = my_things.find_biggest.let_if { |biggest|
+      Bound.new(:width => biggest.width, :height => biggest.height)
+    }
+
++bounds+ will be nil if +find_biggest+ returns nil.
+
 = See also
 
 Discussion at http://www.opensourcery.com/blog/zack-hobson/objectlet-ruby-0
@@ -31,7 +50,6 @@ The "let" gem (https://rubygems.org/gems/let) provides a module that can be
 included in a class to define memoizing accessors.  That gem and this one
 are compatible.
 
-
 == Installation
 
 Install via:
@@ -42,6 +60,11 @@ or in your Gemfile:
 
    gem "object-let"
 
+== History
+
+  * 0.1.0 - Add <tt>Object#left_if</tt>
+  * 0.0.1 - Initial version
+
 == Copyright
 
 Released under the MIT License.  See LICENSE for details.

data/lib/object-let/object.rb

@@ -3,5 +3,8 @@ module ObjectLet
     def let
       yield self
     end
+    def let_if
+      yield self if self
+    end
   end
 end

data/lib/object-let/version.rb

@@ -1,3 +1,3 @@
 module ObjectLet
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/object_spec.rb

@@ -1,21 +1,58 @@
 require "spec_helper"
 
-describe "Object" do
+shared_examples "let" do
 
-  it "should support let method" do
+  it "should be supported" do
     obj = Object.new
-    obj.should be_respond_to :let
+    obj.should be_respond_to method
   end
 
-  it "let should yield the object" do
+  it "should yield the object" do
     obj = Object.new
-    obj.let { |arg|
+    obj.send(method) { |arg|
       arg.should equal obj
     }
   end
 
-  it "let should return the block result" do
+  it "should return the block result" do
     obj = Object.new
-    obj.let{|arg| 3}.should == 3
+    obj.send(method) {|arg| 3}.should == 3
   end
 end
+
+shared_examples "let_if" do
+  it "should not yield" do
+    expect { subject.let_if { raise "in block"} }.should_not raise_error
+  end
+
+  it "should return nil" do
+    subject.let_if { 12345 }.should be_nil
+  end
+end
+
+describe "Object" do
+
+  context "let" do
+    it_should_behave_like "let" do
+      let(:method) { :let }
+    end
+  end
+
+  context "let_if" do
+    it_should_behave_like "let" do
+      let(:method) { :let_if }
+    end
+
+    context "when object is nil" do
+      subject { nil }
+      it_should_behave_like "let_if"
+    end
+
+    context "when object is false" do
+      subject { false }
+      it_should_behave_like "let_if"
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: object-let
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-21 00:00:00.000000000 Z
+date: 2012-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70124170808020 !ruby/object:Gem::Requirement
+  requirement: &70259253506940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70124170808020
+  version_requirements: *70259253506940
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70124170806780 !ruby/object:Gem::Requirement
+  requirement: &70259253506520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70124170806780
+  version_requirements: *70259253506520
 - !ruby/object:Gem::Dependency
   name: simplecov-gem-adapter
-  requirement: &70124170805840 !ruby/object:Gem::Requirement
+  requirement: &70259253506060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70124170805840
+  version_requirements: *70259253506060
 description: Defines Object#let, which yields the object and returns the result
 email:
 - ronen@barzel.org
@@ -93,3 +93,4 @@ summary: Defines Object#let, which yields the object and returns the result.  Th
 test_files:
 - spec/object_spec.rb
 - spec/spec_helper.rb
+has_rdoc: