entity_store 0.0.7 → 0.0.8

data/lib/entity_store/attributes.rb

@@ -0,0 +1,18 @@
+module EntityStore
+  module Attributes
+    def self.included(klass)
+      klass.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def entity_value_attribute(name, klass)
+        define_method(name) { instance_variable_get("@#{name}") }
+        define_method("#{name}=") do |value|
+          instance_variable_set("@#{name}", value.is_a?(Hash) ? klass.new(value) : value)
+        end
+      end
+    end
+  end
+end

data/lib/entity_store/entity.rb

@@ -2,14 +2,10 @@ module EntityStore
   module Entity
     attr_accessor :id
     
-    # Holds a reference to the store used to load this entity so the same store
-    # can be used for related entities
-    attr_accessor :related_entity_loader
-
-    attr_writer :version
-
     def self.included(klass)
       klass.class_eval do
+        include HashSerialization
+        include Attributes
         extend ClassMethods
       end
     end
@@ -24,8 +20,8 @@ module EntityStore
 
           # lazy loader for related entity
           define_method(name) {
-            if instance_variable_get("@#{name}_id") && related_entity_loader
-              instance_variable_get("@_#{name}") || instance_variable_set("@_#{name}", related_entity_loader.get(instance_variable_get("@#{name}_id")))
+            if instance_variable_get("@#{name}_id") && @_related_entity_loader
+              instance_variable_get("@_#{name}") || instance_variable_set("@_#{name}", @_related_entity_loader.get(instance_variable_get("@#{name}_id")))
             end
           }
         end
@@ -37,22 +33,32 @@ module EntityStore
 
     end
 
-    def initialize(attr={})
-      attr.each_pair { |k,v| self.send("#{k}=", v) }
-    end
-    
     def type
       self.class.name
     end
   
     def version
-      @version ||= 1
+      @_version ||= 1
     end
-  
+
+    def version=(value)
+      @_version = value
+    end
+
+    # Holds a reference to the store used to load this entity so the same store
+    # can be used for related entities
+    def related_entity_loader=(value)
+      @_related_entity_loader = value
+    end
+    
     def pending_events
       @pending_events ||= []
     end
   
+    def clear_pending_events
+      @pending_events = []  
+    end
+
     def record_event(event)
       apply_event(event)
       pending_events<<event
@@ -61,5 +67,6 @@ module EntityStore
     def apply_event(event)
       event.apply(self)
     end
+
   end
 end

data/lib/entity_store/entity_value.rb

@@ -2,21 +2,11 @@ module EntityStore
   module EntityValue
     def self.included(klass)
       klass.class_eval do
-        extend ClassMethods
+        include HashSerialization
+        include Attributes
       end
     end
 
-    def initialize(attr={})
-      attr.each_pair { |k,v| self.send("#{k}=", v) if self.respond_to? "#{k}=" }
-    end
-
-    def attributes
-      Hash[*public_methods.select {|m| m =~ /\w\=$/}.collect do |m|
-        attribute_name = m.to_s.chop.to_sym
-        [attribute_name, send(attribute_name).respond_to?(:attributes) ? send(attribute_name).attributes : send(attribute_name)]
-      end.flatten]
-    end
-
     def ==(other)
       attributes.each_key do |attr|
         return false unless other.respond_to?(attr) && send(attr) == other.send(attr)
@@ -24,13 +14,5 @@ module EntityStore
       return true
     end
 
-    module ClassMethods
-      def entity_value_attribute(name, klass)
-        define_method(name) { instance_variable_get("@#{name}") }
-        define_method("#{name}=") do |value|
-          instance_variable_set("@#{name}", value.is_a?(Hash) ? klass.new(value) : value)
-        end
-      end
-    end
   end
 end

data/lib/entity_store/event.rb

@@ -2,9 +2,11 @@ module EntityStore
   module Event
     attr_accessor :entity_id, :entity_version
 
-    def initialize(attrs={})
-      attrs.each_pair do |key, value|
-        send("#{key}=", value) if respond_to?("#{key}=")
+    def self.included(klass)
+      klass.class_eval do
+        include Attributes
+        include HashSerialization
+        extend ClassMethods
       end
     end
 
@@ -17,19 +19,6 @@ module EntityStore
          downcase
     end
 
