toystore 0.6.6 → 0.7.0

data/LOGGING.rdoc

@@ -9,8 +9,4 @@ What the 3 letter codes mean when they show up in logging:
   IMS: write to identity map
   IMD: delete from identity map
 
-  RTG: get cache read
-  RTS: get cache set
-  WTS: cache write set
-
   IEM: invalid embedded document

data/lib/toy/attribute.rb

@@ -54,7 +54,7 @@ module Toy
       options[:abbr]
     end
 
-    def store_key
+    def persisted_name
       abbr? ? abbr : name
     end
 

data/lib/toy/attributes.rb

@@ -40,8 +40,8 @@ module Toy
       end
 
       def reload
-        if attrs = store.read(store_key)
-          attrs['id'] = store_key
+        if attrs = store.read(id)
+          attrs['id'] = id
           instance_variables.each        { |ivar| instance_variable_set(ivar, nil) }
           initialize_attributes_with_defaults
           send(:attributes=, attrs, new_record?)
@@ -65,7 +65,7 @@ module Toy
         {}.tap do |attrs|
           self.class.attributes.each do |name, attribute|
             next if attribute.virtual?
-            attrs[attribute.store_key] = attribute.to_store(read_attribute(attribute.name))
+            attrs[attribute.persisted_name] = attribute.to_store(read_attribute(attribute.name))
           end
         end.merge(embedded_attributes)
       end

data/lib/toy/identity_map.rb

@@ -47,17 +47,16 @@ module Toy
 
       def get_from_identity_map(id)
         return nil unless identity_map_on?
-        key = store_key(id)
-        if record = identity_map[key]
-          logger.debug("ToyStore IMG #{self.name} #{key.inspect}")
+        if record = identity_map[id]
+          log_operation(:img, self.name, store, id)
           record
         end
       end
 
-      def load(key, attrs)
+      def load(id, attrs)
         return nil if attrs.nil?
 
-        if instance = identity_map[store_key(key)]
+        if instance = identity_map[id]
           instance
         else
           super.tap { |doc| doc.add_to_identity_map }
@@ -81,16 +80,14 @@ module Toy
 
     def add_to_identity_map
       return unless self.class.identity_map_on?
-      key = store_key
-      identity_map[key] = self
-      logger.debug("ToyStore IMS #{self.class.name} #{key.inspect}")
+      identity_map[id] = self
+      log_operation(:ims, self.class.name, store, id)
     end
 
     def remove_from_identity_map
       return unless self.class.identity_map_on?
-      key = store_key
-      identity_map.delete(key)
-      logger.debug("ToyStore IMD #{self.class.name} #{key.inspect}")
+      identity_map.delete(id)
+      log_operation(:imd, self.class.name, store, id)
     end
 
     private

data/lib/toy/logger.rb

@@ -7,9 +7,11 @@ module Toy
         Toy.logger
       end
 
-      def log_operation(operation, model, adapter, key, value)
-        logger.debug("ToyStore #{operation} #{model} :#{adapter.name} #{key.inspect}")
-        logger.debug("  #{value.inspect}")
+      def log_operation(operation, model, adapter, key, value=nil)
+        if logger.debug?
+          logger.debug("ToyStore #{operation.to_s.upcase} #{model} :#{adapter.name} #{key.inspect}")
+          logger.debug("  #{value.inspect}") unless value.nil?
+        end
       end
     end
 

data/lib/toy/persistence.rb

@@ -6,7 +6,7 @@ module Toy
       def store(name=nil, client=nil, options={})
         assert_client(name, client)
         @store = Adapter[name].new(client, options) if !name.nil? && !client.nil?
-        assert_store(name, client, 'store')
+        assert_store(name, client)
         @store
       end
 
@@ -14,21 +14,6 @@ module Toy
         !@store.nil?
       end
 
