toystore 0.6.3 → 0.6.4

data/.gitignore

@@ -3,4 +3,5 @@ testing/
 .rvmrc
 log
 tmp
-pkg
+pkg
+.bundle

data/README.rdoc

@@ -4,6 +4,10 @@ An object mapper for anything that can read, write and delete data.
 
 See examples/ for potential direction. The idea is that any key-value store (via adapters) that supports read, write, delete will work (memcache, membase, mongo, redis, couch, toyko. Potentially even RESTFUL services or sqlite with a single key-value table?)
 
+== Mailing List
+
+https://groups.google.com/forum/#!forum/toystoreadapter
+
 == Identity Map
 
 By default, Toystore has identity map turned on. It assumes that any Toystore model has a unique id across all models. This means you either need to use the default uuid id's, object_id's (included), some other unique id, or create your own key factory that namespaces to model (see examples).

data/examples/attributes_abbreviation.rb

@@ -0,0 +1,26 @@
+require 'pp'
+require 'pathname'
+require 'rubygems'
+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, {}
+
+  attribute :email, String
+  attribute :my_really_long_field_name, String, :abbr => :my
+end
+
+user = User.create({
+  :email => 'nunemaker@gmail.com',
+  :my_really_long_field_name => 'something',
+})
+
+pp Marshal.load(User.store.client[user.id])
+# Abbreviated attributes are stored in the database as the abbreviation for when you want to conserve space. The abbreviation and the full attribute name work exactly the same in Ruby, the only difference is how they get persisted.
+# {"my"=>"something", "email"=>"nunemaker@gmail.com"}

data/examples/attributes_virtual.rb

@@ -0,0 +1,41 @@
+require 'pp'
+require 'pathname'
+require 'rubygems'
+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, {}
+
+  attribute :email, String
+  attribute :crypted_password, String
+
+  attribute :password, String, :virtual => true
+  attribute :password_confirmation, String, :virtual => true
+
+  before_validation :encrypt_password
+
+private
+  def encrypt_password
+    self.crypted_password = encrypt(password)
+  end
+
+  def encrypt(password)
+    password # do something magical here
+  end
+end
+
+user = User.create({
+  :email => 'nunemaker@gmail.com',
+  :password => 'testing',
+  :password_confirmation => 'testing',
+})
+
+pp Marshal.load(User.store.client[user.id])
+# Virtual attributes are never persisted. In the data store, only email and crypted_password are stored.
+# {"crypted_password"=>"testing", "email"=>"nunemaker@gmail.com"}

data/examples/identity_map.rb

@@ -0,0 +1,45 @@
+require 'pp'
+require 'pathname'
+require 'rubygems'
+require 'adapter/memory'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+require 'toystore'
+
+# Identity map is turned on by default for Toystore. To turn it off for an entire model, just call identity_map_off.
+#
+# More Reading...
+# http://martinfowler.com/eaaCatalog/identityMap.html
+# http://en.wikipedia.org/wiki/Identity_map
+
+class User
+  include Toy::Store
+  store :memory, {}
+
+  # identity_map_off # if uncommented, User would not use identity map
+
+  attribute :name, String
+end
+
+user = User.create(:name => 'John')
+# User is added to identity map
+# ToyStore SET #<User:0x10220b4c8> :memory "08a1c54c-3393-11e0-8b37-89da41d2f675"
+#   {"name"=>"John"}
+# ToyStore IMS User "08a1c54c-3393-11e0-8b37-89da41d2f675"
+
+User.get(user.id)
+# User is retrieved from identity map instead of querying
+# ToyStore IMG User "08a1c54c-3393-11e0-8b37-89da41d2f675"
+
+User.without_identity_map do
+  User.get(user.id)
+  # User is queried from database
+  # ToyStore GET User :memory "08a1c54c-3393-11e0-8b37-89da41d2f675"
+  #   {"name"=>"John"}
+end
+
+User.get(user.id)
+# User is retrieved from identity map instead of querying
+# ToyStore IMG User "08a1c54c-3393-11e0-8b37-89da41d2f675"

