toystore 0.6.1 → 0.6.2

data/examples/memcached.rb

@@ -1,8 +1,13 @@
 require 'pp'
+require 'pathname'
 require 'rubygems'
-require 'toystore'
 require 'adapter/memcached'
 
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+require 'toystore'
+
 class GameList
   include Toy::Store
   store :memcached, Memcached.new

data/examples/memory.rb

@@ -1,8 +1,13 @@
 require 'pp'
+require 'pathname'
 require 'rubygems'
-require 'toystore'
 require 'adapter/memory'
 
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+require 'toystore'
+
 class User
   include Toy::Store
   store :memory, {}

data/examples/mongo.rb

@@ -1,11 +1,16 @@
 require 'pp'
+require 'pathname'
 require 'rubygems'
-require 'toystore'
 require 'adapter/mongo'
 
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+require 'toystore'
 class User
   include Toy::Store
   store :mongo, Mongo::Connection.new.db('adapter')['testing']
+  key(:object_id)
 
   attribute :name, String
 end

data/examples/namespacing_keys.rb

@@ -9,6 +9,10 @@ $:.unshift(lib_path)
 require 'toystore'
 
 class NamespacedUUIDKeyFactory < Toy::Identity::AbstractKeyFactory
+  def key_type
+    String
+  end
+
   def next_key(object)
     [object.class.name, SimpleUUID::UUID.new.to_guid].join(':')
   end

data/examples/redis.rb

@@ -1,8 +1,13 @@
 require 'pp'
+require 'pathname'
 require 'rubygems'
-require 'toystore'
 require 'adapter/redis'
 
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+require 'toystore'
+
 class User
   include Toy::Store
   store :redis, Redis.new

data/examples/riak.rb

@@ -1,8 +1,13 @@
 require 'pp'
+require 'pathname'
 require 'rubygems'
-require 'toystore'
 require 'adapter/riak'
 
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+require 'toystore'
+
 class GameList
   include Toy::Store
   store :riak, Riak::Client.new['adapter_example']

data/lib/toy/attributes.rb

@@ -5,7 +5,6 @@ module Toy
 
     included do
       attribute_method_suffix('', '=', '?')
-      attribute :id, String
     end
 
     module ClassMethods
@@ -42,6 +41,7 @@ module Toy
 
       def reload
         if attrs = store.read(store_key)
+          attrs['id'] = store_key
           instance_variables.each        { |ivar| instance_variable_set(ivar, nil) }
           initialize_attributes_with_defaults
           self.attributes = attrs

data/lib/toy/exceptions.rb

@@ -26,4 +26,16 @@ module Toy
       super("#{adapter.name.to_s.capitalize} adapter does not support locking")
     end
   end
+
+  class InvalidKeyFactory < Error
+    def initialize(name_or_factory)
+      super("#{name_or_factory.inspect} is not a valid name and did not respond to next_key and key_type")
+    end
+  end
+
+  class InvalidKey < Error
+    def initialize(*)
+      super("Key may not be nil")
+    end
+  end
 end

data/lib/toy/identity/abstract_key_factory.rb

@@ -1,6 +1,10 @@
 module Toy
   module Identity
     class AbstractKeyFactory
+      def key_type
+        raise NotImplementedError, "#{self.class.name}.store_type isn't implemented."
+      end
+
       def next_key(object)
         raise NotImplementedError, "#{self.class.name}#next_key isn't implemented."
       end

data/lib/toy/identity/object_id_key_factory.rb

@@ -3,9 +3,24 @@ require 'bson'
 module Toy
   module Identity
     class ObjectIdKeyFactory < AbstractKeyFactory
+      def key_type
+        BSON::ObjectId
+      end
+
       def next_key(object)
         BSON::ObjectId.new
       end
     end
   end
+end
+
+class BSON::ObjectId
+  def self.to_store(value, *)
+    return value if value.is_a?(BSON::ObjectId)
+    BSON::ObjectId.from_string(value.to_s)
+  end
+
+  def self.from_store(value, *)
+    value
+  end
 end

data/lib/toy/identity/uuid_key_factory.rb

@@ -1,6 +1,10 @@
 module Toy
   module Identity
     class UUIDKeyFactory < AbstractKeyFactory
+      def key_type
+        String
+      end
+
       def next_key(object)
         SimpleUUID::UUID.new.to_guid
       end

data/lib/toy/identity.rb

@@ -15,13 +15,20 @@ module Toy
           require 'toy/identity/object_id_key_factory'
           ObjectIdKeyFactory.new
         else
-          name_or_factory
+          if name_or_factory.respond_to?(:next_key) &&
+             name_or_factory.respond_to?(:key_type)
+            name_or_factory
+          else
+            raise InvalidKeyFactory.new(name_or_factory)
+          end
         end