-      def cache(name=nil, client=nil)
-        assert_client(name, client)
-        @cache = Adapter[name].new(client) if !name.nil? && !client.nil?
-        assert_store(name, client, 'cache')
-        @cache
-      end
-
-      def has_cache?
-        !@cache.nil?
-      end
-
-      def store_key(id)
-        id
-      end
-
       def create(attrs={})
         new(attrs).tap { |doc| doc.save }
       end
@@ -46,8 +31,8 @@ module Toy
           raise(ArgumentError, 'Client is required') if !name.nil? && client.nil?
         end
 
-        def assert_store(name, client, which)
-          raise(StandardError, "No #{which} has been set") if name.nil? && client.nil? && !send(:"has_#{which}?")
+        def assert_store(name, client)
+          raise(StandardError, "No store has been set") if name.nil? && client.nil? && !has_store?
         end
     end
 
@@ -56,14 +41,6 @@ module Toy
         self.class.store
       end
 
-      def cache
-        self.class.cache
-      end
-
-      def store_key
-        self.class.store_key(id)
-      end
-
       def new_record?
         @_new_record == true
       end
@@ -90,10 +67,9 @@ module Toy
       end
 
       def delete
-        key = store_key
         @_destroyed = true
-        logger.debug("ToyStore DEL #{self.class.name} #{key.inspect}")
-        store.delete(key)
+        log_operation(:del, self.class.name, store, id)
+        store.delete(id)
       end
 
       private
@@ -110,14 +86,10 @@ module Toy
         end
 
         def persist!
-          key, attrs = store_key, persisted_attributes
+          attrs = persisted_attributes
           attrs.delete('id') # no need to persist id as that is key
-          if self.class.has_cache?
-            cache.write(key, attrs)
-            log_operation('WTS', self, cache, key, attrs)
-          end
-          store.write(key, attrs)
-          log_operation('SET', self, store, key, attrs)
+          store.write(id, attrs)
+          log_operation(:set, self.class.name, store, id, attrs)
           persist
           each_embedded_object { |doc| doc.send(:persist) }
           true

data/lib/toy/querying.rb

@@ -4,24 +4,9 @@ module Toy
 
     module ClassMethods
       def get(id)
-        key = store_key(id)
-
-        if has_cache?
-          value = cache.read(key)
-          log_operation('RTG', self, cache, key, value)
-        end
-
-        if value.nil?
-          value = store.read(key)
-          log_operation('GET', self, store, key, value)
-
-          if has_cache?
-            cache.write(key, value)
-            log_operation('RTS', self, cache, key, value)
-          end
-        end
-
-        load(key, value)
+        value = store.read(id)
+        log_operation(:get, self, store, id, value)
+        load(id, value)
       end
 
       def get!(id)
@@ -41,15 +26,14 @@ module Toy
       end
 
       def key?(id)
-        key = store_key(id)
-        value = store.key?(key)
-        log_operation('KEY', self, store, key, value)
+        value = store.key?(id)
+        log_operation(:key, self, store, id, value)
         value
       end
       alias :has_key? :key?
 
-      def load(key, attrs)
-        attrs && allocate.initialize_from_database(attrs.update('id' => key))
+      def load(id, attrs)
+        attrs && allocate.initialize_from_database(attrs.update('id' => id))
       end
     end
   end

data/lib/toy/validations.rb

@@ -11,12 +11,16 @@ module Toy
     module ClassMethods
       def validates_embedded(*names)
         validates_each(*names) do |record, name, value|
-          invalid = value.compact.select { |o| !o.valid? }
+          invalid = value.compact.select { |obj| !obj.valid? }
           if invalid.any?
             record.errors.add(name, 'is invalid')
-            logger.debug("ToyStore #{self.name} IEM")
-            invalid.each do |o|
-              logger.debug("  #{o.attributes.inspect} - #{o.errors.full_messages.inspect}")
+
+            if logger.debug?
+              invalid_messages = []
+              invalid.each do |obj|
+                invalid_messages << [obj.attributes, obj.errors.full_messages]
+              end
+              log_operation(:iem, self.name, store, record.id, invalid_messages)
             end
           end
         end

data/lib/toy/version.rb

