fetchable 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fetchable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stephen Best
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# Fetchable
+
+Provides a decorator to add a `Hash#fetch` like interface to any object.
+
+For extra flexibility you may specify the method used to fetch items from the
+underlying collection, the default is `[]`.
+
+A lambda and `call` is a fun alternative.
+
+`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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fetchable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fetchable
+
+## Usage
+
+### Default Finder Method
+
+```ruby
+
+require "fetchable"
+
+array = ["zero", "one", "two"]
+
+fetchable_array = Fetchable.new(array)
+
+fetchable_array.fetch(0)
+ => "zero"
+
+fetchable_array.fetch(2)
+ => "two"
+
+fetchable_array.fetch(3)
+ => KeyError key not found 3
+
+fetchable_array.fetch(3, "three")
+ => "three"
+
+fetchable_array.fetch(3) { "Execute a block!" }
+ => "Execute a block!"
+
+fetchable_array.fetch(3) { |key| "Do something based on missing key #{key}" }
+ => "Do something based on missing key 3"
+
+```
+
+### A Custom Finder Method
+
+Add fetch to lambda, a HTTP client or just about anything.
+
+```ruby
+
+function = ->(key) { |key| ["zero", "one", "two"][key] }
+fetchable_function =Fetchable.new(function, :finder_method => :call)
+
+fetchable_function.fetch(1)
+ => "one"
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fetchable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fetchable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fetchable"
+  spec.version       = Fetchable::VERSION
+  spec.authors       = ["Stephen Best"]
+  spec.email         = ["bestie@gmail.com"]
+  spec.summary       = %q{Provides a decorator to add a Hash#fetch style interface to any object.}
+  spec.description   = spec.summary + " " + %{For extra flexibility you may specify the method used to fetch items from the underlying collection.}
+  spec.homepage      = "https://github.com/bestie/fetchable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec",   "~> 2.14"
+  spec.add_development_dependency "pry",     "~> 0.9.12"
+end

data/lib/fetchable.rb

@@ -0,0 +1,36 @@
+require "fetchable/version"
+require "delegate"
+
+class Fetchable < SimpleDelegator
+  def initialize(collection, args={})
+    @collection = collection
+    @finder_method_name = args.fetch(:finder_method, :[])
+    super(collection)
+  end
+
+  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)
+  end
+
+  private
+
+  def no_default_given
+    @default ||= Object.new
+  end
+
+  def default_value(key, not_found_value, &block)
+    if not_found_value == no_default_given
+      if block
+        block.call(key)
+      else
+        raise KeyError.new("#{key} not found in #{@collection.inspect}")
+      end
+    else
+      not_found_value
+    end
+  end
+end

data/lib/fetchable/version.rb

@@ -0,0 +1,3 @@
+require "fetchable"
+
+Fetchable::VERSION = "0.0.1"

data/spec/lib/fetchable_spec.rb

@@ -0,0 +1,98 @@
+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)
+  }
+
+  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
+      fetchable.fetch(fetch_key)
+
+      expect(collection).to have_received(finder_method).with(fetch_key)
+    end
+
+    context "when entry for key exists" do
+      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 collection" do
+        expect(fetchable.fetch(fetch_key)).to be fetched_object
+      end
+    end
+
+    context "when entry for key does not exist" do
+      let(:fetched_object) { nil }
+
+      context "when a default argument is given" do
+        let(:default) { double(:default) }
+
+        it "returns the default" do
+          expect(fetchable.fetch(fetch_key, default)).to be default
+        end
+
+        context "when default argument is nil" do
+          it "returns nil" do
+            expect(fetchable.fetch(fetch_key, nil)).to be nil
+          end
+        end
+
+        context "when default argument is false" do
+          it "returns false" do
+            expect(fetchable.fetch(fetch_key, false)).to be false
+          end
+        end
+      end
+
+      context "when a block is given" do
+        let(:spy) { double(:spy, :block_was_called => block_return_value) }
+        let(:block) { lambda { |key| spy.block_was_called(key) } }
+        let(:block_return_value) { double(:block_return_value) }
+
+        it "returns the result of block" do
+          expect(fetchable.fetch(fetch_key, &block)).to be block_return_value
+        end
+
+        it "yields the key to the block" do
+          fetchable.fetch(fetch_key, &block)
+          expect(spy).to have_received(:block_was_called).with(fetch_key)
+        end
+      end
+
+      context "no default or block given" do
+        it "raises record not found" do
+          expect{ fetchable.fetch(fetch_key) }.to raise_error(KeyError)
+        end
+      end
+    end
+
+    context "when both block and default argument is given" do
+      it "raises ArgumentError" do
+        expect{ fetchable.fetch(fetch_key, nil) {} }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: fetchable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Best
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    none: false
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+    none: false
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+    none: false
+description: Provides a decorator to add a Hash#fetch style interface to any object.
+  For extra flexibility you may specify the method used to fetch items from the underlying
+  collection.
+email:
+- bestie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fetchable.gemspec
+- lib/fetchable.rb
+- lib/fetchable/version.rb
+- spec/lib/fetchable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bestie/fetchable
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+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/spec_helper.rb