perpetuity 0.5.0 → 0.6.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Version 0.6.0
+
+- Stop extending persisted/retrieved objects with `Perpetuity::PersistedObject`. Extending these objects invalidates method caches inside the VM, which degrades performance.
+- Cache all objects returned from `Mapper#find(id)` by default into the mapper object. This can be bypassed with `Mapper#find(id, false)`
+- Do not store uninitialized attributes with the MongoDB serializer. This shrinks the size of documents when possible.
+
 ## Version 0.5.0
 
 - Allow querying based on referenced class/id or embedded-object data

data/lib/perpetuity/data_injectable.rb

@@ -1,5 +1,3 @@
-require 'perpetuity/persisted_object'
-
 module Perpetuity
   module DataInjectable
     def inject_attribute object, attribute, value
@@ -17,7 +15,6 @@ module Perpetuity
       if args.any?
         inject_attribute object, :id, args.first
       end
-      object.extend PersistedObject
     end
   end
 end

data/lib/perpetuity/identity_map.rb

@@ -7,11 +7,13 @@ module Perpetuity
     end
 
     def [] klass, id
-      map[klass][id]
+      map[klass][id.to_s]
     end
 
     def << object
-      map[object.class][object.id] = object
+      klass = object.class
+      id = object.instance_variable_get(:@id)
+      map[klass][id.to_s] = object
     end
   end
 end

data/lib/perpetuity/mapper.rb

@@ -8,10 +8,11 @@ require 'perpetuity/retrieval'
 module Perpetuity
   class Mapper
     include DataInjectable
-    attr_reader :mapper_registry
+    attr_reader :mapper_registry, :identity_map
 
     def initialize registry=Perpetuity.mapper_registry
       @mapper_registry = registry
+      @identity_map = IdentityMap.new
     end
 
     def self.map klass, registry=Perpetuity.mapper_registry
@@ -106,12 +107,20 @@ module Perpetuity
 
     alias :find_all :select
 
-    def find *args, &block
+    def find id=nil, cache_result=true, &block
       if block_given?
         select(&block).first
       else
-        id = args.first
-        select { |object| object.id == id }.first
+        cached_value = identity_map[mapped_class, id]
+        return cached_value if cached_value
+
+        result = select { |object| object.id == id }.first
+
+        if cache_result and !result.nil?
+          identity_map << result
+        end
+
+        result
       end
     end
 
@@ -122,7 +131,7 @@ module Perpetuity
     end
 
     def delete object
-      id = object.is_a?(PersistedObject) ? object.id : object
+      id = persisted?(object) ? id_for(object) : object
       data_source.delete id, mapped_class
     end
 
@@ -152,7 +161,7 @@ module Perpetuity
     end
 
     def update object, new_data, update_in_memory = true
-      id = object.is_a?(mapped_class) ? object.id : object
+      id = object.is_a?(mapped_class) ? id_for(object) : object
 
       inject_data object, new_data if update_in_memory
       data_source.update mapped_class, id, new_data
@@ -163,17 +172,25 @@ module Perpetuity
     end
 
     def increment object, attribute, count=1
-      data_source.increment mapped_class, object.id, attribute, count
+      data_source.increment mapped_class, id_for(object), attribute, count
     rescue Moped::Errors::OperationFailure
       raise ArgumentError.new('Attempted to increment a non-numeric value')
     end
 
     def decrement object, attribute, count=1
-      data_source.increment mapped_class, object.id, attribute, -count
+      data_source.increment mapped_class, id_for(object), attribute, -count
     rescue Moped::Errors::OperationFailure
       raise ArgumentError.new('Attempted to decrement a non-numeric value')
     end
 
+    def persisted? object
+      object.instance_variable_defined?(:@id)
+    end
+
+    def id_for object
+      object.instance_variable_get(:@id)
+    end
+
     def self.validate &block
       validations.instance_exec(&block)
     end

data/lib/perpetuity/mongodb/serializer.rb

@@ -17,8 +17,14 @@ module Perpetuity
         object.instance_variable_get("@#{attribute_name}")
       end
 
+      def has_attribute? object, attribute_name
+        object.instance_variable_defined? "@#{attribute_name}"
+      end
+
       def serialize object
         attrs = mapper.class.attribute_set.map do |attrib|
+          next unless has_attribute? object, attrib.name
+
           value = attribute_for object, attrib.name
 
           serialized_value = if value.is_a? Reference
@@ -36,7 +42,7 @@ module Perpetuity
           [attrib.name.to_s, serialized_value]
         end
 
-        Hash[attrs]
+        Hash[attrs.compact]
       end
 
       def unserialize data