+        attribute :id, @key_factory.key_type
+        @key_factory
       end
 
       def next_key(object = nil)
         @key_factory.next_key(object).tap do |key|
-          raise "Keys may not be nil" if key.nil?
+          raise InvalidKey.new if key.nil?
         end
       end
     end

data/lib/toy/identity_map.rb

@@ -49,15 +49,15 @@ module Toy
         return nil unless identity_map_on?
         key = store_key(id)
         if record = identity_map[key]
-          logger.debug("ToyStore IMG #{key.inspect}")
+          logger.debug("ToyStore IMG #{self.name} #{key.inspect}")
           record
         end
       end
 
-      def load(attrs)
+      def load(key, attrs)
         return nil if attrs.nil?
 
-        if instance = identity_map[store_key(attrs['id'])]
+        if instance = identity_map[store_key(key)]
           instance
         else
           super.tap { |doc| doc.add_to_identity_map }
@@ -83,14 +83,14 @@ module Toy
       return unless self.class.identity_map_on?
       key = store_key
       identity_map[key] = self
-      logger.debug("ToyStore IMS #{key.inspect}")
+      logger.debug("ToyStore IMS #{self.class.name} #{key.inspect}")
     end
 
     def remove_from_identity_map
       return unless self.class.identity_map_on?
       key = store_key
       identity_map.delete(key)
-      logger.debug("ToyStore IMD #{key.inspect}")
+      logger.debug("ToyStore IMD #{self.class.name} #{key.inspect}")
     end
 
     private

data/lib/toy/logger.rb

@@ -7,8 +7,8 @@ module Toy
         Toy.logger
       end
 
-      def log_operation(operation, adapter, key, value)
-        logger.debug("ToyStore #{operation} :#{adapter.name} #{key.inspect}")
+      def log_operation(operation, model, adapter, key, value)
+        logger.debug("ToyStore #{operation} #{model} :#{adapter.name} #{key.inspect}")
         logger.debug("  #{value.inspect}")
       end
     end

data/lib/toy/persistence.rb

@@ -92,7 +92,7 @@ module Toy
       def delete
         key = store_key
         @_destroyed = true
-        logger.debug("ToyStore DEL #{key.inspect}")
+        logger.debug("ToyStore DEL #{self.class.name} #{key.inspect}")
         store.delete(key)
       end
 
@@ -111,14 +111,13 @@ module Toy
 
         def persist!
           key, attrs = store_key, 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', cache, key, attrs)
+            log_operation('WTS', self, cache, key, attrs)
           end
-
           store.write(key, attrs)
-          log_operation('SET', store, key, attrs)
+          log_operation('SET', self, store, key, attrs)
           persist
           each_embedded_object { |doc| doc.send(:persist) }
           true

data/lib/toy/proxies/embedded_list.rb

@@ -34,7 +34,12 @@ module Toy
 
       def replace(instances)
         @target = instances.map do |instance|
-          instance = instance.is_a?(proxy_class) ? instance : proxy_class.load(instance)
+          instance = if instance.is_a?(proxy_class)
+            instance
+          else
+            key = instance.delete('id')
+            proxy_class.load(key, instance)
+          end
           assign_reference(instance)
         end
       end

data/lib/toy/querying.rb

@@ -8,20 +8,20 @@ module Toy
 
         if has_cache?
           value = cache.read(key)
-          log_operation('RTG', cache, key, value)
+          log_operation('RTG', self, cache, key, value)
         end
 
         if value.nil?
           value = store.read(key)
-          log_operation('GET', store, key, value)
+          log_operation('GET', self, store, key, value)
 
           if has_cache?
             cache.write(key, value)
-            log_operation('RTS', cache, key, value)
+            log_operation('RTS', self, cache, key, value)
           end
         end
 
-        load(value)
+        load(key, value)
       end
 
       def get!(id)
@@ -43,13 +43,14 @@ module Toy
       def key?(id)
         key = store_key(id)
         value = store.key?(key)
-        log_operation('KEY', store, key, value)
+        log_operation('KEY', self, store, key, value)
         value
       end
       alias :has_key? :key?
 
-      def load(attrs)
+      def load(key, attrs)
         return nil if attrs.nil?
+        attrs['id'] = key
         allocate.initialize_from_database(attrs)
       end
     end

data/lib/toy/serialization.rb

@@ -14,7 +14,8 @@ module Toy
       options[:only]   = Array.wrap(options[:only]).map(&:to_sym)
       options[:except] = Array.wrap(options[:except]).map(&:to_sym)
 