-    def attributes
-      Hash[*public_methods.select {|m| m =~ /\w\=$/}.collect do |m|
-        attribute_name = m.to_s.chop.to_sym
-        [attribute_name, send(attribute_name).respond_to?(:attributes) ? send(attribute_name).attributes : send(attribute_name)]
-      end.flatten]
-    end
-
-    def self.included(klass)
-      klass.class_eval do
-        extend ClassMethods
-      end
-    end
-
     module ClassMethods
       def time_attribute(*names)
         class_eval do

data/lib/entity_store/hash_serialization.rb

@@ -0,0 +1,32 @@
+module EntityStore
+  module HashSerialization
+
+    def initialize(attr={})
+      attr.each_pair { |k,v| send("#{k}=", v) if respond_to?("#{k}=") }
+    end
+
+    # Public - generate attributes hash 
+    # did use flatten but this came a-cropper when the attribute value was an array
+    def attributes
+      attrs = {}
+      public_methods
+        .select { |m| m =~ /\w\=$/ }
+        .select { |m| respond_to?(m.to_s.chop) }
+        .collect { |m| m.to_s.chop.to_sym }
+        .collect { |m| [m, attribute_value(send(m))] }
+        .each do |item| attrs[item[0]] = item[1] end
+      attrs
+    end
+
+    def attribute_value(value)
+      if value.respond_to?(:attributes)
+        value.attributes
+      elsif value.respond_to?(:each)
+        value.collect { |v| attribute_value(v) }
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/entity_store/mongo_entity_store.rb

@@ -28,7 +28,8 @@ module EntityStore
     end
 
     def ensure_indexes
-      events_collection.ensure_index([['entity_id', Mongo::ASCENDING], ['_id', Mongo::ASCENDING]])
+      events.ensure_index([['entity_id', Mongo::ASCENDING], ['_id', Mongo::ASCENDING]])
+      events.ensure_index([['entity_id', Mongo::ASCENDING], ['entity_version', Mongo::ASCENDING], ['_id', Mongo::ASCENDING]])
     end
 
     def add_entity(entity)
@@ -39,6 +40,20 @@ module EntityStore
       entities.update({'_id' => BSON::ObjectId.from_string(entity.id)}, { '$set' => { 'version' => entity.version } })
     end
 
+    # Public - create a snapshot of the entity and store in the entities collection
+    # 
+    def snapshot_entity(entity)
+      query = {'_id' => BSON::ObjectId.from_string(entity.id)}
+      updates = { '$set' => { 'snapshot' => entity.attributes } }
+      entities.update(query, updates, { :upsert => true} )
+    end
+
+    # Public - remove the snapshot for an entity
+    # 
+    def remove_entity_snapshot(id)
+      entities.update({'_id' => BSON::ObjectId.from_string(id)}, { '$unset' => { 'snapshot' => 1}})
+    end
+
     def add_event(event)
       events.insert({'_type' => event.class.name, '_entity_id' => BSON::ObjectId.from_string(event.entity_id) }.merge(event.attributes) ).to_s
     end
@@ -47,28 +62,44 @@ module EntityStore
       get_entity(id, true)
     end
 
+    # Public - loads the entity from the store, including any available snapshots
+    # then loads the events to complete the state
+    # 
+    # id                - String representation of BSON::ObjectId
+    # raise_exception   - Boolean indicating whether to raise an exception if not found (default=false)
+    # 
+    # Returns an object of the entity type
     def get_entity(id, raise_exception=false)
-      begin
-        if attrs = entities.find('_id' => BSON::ObjectId.from_string(id)).first
-          get_type_constant(attrs['_type']).new('id' => id, 'version' => attrs['version'])
-        else
-          if raise_exception
-            raise NotFound.new(id)
-          else
-            return nil
-          end
-        end
-      rescue BSON::InvalidObjectId
-        if raise_exception
-          raise NotFound.new(id)
-        else
-          return nil
+      if attrs = entities.find_one('_id' => BSON::ObjectId.from_string(id))
+        entity = get_type_constant(attrs['_type']).new(attrs['snapshot'] || {'id' => id, 'version' => attrs['version']})
+
+        since_version = attrs['snapshot'] ? attrs['snapshot']['version'] : nil
+
+        get_events(id, since_version).each do |e| 
+          e.apply(entity) 
+          entity.version = e.entity_version
         end
+
+        entity
+      else
+        raise NotFound.new(id) if raise_exception
+        nil
       end