@@ -1,3 +1,3 @@
 module Toy
-  VERSION = "0.6.6"
+  VERSION = "0.7.0"
 end

data/lib/toy.rb

@@ -38,7 +38,6 @@ module Toy
   def clear
     models.each do |model|
       model.store.clear         if model.has_store?
-      model.cache.clear         if model.has_cache?
       model.identity_map.clear  if model.identity_map_on?
     end
   end

data/spec/support/identity_map_matcher.rb

@@ -2,7 +2,7 @@ module IdentityMapMatcher
   class BeInIdentityMap
     def matches?(obj)
       @obj = obj
-      @obj.identity_map[@obj.store_key] == @obj
+      @obj.identity_map[@obj.id] == @obj
     end
 
     def failure_message

data/spec/toy/attribute_spec.rb

@@ -95,13 +95,13 @@ describe Toy::Attribute do
     end
   end
 
-  describe "#store_key" do
+  describe "#persisted_name" do
     it "returns abbr if abbreviated" do
-      Toy::Attribute.new(User, :age, String, :abbr => :a).store_key.should == 'a'
+      Toy::Attribute.new(User, :age, String, :abbr => :a).persisted_name.should == 'a'
     end
 
     it "returns name if not abbreviated" do
-      Toy::Attribute.new(User, :age, String).store_key.should == 'age'
+      Toy::Attribute.new(User, :age, String).persisted_name.should == 'age'
     end
   end
 

data/spec/toy/attributes_spec.rb

@@ -325,7 +325,7 @@ describe Toy::Attributes do
 
     it "persists to store using abbreviation" do
       user = User.create(:twitter_access_token => '1234')
-      raw = user.store.read(user.store_key)
+      raw = user.store.read(user.id)
       raw['tat'].should == '1234'
       raw.should_not have_key('twitter_access_token')
     end

data/spec/toy/identity_map_spec.rb

@@ -69,7 +69,7 @@ describe Toy::IdentityMap do
     it "forces new query each time and skips the identity map" do
       user = User.create
       user.should be_in_identity_map
-      User.store.should_receive(:read).with(user.store_key).and_return({})
+      User.store.should_receive(:read).with(user.id).and_return({})
       user.reload
     end
   end
@@ -117,7 +117,7 @@ describe Toy::IdentityMap do
         user = User.create
         user.should be_in_identity_map
         User.identity_map_off
-        user.store.should_receive(:read).with(user.store_key).and_return(user.persisted_attributes)
+        user.store.should_receive(:read).with(user.id).and_return(user.persisted_attributes)
         User.get(user.id)
       end
     end

data/spec/toy/logger_spec.rb

@@ -17,7 +17,7 @@ describe Toy::Logger do
     it "logs operation" do
       User.logger.should_receive(:debug).with('ToyStore GET User :memory "foo"')
       User.logger.should_receive(:debug).with('  "bar"')
-      User.log_operation('GET', User, adapter, 'foo', 'bar')
+      User.log_operation(:get, User, adapter, 'foo', 'bar')
     end
   end
 
@@ -27,7 +27,7 @@ describe Toy::Logger do
     it "logs operation" do
       User.logger.should_receive(:debug).with('ToyStore GET User :memory "foo"')
       User.logger.should_receive(:debug).with('  "bar"')
-      User.log_operation('GET', User, adapter, 'foo', 'bar')
+      User.log_operation(:get, User, adapter, 'foo', 'bar')
     end
   end
 end

data/spec/toy/persistence_spec.rb

@@ -36,54 +36,17 @@ describe Toy::Persistence do
     end
   end
 
-  describe ".cache" do
-    it "sets if arguments and reads if not" do
-      klass.cache(:memory, {})
-      klass.cache.should == Adapter[:memory].new({})
-    end
-
-    it "raises argument error if name provided but not client" do
-      lambda do
-        klass.cache(:memory)
-      end.should raise_error(ArgumentError, 'Client is required')
-    end
-
-    it "raises argument error if no name or client provided and has not been set" do
-      lambda do
-        klass.cache
-      end.should raise_error(StandardError, 'No cache has been set')
-    end
-  end
-
   describe ".has_store?" do