@@ -134,10 +140,10 @@ module Perpetuity
         if value.is_a? Reference
           reference = value
         else
-          unless value.is_a? PersistedObject
+          unless mapper.persisted? value
             mapper_registry[value.class].insert value
           end
-          reference = Reference.new(value.class.to_s, value.id)
+          reference = Reference.new(value.class.to_s, mapper.id_for(value))
         end
         {
           '__metadata__' => {

data/lib/perpetuity/reference.rb

@@ -7,11 +7,15 @@ module Perpetuity
     end
 
     def == other
-      klass == other.klass && id == other.id
+      if other.is_a? self.class
+        klass == other.klass && id == other.id
+      else
+        other.is_a?(klass) && id == other.id
+      end
     end
 
     def eql? other
-      self == other
+      other.is_a?(self.class) && self == other
     end
   end
 end

data/lib/perpetuity/version.rb

@@ -1,3 +1,3 @@
 module Perpetuity
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/perpetuity.rb

@@ -1,5 +1,4 @@
 require "perpetuity/version"
-require "perpetuity/retrieval"
 require "perpetuity/mongodb"
 require "perpetuity/config"
 require "perpetuity/mapper"

data/spec/integration/associations_spec.rb

@@ -17,16 +17,16 @@ describe 'associations with other objects' do
   end
 
   describe 'referenced relationships' do
-    let(:creator) { topic_mapper.find(topic.id).creator }
+    let(:creator) { topic_mapper.find(topic_mapper.id_for topic).creator }
     subject { creator }
 
     it { should be_a Perpetuity::Reference }
     its(:klass) { should be User }
-    its(:id) { should be == user.id }
+    its(:id) { should be == user_mapper.id_for(user) }
   end
 
   it 'can retrieve a one-to-one association' do
-    retrieved_topic = topic_mapper.find(topic.id)
+    retrieved_topic = topic_mapper.find(topic_mapper.id_for topic)
 
     topic_mapper.load_association! retrieved_topic, :creator
     retrieved_topic.creator.name.should eq 'Flump'
@@ -45,7 +45,7 @@ describe 'associations with other objects' do
     end
 
     it 'can retrieve a one-to-many association' do
-      persisted_book = book_mapper.find(pragprog_book.id)
+      persisted_book = book_mapper.find(book_mapper.id_for pragprog_book)
       book_mapper.load_association! persisted_book, :authors
 
       persisted_book.authors.first.name.should be == 'Dave'
@@ -55,7 +55,7 @@ describe 'associations with other objects' do
     it 'can retrieve a many-to-many association' do
       cuke_authors.each { |author| Perpetuity[User].insert author }
       book_mapper.insert cuke_book
-      book_ids = [pragprog_book, cuke_book].map(&:id)
+      book_ids = [pragprog_book, cuke_book].map { |book| book_mapper.id_for(book) }
 
       books = book_mapper.select { |book| book.id.in book_ids }.to_a
       book_mapper.load_association! books, :authors
@@ -70,7 +70,7 @@ describe 'associations with other objects' do
       mapper = Perpetuity[Article]
 
       mapper.insert article
-      retrieved = mapper.find(article.id)
+      retrieved = mapper.find(mapper.id_for(article))
       mapper.load_association! retrieved, :author
       retrieved.author.should == [foo, bar]
     end
@@ -90,7 +90,8 @@ describe 'associations with other objects' do
 
       it 'serializes attributes' do
         mapper.insert object
-        mapper.find(object.id).embedded_attribute.should be == [unserializable_object]
+        attr = mapper.find(mapper.id_for object).embedded_attribute
+        attr.should be == [unserializable_object]
       end
     end
   end

data/spec/integration/indexing_spec.rb

@@ -14,7 +14,12 @@ describe 'indexing' do
       index.attribute.to_s == :name
     end
   end
+  let(:db_name) { Perpetuity.configuration.data_source.db }
 
+  before do
+    Perpetuity.data_source :mongodb, db_name
+    mapper.data_source.drop_collection Object
+  end
   after { mapper.data_source.drop_collection Object }
 
   it 'adds indexes to database collections/tables' do

data/spec/integration/mongodb_spec.rb

@@ -125,6 +125,7 @@ module Perpetuity
       end
 
       it 'creates indexes on the database collection' do
+        mongo.delete_all collection
         index = mongo.index collection, 'real_index', order: :descending, unique: true
         mongo.activate_index! index
 
@@ -132,6 +133,7 @@ module Perpetuity
       end
 
       it 'removes indexes' do
+        mongo.drop_collection collection
         index = mongo.index collection, 'real_index', order: :descending, unique: true
         mongo.activate_index! index
         mongo.remove_index index
@@ -156,7 +158,11 @@ module Perpetuity
       let(:data) { { foo: 'bar' } }
       let(:index) { mongo.index Object, :foo, unique: true }
 
-      before { mongo.activate_index! index }
+      before do
+        mongo.delete_all Object
+        mongo.activate_index! index
+      end
+
       after { mongo.drop_collection Object }
 
       it 'raises an exception when insertion fails' do

data/spec/integration/persistence_spec.rb

@@ -2,56 +2,61 @@ require 'spec_helper'
 require 'support/test_classes'
 
 describe 'Persistence' do
+  let(:mapper) { Perpetuity[Article] }
+
   it "persists an object" do
     article = Article.new 'I have a title'
-    expect { Perpetuity[Article].insert article }.
-      to change { Perpetuity[Article].count }.by 1
-    Perpetuity[Article].find(article.id).title.should eq 'I have a title'
+    expect { mapper.insert article }.
+      to change { mapper.count }.by 1
+    mapper.find(mapper.id_for(article)).title.should eq 'I have a title'
   end
 
   it 'returns the id of the persisted object' do
     article = Article.new
-    Perpetuity[Article].insert(article).should eq article.id
+    mapper.insert(article).should eq mapper.id_for(article)
   end
 
   it "gives an id to objects" do
     article = Article.new
-    Perpetuity[Article].give_id_to article, 1
+    mapper.give_id_to article, 1
 
-    article.id.should eq 1
+    mapper.id_for(article).should eq 1
   end
 
   it 'persists referenced objects if they are not persisted' do
     article = Article.new
     article.author = User.new
-    Perpetuity[Article].insert article
+    mapper.insert article
 
-    Perpetuity[Article].find(article.id).author.id.should be == article.author.id
+    retrieved = mapper.find(mapper.id_for(article))
+    mapper.id_for(retrieved.author).should be == mapper.id_for(article.author)
   end
 
   it 'persists arrays of referenced objects if they are not persisted' do
     authors = [User.new('Dave'), User.new('Andy')]
     book = Book.new
     book.authors = authors
-    Perpetuity[Book].insert book
+    mapper = Perpetuity[Book]
+    mapper.insert book
 
-    Perpetuity[Book].find(book.id).authors.first.id.should be == authors.first.id
+    first_author = mapper.find(mapper.id_for book).authors.first
+    mapper.id_for(first_author).should be == mapper.id_for(authors.first)
   end
 
   describe 'id injection' do
     let(:article) { Article.new }
 
     it 'assigns an id to the inserted object' do
-      Perpetuity[Article].insert article
-      article.should respond_to :id
+      mapper.insert article
+      mapper.id_for(article).should_not be_nil
     end
 
     it "assigns an id using Mapper.first" do
-      Perpetuity[Article].first.should respond_to :id
+      mapper.id_for(mapper.first).should_not be_nil
     end
 
     it 'assigns an id using Mapper.all.first' do
-      Perpetuity[Article].all.first.should respond_to :id
+      mapper.id_for(mapper.all.first).should_not be_nil
     end
   end
 
@@ -60,18 +65,17 @@ describe 'Persistence' do
 
     it 'persists arrays' do
       article.comments << 1 << 2 << 3
-      Perpetuity[Article].insert article
-      Perpetuity[Article].find(article.id).comments.should eq [1, 2, 3]
+      mapper.insert article
+      mapper.find(mapper.id_for article).comments.should eq [1, 2, 3]
     end
 
     it 'persists arrays with unserializable objects in them' do
       comment = Comment.new('my comment')
       article.comments << comment
-      Perpetuity[Article].insert article
-      Perpetuity[Article].find(article.id).comments.first.tap do |persisted_comment|
-        persisted_comment.should be_a Comment
-        persisted_comment.body.should eq comment.body
-      end
+      mapper.insert article
+      persisted_comment = mapper.find(mapper.id_for article).comments.first
+      persisted_comment.should be_a Comment
+      persisted_comment.body.should eq comment.body
     end
   end
 
@@ -82,7 +86,7 @@ describe 'Persistence' do
 
     it 'saves and retrieves hashes' do
       user_mapper.insert user
-      user_mapper.find(user.id).name.should be == name_hash
+      user_mapper.find(user_mapper.id_for user).name.should be == name_hash
     end
   end
 
@@ -91,7 +95,7 @@ describe 'Persistence' do
     book = Book.new("My Title #{noise}")
 
     Perpetuity[Book].insert book
-    book.id.should eq "my-title-#{noise}"
+    Perpetuity[Book].id_for(book).should eq "my-title-#{noise}"
   end
 
   context 'with namespaced classes' do
@@ -102,7 +106,7 @@ describe 'Persistence' do
 
     it 'persists even with colons in the names' do
       mapper.insert person
-      person.should be_a Perpetuity::PersistedObject
+      mapper.persisted?(person).should be_true
     end
   end
 end

data/spec/integration/retrieval_spec.rb

@@ -4,23 +4,17 @@ require 'securerandom'
 
 describe "retrieval" do
   let(:mapper) { Perpetuity[Article] }
-
   it "gets all the objects of a class" do
     expect { mapper.insert Article.new }.
       to change { mapper.all.to_a.count }.by 1
   end
 
-  it "has an ID when retrieved" do
-    mapper.insert Article.new
-    mapper.first.should respond_to :id
-  end
-
   it "gets an item with a specific ID" do
     article = Article.new
     mapper.insert article
-    retrieved = mapper.find(article.id)
+    retrieved = mapper.find(mapper.id_for article)
 
-    retrieved.id.should eq article.id
+    mapper.id_for(retrieved).should be == mapper.id_for(article)
     retrieved.title.should eq article.title
     retrieved.body.should eq article.body
   end
@@ -61,6 +55,10 @@ describe "retrieval" do
   describe "Array-like syntax" do
     let(:draft) { Article.new 'Draft', 'draft content', nil, Time.now + 30 }
     let(:published) { Article.new 'Published', 'content', nil, Time.now - 30, 3 }
+
+    let(:published_id) { mapper.id_for published }
+    let(:draft_id) { mapper.id_for draft }
+
     before do
       mapper.insert draft
       mapper.insert published
@@ -68,57 +66,58 @@ describe "retrieval" do
 
     it 'selects objects using equality' do
       selected = mapper.select { |article| article.title == 'Published' }
-      selected.map(&:id).should include published.id
-      selected.map(&:id).should_not include draft.id
+      ids = selected.map { |article| mapper.id_for article }
+      ids.should include published_id
+      ids.should_not include draft_id
     end
 
     it 'selects objects using greater-than' do
       selected = mapper.select { |article| article.published_at < Time.now }
-      ids = selected.map(&:id)
-      ids.should include published.id
-      ids.should_not include draft.id
+      ids = selected.map { |article| mapper.id_for article }
+      ids.should include published_id
+      ids.should_not include draft_id
     end
 
     it 'selects objects using greater-than-or-equal' do
       selected = mapper.select { |article| article.views >= 3 }
-      ids = selected.map(&:id)
-      ids.should include published.id
-      ids.should_not include draft.id
+      ids = selected.map { |article| mapper.id_for article }
+      ids.should include published_id
+      ids.should_not include draft_id
     end
 
     it 'selects objects using less-than' do
       selected = mapper.select { |article| article.views < 3 }
-      ids = selected.map(&:id)
-      ids.should include draft.id
-      ids.should_not include published.id
+      ids = selected.map { |article| mapper.id_for article }
+      ids.should include draft_id
+      ids.should_not include published_id
     end
 
     it 'selects objects using less-than-or-equal' do
       selected = mapper.select { |article| article.views <= 0 }
-      ids = selected.map(&:id)
-      ids.should include draft.id
-      ids.should_not include published.id
+      ids = selected.map { |article| mapper.id_for article }
+      ids.should include draft_id
+      ids.should_not include published_id
     end
 
     it 'selects objects using inequality' do
       selected = mapper.select { |article| article.title != 'Draft' }
-      ids = selected.map(&:id)
-      ids.should_not include draft.id
-      ids.should include published.id
+      ids = selected.map { |article| mapper.id_for article }
+      ids.should_not include draft_id
+      ids.should include published_id
     end
 
     it 'selects objects using regular expressions' do
       selected = mapper.select { |article| article.title =~ /Pub/ }
-      ids = selected.map(&:id)
-      ids.should include published.id
-      ids.should_not include draft.id
+      ids = selected.map { |article| mapper.id_for article }
+      ids.should include published_id
+      ids.should_not include draft_id
     end
 
     it 'selects objects using inclusion' do
       selected = mapper.select { |article| article.title.in %w( Published ) }
-      ids = selected.map(&:id)
-      ids.should include published.id
-      ids.should_not include draft.id
+      ids = selected.map { |article| mapper.id_for article }
+      ids.should include published_id
+      ids.should_not include draft_id
     end
   end
 
@@ -171,7 +170,7 @@ describe "retrieval" do
 
     it 'gets a CRM::Person object back' do
       mapper.insert article
-      retrieved_article = mapper.find(article.id)
+      retrieved_article = mapper.find(mapper.id_for article)
       mapper.load_association! retrieved_article, :author
       retrieved_article.author.should be_a CRM::Person
     end
@@ -181,6 +180,8 @@ describe "retrieval" do
     user = User.new(first_name: 'foo', last_name: 'bar')
     mapper = Perpetuity[User]
     mapper.insert user
-    mapper.select { |user| user.name.first_name == 'foo' }.map(&:id).should include user.id
+    users = mapper.select { |user| user.name.first_name == 'foo' }
+    ids = users.map { |retrieved_user| mapper.id_for(retrieved_user) }
+    ids.should include mapper.id_for(user)
   end
 end

data/spec/integration/serialization_spec.rb

@@ -13,7 +13,7 @@ describe 'serialization' do
       'author' => {
         '__metadata__' => {
           'class' => author.class.to_s,
-          'id' => author.id
+          'id' => mapper.id_for(author)
         }
       },
       'comments' => [
@@ -25,7 +25,7 @@ describe 'serialization' do
           'author' => {
             '__metadata__' => {
               'class' => author.class.to_s,
-              'id' => author.id
+              'id' => mapper.id_for(author)
             }
           }
         },
@@ -49,7 +49,7 @@ describe 'serialization' do
   end
 
   it 'deserializes hashes into proper objects' do
-    unserialized = mapper.find article.id
+    unserialized = mapper.find mapper.id_for(article)
     unserialized.should be_a Article
     unserialized.title.should be == article.title
     unserialized.body.should be == article.body

data/spec/integration/update_spec.rb

@@ -12,7 +12,7 @@ describe 'updating' do
 
   it 'updates an object in the database' do
     mapper.update article, title: new_title
-    mapper.find(article.id).title.should eq new_title
+    mapper.find(mapper.id_for article).title.should eq new_title
   end
 
   it 'updates the object in memory' do
@@ -23,7 +23,7 @@ describe 'updating' do
   it 'resaves the object in the database' do
     article.title = new_title
     mapper.save article
-    mapper.find(article.id).title.should eq new_title
+    mapper.find(mapper.id_for article).title.should eq new_title
   end
 
   it 'updates an object with referenced attributes' do
@@ -31,11 +31,11 @@ describe 'updating' do
     article.author = user
     mapper.save article
 
-    retrieved_article = mapper.find(article.id)
+    retrieved_article = mapper.find(mapper.id_for article)
     retrieved_article.title = new_title
     mapper.save retrieved_article
 
-    retrieved_article = mapper.find(retrieved_article.id)
+    retrieved_article = mapper.find(mapper.id_for retrieved_article)
     retrieved_article.author.should be_a Perpetuity::Reference
   end
 
@@ -48,13 +48,13 @@ describe 'updating' do
 
     mapper.insert book
 
-    retrieved_book = mapper.find(book.id)
+    retrieved_book = mapper.find(mapper.id_for book)
     retrieved_book.authors << andy
     mapper.save retrieved_book
 
-    retrieved_authors = mapper.find(retrieved_book.id).authors
+    retrieved_authors = Perpetuity[Book].find(mapper.id_for retrieved_book).authors
     retrieved_authors.map(&:klass).should == [User, User]
-    retrieved_authors.map(&:id).should == [dave.id, andy.id]
+    retrieved_authors.map(&:id).should == [mapper.id_for(dave), mapper.id_for(andy)]
   end
 
   describe 'atomic increments/decrements' do
@@ -64,13 +64,13 @@ describe 'updating' do
     it 'increments attributes of objects in the database' do
       mapper.increment article, :views
       mapper.increment article, :views, 10
-      mapper.find(article.id).views.should == view_count + 11
+      mapper.find(mapper.id_for(article)).views.should == view_count + 11
     end
 
     it 'decrements attributes of objects in the database' do
       mapper.decrement article, :views
       mapper.decrement article, :views, 10
-      mapper.find(article.id).views.should == view_count - 11
+      mapper.find(mapper.id_for(article)).views.should == view_count - 11
     end
 
     context 'with an object with the specified attribute missing' do

data/spec/perpetuity/data_injectable_spec.rb

@@ -20,12 +20,12 @@ module Perpetuity
 
     it 'injects an id' do
       klass.inject_data object, { id: 1 }
-      object.id.should eq 1
+      object.instance_variable_get(:@id).should eq 1
     end
 
     it 'injects a specified id' do
       klass.give_id_to object, 2
-      object.id.should eq 2
+      object.instance_variable_get(:@id).should eq 2
     end
   end
 end