+    rescue BSON::InvalidObjectId
+      raise NotFound.new(id) if raise_exception
+      nil
     end
 
-    def get_events(id)
-      events.find('_entity_id' => BSON::ObjectId.from_string(id)).collect do |attrs|
+    def get_events(id, since_version=nil)
+
+      query = { '_entity_id' => BSON::ObjectId.from_string(id) }
+      query['entity_version'] = { '$gt' => since_version } if since_version
+
+      options = {
+        :sort => [['entity_version', Mongo::ASCENDING], ['_id', Mongo::ASCENDING]]
+      }
+
+      events.find(query, options).collect do |attrs|
         begin
           get_type_constant(attrs['_type']).new(attrs)
         rescue => e

data/lib/entity_store/store.rb

@@ -1,7 +1,7 @@
 module EntityStore
   class Store
     def storage_client
-      @storage_client || MongoEntityStore.new
+      @_storage_client ||= MongoEntityStore.new
     end
 
     def add(entity)
@@ -29,6 +29,7 @@ module EntityStore
           entity.id = storage_client.add_entity(entity)
         end
         add_events(entity)
+        snapshot_entity(entity) if entity.version % EntityStore.snapshot_threshold == 0
       end
       entity
     rescue => e
@@ -36,6 +37,15 @@ module EntityStore
       raise e
     end
 
+    def snapshot_entity(entity)
+      EntityStore.logger.info { "Store#snapshot_entity : Snapshotting #{entity.id}"}
+      storage_client.snapshot_entity(entity)
+    end
+
+    def remove_entity_snapshot(id)
+      storage_client.remove_entity_snapshot(id)
+    end
+
     def add_events(entity)
       entity.pending_events.each do |e|
         e.entity_id = entity.id.to_s
@@ -43,6 +53,7 @@ module EntityStore
         storage_client.add_event(e)
       end
       entity.pending_events.each {|e| EventBus.publish(entity.type, e) }
+      entity.clear_pending_events
     end
 
     def get!(id)
@@ -51,7 +62,6 @@ module EntityStore
 
     def get(id, raise_exception=false)
       if entity = storage_client.get_entity(id, raise_exception)
-        storage_client.get_events(id).each { |e| e.apply(entity) }
         # assign this entity loader to allow lazy loading of related entities
         entity.related_entity_loader = self
       end
@@ -64,7 +74,7 @@ module EntityStore
     def clear_all
       storage_client.entities.drop
       storage_client.events.drop
-      @storage_client = nil
+      @_storage_client = nil
     end
 
   end

data/lib/entity_store/version.rb

@@ -1,3 +1,3 @@
 module EntityStore
-  VERSION = "0.0.7".freeze
+  VERSION = "0.0.8".freeze
 end

data/lib/entity_store.rb

@@ -9,6 +9,8 @@ module EntityStore
   require 'entity_store/mongo_entity_store'
   require 'entity_store/event_bus'
   require 'entity_store/not_found'
+  require 'entity_store/hash_serialization'
+  require 'entity_store/attributes'
 
   class << self
     def setup
@@ -35,6 +37,16 @@ module EntityStore
       @_event_subscribers ||=[]
     end
     
+    # Public - indicates the version increment that is used to 
+    # decided whether a snapshot of an entity should be created when it's saved
+    def snapshot_threshold
+      @_snapshot_threshold ||= 10
+    end
+
+    def snapshot_threshold=(value)
+      @_snapshot_threshold = value
+    end
+
     def log_level
       @_log_level ||= Logger::INFO
     end

data/spec/entity_store/entity_spec.rb

@@ -5,6 +5,8 @@ class DummyEntity
 
   related_entities :club, :user
 
+  attr_accessor :name, :description, :members
+
 end
 
 describe Entity do
@@ -66,4 +68,18 @@ describe Entity do
       end
     end
   end
+
+  describe "#attributes" do
+    before(:each) do
+      @entity = DummyEntity.new(:id => @id = random_object_id, :club_id => @club_id = random_string, 
+        :user_id => @user_id = random_string, :name => @name = random_string, :version => @version = random_integer,
+        :members => [])
+    end
+
+    subject { @entity.attributes }
+
+    it "returns a hash of the attributes" do
+      subject.should eq({:id => @id, :version => @version, :name => @name, :club_id => @club_id, :user_id => @user_id, :description => nil, :members => []})
+    end
+  end
 end

