fetchable 0.0.2 → 0.1.0

data/README.md

@@ -1,16 +1,22 @@
 # Fetchable
 
-Provides a decorator to add a `Hash#fetch` like interface to any object.
+[![Gem Version](https://badge.fury.io/rb/keyword_curry.png)](http://badge.fury.io/rb/keyword_curry)
 
-For extra flexibility you may specify the method used to fetch items from the
-underlying collection, the default is `[]`.
+Provides a mixin and decorator to add a `Hash#fetch` like interface to any object.
 
-A lambda and `call` is a fun alternative.
+You must define a `[]` subscript method for raw access to the fetchable data.
+
+Your `[]` method must return anything but nil in order for `#fetch` to consider
+a key successfully fetched. `False` is considered sucessful.
 
 `Hash#Fetch` is one of my favourite Ruby methods and can be tricky to implement
 its full behaviour so here it is extracted for you to add to whichever object
 you choose.
 
+If you're not familiar with `Hash#fetch` it's a great way to help eliminate nils
+as it raises an error when the desired key is not found. For more info consult
+[Ruby Hash documentation](http://www.ruby-doc.org/core-2.1.0/Hash.html#method-i-fetch).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,50 +33,61 @@ Or install it yourself as:
 
 ## Usage
 
-### Default Finder Method
+### Include into a object with a `[]` method
 
 ```ruby
 
 require "fetchable"
 
-array = ["zero", "one", "two"]
-
-fetchable_array = Fetchable.new(array)
+things = %w(zero one two).extend(Fetchable)
 
-fetchable_array.fetch(0)
+things.fetch(0)
  => "zero"
 
-fetchable_array.fetch(2)
+things.fetch(2)
  => "two"
 
-fetchable_array.fetch(3)
- => KeyError key not found 3
+things.fetch(3)
+ => KeyError: key not found 3
 
-fetchable_array.fetch(3, "three")
+things.fetch(3, "three")
  => "three"
 
-fetchable_array.fetch(3) { "Execute a block!" }
+things.fetch(3) { "Execute a block!" }
  => "Execute a block!"
 
-fetchable_array.fetch(3) { |key| "Do something based on missing key #{key}" }
+things.fetch(3) { |key| "Do something based on missing key #{key}" }
  => "Do something based on missing key 3"
 
 ```
 
-### A Custom Finder Method
+### Prefer composition over inheritance?
 
-Add fetch to lambda, a HTTP client or just about anything.
+We got you covered! Use `Fetchable::Decorator` instead.
 
 ```ruby
 
-function = ->(key) { |key| ["zero", "one", "two"][key] }
-fetchable_function =Fetchable.new(function, :finder_method => :call)
+require "fetchable/decorator"
+
+things = %w(zero one two)
+
+fetchable_things = Fetchable::Decorator.new(things)
 
-fetchable_function.fetch(1)
+fetchable_things.fetch(1)
  => "one"
 
 ```
 
+### For bonus points use lambdas
+
+Lambdas, procs and method objects can also be called with `#[]`.
+
+Why not make them fetchable?
+
+It might be funny.
+
+Dammit method, you better not return me a `nil`, I'll be so mad.
+
 ## Contributing
 
 1. Fork it

data/lib/fetchable.rb

@@ -1,18 +1,16 @@
-require "delegate"
-
-class Fetchable < SimpleDelegator
-  def initialize(collection, args={})
-    @collection = collection
-    @finder_method_name = args.fetch(:finder_method, :[])
-    super(collection)
-  end
-
+module Fetchable
   def fetch(key, not_found_value = no_default_given, &block)
     if not_found_value != no_default_given && block
       raise ArgumentError.new("Cannot provide both a default arg and block to #fetch")
     end
 
-    @collection.public_send(@finder_method_name, key) || default_value(key, not_found_value, &block)
+    result = public_send(:[], key)
+
+    if result.nil?
+      default_value(key, not_found_value, &block)
+    else
+      result
+    end
   end
 
   private
@@ -26,7 +24,7 @@ class Fetchable < SimpleDelegator
       if block
         block.call(key)
       else
-        raise KeyError.new("#{key} not found in #{@collection.inspect}")
+        raise KeyError.new("key not found #{key}")
       end
     else
       not_found_value

data/lib/fetchable/decorator.rb

@@ -0,0 +1,11 @@
+require "fetchable"
+require "delegate"
+
+class Fetchable::Decorator < SimpleDelegator
+  include Fetchable
+
+  def [](asd)
+    __getobj__[asd]
+  end
+end
+

data/lib/fetchable/version.rb

@@ -1,3 +1,5 @@
 require "fetchable"
 
-Fetchable::VERSION = "0.0.2"
+module Fetchable
+  VERSION = "0.1.0"
+end

data/spec/fetchable/decorator_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+require "fetchable/decorator"
+
+describe Fetchable::Decorator do
+  subject(:fetchable) {
+    Fetchable::Decorator.new(collection)
+  }
+
+  let(:collection)     { double(:collection, :[] => fetched_object) }
+
+  let(:fetched_object) { double(:fetched_object) }
+  let(:fetch_key)      { double(:fetch_key) }
+
+  it "is a true decorator" do
+    expect(collection).to receive(:i_am_a_decorator_and_forward_all_messages)
+      .with("some", "args")
+
+    fetchable.i_am_a_decorator_and_forward_all_messages("some", "args")
+  end
+
+  it "is fetchable" do
+    expect(fetchable).to be_a(Fetchable)
+  end
+
+  describe "#fetch" do
+    it "delegates to the collection's #[] method" do
+      fetchable.fetch(fetch_key)
+
+      expect(collection).to have_received(:[]).with(fetch_key)
+    end
+
+    it "returns the entry from the collection" do
+      expect(fetchable.fetch(fetch_key)).to be fetched_object
+    end
+  end
+end

data/spec/{lib/fetchable_spec.rb → fetchable_spec.rb}

@@ -3,33 +3,18 @@ require "spec_helper"
 require "fetchable"
 
 describe Fetchable do
-  subject(:fetchable) { Fetchable.new(collection, finder_method: finder_method) }
-
-  let(:collection) {
-    double(:collection, finder_method => fetched_object)
+  subject(:fetchable) {
+    double(:fetchable, :[] => fetched_object).extend(Fetchable)
   }
 
-  let(:finder_method)  { :[] }
   let(:fetched_object) { double(:fetched_object) }
   let(:fetch_key)      { double(:fetch_key) }
 
-  it "is a true decorator" do
-    expect(collection).to receive(:arbitrary).with("an arg")
-
-    fetchable.arbitrary("an arg")
-  end
-
-  it "defaults the finder method to []" do
-    expect(
-      Fetchable.new(collection).fetch(fetch_key)
-    ).to be fetched_object
-  end
-
   describe "#fetch" do
-    it "delegates to the collection's finder method" do
+    it "delegates to the fetchable's finder method" do
       fetchable.fetch(fetch_key)
 
-      expect(collection).to have_received(finder_method).with(fetch_key)
+      expect(fetchable).to have_received(:[]).with(fetch_key)
     end
 
     context "when entry for key exists" do
@@ -39,7 +24,21 @@ describe Fetchable do
         }.not_to raise_error
       end
 
-      it "returns the entry from the collection" do
+      it "returns the entry from the fetchable" do
+        expect(fetchable.fetch(fetch_key)).to be fetched_object
+      end
+    end
+
+    context "when the enrty for the key comes back false" do
+      let(:fetched_object) { false }
+
+      it "does not execute the block" do
+        expect {
+          fetchable.fetch(fetch_key) { raise "This block must not run" }
+        }.not_to raise_error
+      end
+
+      it "returns the entry from the fetchable" do
         expect(fetchable.fetch(fetch_key)).to be fetched_object
       end
     end
@@ -84,7 +83,7 @@ describe Fetchable do
 
       context "no default or block given" do
         it "raises record not found" do
-          expect{ fetchable.fetch(fetch_key) }.to raise_error(KeyError)
+          expect{ fetchable.fetch(fetch_key) }.to raise_error(KeyError, "key not found #{fetch_key}")
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fetchable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,8 +78,10 @@ files:
 - Rakefile
 - fetchable.gemspec
 - lib/fetchable.rb
+- lib/fetchable/decorator.rb
 - lib/fetchable/version.rb
-- spec/lib/fetchable_spec.rb
+- spec/fetchable/decorator_spec.rb
+- spec/fetchable_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bestie/fetchable
 licenses:
@@ -107,5 +109,6 @@ signing_key:
 specification_version: 3
 summary: Provides a decorator to add a Hash#fetch style interface to any object.
 test_files:
-- spec/lib/fetchable_spec.rb
+- spec/fetchable/decorator_spec.rb
+- spec/fetchable_spec.rb
 - spec/spec_helper.rb