-      serializable_stuff = serializable_attributes.map(&:to_sym) + self.class.embedded_lists.keys.map(&:to_sym)
+      serializable_stuff =  serializable_attributes.map(&:to_sym) +
+                            self.class.embedded_lists.keys.map(&:to_sym)
 
       if options[:only].any?
         serializable_stuff &= options[:only]

data/lib/toy/validations.rb

@@ -14,7 +14,7 @@ module Toy
           invalid = value.compact.select { |o| !o.valid? }
           if invalid.any?
             record.errors.add(name, 'is invalid')
-            logger.debug("ToyStore IEM")
+            logger.debug("ToyStore #{self.name} IEM")
             invalid.each do |o|
               logger.debug("  #{o.attributes.inspect} - #{o.errors.full_messages.inspect}")
             end

data/lib/toy/version.rb

@@ -1,3 +1,3 @@
 module Toy
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/spec/helper.rb

@@ -31,5 +31,6 @@ Rspec.configure do |c|
   c.before(:each) do
     Toy.clear
     Toy.reset
+    Toy.key_factory = nil
   end
 end

data/spec/support/name_and_number_key_factory.rb

@@ -1,4 +1,8 @@
 class NameAndNumberKeyFactory < Toy::Identity::AbstractKeyFactory
+  def key_type
+    String
+  end
+
   def next_key(object)
     "#{object.name}-#{object.number}" unless object.name.nil? || object.number.nil?
   end

data/spec/toy/attributes_spec.rb

@@ -52,6 +52,10 @@ describe Toy::Attributes do
       @game.persisted_attributes.should have_key('moves')
     end
 
+    it "includes ids of embedded" do
+      @game.persisted_attributes['moves'][0].should have_key('id')
+    end
+
     it "does not include virtual attributes" do
       @game.persisted_attributes.should_not have_key(:creator_score)
     end
@@ -328,6 +332,12 @@ describe Toy::Attributes do
     end
     let(:user) { @user }
 
+    it "reloads id from database" do
+      id = user.id
+      user.reload
+      user.id.should == id
+    end
+
     it "reloads record from the database" do
       user.name = 'Steve'
       user.reload

data/spec/toy/identity/abstract_key_factory_spec.rb

@@ -1,6 +1,12 @@
 require 'helper'
 
 describe Toy::Identity::AbstractKeyFactory do
+  it "should raise not implemented for #key_type" do
+    lambda {
+      Toy::Identity::AbstractKeyFactory.new.key_type
+    }.should raise_error(NotImplementedError)
+  end
+
   it "should raise not implemented error for #next_key" do
     lambda { Toy::Identity::AbstractKeyFactory.new.next_key("any object") }.should raise_error(NotImplementedError)
   end

data/spec/toy/identity/object_id_key_factory_spec.rb

@@ -2,8 +2,35 @@ require 'helper'
 require 'toy/identity/object_id_key_factory'
 
 describe Toy::Identity::ObjectIdKeyFactory do
+  uses_constants('User')
+
+  it "should use String as store_type" do
+    Toy::Identity::ObjectIdKeyFactory.new.key_type.should be(BSON::ObjectId)
+  end
+
   it "should use object id for next key" do
     key = Toy::Identity::ObjectIdKeyFactory.new.next_key(nil)
     key.should be_instance_of(BSON::ObjectId)
   end
+
+  describe "Declaring key to be object_id" do
+    before(:each) do
+      User.key(:object_id)
+      User.attribute(:name, String)
+    end
+
+    it "sets id attribute to BSON::ObjectId type" do
+      User.attributes['id'].type.should be(BSON::ObjectId)
+    end
+
+    it "correctly stores id in database" do
+      user = User.create(:name => 'John')
+      user.id.should be_instance_of(BSON::ObjectId)
+      # key_for in memory adapter marshals non symbol/string keys
+      # so we have to unmarshal to get the key type
+      key =  Marshal.load(user.store.client.keys.first)
+      key.should be_instance_of(BSON::ObjectId)
+      user.id.should == key
+    end
+  end
 end

data/spec/toy/identity/uuid_key_factory_spec.rb

@@ -1,7 +1,23 @@
 require 'helper'
 
 describe Toy::Identity::UUIDKeyFactory do
+  uses_constants('User')
+
+  it "should use String as store_type" do
+    Toy::Identity::UUIDKeyFactory.new.key_type.should be(String)
+  end
+
   it "should use uuid for next key" do
     Toy::Identity::UUIDKeyFactory.new.next_key(nil).length.should == 36
   end
+
+  describe "Declaring key to be object_id" do
+    before(:each) do
+      User.key(:uuid)
+    end
+
+    it "sets id attribute to String type" do
+      User.attributes['id'].type.should be(String)
+    end
+  end
 end

data/spec/toy/identity_map_spec.rb

