adapter 0.6.3 → 0.7.0

data/Changelog.md

@@ -1,7 +1,15 @@
-* 0.5.2 => 0.6.0
+# Changelog
 
-  * 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.
+## 0.7.0
+
+* `key_for`, `encode` and `decode` are no longer provided or necessary.
+* All methods must accept options as last parameter. They do not need to do anything with them, but they must at least be declared.
+* Tightened up API. `get`, `set`, `[]`, `[]=`, and `get_multiple` are now gone.
+
+## 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/README.md

@@ -8,19 +8,19 @@ 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)])
+  def read(key, options = nil)
+    client[key]
   end
 
-  def write(key, attributes)
-    client[key_for(key)] = encode(attributes)
+  def write(key, attributes, options = nil)
+    client[key] = attributes
   end
 
-  def delete(key)
-    client.delete(key_for(key))
+  def delete(key, options = nil)
+    client.delete(key)
   end
 
-  def clear
+  def clear(options = nil)
     client.clear
   end
 end
@@ -44,8 +44,6 @@ 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

data/lib/adapter.rb

@@ -43,14 +43,6 @@ module Adapter
 
         include Adapter.definitions[name.to_sym]
 
-        alias_method :get, :read
-        alias_method :set, :write
-
-        alias_method :[], :read
-        alias_method :[]=, :write
-
-        alias_method :get_multiple, :read_multiple
-
         def eql?(other)
           self.class.eql?(other.class) && client == other.client
         end

data/lib/adapter/defaults.rb

@@ -1,7 +1,7 @@
 module Adapter
   module Defaults
-    def fetch(key, default_attributes=nil)
-      read(key) || begin
+    def fetch(key, default_attributes=nil, options = nil)
+      read(key, options) || begin
         if block_given?
           yield(key)
         else
@@ -10,26 +10,14 @@ module Adapter
       end
     end
 
-    def read_multiple(*keys)
+    def read_multiple(keys, options = nil)
       result = {}
-      keys.each { |key| result[key_for(key)] = read(key) }
+      keys.each { |key| result[key] = read(key, options) }
       result
     end
 
-    def key?(key)
-      !read(key).nil?
-    end
-
-    def key_for(key)
-      key
-    end
-
-    def encode(attributes)
-      attributes
-    end
-
-    def decode(attributes)
-      attributes
+    def key?(key, options = nil)
+      !read(key, options).nil?
     end
   end
 end

data/lib/adapter/memory.rb

@@ -2,19 +2,19 @@ require 'adapter'
 
 module Adapter
   module Memory
-    def read(key)
-      decode(client[key_for(key)])
+    def read(key, options = nil)
+      client[key]
     end
 
-    def write(key, attributes)
-      client[key_for(key)] = encode(attributes)
+    def write(key, attributes, options = nil)
+      client[key] = attributes
     end
 
-    def delete(key)
-      decode(client.delete(key_for(key)))
+    def delete(key, options = nil)
+      client.delete(key)
     end
 
-    def clear
+    def clear(options = nil)
       client.clear
     end
   end

data/lib/adapter/spec/an_adapter.rb

@@ -34,33 +34,11 @@ shared_examples_for "an adapter" do
         result[column].should eq(value)
       end
     end
-  end
-
-  describe "#get" do
-    it "returns nil if key not available" do
-      adapter.get(key).should be_nil
-    end
-
-    it "returns attributes if key available" do
-      adapter.write(key, attributes)
-      result = adapter.get(key)
-      attributes.each do |column, value|
-        result[column].should eq(value)
-      end
-    end
-  end
 
-  describe "#[]" do
-    it "returns nil if key not available" do
-      adapter[key].should be_nil
-    end
-
-    it "returns attributes if key available" do
-      adapter.write(key, attributes)
-      result = adapter[key]
-      attributes.each do |column, value|
-        result[column].should eq(value)
-      end
+    it "accepts options" do
+      expect {
+        adapter.read(key, :something => 'else')
+      }.to_not raise_error
     end
   end
 
@@ -71,7 +49,7 @@ shared_examples_for "an adapter" do
     end
 
     it "returns Hash of keys and attributes" do
-      result = adapter.read_multiple(key, key2)
+      result = adapter.read_multiple([key, key2])
 
       attributes.each do |column, value|
         result[key][column].should eq(value)