data/examples/mongo.rb

@@ -7,6 +7,7 @@ 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']

data/examples/read_write_caching.rb

@@ -0,0 +1,50 @@
+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"}

data/lib/toy/attributes.rb

@@ -29,7 +29,7 @@ module Toy
       def initialize(attrs={})
         @_new_record = true unless defined?(@_new_record)
         initialize_attributes_with_defaults
-        self.attributes = attrs
+        send(:attributes=, attrs, @_new_record)
         write_attribute :id, self.class.next_key(self) unless id?
       end
 
@@ -44,7 +44,7 @@ module Toy
           attrs['id'] = store_key
           instance_variables.each        { |ivar| instance_variable_set(ivar, nil) }
           initialize_attributes_with_defaults
-          self.attributes = attrs
+          send(:attributes=, attrs, new_record?)
           self.class.lists.each_key      { |name| send(name).reset }
           self.class.references.each_key { |name| send(name).reset }
         else
@@ -78,7 +78,7 @@ module Toy
         end
       end
 
-      def attributes=(attrs)
+      def attributes=(attrs, *)
         return if attrs.nil?
         attrs.each do |key, value|
           if attribute_method?(key)

data/lib/toy/exceptions.rb

@@ -1,7 +1,7 @@
 module Toy
   class Error < StandardError; end
 
-  class RecordInvalidError < Error
+  class RecordInvalid < Error
     attr_reader :record
     def initialize(record)
       @record = record
@@ -15,18 +15,6 @@ module Toy
     end
   end
 
-  class UndefinedLock < Error
-    def initialize(klass, name)
-      super("Undefined lock :#{name} for class #{klass.name}")
-    end
-  end
-
-  class AdapterNoLocky < Error
-    def initialize(adapter)
-      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")

data/lib/toy/identity.rb

@@ -26,6 +26,10 @@ module Toy
         @key_factory
       end
 
+      def key_type
+        @key_factory.key_type
+      end
+
       def next_key(object = nil)
         @key_factory.next_key(object).tap do |key|
           raise InvalidKey.new if key.nil?

data/lib/toy/identity/object_id_key_factory.rb

@@ -20,7 +20,7 @@ class BSON::ObjectId
     BSON::ObjectId.from_string(value.to_s)
   end
 
-  def self.from_store(value, *)
-    value
+  def self.from_store(value, *args)
+    to_store(value, *args)
   end
 end

data/lib/toy/mass_assignment_security.rb

@@ -4,12 +4,9 @@ module Toy
     include ActiveModel::MassAssignmentSecurity
 
     module InstanceMethods
-      def initialize(attrs={})
-        super(sanitize_for_mass_assignment(attrs || {}))
-      end
-
-      def update_attributes(attrs={})
-        super(sanitize_for_mass_assignment(attrs || {}))
+      def attributes=(attrs, guard_protected_attributes=true)
+        attrs = sanitize_for_mass_assignment(attrs || {}) if guard_protected_attributes
+        super(attrs)
       end
     end
   end

data/lib/toy/querying.rb

@@ -49,9 +49,7 @@ module Toy
       alias :has_key? :key?
 
       def load(key, attrs)
-        return nil if attrs.nil?
-        attrs['id'] = key
-        allocate.initialize_from_database(attrs)
+        attrs && allocate.initialize_from_database(attrs.update('id' => key))
       end
     end
   end

data/lib/toy/reference.rb

@@ -9,7 +9,7 @@ module Toy
       @type    = args.shift
 
       model.references[name] = self
-      model.attribute(key, String)
+      model.attribute(key, type.key_type)
       create_accessors
     end
 

data/lib/toy/validations.rb

@@ -38,7 +38,7 @@ module Toy
       end
 
       def save!