@@ -24,7 +24,7 @@ describe Toy::IdentityMap do
   end
 
   it "adds to map on load" do
-    user = User.load({'id' => '1'})
+    user = User.load('1', 'id' => '1')
     user.should be_in_identity_map
   end
 
@@ -84,7 +84,7 @@ describe Toy::IdentityMap do
 
     it "does not add to map on load" do
       User.identity_map_off
-      user = User.load('id' => '1')
+      user = User.load('1', 'name' => 'John')
       user.should_not be_in_identity_map
     end
 

data/spec/toy/identity_spec.rb

@@ -13,12 +13,12 @@ describe Toy::Identity do
     end
 
     it "should set key factory passed in factory" do
-      factory = Toy::Identity::UUIDKeyFactory
+      factory = Toy::Identity::UUIDKeyFactory.new
       User.key(factory).should == factory
     end
 
     it "should use Toy.key_factory by default" do
-      key_factory     = mock
+      key_factory     = Toy::Identity::UUIDKeyFactory.new
       Toy.key_factory = key_factory
       klass           = Class.new { include Toy::Store }
 
@@ -31,14 +31,14 @@ describe Toy::Identity do
 
   describe ".next_key" do
     it "should call the next key on the key factory" do
-      factory = Toy::Identity::UUIDKeyFactory
+      factory = Toy::Identity::UUIDKeyFactory.new
       factory.should_receive(:next_key).and_return('some_key')
       User.key(factory)
       User.next_key.should == 'some_key'
     end
 
     it "should raise an exception for nil key" do
-      factory = Toy::Identity::UUIDKeyFactory
+      factory = Toy::Identity::UUIDKeyFactory.new
       factory.should_receive(:next_key).and_return(nil)
       User.key(factory)
       lambda { User.next_key }.should raise_error

data/spec/toy/list_spec.rb

@@ -315,7 +315,6 @@ describe Toy::List do
     end
 
     it "sets the inverse association" do
-      # @game.chats.should include(@chat)
       @chat.game.should == @game
     end
   end

data/spec/toy/logger_spec.rb

@@ -15,9 +15,9 @@ describe Toy::Logger do
     let(:adapter) { Adapter[:memory].new({}) }
 
     it "logs operation" do
-      User.logger.should_receive(:debug).with('ToyStore GET :memory "foo"')
+      User.logger.should_receive(:debug).with('ToyStore GET User :memory "foo"')
       User.logger.should_receive(:debug).with('  "bar"')
-      User.log_operation('GET', adapter, 'foo', 'bar')
+      User.log_operation('GET', User, adapter, 'foo', 'bar')
     end
   end
 
@@ -25,9 +25,9 @@ describe Toy::Logger do
     let(:adapter) { Adapter[:memory].new({}) }
 
     it "logs operation" do
-      User.logger.should_receive(:debug).with('ToyStore GET :memory "foo"')
+      User.logger.should_receive(:debug).with('ToyStore GET User :memory "foo"')
       User.logger.should_receive(:debug).with('  "bar"')
-      User.log_operation('GET', adapter, 'foo', 'bar')
+      User.log_operation('GET', User, adapter, 'foo', 'bar')
     end
   end
 end

data/spec/toy/persistence_spec.rb

@@ -95,7 +95,6 @@ describe Toy::Persistence do
     it "creates key in database with attributes" do
       User.store.read(doc.store_key).should == {
         'name' => 'John',
-        'id'   => doc.id,
         'age'  => 50,
       }
     end
@@ -286,9 +285,10 @@ describe Toy::Persistence do
 
   describe "with cache store" do
     before do
+      User.attribute(:name, String)
       @cache  = User.cache(:memory, {})
       @memory = User.store(:memory, {})
-      @user   = User.create
+      @user   = User.create(:name => 'John')
     end
 
     let(:cache)   { @cache }
@@ -296,8 +296,8 @@ describe Toy::Persistence do
     let(:user)    { @user }
 
     it "writes to cache and store" do
-      cache[user.store_key].should == user.persisted_attributes
-      memory[user.store_key].should    == user.persisted_attributes
+      cache[user.store_key].should  == {'name' => 'John'}
+      memory[user.store_key].should == {'name' => 'John'}
     end
   end
 end

data/spec/toy/querying_spec.rb

@@ -88,7 +88,7 @@ describe Toy::Querying do
   end
 
   describe ".load (with hash)" do
-    before    { @doc = User.load(:id => '1', :name => 'John') }
+    before    { @doc = User.load('1', :name => 'John') }
     let(:doc) { @doc }
 
     it "returns instance" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 1
-  version: 0.6.1
+  - 2
+  version: 0.6.2
 platform: ruby
 authors: 
 - Geoffrey Dagley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 -05:00
+date: 2011-02-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency