adapter 0.5.2 → 0.6.0

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle
+log
+pkg

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.3
+notifications:
+  email: false
+bundler_args: --without guard

data/Changelog.md

@@ -0,0 +1,7 @@
+* 0.5.2 => 0.6.0
+
+  * Now aimed at key/value where value is Hash of attributes instead of just any random value, such as String, Array, etc.
+  * `#key_for` now defaults to whatever was passed in, rather than Marshaling anything that was not a String or a Symbol.
+  * `#encode` and `#decode` now default to whatever was passed in, instead of marshaling.
+  * `#delete` no longer returns value. Raise error if delete fails. If you need value, do a read before delete.
+  * Added `#read_multiple`. This can be overridden per adapter to make it more efficient based on the data store. Defaults to multiple single reads.

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+gemspec
+
+gem 'rake'
+
+group(:guard) do
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+end
+
+group(:test) do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    adapter (0.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    guard (1.0.0)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-bundler (0.1.3)
+      bundler (>= 1.0.0)
+      guard (>= 0.2.2)
+    guard-rspec (0.6.0)
+      guard (>= 0.10.0)
+    rake (0.9.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adapter!
+  guard
+  guard-bundler
+  guard-rspec
+  rake
+  rspec

data/Guardfile

@@ -0,0 +1,16 @@
+rspec_options = {
+  :all_after_pass => false,
+  :all_on_start   => false,
+}
+
+guard 'rspec', rspec_options do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/helper.rb')  { "spec" }
+  watch(%r{lib/adapter/spec/(.+)\.rb}) { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE

@@ -6,4 +6,4 @@ Redistribution and use in source and binary forms, with or without modification,
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 * Neither the name of Zynga Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,69 @@
+# Adapter
+
+A simple interface to anything.
+
+## Defining an Adapter
+
+An adapter requires 4 methods to work: read, write, delete and clear.
+
+```ruby
+Adapter.define(:memory) do
+  def read(key)
+    decode(client[key_for(key)])
+  end
+
+  def write(key, value)
+    client[key_for(key)] = encode(value)
+  end
+
+  def delete(key)
+    client.delete(key_for(key))
+  end
+
+  def clear
+    client.clear
+  end
+end
+```
+
+Note: in order for things to be most flexible, always wrap key with key_for(key) which will ensure that pretty much anything can be a key. Also, by default encode and decode are included and they Marshal.dump and Marshal.load. Feel free to override these if you prefer JSON serialization or something else.
+
+Once you have defined an adapter, you can get a class of that adapter like this:
+
+```ruby
+Adapter[:memory]
+```
+
+This returns a dynamic class with your adapting methods included and an initialize method that takes a client. This means you can get an instance of the adapter by using new and passing the client (in this instance a boring hash):
+
+```ruby
+adapter = Adapter[:memory].new({}) # sets {} to client
+adapter.write('foo', 'bar')
+adapter.read('foo') # 'bar'
+adapter.delete('foo')
+adapter.fetch('foo', 'bar') # returns bar and sets foo to bar
+```
+
+`get` and `[]` are aliased to read. `set` and `[]=` are aliased to write.
+
+Note: You can also optionally provide a lock method. [Read More](https://github.com/jnunemaker/adapter/wiki/Locking)
+
+## Adapter Power User Guides
+
+* [Wiki Home](https://github.com/jnunemaker/adapter/wiki)
+* [Creating an Adapter](https://github.com/jnunemaker/adapter/wiki/Creating-an-Adapter)
+* [Overriding an Adapter](https://github.com/jnunemaker/adapter/wiki/Overriding-an-Adapter)
+* [Allowing for Options](https://github.com/jnunemaker/adapter/wiki/Allowing-for-Options)
+* [Adapter defaults](https://github.com/jnunemaker/adapter/wiki/Adapter-defaults)
+
+## Mailing List
+
+https://groups.google.com/forum/#!forum/toystoreadapter
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix in a topic branch.
+* Add tests for it. This is important so we don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine, but bump version in a commit by itself so we can ignore when we pull)
+* Send a pull request.

data/Rakefile

@@ -1,7 +1,6 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 
-task :default => :spec
+task :default => :spec

data/adapter.gemspec

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+require File.expand_path('../lib/adapter/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name         = 'adapter'
+  s.homepage     = 'http://github.com/jnunemaker/adapter'
+  s.summary      = 'A simple interface to anything'
+  s.require_paths = ["lib"]
+  s.authors      = ['John Nunemaker', 'Geoffrey Dagley', 'Brandon Keepers']
+  s.email        = ['nunemaker@gmail.com', 'gdagley@gmail.com', 'brandon@opensoul.org']
+  s.version      = Adapter::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.files        = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+end

data/examples/memory.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'pathname'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'adapter/memory'
+
+adapter = Adapter[:memory].new({})
+adapter.clear
+
+adapter.write('foo', 'bar')
+puts 'Should be bar: ' + adapter.read('foo').inspect
+
+adapter.delete('foo')
+puts 'Should be nil: ' + adapter.read('foo').inspect
+
+adapter.write('foo', 'bar')
+adapter.clear
+puts 'Should be nil: ' + adapter.read('foo').inspect
+
+puts 'Should be bar: ' + adapter.fetch('foo', 'bar').inspect
+puts 'Should be bar: ' + adapter.read('foo').inspect

data/examples/overriding_serialization.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'active_support'
+require 'pathname'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'adapter/memory'
+
+# Adapter.define also takes any combination of module and block.
+#
+# If module present, it is included. If block present, it is turned
+# into a module and included. This means that including a module and
+# a block allows overriding the module by defining methods in the block.
+#
+# In our case below, we simply override the memory adapter to create
+# a new adapter that encodes/decodes using JSON instead of the default
+# Marshal.load/dump. Also, important to note that this does not affect
+# the memory adapter which still uses Marshal.
+Adapter.define(:memory_json, Adapter::Memory) do
+  def encode(value)
+    ActiveSupport::JSON.encode(value)
+  end
+
+  def decode(value)
+    ActiveSupport::JSON.decode(value)
+  end
+end
+
+adapter = Adapter[:memory_json].new({})
+adapter.clear
+
+adapter.write('foo', 'bar' => 'baz')
+# Encoded in adapter as json instead of being marshal'd
+puts adapter.client['foo'].inspect # "{\"bar\":\"baz\"}"
+
+
+adapter.client['foo'] = ActiveSupport::JSON.encode('chunky' => 'bacon')
+# Decoded from adapter using json instead of being un-marshal'd
+puts adapter.read('foo').inspect # {"chunky"=>"bacon"}

data/lib/adapter.rb

@@ -6,6 +6,7 @@ module Adapter
   extend Asserts
   include Defaults
 
+  # Stores the definitions for each adapter by name
   def self.definitions
     @definitions ||= {}
   end
@@ -20,6 +21,7 @@ module Adapter
     definitions[name.to_sym] = definition_module
   end
 
+  # Memoizes adapter instances based on their definitions
   def self.adapters
     @adapters ||= {}
   end
@@ -41,11 +43,13 @@ module Adapter
 
         include Adapter.definitions[name.to_sym]
 
-        alias get read
-        alias set write
+        alias_method :get, :read
+        alias_method :set, :write
 
-        alias []  read
-        alias []= write
+        alias_method :[], :read
+        alias_method :[]=, :write
+
+        alias_method :get_multiple, :read_multiple
 
         def eql?(other)
           self.class.eql?(other.class) && client == other.client
@@ -55,4 +59,4 @@ module Adapter
         class_eval "def name; :#{name} end"
       end
     end
-end
+end

data/lib/adapter/asserts.rb

@@ -18,4 +18,4 @@ module Adapter
       raise IncompleteAPI.new(missing_methods) unless missing_methods.empty?
     end
   end
-end
+end

data/lib/adapter/defaults.rb

@@ -7,26 +7,26 @@ module Adapter
       end
     end
 
+    def read_multiple(*keys)
+      result = {}
+      keys.each { |key| result[key_for(key)] = read(key) }
+      result
+    end
+
     def key?(key)
       !read(key).nil?
     end
 
     def key_for(key)
-      if key.is_a?(String)
-        key
-      elsif key.is_a?(Symbol)
-        key.to_s
-      else
-        Marshal.dump(key)
-      end
+      key
     end
 
     def encode(value)
-      Marshal.dump(value)
+      value
     end
 
     def decode(value)
-      value && Marshal.load(value)
+      value
     end
   end
-end
+end

data/lib/adapter/exceptions.rb

@@ -14,4 +14,4 @@ module Adapter
       super("Timeout on lock #{key} exceeded #{timeout} sec")
     end
   end
-end
+end

data/lib/adapter/memory.rb

@@ -11,7 +11,7 @@ module Adapter
     end
 
     def delete(key)
-      read(key).tap { client.delete(key_for(key)) }
+      decode(client.delete(key_for(key)))
     end
 
     def clear
@@ -20,4 +20,4 @@ module Adapter
   end
 end
 
-Adapter.define(:memory, Adapter::Memory)
+Adapter.define(:memory, Adapter::Memory)

data/lib/adapter/spec/an_adapter.rb

@@ -3,118 +3,201 @@ shared_examples_for "an adapter" do
     adapter.client.should == client
   end
 
-  Adapter::Spec::Types.each do |type, (key, key2)|
-    it "reads from keys that are #{type}s like a Hash" do
-      adapter[key].should == nil
+  let(:key)  { 'key' }
+  let(:key2) { 'key2' }
+
+  let(:attributes) {
+    {
+      :one   => 'one',
+      :three => 'three',
+    }
+  }
+
+  let(:attributes2) {
+    {
+      :two  => 'two',
+      :four => 'four',
+    }
+  }
+
+  describe "#read" do
+    it "returns nil if key not available" do
+      adapter.read(key).should be_nil
     end
 
-    it "writes String values to keys that are #{type}s like a Hash" do
-      adapter[key] = "value"
-      adapter[key].should == "value"
+    it "returns value if key available" do
+      adapter.write(key, attributes)
+      adapter.read(key).should eq(attributes)
     end
+  end
 
-    it "guarantees that a different String value is retrieved from the #{type} key" do
-      value = "value"
-      adapter[key] = value
-      adapter[key].should_not be_equal(value)
+  describe "#get" do
+    it "returns nil if key not available" do
+      adapter.get(key).should be_nil
     end
 
-    it "guarantees that a different Object value is retrieved from the #{type} key" do
-      value = {:foo => :bar}
-      adapter[key] = value
-      adapter[key].should_not be_equal(:foo => :bar)
+    it "returns value if key available" do
+      adapter.write(key, attributes)
+      adapter.get(key).should eq(attributes)
     end
+  end
 
-    it "returns false from key? if a #{type} key is not available" do
-      adapter.key?(key).should be_false
+  describe "#[]" do
+    it "returns nil if key not available" do
+      adapter[key].should be_nil
     end
 
-    it "returns true from key? if a #{type} key is available" do
-      adapter[key] = "value"
-      adapter.key?(key).should be_true
+    it "returns value if key available" do
+      adapter.write(key, attributes)
+      adapter[key].should eq(attributes)
     end
+  end
 
-    it "removes and return an element with a #{type} key from the backing store via delete if it exists" do
-      adapter[key] = "value"
-      adapter.delete(key).should == "value"
-      adapter.key?(key).should be_false
+  describe "#read_multiple" do
+    before do
+      adapter.write(key, attributes)
+      adapter.write(key2, attributes2)
     end
 
-    it "returns nil from delete if an element for a #{type} key does not exist" do
-      adapter.delete(key).should be_nil
+    it "returns Hash of keys and values" do
+      adapter.read_multiple(key, key2).should eq({
+        key  => attributes,
+        key2 => attributes2,
+      })
     end
 
-    it "removes all #{type} keys from the store with clear" do
-      adapter[key] = "value"
-      adapter[key2] = "value2"
-      adapter.clear
-      adapter.key?(key).should_not be_true
-      adapter.key?(key2).should_not be_true
+    context "with mix of keys that are and are not available" do
+      it "returns Hash of keys and values where unavailable keys are nil" do
+        adapter.read_multiple(key, key2, 'foo', 'bar').should eq({
+          key => attributes,
+          key2 => attributes2,
+          'foo' => nil,
+          'bar' => nil,
+        })
+      end
     end
+  end
 
-    it "fetches a #{type} key with a default value with fetch, if the key is not available" do
-      adapter.fetch(key, "value").should == "value"
+  describe "#get_multiple" do
+    before do
+      adapter.write(key, attributes)
+      adapter.write(key2, attributes2)
     end
 
-    it "fetches a #{type} key with a block with fetch, if the key is not available" do
-      adapter.fetch(key) { |k| "value" }.should == "value"
+    it "returns Hash of keys and values" do
+      adapter.get_multiple(key, key2).should eq({
+        key  => attributes,
+        key2 => attributes2,
+      })
     end
 
-    it "does not run the block if the #{type} key is available" do
-      adapter[key] = "value"
-      unaltered = "unaltered"
-      adapter.fetch(key) { unaltered = "altered" }
-      unaltered.should == "unaltered"
+    context "with mix of keys that are and are not available" do
+      it "returns Hash of keys and values where unavailable keys are nil" do
+        adapter.get_multiple(key, key2, 'foo', 'bar').should eq({
+          key => attributes,
+          key2 => attributes2,
+          'foo' => nil,
+          'bar' => nil,
+        })
+      end
     end
+  end
 
-    it "fetches a #{type} key with a default value with fetch, if the key is available" do
-      adapter[key] = "value2"
-      adapter.fetch(key, "value").should == "value2"
+  describe "#key?" do
+    it "returns true if key available" do
+      adapter.write(key, attributes)
+      adapter.key?(key).should be_true
     end
 
-    it "writes #{key} values with #write" do
-      adapter.write(key, "value")
-      adapter[key].should == "value"
+    it "returns false if key not available" do
+      adapter.key?(key).should be_false
     end
   end
 
-  it "refuses to #[] from keys that cannot be marshalled" do
-    lambda do
-      adapter[Struct.new(:foo).new(:bar)]
-    end.should raise_error(TypeError)
-  end
+  describe "#fetch" do
+    context "with key not stored" do
+      context "with default value" do
+        it "returns default value" do
+          adapter.fetch(key, {}).should eq({})
+        end
+      end
+
+      context "with default block" do
+        it "returns value of yielded block" do
+          adapter.fetch(key) { |k| {} }.should eq({})
+        end
+      end
+    end
 
-  it "refuses to fetch from keys that cannot be marshalled" do
-    lambda do
-      adapter.fetch(Struct.new(:foo).new(:bar), true)
-    end.should raise_error(TypeError)
+    context "with key that is stored" do
+      context "with default value" do
+        it "returns key value instead of default" do
+          adapter.write(key, attributes2)
+          adapter.fetch(key, attributes).should eq(attributes2)
+        end
+      end
+
+      context "with default block" do
+        it "does not run the block" do
+          adapter.write(key, attributes)
+          unaltered = 'unaltered'
+          adapter.fetch(key) { unaltered = 'altered' }
+          unaltered.should eq('unaltered')
+        end
+      end
+    end
   end
 
-  it "refuses to #[]= to keys that cannot be marshalled" do
-    lambda do
-      adapter[Struct.new(:foo).new(:bar)] = "value"
-    end.should raise_error(TypeError)
+  describe "#write" do
+    it "sets key to value" do
+      adapter.write(key, attributes)
+      adapter.read(key).should eq(attributes)
+    end
   end
 
-  it "refuses to store to keys that cannot be marshalled" do
-    lambda do
-      adapter.write Struct.new(:foo).new(:bar), "value"
-    end.should raise_error(TypeError)
+  describe "#set" do
+    it "sets key to value" do
+      adapter.set(key, attributes)
+      adapter.read(key).should eq(attributes)
+    end
   end
 
-  it "refuses to check for key? if the key cannot be marshalled" do
-    lambda do
-      adapter.key? Struct.new(:foo).new(:bar)
-    end.should raise_error(TypeError)
+  describe "#[]=" do
+    it "sets key to value" do
+      adapter[key] = attributes
+      adapter.read(key).should eq(attributes)
+    end
   end
 
-  it "refuses to delete a key if the key cannot be marshalled" do
-    lambda do
-      adapter.delete Struct.new(:foo).new(:bar)
-    end.should raise_error(TypeError)
+  describe "#delete" do
+    context "when key available" do
+      before do
+        adapter.write(key, attributes)
+        adapter.delete(key)
+      end
+
+      it "removes key" do
+        adapter.key?(key).should be_false
+      end
+    end
+
+    context "when key not available" do
+      it "does not complain" do
+        adapter.delete(key)
+      end
+    end
   end
 
-  it "specifies that it is writable via frozen?" do
-    adapter.should_not be_frozen
+  describe "#clear" do
+    before do
+      adapter[key] = attributes
+      adapter[key2] = attributes2
+      adapter.clear
+    end
+
+    it "removes all stored keys" do
+      adapter.key?(key).should be_false
+      adapter.key?(key2).should be_false
+    end
   end
-end
+end

data/lib/adapter/version.rb

@@ -1,3 +1,3 @@
 module Adapter
-  VERSION = '0.5.2'
-end
+  VERSION = '0.6.0'
+end

data/spec/adapter/defaults_spec.rb

@@ -8,33 +8,26 @@ describe Adapter::Defaults do
   end
 
   describe "#key_for" do
-    it "returns value for string" do
-      mod.key_for('foo').should == 'foo'
-    end
-
-    it "returns string for symbol" do
-      mod.key_for(:foo).should == 'foo'
-    end
-
-    it "marshals anything not a string or symbol" do
-      mod.key_for({'testing' => 'this'}).should == %Q(\004\b{\006\"\ftesting\"\tthis)
+    it "returns whatever is passed to it" do
+      [nil, 'foo', :foo, {:foo => 'bar'}].each do |key|
+        mod.key_for(key).should be(key)
+      end
     end
   end
 
   describe "#encode" do
-    it "marshals value" do
-      mod.encode(nil).should == "\004\b0"
-      mod.encode({'testing' => 'this'}).should == %Q(\004\b{\006\"\ftesting\"\tthis)
+    it "returns whatever is passed to it" do
+      [nil, 'foo', :foo, {:foo => 'bar'}].each do |value|
+        mod.encode(value).should be(value)
+      end
     end
   end
 
   describe "#decode" do
-    it "returns nil if nil" do
-      mod.decode(nil).should be_nil
-    end
-
-    it "returns marshal load if not nil" do
-      mod.decode(%Q(\004\b{\006\"\ftesting\"\tthis)).should == {'testing' => 'this'}
+    it "returns whatever is passed to it" do
+      [nil, 'foo', :foo, {:foo => 'bar'}].each do |value|
+        mod.decode(value).should be(value)
+      end
     end
   end
-end
+end

data/spec/adapter/memory_spec.rb

@@ -3,6 +3,7 @@ require 'adapter/memory'
 
 describe "Memory adapter" do
   before do
+    Adapter.define(:memory, Adapter::Memory)
     @client = {}
     @adapter = Adapter[:memory].new(@client)
     @adapter.clear
@@ -11,5 +12,5 @@ describe "Memory adapter" do
   let(:adapter) { @adapter }
   let(:client)  { @client }
 
-  it_should_behave_like 'a marshaled adapter'
-end
+  it_should_behave_like 'an adapter'
+end

data/spec/adapter_spec.rb

@@ -1,6 +1,16 @@
 require 'helper'
 
 describe Adapter do
+  before do
+    Adapter.definitions.clear
+    Adapter.adapters.clear
+  end
+
+  after do
+    Adapter.definitions.clear
+    Adapter.adapters.clear
+  end
+
   describe ".definitions" do
     it "defaults to empty hash" do
       Adapter.instance_variable_set("@definitions", nil)
@@ -104,11 +114,11 @@ describe Adapter do
     before do
       Adapter.define(:memory_json, valid_module) do
         def encode(value)
-          ActiveSupport::JSON.encode(value)
+          'encoded'
         end
 
         def decode(value)
-          ActiveSupport::JSON.decode(value)
+          'decoded'
         end
       end
     end
@@ -117,13 +127,13 @@ describe Adapter do
     it "encodes correctly" do
       hash = {'foo' => 'bar'}
       adapter.write('foo', hash)
-      adapter.client['foo'].should == ActiveSupport::JSON.encode(hash)
+      adapter.client['foo'].should == 'encoded'
     end
 
     it "decodes correctly" do
       hash = {'foo' => 'bar'}
-      adapter.client['foo'] = ActiveSupport::JSON.encode(hash)
-      adapter.read('foo').should == hash
+      adapter.client['foo'] = hash
+      adapter.read('foo').should == 'decoded'
     end
   end
 
@@ -308,4 +318,4 @@ describe Adapter do
       end
     end
   end
-end
+end

data/spec/helper.rb

@@ -1,27 +1,13 @@
 $:.unshift(File.expand_path('../../lib', __FILE__))
 
+require 'pathname'
 require 'rubygems'
 require 'bundler'
 
-Bundler.require(:default, :development)
-
-require 'pathname'
-require 'logger'
-
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-log_path  = root_path.join('log')
-log_path.mkpath
-
 require 'adapter/spec/an_adapter'
-require 'adapter/spec/marshal_adapter'
-require 'adapter/spec/json_adapter'
-require 'adapter/spec/types'
-
 require 'support/module_helpers'
 
-logger = Logger.new(log_path.join('test.log'))
-LogBuddy.init(:logger => logger)
+Bundler.require(:default, :test)
 
 Rspec.configure do |c|
   c.include(ModuleHelpers)

data/spec/spec.opts

@@ -1,3 +1,3 @@
 --colour
 --timeout
-20
+20

data/spec/support/module_helpers.rb

@@ -18,4 +18,4 @@ module ModuleHelpers
       end
     end
   end
-end
+end

metadata

@@ -1,90 +1,86 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: adapter
-version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
-  segments: 
-  - 0
-  - 5
-  - 2
-  version: 0.5.2
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - John Nunemaker
 - Geoffrey Dagley
 - Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-26 00:00:00 -05:00
-default_executable: 
+date: 2012-11-07 00:00:00.000000000 Z
 dependencies: []
-
 description: 
-email: 
+email:
 - nunemaker@gmail.com
 - gdagley@gmail.com
 - brandon@opensoul.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .gitignore
+- .travis.yml
+- Changelog.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- adapter.gemspec
+- examples/memory.rb
+- examples/overriding_serialization.rb
+- lib/adapter.rb
 - lib/adapter/asserts.rb
 - lib/adapter/defaults.rb
 - lib/adapter/exceptions.rb
 - lib/adapter/memory.rb
 - lib/adapter/spec/an_adapter.rb
-- lib/adapter/spec/json_adapter.rb
-- lib/adapter/spec/marshal_adapter.rb
-- lib/adapter/spec/types.rb
 - lib/adapter/version.rb
-- lib/adapter.rb
 - spec/adapter/defaults_spec.rb
 - spec/adapter/memory_spec.rb
 - spec/adapter_spec.rb
 - spec/helper.rb
 - spec/spec.opts
 - spec/support/module_helpers.rb
-- LICENSE
-- Rakefile
-- README.rdoc
-has_rdoc: true
-homepage: http://github.com/newtoy/adapter
+homepage: http://github.com/jnunemaker/adapter
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -254287751766179836
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -254287751766179836
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A simple interface to anything
-test_files: []
-
+test_files:
+- spec/adapter/defaults_spec.rb
+- spec/adapter/memory_spec.rb
+- spec/adapter_spec.rb
+- spec/helper.rb
+- spec/spec.opts
+- spec/support/module_helpers.rb

data/README.rdoc

@@ -1,55 +0,0 @@
-= Adapter
-
-A simple interface to anything.
-
-== Defining an Adapter
-
-An adapter requires 4 methods to work: read, write, delete and clear.
-
-    Adapter.define(:memory) do
-      def read(key)
-        decode(client[key_for(key)])
-      end
-
-      def write(key, value)
-        client[key_for(key)] = encode(value)
-      end
-
-      def delete(key)
-        client.delete(key_for(key))
-      end
-
-      def clear
-        client.clear
-      end
-    end
-
-Note: in order for things to be most flexible, always wrap key with key_for(key) which will ensure that pretty much anything can be a key. Also, by default encode and decode are included and they Marshal.dump and Marshal.load. Feel free to override these if you prefer JSON serialization or something else.
-
-Once you have defined an adapter, you can get a class of that adapter like this:
-
-    Adapter[:memory]
-
-This returns a dynamic class with your adapting methods included and an initialize method that takes a client. This means you can get an instance of the adapter by using new and passing the client (in this instance a boring hash):
-
-    adapter = Adapter[:memory].new({}) # sets {} to client
-    adapter.write('foo', 'bar')
-    adapter.read('foo') # 'bar'
-    adapter.delete('foo')
-    adapter.fetch('foo', 'bar') # returns bar and sets foo to bar
-
-get and [] are aliased to read. set and []= are aliased to write.
-
-Note: You can also optionally provide a lock method. See the memcached and redis adapters for more on locking.
-
-== Extending Adapters
-
-Adapters can be defined using a block, a module, or a module and a block. This allows very flexibly overriding specific things in an adapter to create a new adapter, without having to redo all of the work. See examples/overriding_serialization.rb for an example of this.
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so we don't break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine, but bump version in a commit by itself so we can ignore when we pull)
-* Send us a pull request. Bonus points for topic branches.

data/lib/adapter/spec/json_adapter.rb

@@ -1,10 +0,0 @@
-shared_examples_for "a json adapter" do
-  it_should_behave_like 'an adapter'
-
-  Adapter::Spec::Types.each do |type, (key, key2)|
-    it "writes Object values to keys that are #{type}s like a Hash" do
-      adapter[key] = {:foo => :bar}
-      adapter[key].should == {'foo' => 'bar'}
-    end
-  end
-end

data/lib/adapter/spec/marshal_adapter.rb

@@ -1,10 +0,0 @@
-shared_examples_for "a marshaled adapter" do
-  it_should_behave_like 'an adapter'
-
-  Adapter::Spec::Types.each do |type, (key, key2)|
-    it "writes Object values to keys that are #{type}s like a Hash" do
-      adapter[key] = {:foo => :bar}
-      adapter[key].should == {:foo => :bar}
-    end
-  end
-end

data/lib/adapter/spec/types.rb

@@ -1,5 +0,0 @@
-module Adapter
-  module Spec
-    Types = {"String" => ["key", "key2"]}
-  end
-end