perpetuity 1.0.0.beta3 → 1.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cf95b4e9ae21a8017556d5928b72d0ce4a23e94
-  data.tar.gz: 0ac11a4957b4b6a8b3f991b35b726b0f0da1533f
+  metadata.gz: c67c2d6a7eed0f92f1b9878069d05697405363da
+  data.tar.gz: 21cddf8c8f2440bea99722e28fefeca46f9ba4f6
 SHA512:
-  metadata.gz: 07de997c8ddb238ae077bc8154a58e0d4f7a422c465bf4e98b303ecf6082701e5c1230cb70728b3e37d5124751c3b4ba90d55e44837d61407aac05a9eeb37bfd
-  data.tar.gz: 627e785dbb378e4e00e5de44645635f33d600376f19ed562eb906b19e265919a3ea13aaf24221df7a02dfb1fce1617ab12a85c67ff82c7350ac46c2da8e7a825
+  metadata.gz: eab30eabb92736be84697d75277242d77014f2fd71cf629fcec51b064f8a6f50a87e11643793773d49a8ca513f44cc9c9ae989d0ba1c8cebf1d4f94a6eb4edb5
+  data.tar.gz: b463f4b0a47ae396095b7d700b28bf3a5474a227a4ccb7b96ffa54a0175d39944d83b33012d1e0cc372d10f2df02e1a3f1623ceaf7eb3c03a9a8f6bc0c3b4004

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## Version 1.0.0.beta5
+
+- Don't stringify ids in `IdentityMap`. This should result in a little better performance. To be honest, I'm not even sure anymore why I put that in there.
+- Use the IdentityMap when retrieving multiple objects by id.
+
+## Version 1.0.0.beta4
+
+- Remove in-memory updating of objects using the `Mapper#update` method.
+- Separate dirty tracking from `IdentityMap` and return to a real Identity Map.
+- Pass IdentityMap around when loading associations
+- Add `Perpetuity.register_adapter` method to allow various data-source adapters to register without Perpetuity knowing about them.
+
 ## Version 1.0.0.beta3
 
 - Fix title-case -> snake-case support to convert something like `UserRegistration` to `user_registration`. Previously, it would return `userregistration`.

data/README.md

@@ -248,3 +248,11 @@ This will let Rails know how to talk to your models in the way that Perpetuity h
 ## Contributing
 
 There are plenty of opportunities to improve what's here and possibly some design decisions that need some more refinement. You can help. If you have ideas to build on this, send some love in the form of pull requests, issues or [tweets](http://twitter.com/jamie_gaskins) and I'll do what I can for them.
+
+Please be sure that the tests run before submitting a pull request. Just run `rspec`.
+
+The tests include integration with an adapter. By default, this is the MongoDB adapter, but you can change that to Postgres by setting the `PERPETUITY_ADAPTER` environment variable to `postgres`.
+
+When testing with the MongoDB adapter, you'll need to have MongoDB running. On Mac OS X, you can install MongoDB via Homebrew and start it with `mongod`. No configuration is necessary.
+
+When testing with the Postgres adapter, you'll need to have PostgreSQL running. On Mac OS X, you can install PostgreSQL via Homebrew and start it with `pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start`. No other configuration is necessary, as long as the user has rights to create a database. NOTE: The Postgres adapter is incomplete at this time, and the tests do not yet pass with this adapter.

data/lib/perpetuity.rb

@@ -5,6 +5,7 @@ require "perpetuity/mapper_registry"
 
 module Perpetuity
   def self.configure &block
+    register_standard_adapters
     detect_rails
     configuration.instance_exec(&block)
   end
@@ -31,8 +32,28 @@ module Perpetuity
     configure { data_source *args }
   end
 
+  def self.register_adapter adapters
+    config_adapters = Perpetuity::Configuration.adapters
+    adapters.each do |adapter_name, adapter_class|
+      if config_adapters.has_key?(adapter_name) && config_adapters[adapter_name] != adapter_class
+        raise "That adapter name has already been registered for #{config_adapters[adapter_name]}"
+      else
+        config_adapters[adapter_name] = adapter_class
+      end
+    end
+  end
+
+  private
+
   # Necessary to be able to check whether Rails is loaded and initialized
   def self.detect_rails
     require File.expand_path('../perpetuity/rails.rb', __FILE__) if defined? Rails
   end