data/spec/entity_store/entity_value_spec.rb

@@ -32,8 +32,11 @@ describe EntityValue do
     before(:each) do
       @value = DummyEntityValue.new(:name => @name, :home => @home)
     end
-    it "should return hash of attributes" do
-      @value.attributes.should eq({:name => @name, :home => @home})
+
+    subject { @value.attributes }
+
+    it "should return hash of attributes and type" do
+      subject.should eq({:name => @name, :home => @home})
     end
     context "nested attributes" do
       before(:each) do
@@ -42,8 +45,9 @@ describe EntityValue do
         @value.home = NestedEntityValue.new(:street => @street, :town => @town)
       end
       it "should return a hash containing the nested attribute" do
-        @value.attributes.should eq({:name => @name, :home => {:street => @street, :town => @town}})
+        subject.should eq({:name => @name, :home => {:street => @street, :town => @town}})
       end
+
     end
     
   end

data/spec/entity_store/external_store_spec.rb

@@ -94,4 +94,5 @@ describe ExternalStore do
     end
 
   end
+
 end

data/spec/entity_store/mongo_entity_store_spec.rb

@@ -7,12 +7,80 @@ module Level1
   end
 end
 
+module MongoEntityStoreSpec
+  class DummyEntity
+    include Entity
+
+    attr_accessor :name, :description
+
+  end
+end
+
 describe MongoEntityStore do
   before(:each) do
     EntityStore.connection_profile = "mongodb://localhost/entity_store_default"
     @store = MongoEntityStore.new
   end
+
+  describe "#get_entity" do
+    before(:each) do
+      @id = random_object_id
+      @attrs = { 
+        '_type' => "MongoEntityStoreSpec::DummyEntity", 
+        'version' => @version = random_integer
+      }
+      @entity = MongoEntityStoreSpec::DummyEntity.new
+      MongoEntityStoreSpec::DummyEntity.stub(:new) { @entity }
+      @entities_collection = mock('MongoCollection', :find_one => @attrs)
+      @store.stub(:entities) { @entities_collection }
+      @events = [
+        mock('Event', :apply => true, :entity_version => random_integer), mock('Event', :apply => true, :entity_version => random_integer)
+      ]
+      @store.stub(:get_events) { @events }
+    end
+
+    subject { @store.get_entity(@id) }
+
+    it "should attempt to retrieve the entity record from the store" do
+      @entities_collection.should_receive(:find_one).with({'_id' => BSON::ObjectId.from_string(@id)})
+      subject
+    end
+    it "should construct a new entity" do
+      MongoEntityStoreSpec::DummyEntity.should_receive(:new).with({'id' => @id, 'version' => @version})
+      subject
+    end
+    it "should retrieve it's events" do
+      @store.should_receive(:get_events).with(@id, nil)
+      subject
+    end
+    it "should apply each event to the entity" do
+      @events.each do |event| event.should_receive(:apply).with(@entity) end
+      subject
+    end
+    it "should set the entity version to that of the last event" do
+      subject
+      @entity.version.should eq(@events.last.entity_version)
+    end
+    context "when a snapshot exists" do
+      before(:each) do
+        @attrs['snapshot'] = {
+          'version' => @snapshot_version = random_integer,
+          'name' => @name = random_string
+        }
+      end
+      it "should construct a new entity with from the snapshot" do
+        MongoEntityStoreSpec::DummyEntity.should_receive(:new).with(@attrs['snapshot'])
+        subject
+      end
+      it "should load the events since the snapshot version" do
+         @store.should_receive(:get_events).with(@id, @snapshot_version)
+         subject
+      end
+    end
+  end
+
   describe "#get_entity!" do
+
     context "when invalid id format passed" do
       
       subject { @store.get_entity!(random_string) }
@@ -22,9 +90,6 @@ describe MongoEntityStore do
       end
     end
     context "when valid id format passed but no object exists" do
-      before(:each) do
-        @store = MongoEntityStore.new
-      end
       
       subject { @store.get_entity!(random_object_id) }
       
@@ -43,4 +108,21 @@ describe MongoEntityStore do
       subject.should eq(Level1::Level2::MyClass)
     end
   end