@@ -84,7 +62,7 @@ shared_examples_for "an adapter" do
 
     context "with mix of keys that are and are not available" do
       it "returns Hash of keys and attributes where unavailable keys are nil" do
-        result = adapter.read_multiple(key, key2, unavailable_key)
+        result = adapter.read_multiple([key, key2, unavailable_key])
 
         attributes.each do |column, value|
           result[key][column].should eq(value)
@@ -97,40 +75,11 @@ shared_examples_for "an adapter" do
         result[unavailable_key].should be_nil
       end
     end
-  end
-
-  describe "#get_multiple" do
-    before do
-      adapter.write(key, attributes)
-      adapter.write(key2, attributes2)
-    end
-
-    it "returns Hash of keys and attributes" do
-      result = adapter.get_multiple(key, key2)
-
-      attributes.each do |column, value|
-        result[key][column].should eq(value)
-      end
-
-      attributes2.each do |column, value|
-        result[key2][column].should eq(value)
-      end
-    end
-
-    context "with mix of keys that are and are not available" do
-      it "returns Hash of keys and attributes where unavailable keys are nil" do
-        result = adapter.get_multiple(key, key2, unavailable_key)
-
-        attributes.each do |column, value|
-          result[key][column].should eq(value)
-        end
-
-        attributes2.each do |column, value|
-          result[key2][column].should eq(value)
-        end
 
-        result[unavailable_key].should be_nil
-      end
+    it "accepts options" do
+      expect {
+        adapter.read_multiple([key], :something => 'else')
+      }.to_not raise_error
     end
   end
 
@@ -143,6 +92,12 @@ shared_examples_for "an adapter" do
     it "returns false if key not available" do
       adapter.key?(key).should be_false
     end
+
+    it "accepts options" do
+      expect {
+        adapter.key?(key, :something => 'else')
+      }.to_not raise_error
+    end
   end
 
   describe "#fetch" do
@@ -180,35 +135,27 @@ shared_examples_for "an adapter" do
         end
       end
     end
-  end
 
-  describe "#write" do
-    it "sets key to attributes" do
-      adapter.write(key, attributes)
-      result = adapter.read(key)
-      attributes.each do |column, value|
-        result[column].should eq(value)
-      end
+    it "accepts options" do
+      expect {
+        adapter.fetch(key, true, :something => 'else')
+      }.to_not raise_error
     end
   end
 
-  describe "#set" do
+  describe "#write" do
     it "sets key to attributes" do
-      adapter.set(key, attributes)
+      adapter.write(key, attributes)
       result = adapter.read(key)
       attributes.each do |column, value|
         result[column].should eq(value)
       end
     end
-  end
 
-  describe "#[]=" do
-    it "sets key to attributes" do
-      adapter[key] = attributes
-      result = adapter.read(key)
-      attributes.each do |column, value|
-        result[column].should eq(value)
-      end
+    it "accepts options" do
+      expect {
+        adapter.write(key, attributes, :something => 'else')
+      }.to_not raise_error
     end
   end
 
@@ -229,6 +176,12 @@ shared_examples_for "an adapter" do
         adapter.key?(key).should be_false
       end
     end
+
+    it "accepts options" do
+      expect {
+        adapter.delete(key, :something => 'else')
+      }.to_not raise_error
+    end
   end
 
   describe "#clear" do
@@ -241,5 +194,11 @@ shared_examples_for "an adapter" do
       adapter.key?(key).should be_false
       adapter.key?(key2).should be_false
     end
+
+    it "accepts options" do
+      expect {
+        adapter.clear(:something => 'else')
+      }.to_not raise_error
+    end
   end
 end

data/lib/adapter/version.rb

@@ -1,3 +1,3 @@
 module Adapter
-  VERSION = '0.6.3'
+  VERSION = '0.7.0'
 end

data/spec/adapter_spec.rb

@@ -43,9 +43,8 @@ describe Adapter do
           include Adapter.definitions[:memory]
         end.tap do |klass|
           klass.new.respond_to?(:fetch).should be_true
-          klass.new.respond_to?(:key_for, true).should be_true
-          klass.new.respond_to?(:encode, true).should be_true
-          klass.new.respond_to?(:decode, true).should be_true
+          klass.new.respond_to?(:key?).should be_true
+          klass.new.respond_to?(:read_multiple).should be_true
         end
       end
 