+
+  # Necessary until these adapters are updated to register themselves.
+  def self.register_standard_adapters
+    Perpetuity.register_adapter :mongodb => Perpetuity::MongoDB if defined?(Perpetuity::MongoDB)
+    Perpetuity.register_adapter :postgres => Perpetuity::Postgres if defined?(Perpetuity::Postgres)
+    Perpetuity.register_adapter :dynamodb => Perpetuity::DynamoDB if defined?(Perpetuity::DynamoDB)
+  end
 end

data/lib/perpetuity/config.rb

@@ -14,7 +14,7 @@ module Perpetuity
           adapter = args.shift
           db_name = args.shift
           options = args.shift || {}
-          adapter_class = Perpetuity.const_get(adapter(adapter))
+          adapter_class = adapter(adapter)
 
           @db = adapter_class.new(options.merge(db: db_name))
         end
@@ -28,7 +28,7 @@ module Perpetuity
       options = args.shift || {}
 
       protocol = uri.scheme
-      klass = Perpetuity.const_get(adapter(protocol))
+      klass = adapter(protocol)
       db_options = {
         db: uri.path[1..-1],
         username: uri.user,
@@ -44,11 +44,7 @@ module Perpetuity
     end
 
     def self.adapters
-      @adapters ||= {
-        dynamodb: 'DynamoDB',
-        mongodb:  'MongoDB',
-        postgres: 'Postgres',
-      }
+      @adapters ||= {}
     end
 
     def adapter name

data/lib/perpetuity/dereferencer.rb

@@ -5,8 +5,8 @@ module Perpetuity
   class Dereferencer
     attr_reader :map, :mapper_registry
 
-    def initialize mapper_registry
-      @map = IdentityMap.new
+    def initialize mapper_registry, identity_map=IdentityMap.new
+      @map = identity_map
       @mapper_registry = mapper_registry
     end
 
@@ -37,13 +37,11 @@ module Perpetuity
     def objects klass, ids
       ids = ids.uniq
       if ids.one?
-        mapper_registry[klass].find(ids.first)
+        mapper_registry.mapper_for(klass, identity_map: map).find(ids.first)
       elsif ids.none?
         []
       else
-        mapper_registry[klass].select { |object|
-          object.id.in ids.uniq
-        }.to_a
+        mapper_registry[klass].find(ids.uniq).to_a
       end
     end
 

data/lib/perpetuity/dirty_tracker.rb

@@ -0,0 +1,19 @@
+require 'perpetuity/duplicator'
+
+module Perpetuity
+  class DirtyTracker
+    def initialize
+      @map = Hash.new { |hash, key| hash[key] = {} }
+    end
+
+    def [] klass, id
+      @map[klass][id.to_s]
+    end
+
+    def << object
+      klass = object.class
+      id = object.instance_variable_get(:@id)
+      @map[klass][id.to_s] = object.dup
+    end
+  end
+end

data/lib/perpetuity/identity_map.rb

@@ -1,19 +1,21 @@
 module Perpetuity
   class IdentityMap
-    attr_reader :map
-
     def initialize
       @map = Hash.new { |hash, key| hash[key] = {} }
     end
 
     def [] klass, id
-      map[klass][id.to_s]
+      @map[klass][id]
     end
 
     def << object
       klass = object.class
       id = object.instance_variable_get(:@id)
-      map[klass][id.to_s] = object.dup
+      @map[klass][id] = object
+    end
+
+    def ids_for klass
+      @map[klass].keys
     end
   end
 end

data/lib/perpetuity/mapper.rb

@@ -3,16 +3,17 @@ require 'perpetuity/attribute'
 require 'perpetuity/data_injectable'
 require 'perpetuity/dereferencer'
 require 'perpetuity/retrieval'
-require 'perpetuity/duplicator'
+require 'perpetuity/dirty_tracker'
 
 module Perpetuity
   class Mapper
     include DataInjectable
-    attr_reader :mapper_registry, :identity_map
+    attr_reader :mapper_registry, :identity_map, :dirty_tracker
 
-    def initialize registry=Perpetuity.mapper_registry
+    def initialize registry=Perpetuity.mapper_registry, id_map=IdentityMap.new
       @mapper_registry = registry
-      @identity_map = IdentityMap.new
+      @identity_map = id_map
+      @dirty_tracker = DirtyTracker.new
     end
 
     def self.map klass, registry=Perpetuity.mapper_registry
@@ -128,17 +129,27 @@ module Perpetuity
 
     alias :find_all :select
 
-    def find id=nil, cache_result=true, &block
+    def find id=nil, &block
       if block_given?
         select(&block).first
       else
         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 << Duplicator.new(result).object
+        result = if id.is_a? Array
+                   ids = id
+                   ids_in_map = ids & identity_map.ids_for(mapped_class)
+                   ids_to_select = ids - ids_in_map
+                   retrieved = select { |object| object.id.in ids_to_select }.to_a
+                   from_map = ids_in_map.map { |id| identity_map[mapped_class, id] }
+                   retrieved + from_map
+                 else
+                   select { |object| object.id == id }.first
+                 end
+
+        Array(result).each do |r|
+          identity_map << r
+          dirty_tracker << r
         end
 
         result
@@ -158,7 +169,7 @@ module Perpetuity
 
     def load_association! object, attribute
       objects = Array(object)
-      dereferencer = Dereferencer.new(mapper_registry)
+      dereferencer = Dereferencer.new(mapper_registry, identity_map)
       dereferencer.load objects.map { |obj| obj.instance_variable_get("@#{attribute}") }
 
       objects.each do |obj|
@@ -185,10 +196,8 @@ module Perpetuity
       end
     end
 
-    def update object, new_data, update_in_memory = true
+    def update object, new_data
       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
     end
 
@@ -197,7 +206,7 @@ module Perpetuity
       if changed_attributes && changed_attributes.any?
         update object, changed_attributes
       else
-        update object, serialize(object), false
+        update object, serialize(object)
       end
     end
 
@@ -237,7 +246,7 @@ module Perpetuity
     end
 
     def serialize_changed_attributes object
-      cached = identity_map[object.class, id_for(object)]
+      cached = dirty_tracker[object.class, id_for(object)]
       if cached
         data_source.serialize_changed_attributes(object, cached, self)
       end

data/lib/perpetuity/mapper_registry.rb

@@ -11,15 +11,22 @@ module Perpetuity
     end
 
     def [] klass
-      mapper_class = @mappers.fetch(klass) do
+      mapper_class(klass).new(self)
+    end
+
+    def mapper_for klass, options={}
+      identity_map = options[:identity_map]
+      mapper_class(klass).new(self, *Array(identity_map))
+    end
+
+    def mapper_class klass
+      @mappers.fetch(klass) do
         load_mappers
         unless @mappers.has_key? klass
           raise KeyError, "No mapper for #{klass}"
         end
         @mappers[klass]
       end
-
-      mapper_class.new(self)
     end
 
     def []= klass, mapper

data/lib/perpetuity/version.rb

@@ -1,3 +1,3 @@
 module Perpetuity
-  VERSION = "1.0.0.beta3"
+  VERSION = "1.0.0.beta5"
 end

data/spec/integration/update_spec.rb

@@ -15,11 +15,6 @@ describe 'updating' do
     mapper.find(mapper.id_for article).title.should eq new_title
   end
 
-  it 'updates the object in memory' do
-    mapper.update article, title: new_title
-    article.title.should eq new_title
-  end
-
   it 'resaves the object in the database' do
     article.title = new_title
     mapper.save article

data/spec/perpetuity/dereferencer_spec.rb

@@ -16,6 +16,10 @@ module Perpetuity
       it 'loads objects based on the specified objects and attribute' do
         first.instance_variable_set :@id, 1
         mapper.should_receive(:find).with(1) { first }
+        id_map = IdentityMap.new
+        derefer.stub(map: id_map)
+        registry.stub(:mapper_for)
+                .with(Object, identity_map: id_map) { mapper }
 
         derefer.load first_ref
         id = derefer[first_ref].instance_variable_get(:@id)
@@ -31,9 +35,7 @@ module Perpetuity
 
     context 'with multiple references' do
       it 'returns the array of dereferenced objects' do
-        first.instance_variable_set :@id, 1
-        second.instance_variable_set :@id, 2
-        mapper.should_receive(:select) { objects }
+        mapper.should_receive(:find).with([1, 2]) { objects }
         derefer.load([first_ref, second_ref]).should == objects
       end
     end

data/spec/perpetuity/dirty_tracker_spec.rb

@@ -0,0 +1,49 @@
+require 'perpetuity/dirty_tracker'
+
+module Perpetuity
+  describe DirtyTracker do
+    let(:mapper) { double('ObjectMapper') }
+    let(:tracker) { DirtyTracker.new }
+
+    context 'when the object exists in the IdentityMap' do
+      let(:klass) do
+        Class.new do
+          attr_accessor :id, :name
+          def initialize id, name
+            @id = id
+            @name = name
+          end
+        end
+      end
+      let(:object) { klass.new(1, 'foo') }
+
+      before do
+        mapper.stub(:id_for).with(object) { object.id }
+        tracker << object
+      end
+
+      it 'returns the object with the given class and id' do
+        object.name = 'bar'
+        retrieved = tracker[klass, 1]
+
+        retrieved.id.should == 1
+        retrieved.name.should == 'foo'
+      end
+
+      specify 'the object returned is a duplicate' do
+        tracker[klass, 1].should_not be object
+      end
+
+      it 'stringifies keys when checking' do
+        retrieved = tracker[klass, '1']
+        retrieved.id.should == 1
+      end
+    end
+
+    context 'when the object does not exist in the IdentityMap' do
+      it 'returns nil' do
+        tracker[Object, 1].should be_nil
+      end
+    end
+  end
+end

data/spec/perpetuity/identity_map_spec.rb

@@ -3,28 +3,29 @@ require 'perpetuity/identity_map'
 module Perpetuity
   describe IdentityMap do
     let(:id_map) { IdentityMap.new }
+    let(:klass) do
+      Class.new do
+        attr_reader :id
+        def initialize id
+          @id = id
+        end
+      end
+    end
+    let(:object) { klass.new(1) }
 
     context 'when the object exists in the IdentityMap' do
-      let(:object) { Object.new }
-
       before do
-        object.instance_variable_set :@id, 1
         id_map << object
       end
 
       it 'returns the object with the given class and id' do
-        retrieved = id_map[Object, 1]
+        retrieved = id_map[klass, 1]
 
-        retrieved.instance_variable_get(:@id).should == 1
+        retrieved.id.should == 1
       end
 
-      specify 'the object returned is a duplicate, not the same object' do
-        id_map[Object, 1].should_not be object
-      end
-
-      it 'stringifies keys when checking' do
-        retrieved = id_map[Object, '1']
-        retrieved.instance_variable_get(:@id).should == 1
+      specify 'the object returned is the same object' do
+        id_map[klass, 1].should be object
       end
     end
 
@@ -33,5 +34,10 @@ module Perpetuity
         id_map[Object, 1].should be_nil
       end
     end
+
+    it 'returns all of the ids it contains' do
+      id_map << object
+      id_map.ids_for(klass).should == [1]
+    end
   end
 end

data/spec/perpetuity/mapper_registry_spec.rb

@@ -1,9 +1,10 @@
 require 'perpetuity/mapper_registry'
+require 'perpetuity/mapper'
 
 module Perpetuity
   describe MapperRegistry do
     let(:registry) { MapperRegistry.new }
-    let(:mapper) { Class.new { def initialize(map_reg); end } }
+    let(:mapper) { Mapper }
     subject { registry }
 
     before { registry[Object] = mapper }
@@ -30,5 +31,11 @@ module Perpetuity
         registry.load_mappers
       end
     end
+
+    it 'returns a mapper initialized with the specified identity map' do
+      identity_map = double('IdentityMap')
+      mapper = registry.mapper_for(Object, identity_map: identity_map)
+      mapper.identity_map.should be identity_map
+    end
   end
 end

data/spec/perpetuity/mapper_spec.rb

@@ -71,6 +71,17 @@ module Perpetuity
           mapper.find(1).should be == returned_object
         end
 
+        it 'finds multiple objects by ID' do
+          first, second = double, double
+          criteria = data_source.query { |o| o.id.in [1, 2] }
+          options.merge! limit: nil
+          data_source.should_receive(:retrieve)
+                     .with(Object, criteria, options)
+                     .and_return [first, second]
+
+          mapper.find([1, 2]).to_a.should be == [first, second]
+        end
+
         it 'finds multiple objects with a block' do
           criteria = data_source.query { |o| o.name == 'foo' }
           options = self.options.merge(limit: nil)
@@ -132,7 +143,7 @@ module Perpetuity
         object.instance_variable_set :@id, 1
         object.instance_variable_set :@modified, false
         object.instance_variable_set :@unmodified, false
-        mapper.identity_map << object
+        mapper.dirty_tracker << object
 
         object.instance_variable_set :@modified, true
 
@@ -196,5 +207,14 @@ module Perpetuity
         end
       end
     end
+
+    describe 'using an existing identity map' do
+      it 'is initialized with an existing map' do
+        registry = Object.new
+        id_map = Object.new
+        mapper = Mapper.new(registry, id_map)
+        mapper.identity_map.should be id_map
+      end
+    end
   end
 end

data/spec/perpetuity_spec.rb

@@ -49,4 +49,28 @@ describe Perpetuity do
       unpublished_ids.should include draft_id, not_yet_published_id
     end
   end
+
+  describe 'adapter registration' do
+    before do
+      class ExampleAdapter; end
+    end
+
+    it 'registers an adapter' do
+      Perpetuity.register_adapter :example => ExampleAdapter
+      Perpetuity::Configuration.adapters[:example].should == ExampleAdapter
+    end
+
+    it 'can re-register an adapter' do
+      Perpetuity.register_adapter :example => ExampleAdapter
+      Perpetuity.register_adapter :example => ExampleAdapter
+      Perpetuity::Configuration.adapters[:example].should == ExampleAdapter
+    end
+
+    it 'cannot re-register an adapter with a different class than originally registered' do
+      Perpetuity.register_adapter :example => ExampleAdapter
+      expect { Perpetuity.register_adapter :example => TrueClass }.to raise_exception
+      Perpetuity::Configuration.adapters[:example].should == ExampleAdapter
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perpetuity
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.beta5
 platform: ruby
 authors:
 - Jamie Gaskins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,6 +59,7 @@ files:
 - lib/perpetuity/config.rb
 - lib/perpetuity/data_injectable.rb
 - lib/perpetuity/dereferencer.rb
+- lib/perpetuity/dirty_tracker.rb
 - lib/perpetuity/duplicator.rb
 - lib/perpetuity/exceptions/duplicate_key_error.rb
 - lib/perpetuity/identity_map.rb
@@ -84,6 +85,7 @@ files:
 - spec/perpetuity/config_spec.rb
 - spec/perpetuity/data_injectable_spec.rb
 - spec/perpetuity/dereferencer_spec.rb
+- spec/perpetuity/dirty_tracker_spec.rb
 - spec/perpetuity/duplicator_spec.rb
 - spec/perpetuity/identity_map_spec.rb
 - spec/perpetuity/mapper_registry_spec.rb
@@ -143,6 +145,7 @@ test_files:
 - spec/perpetuity/config_spec.rb
 - spec/perpetuity/data_injectable_spec.rb
 - spec/perpetuity/dereferencer_spec.rb
+- spec/perpetuity/dirty_tracker_spec.rb
 - spec/perpetuity/duplicator_spec.rb
 - spec/perpetuity/identity_map_spec.rb
 - spec/perpetuity/mapper_registry_spec.rb