+
+  describe "#snapshot_entity" do
+    before(:each) do
+      @entity = MongoEntityStoreSpec::DummyEntity.new(:id => random_object_id, :version => random_integer, :name => random_string)
+    end
+
+    subject { @store.snapshot_entity(@entity) }
+
+    it "should add a snaphot to the entity record" do
+      subject 
+      saved_entity = @store.entities.find_one({'_id' => BSON::ObjectId.from_string(@entity.id)})['snapshot']
+      saved_entity['id'].should eq(@entity.id)
+      saved_entity['version'].should eq(@entity.version)
+      saved_entity['name'].should eq(@entity.name)
+      saved_entity['description'].should eq(@entity.description)
+    end
+  end
 end

data/spec/entity_store/store_spec.rb

@@ -79,6 +79,7 @@ describe Store do
     context "when entity has related entities loaded" do
       before(:each) do
         @entity = DummyEntityForStore.new(:id => random_string)
+        @entity.version = random_integer * EntityStore.snapshot_threshold + 1
         @store = Store.new
         @related_entity = mock('Entity')
         @entity.stub(:loaded_related_entities) { [ @related_entity ] }
@@ -96,13 +97,13 @@ describe Store do
         subject
       end
     end
-
   end
 
   describe "#do_save" do
     before(:each) do
       @new_id = random_string
       @entity = DummyEntityForStore.new(:id => random_string)
+      @entity.version = random_integer * EntityStore.snapshot_threshold
       @storage_client = mock("StorageClient", :save_entity => true)
       @store = Store.new
       @store.stub(:add_events)
@@ -113,8 +114,7 @@ describe Store do
     subject { @store.do_save(@entity) }
 
     it "increments the entity version number" do
-      @entity.should_receive(:version=).with(@entity.version + 1)
-      subject
+      expect { subject }.to change { @entity.version }.by 1
     end
     it "save the new entity to the store" do
       @storage_client.should_receive(:save_entity).with(@entity)
@@ -127,6 +127,11 @@ describe Store do
     it "returns a reference to the entity" do
       subject.should eq(@entity)
     end
+    it "should not snapshot the entity" do
+      @store.should_not_receive(:snapshot_entity)
+      subject
+    end
+
     context "when no pending events" do
       before(:each) do
         @entity.stub(:pending_events) { [] }
@@ -140,6 +145,7 @@ describe Store do
         subject
       end
     end
+
     context "when entity doesn't have an id" do
       before(:each) do
         @entity.id = nil
@@ -151,13 +157,25 @@ describe Store do
         subject
       end
     end
+
+    context "when entity version is commensurate with snapshotting" do
+      before(:each) do
+        @entity.version = random_integer * EntityStore.snapshot_threshold - 1
+      end
+
+      it "should snapshot the entity" do
+        @storage_client.should_receive(:snapshot_entity).with(@entity)
+        subject
+      end
+    end
+
   end
 
   describe "#get" do
     before(:each) do
       @id = random_integer
       @entity = DummyEntityForStore.new
-      DummyEntityForStore.stub(:new).and_return(@ride)
+      DummyEntityForStore.stub(:new).and_return(@entity)
       @events = [mock("Event", :apply => true), mock("Event", :apply => true)]
 
       @storage_client = mock("StorageClient", :get_entity => @entity, :get_events => @events)
@@ -171,18 +189,9 @@ describe Store do
       @storage_client.should_receive(:get_entity).with(@id, false)
       subject
     end
-    it "should retrieve the events for the entity" do
-      @storage_client.should_receive(:get_events).with(@id)
-      subject
-    end
-    it "should apply each event" do
-      @events.each do |e|
-        e.should_receive(:apply).with(@entity)
-      end
-      subject
-    end
     it "should assign itself as the related_entity_loader" do
-      subject.related_entity_loader.should eq(@store)
+      @entity.should_receive(:related_entity_loader=).with(@store)
+      subject
     end
     it "should return a ride" do
       subject.should eq(@entity)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: entity_store
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-13 00:00:00.000000000 Z
+date: 2012-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -49,6 +49,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/entity_store/attributes.rb
 - lib/entity_store/config.rb
 - lib/entity_store/entity.rb
 - lib/entity_store/entity_value.rb
@@ -56,6 +57,7 @@ files:
 - lib/entity_store/event_bus.rb
 - lib/entity_store/event_data_object.rb
 - lib/entity_store/external_store.rb
+- lib/entity_store/hash_serialization.rb
 - lib/entity_store/mongo_entity_store.rb
 - lib/entity_store/not_found.rb
 - lib/entity_store/store.rb