@@ -110,33 +109,6 @@ describe Adapter do
     end
   end
 
-  describe "Overriding encode/decode" do
-    before do
-      Adapter.define(:memory_json, valid_module) do
-        def encode(value)
-          'encoded'
-        end
-
-        def decode(value)
-          'decoded'
-        end
-      end
-    end
-    let(:adapter) { Adapter[:memory_json].new({}) }
-
-    it "encodes correctly" do
-      hash = {'foo' => 'bar'}
-      adapter.write('foo', hash)
-      adapter.client['foo'].should == 'encoded'
-    end
-
-    it "decodes correctly" do
-      hash = {'foo' => 'bar'}
-      adapter.client['foo'] = hash
-      adapter.read('foo').should == 'decoded'
-    end
-  end
-
   describe "Redefining an adapter" do
     before do
       Adapter.define(:memory, valid_module)
@@ -258,36 +230,6 @@ describe Adapter do
       end
     end
 
-    describe "#[]" do
-      it "is aliased to read" do
-        adapter.write('foo', 'bar')
-        adapter['foo'].should == 'bar'
-      end
-    end
-
-    describe "#get" do
-      it "is aliased to read" do
-        adapter.write('foo', 'bar')
-        adapter.get('foo').should == 'bar'
-      end
-    end
-
-    describe "#[]=" do
-      it "is aliased to write" do
-        adapter.read('foo').should be_nil
-        adapter['foo'] = 'bar'
-        adapter.read('foo').should == 'bar'
-      end
-    end
-
-    describe "#[]=" do
-      it "is aliased to write" do
-        adapter.read('foo').should be_nil
-        adapter.set('foo', 'bar')
-        adapter.read('foo').should == 'bar'
-      end
-    end
-
     describe "#eql?" do
       it "returns true if same name and client" do
         adapter.should eql(Adapter[:memory].new({}))

data/spec/support/module_helpers.rb

@@ -1,19 +1,19 @@
 module ModuleHelpers
   def valid_module
     Module.new do
-      def read(key)
-        decode(client[key_for(key)])
+      def read(key, options = nil)
+        client[key]
       end
 
-      def write(key, value)
-        client[key_for(key)] = encode(value)
+      def write(key, attributes, options = nil)
+        client[key] = attributes
       end
 
-      def delete(key)
-        client.delete(key_for(key))
+      def delete(key, options = nil)
+        client.delete(key)
       end
 
-      def clear
+      def clear(options = nil)
         client.clear
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adapter
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-08 00:00:00.000000000 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -33,7 +33,6 @@ files:
 - Rakefile
 - adapter.gemspec
 - examples/memory.rb
-- examples/overriding_serialization.rb
 - lib/adapter.rb
 - lib/adapter/asserts.rb
 - lib/adapter/defaults.rb
@@ -41,7 +40,6 @@ files:
 - lib/adapter/memory.rb
 - lib/adapter/spec/an_adapter.rb
 - lib/adapter/version.rb
-- spec/adapter/defaults_spec.rb
 - spec/adapter/memory_spec.rb
 - spec/adapter_spec.rb
 - spec/helper.rb
@@ -61,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2517680181409283620
+      hash: -3971462986522991122
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -70,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2517680181409283620
+      hash: -3971462986522991122
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -78,7 +76,6 @@ signing_key:
 specification_version: 3
 summary: A simple interface to anything
 test_files:
-- spec/adapter/defaults_spec.rb
 - spec/adapter/memory_spec.rb
 - spec/adapter_spec.rb
 - spec/helper.rb

data/examples/overriding_serialization.rb

@@ -1,41 +0,0 @@
-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(attributes)
-    ActiveSupport::JSON.encode(attributes)
-  end
-
-  def decode(attributes)
-    ActiveSupport::JSON.decode(attributes)
-  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/spec/adapter/defaults_spec.rb

@@ -1,33 +0,0 @@
-require 'helper'
-
-describe Adapter::Defaults do
-  let(:mod) do
-    Module.new.tap do |m|
-      m.extend(Adapter::Defaults)
-    end
-  end
-
-  describe "#key_for" do
-    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 "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 whatever is passed to it" do
-      [nil, 'foo', :foo, {:foo => 'bar'}].each do |value|
-        mod.decode(value).should be(value)
-      end
-    end
-  end
-end