-    it "returns true if cache set" do
+    it "returns true if store set" do
       klass.store(:memory, {})
       klass.has_store?.should be_true
     end
 
-    it "returns false if cache not set" do
+    it "returns false if store not set" do
       klass.has_store?.should be_false
     end
   end
 
-  describe ".has_cache?" do
-    it "returns true if cache set" do
-      klass.cache(:memory, {})
-      klass.has_cache?.should be_true
-    end
-
-    it "returns false if cache not set" do
-      klass.has_cache?.should be_false
-    end
-  end
-
-  describe ".store_key" do
-    it "returns id" do
-      doc = User.new
-      User.store_key(doc.id).should == doc.id
-    end
-  end
-
   describe ".create" do
     before do
       User.attribute :name, String
@@ -93,7 +56,7 @@ describe Toy::Persistence do
     let(:doc) { @doc }
 
     it "creates key in database with attributes" do
-      User.store.read(doc.store_key).should == {
+      User.store.read(doc.id).should == {
         'name' => 'John',
         'age'  => 50,
       }
@@ -156,13 +119,6 @@ describe Toy::Persistence do
     end
   end
 
-  describe "#store_key" do
-    it "returns id" do
-      doc = User.new
-      doc.store_key.should == doc.id
-    end
-  end
-
   describe "#new_record?" do
     it "returns true if new" do
       User.new.should be_new_record
@@ -207,15 +163,15 @@ describe Toy::Persistence do
       end
 
       it "does not persist virtual attributes" do
-        @doc.store.read(@doc.store_key).should_not include('accepted_terms')
+        @doc.store.read(@doc.id).should_not include('accepted_terms')
       end
     end
 
     context "with existing record" do
       before do
         @doc      = User.create(:name => 'John', :age => 28)
-        @key      = @doc.store_key
-        @value    = User.store.read(@doc.store_key)
+        @key      = @doc.id
+        @value    = User.store.read(@doc.id)
         @doc.name = 'Bill'
         @doc.accepted_terms = false
         @doc.save
@@ -223,15 +179,15 @@ describe Toy::Persistence do
       let(:doc) { @doc }
 
       it "stores in same key" do
-        doc.store_key.should == @key
+        doc.id.should == @key
       end
 
       it "updates value in store" do
-        User.store.read(doc.store_key).should_not == @value
+        User.store.read(doc.id).should_not == @value
       end
 
       it "does not persist virtual attributes" do
-        @doc.store.read(@doc.store_key).should_not include('accepted_terms')
+        @doc.store.read(@doc.id).should_not include('accepted_terms')
       end
 
       it "updates the attributes in the instance" do
@@ -282,22 +238,4 @@ describe Toy::Persistence do
       doc.should be_destroyed
     end
   end
-
-  describe "with cache store" do
-    before do
-      User.attribute(:name, String)
-      @cache  = User.cache(:memory, {})
-      @memory = User.store(:memory, {})
-      @user   = User.create(:name => 'John')
-    end
-
-    let(:cache)   { @cache }
-    let(:memory)  { @memory }
-    let(:user)    { @user }
-
-    it "writes to cache and store" do
-      cache[user.store_key].should  == {'name' => 'John'}
-      memory[user.store_key].should == {'name' => 'John'}
-    end
-  end
 end

data/spec/toy/querying_spec.rb

@@ -103,60 +103,4 @@ describe Toy::Querying do
       doc.name.should == 'John'
     end
   end
-
-  describe "with cache store" do
-    before do
-      @cache  = User.cache(:memory, {})
-      @memory = User.store(:memory, {})
-      @user   = User.create
-      Toy.identity_map.clear # ensure we are just working with database
-    end
-
-    let(:cache)   { @cache }
-    let(:memory)  { @memory }
-    let(:user)    { @user }
-
-    describe "not found in cache or store" do
-      before do
-        cache.delete(user.store_key)
-        memory.delete(user.store_key)
-      end
-
-      it "returns nil" do
-        User.get('foo').should be_nil
-      end
-    end
-
-    describe "not found in cache" do
-      before do
-        cache.delete(user.store_key)
-      end
-
-      it "returns from store" do
-        User.get(user.id).should == user
-      end
-
-      it "populates cache" do
-        cache.key?(user.store_key).should be_false
-        User.get(user.id)
-        cache.key?(user.store_key).should be_true
-      end
-    end
-
-    describe "found in cache" do
-      before do
-        cache.key?(user.store_key).should be_true
-      end
-
-      it "returns from cache" do
-        cache.should_receive(:read).with(user.store_key).and_return(user.persisted_attributes)
-        User.get(user.id)
-      end
-
-      it "does not hit store" do
-        memory.should_not_receive(:read)
-        User.get(user.id)
-      end
-    end
-  end
 end

data/spec/toy_spec.rb

@@ -17,10 +17,5 @@ describe Toy do
       klass = Class.new { include Toy::Store }
       lambda { Toy.clear }.should_not raise_error
     end
-
-    it "does not raise error when no cache set" do
-      klass = Class.new { include Toy::Store }
-      lambda { Toy.clear }.should_not raise_error
-    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: toystore
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 6
-  - 6
-  version: 0.6.6
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Geoffrey Dagley
@@ -109,7 +109,6 @@ files:
 - examples/models.rb
 - examples/mongo.rb
 - examples/namespacing_keys.rb
-- examples/read_write_caching.rb
 - examples/redis.rb
 - examples/riak.rb
 - lib/toy.rb

data/examples/read_write_caching.rb

@@ -1,50 +0,0 @@
-require 'pp'
-require 'pathname'
-require 'rubygems'
-require 'adapter/memcached'
-require 'adapter/riak'
-
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-require 'toystore'
-
-class User
-  include Toy::Store
-  identity_map_off # turning off so we can better illustrate read/write through caching stuff
-
-  store :riak, Riak::Client.new['users']
-  cache :memcached, Memcached.new
-
-  attribute :email, String
-end
-
-user = User.create(:email => 'nunemaker@gmail.com')
-# ToyStore WTS #<User:0x102810e18> :memcached "6c39dd2a-3392-11e0-9fbf-040220ce8970"
-#   {"email"=>"nunemaker@gmail.com"}
-# ToyStore SET #<User:0x102810e18> :riak "6c39dd2a-3392-11e0-9fbf-040220ce8970"
-#   {"email"=>"nunemaker@gmail.com"}
-
-user = User.get(user.id)
-# Get hits memcache instead of riak since it is cached
-# ToyStore RTG User :memcached "6c39dd2a-3392-11e0-9fbf-040220ce8970"
-#   {"email"=>"nunemaker@gmail.com"}
-
-# delete from cache to demonstrate population on cache miss
-user.cache.delete(user.id)
-
-user = User.get(user.id)
-# Attempt read again, misses memcache, hits riak, caches in memcache
-# ToyStore RTG User :memcached "6c39dd2a-3392-11e0-9fbf-040220ce8970"
-#   nil
-# ToyStore GET User :riak "6c39dd2a-3392-11e0-9fbf-040220ce8970"
-#   {"email"=>"nunemaker@gmail.com"}
-# ToyStore RTS User :memcached "6c39dd2a-3392-11e0-9fbf-040220ce8970"
-#   {"email"=>"nunemaker@gmail.com"}
-
-user.update_attributes(:email => 'john@orderedlist.com')
-# updated in memcache, then riak
-# ToyStore WTS #<User:0x10266f0a0> :memcached "6c39dd2a-3392-11e0-9fbf-040220ce8970"
-#   {"email"=>"john@orderedlist.com"}
-# ToyStore SET #<User:0x10266f0a0> :riak "6c39dd2a-3392-11e0-9fbf-040220ce8970"
-#   {"email"=>"john@orderedlist.com"}