entity_store 0.0.5 → 0.0.7

data/lib/entity_store/entity.rb

@@ -1,8 +1,42 @@
 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
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+
+      def related_entities(*names)
+        names.each do |name|
+          # attr accessor for the id
+          define_method("#{name}_id") { instance_variable_get("@#{name}_id")}
+          define_method("#{name}_id=") do |value| instance_variable_set("@#{name}_id", value) end
+
+          # 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")))
+            end
+          }
+        end
+
+        define_method(:loaded_related_entities) {
+          names.collect{ |name| instance_variable_get("@_#{name}") }.select{|entity| !entity.nil? }
+        }
+      end
+
+    end
+
     def initialize(attr={})
       attr.each_pair { |k,v| self.send("#{k}=", v) }
     end

data/lib/entity_store/mongo_entity_store.rb

@@ -11,12 +11,12 @@ module EntityStore
 
     def open_store
       uri  = URI.parse(EntityStore.connection_profile)
-      connection = Connection.from_uri(EntityStore.connection_profile)
+      connection = Connection.from_uri(EntityStore.connection_profile, :connect_timeout => connect_timeout)
       connection.db(uri.path.gsub(/^\//, ''))
     end
 
     def connect_timeout
-      ENV['ENTITY_STORE_CONNECT_TIMEOUT'] || '2000'
+      (ENV['ENTITY_STORE_CONNECT_TIMEOUT'] || '2').to_i
     end
 
     def entities

data/lib/entity_store/store.rb

@@ -7,20 +7,32 @@ module EntityStore
     def add(entity)
       entity.id = storage_client.add_entity(entity)
       add_events(entity)
-      return entity
+      entity
     rescue => e
       EntityStore.logger.error { "Store#add error: #{e.inspect} - #{entity.inspect}" }
       raise e
     end
 
     def save(entity)
+      do_save entity
+      entity.loaded_related_entities.each do |e| do_save e end if entity.respond_to?(:loaded_related_entities)
+      entity
+    end
+
+    def do_save(entity)
       # need to look at concurrency if we start storing version on client
-      entity.version += 1
-      storage_client.save_entity(entity)
-      add_events(entity)
-      return entity
+      unless entity.pending_events.empty?
+        entity.version += 1
+        if entity.id
+          storage_client.save_entity(entity)
+        else
+          entity.id = storage_client.add_entity(entity)
+        end
+        add_events(entity)
+      end
+      entity
     rescue => e
-      EntityStore.logger.error { "Store#save error: #{e.inspect} - #{entity.inspect}" }
+      EntityStore.logger.error { "Store#do_save error: #{e.inspect} - #{entity.inspect}" }
       raise e
     end
 
@@ -40,8 +52,10 @@ 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
-      return entity
+      entity
     end
 
     # Public : USE AT YOUR PERIL this clears the ENTIRE data store

data/lib/entity_store/version.rb

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

data/spec/entity_store/entity_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+class DummyEntity
+  include Entity
+
+  related_entities :club, :user
+
+end
+
+describe Entity do
+  describe ".related_entities" do
+    before(:each) do
+      @entity_loader = mock(Store)
+      @club = mock('Entity', :id => random_string)
+      @user = mock('Entity', :id => random_string)
+      @entity = DummyEntity.new(:related_entity_loader => @entity_loader, :club_id => @club.id, :user_id => @user.id)
+      @entity_loader.stub(:get) { |id| 
+        case id
+        when @club.id
+          @club 
+        when @user.id
+          @user
+        end
+      }
+    end
+
+    it "should have the club_id set" do
+      @entity.club_id.should eq(@club.id)
+    end
+    it "should load club" do
+      @entity.club.should eq(@club)
+    end
+    it "should call entity_loader with club id" do
+      @entity_loader.should_receive(:get).with(@club.id)
+      @entity.club
+    end
+    it "should have the user_id set" do
+      @entity.user_id.should eq(@user.id)
+    end
+    it "should load user" do
+      @entity.user.should eq(@user)
+    end
+    it "should call entity_loader with user id" do
+      @entity_loader.should_receive(:get).with(@user.id)
+      @entity.user
+    end
+
+    context "when only user loaded" do
+      before(:each) do
+        @entity.user
+      end
+
+      it "should only have user in the loaded related entities collection" do
+        @entity.loaded_related_entities.should eq([@user])
+      end
+    end
+
+    context "when both user and club loaded" do
+      before(:each) do
+        @entity.club
+        @entity.user
+      end
+
+      it "should only have user in the loaded related entities collection" do
+        @entity.loaded_related_entities.should eq([@club, @user])
+      end
+    end
+  end
+end

data/spec/entity_store/store_spec.rb

@@ -1,20 +1,17 @@
 require 'spec_helper'
 
-class DummyEntity
+class DummyEntityForStore
   include Entity
 
   attr_accessor :name
 
-  def initialize(name)
-    @name = name
-  end
 end
 
 describe Store do
   describe "#add" do
     before(:each) do
       @new_id = random_string
-      @entity = DummyEntity.new(random_string)
+      @entity = DummyEntityForStore.new(:name => random_string)
       @storage_client = mock("StorageClient", :add_entity => @new_id)
       @store = Store.new
       @store.stub(:add_events)
@@ -38,7 +35,7 @@ describe Store do
 
   describe "#add_events" do
     before(:each) do
-      @entity = DummyEntity.new(random_string)
+      @entity = DummyEntityForStore.new(:name => random_string)
       @entity.id = random_string
       @entity.version = random_integer
       @entity.pending_events << mock(Event, :entity_id= => true, :entity_version= => true)
@@ -79,16 +76,41 @@ describe Store do
   end
 
   describe "#save" do
+    context "when entity has related entities loaded" do
+      before(:each) do
+        @entity = DummyEntityForStore.new(:id => random_string)
+        @store = Store.new
+        @related_entity = mock('Entity')
+        @entity.stub(:loaded_related_entities) { [ @related_entity ] }
+        @store.stub(:do_save)
+      end
+      
+      subject { @store.save(@entity) }
+
+      it "should save the entity" do
+        @store.should_receive(:do_save).with(@entity)
+        subject
+      end
+      it "should save them as well" do
+        @store.should_receive(:do_save).with(@related_entity)
+        subject
+      end
+    end
+
+  end
+
+  describe "#do_save" do
     before(:each) do
       @new_id = random_string
-      @entity = DummyEntity.new(random_string)
+      @entity = DummyEntityForStore.new(:id => random_string)
       @storage_client = mock("StorageClient", :save_entity => true)
       @store = Store.new
       @store.stub(:add_events)
       @store.stub(:storage_client) { @storage_client }
+      @entity.stub(:pending_events) { [ mock('Event') ] }
     end
 
-    subject { @store.save(@entity) }
+    subject { @store.do_save(@entity) }
 
     it "increments the entity version number" do
       @entity.should_receive(:version=).with(@entity.version + 1)
@@ -102,16 +124,40 @@ describe Store do
       @store.should_receive(:add_events).with(@entity)
       subject
     end
-    it "returns a reference to the ride" do
+    it "returns a reference to the entity" do
       subject.should eq(@entity)
     end
+    context "when no pending events" do
+      before(:each) do
+        @entity.stub(:pending_events) { [] }
+      end
+      it "should not save the entity" do
+        @storage_client.should_not_receive(:save_entity)
+        subject
+      end
+      it "should not add the events" do
+        @storage_client.should_not_receive(:add_events)
+        subject
+      end
+    end
+    context "when entity doesn't have an id" do
+      before(:each) do
+        @entity.id = nil
+        @id = random_string
+        @storage_client.stub(:add_entity) { @id }
+      end
+      it "should add the entity" do
+        @storage_client.should_receive(:add_entity).with(@entity)
+        subject
+      end
+    end
   end
 
   describe "#get" do
     before(:each) do
       @id = random_integer
-      @entity = DummyEntity.new(random_string)
-      DummyEntity.stub(:new).and_return(@ride)
+      @entity = DummyEntityForStore.new
+      DummyEntityForStore.stub(:new).and_return(@ride)
       @events = [mock("Event", :apply => true), mock("Event", :apply => true)]
 
       @storage_client = mock("StorageClient", :get_entity => @entity, :get_events => @events)
@@ -135,6 +181,9 @@ describe Store do
       end
       subject
     end
+    it "should assign itself as the related_entity_loader" do
+      subject.related_entity_loader.should eq(@store)
+    end
     it "should return a ride" do
       subject.should eq(@entity)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: entity_store
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-31 00:00:00.000000000 Z
+date: 2012-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -62,6 +62,7 @@ files:
 - lib/entity_store/version.rb
 - lib/entity_store.rb
 - lib/tasks/entity_store.rake
+- spec/entity_store/entity_spec.rb
 - spec/entity_store/entity_value_spec.rb
 - spec/entity_store/event_bus_spec.rb
 - spec/entity_store/event_spec.rb
@@ -95,6 +96,7 @@ signing_key:
 specification_version: 3
 summary: Event sourced entity store with a Mongo body
 test_files:
+- spec/entity_store/entity_spec.rb
 - spec/entity_store/entity_value_spec.rb
 - spec/entity_store/event_bus_spec.rb
 - spec/entity_store/event_spec.rb