-        save || raise(RecordInvalidError.new(self))
+        save || raise(RecordInvalid.new(self))
       end
     end
   end

data/lib/toy/version.rb

@@ -1,3 +1,3 @@
 module Toy
-  VERSION = "0.6.3"
+  VERSION = "0.6.4"
 end

data/spec/toy/attributes_spec.rb

@@ -130,6 +130,13 @@ describe Toy::Attributes do
     it "does not fail with nil" do
       User.new(nil).should be_instance_of(User)
     end
+
+    it "does guard attributes=" do
+      attrs = {'age' => 21}
+      user = User.allocate
+      user.should_receive(:attributes=).with(attrs, true)
+      user.send(:initialize, attrs)
+    end
   end
 
   describe "#initialize_from_database" do
@@ -159,6 +166,12 @@ describe Toy::Attributes do
     it "returns self" do
       @user.initialize_from_database.should == @user
     end
+
+    it "does not guard attributes=" do
+      attrs = {'age' => 21}
+      @user.should_receive(:attributes=).with(attrs, false)
+      @user.initialize_from_database(attrs)
+    end
   end
 
   describe "#attributes" do
@@ -390,6 +403,15 @@ describe Toy::Attributes do
       @user.reload
       @user.skills.should == []
     end
+
+    it "reloads attributes protected from mass assignment" do
+      User.attribute(:admin, Boolean)
+      User.attr_accessible(:name)
+      user = User.new(:name => 'John')
+      user.admin = true
+      user.save
+      user.reload.admin.should be_true
+    end
   end
 
   describe "Initialization of array attributes" do

data/spec/toy/exceptions_spec.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-describe Toy::RecordInvalidError do
+describe Toy::RecordInvalid do
   uses_constants('User')
 
   before do
@@ -13,6 +13,6 @@ describe Toy::RecordInvalidError do
   it "should include a message of the errors" do
     user = User.new
     user.should_not be_valid
-    Toy::RecordInvalidError.new(user).message.should == "Invalid record: Name can't be blank and Age can't be blank"
+    Toy::RecordInvalid.new(user).message.should == "Invalid record: Name can't be blank and Age can't be blank"
   end
 end

data/spec/toy/identity/object_id_key_factory_spec.rb

@@ -4,7 +4,7 @@ require 'toy/identity/object_id_key_factory'
 describe Toy::Identity::ObjectIdKeyFactory do
   uses_constants('User')
 
-  it "should use String as store_type" do
+  it "should use BSON::ObjectId as key_type" do
     Toy::Identity::ObjectIdKeyFactory.new.key_type.should be(BSON::ObjectId)
   end
 
@@ -19,6 +19,10 @@ describe Toy::Identity::ObjectIdKeyFactory do
       User.attribute(:name, String)
     end
 
+    it "returns BSON::ObjectId as .key_type" do
+      User.key_type.should be(BSON::ObjectId)
+    end
+
     it "sets id attribute to BSON::ObjectId type" do
       User.attributes['id'].type.should be(BSON::ObjectId)
     end

data/spec/toy/identity/uuid_key_factory_spec.rb

@@ -16,6 +16,10 @@ describe Toy::Identity::UUIDKeyFactory do
       User.key(:uuid)
     end
 
+    it "returns String as .key_type" do
+      User.key_type.should be(String)
+    end
+
     it "sets id attribute to String type" do
       User.attributes['id'].type.should be(String)
     end

data/spec/toy/identity_spec.rb

@@ -45,6 +45,13 @@ describe Toy::Identity do
     end
   end
 
+  describe ".key_type" do
+    it "returns the type based on the key factory" do
+      User.key(Toy::Identity::UUIDKeyFactory.new)
+      User.key_type.should be(String)
+    end
+  end
+
   describe "initializing the id" do
     it "should pass use pass the new object" do
       Piece.attribute(:name, String)

data/spec/toy/mass_assignment_security_spec.rb

@@ -31,14 +31,30 @@ describe Toy::MassAssignmentSecurity do
       user.name.should == 'John'
     end
 
+    it "should ignore inaccessible attribute on #attributes=" do
+      user = User.new
+      user.attributes = {:name => 'John', :admin => true}
+      user.admin.should be_false
+      user.name.should == 'John'
+    end
+
+    it "should not ignore inaccessible attribute on #attributes= with no guard" do
+      user = User.new
+      user.send(:attributes=, {:name => 'John', :admin => true}, false)
+      user.admin.should be_true
+      user.name.should == 'John'
+    end
+
     it "should not ignore inaccessible attributes on #initialize from the database" do
       user = User.new(:name => 'John')
       user.admin = true
       user.save!
 
-      user = User.get(user.id)
-      user.admin.should be_true
-      user.name.should == 'John'
+      User.without_identity_map do
+        user = User.get(user.id)
+        user.admin.should be_true
+        user.name.should == 'John'
+      end
     end
 
     it "should ignore inaccessible attribute on #update_attributes" do

data/spec/toy/reference_spec.rb

@@ -37,6 +37,10 @@ describe Toy::Reference do
     Game.attributes.keys.should include('user_id')
   end
 
+  it "sets attribute type to .key_type" do
+    Game.attributes['user_id'].type.should be(String)
+  end
+
   it "adds reader method" do
     Game.new.should respond_to(:user)
   end
@@ -45,6 +49,17 @@ describe Toy::Reference do
     Game.new.should respond_to(:user=)
   end
 
+  describe "with object_id key" do
+    before(:each) do
+      User.key(:object_id)
+      @reference = Game.reference(:user)
+    end
+
+    it "sets type to BSON::ObjectId" do
+      Game.attributes['user_id'].type.should be(BSON::ObjectId)
+    end
+  end
+
   describe "#eql?" do
     it "returns true if same class, model, and name" do
       reference.should eql(reference)

data/spec/toy/validations_spec.rb

@@ -127,8 +127,8 @@ describe Toy::Validations do
         @doc = User.new
       end
 
-      it "raises an RecordInvalidError" do
-        lambda { @doc.save! }.should raise_error(Toy::RecordInvalidError)
+      it "raises an RecordInvalid" do
+        lambda { @doc.save! }.should raise_error(Toy::RecordInvalid)
       end
     end
   end
@@ -142,8 +142,8 @@ describe Toy::Validations do
     end
 
     context "with invalid" do
-      it "raises an RecordInvalidError" do
-        lambda { User.create! }.should raise_error(Toy::RecordInvalidError)
+      it "raises an RecordInvalid" do
+        lambda { User.create! }.should raise_error(Toy::RecordInvalid)
       end
     end
   end

data/specs.watchr

@@ -34,7 +34,7 @@ def run_spec(path)
   path.gsub!(file_name, file_name + "_spec")
   if File.exists?(path)
     system('clear')
-    run(%Q(bundle exec spec #{path}))
+    run(%Q(bundle exec rspec #{path}))
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: toystore
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 6
-  - 3
-  version: 0.6.3
+  - 4
+  version: 0.6.4
 platform: ruby
 authors: 
 - Geoffrey Dagley
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-05 00:00:00 -05:00
+date: 2011-02-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -95,7 +95,6 @@ extra_rdoc_files: []
 
 files: 
 - .autotest
-- .bundle/config
 - .gitignore
 - Gemfile
 - Gemfile.lock
@@ -103,12 +102,16 @@ files:
 - LOGGING.rdoc
 - README.rdoc
 - Rakefile
+- examples/attributes_abbreviation.rb
+- examples/attributes_virtual.rb
 - examples/changing_key_factory.rb
+- examples/identity_map.rb
 - examples/memcached.rb
 - examples/memory.rb
 - 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/.bundle/config

@@ -1,2 +0,0 @@
---- 
-BUNDLE_DISABLE_SHARED_GEMS: "1"