entity_store 1.2.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02a69a4134e4ef998a3258424ed1ff35e171babf83d72665ab37464aaba1abbe
-  data.tar.gz: 2b9af465f21d0131c71b80cd3a9e5fb08579ebfbe27e9c2595e45b9ccffba622
+  metadata.gz: d4575519de291e09a6f02085a07daeb09818edc01a5d8895204d443fc03db6b9
+  data.tar.gz: ce27f46beb087f7bcd48b6d5e690db1239e75adaffdcb524b1c24df0cbeea49f
 SHA512:
-  metadata.gz: 893058a17b8cef182d8a7349ad03107b00361d66af25837f44846aa8daed83cf9bbc38cef57874a753e3d79e7bf47e8c66a4612a25564a893f5188fde7e7119a
-  data.tar.gz: 8b10d320996be80cfc718fa709339132261104b0edb7b6fe3b286757dd5ec9f3535400d1214a6d7af4ef21abc4fb612e47ef0bbdfde9c99a290c34bee226cc48
+  metadata.gz: de737107e012f7a07b5aea26280b425a6db374e13325054344e7c9fac196ee98bde2dbcc7d231fc0cd28b26992d805188a06d727373ef7c46e3552598c9c6e52
+  data.tar.gz: a624bb070c990b68b0a436d07c940f656238a244a80bfe2c789f3bb7feb4f8de0e66c65696496d75b936557e5bb4465466cd1e5f05f1b4583e8cf3bab3cc31ee

data/lib/entity_store/config.rb

@@ -4,9 +4,11 @@ module EntityStore
       # Stores
       attr_accessor :store, :feed_store
 
+      attr_accessor :cache_event_subscribers
+
       # Allows config to pass in a lambda or Proc to use as the type loader in place
-      # of the default. 
-      # Original use case was migration of entity classes to new module namespace when 
+      # of the default.
+      # Original use case was migration of entity classes to new module namespace when
       # extracting to a shared library
       attr_accessor :type_loader
 
@@ -17,15 +19,15 @@ module EntityStore
         yield self
 
         raise StandardError.new("store not assigned") unless store
-        store.open 
+        store.open
         feed_store.open if feed_store
       end
-      
+
       def event_subscribers
         @_event_subscribers ||=[]
       end
-      
-      # Public - indicates the version increment that is used to 
+
+      # 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
@@ -35,7 +37,6 @@ module EntityStore
         @_snapshot_threshold = value
       end
 
-      
       def load_type(type_name)
         if EntityStore::Config.type_loader
           EntityStore::Config.type_loader.call(type_name)
@@ -50,4 +51,4 @@ module EntityStore
     end
 
   end
-end
+end

data/lib/entity_store/event_bus.rb

@@ -4,11 +4,19 @@ module EntityStore
 
     ALL_METHOD = :all_events
 
+    def initialize(event_subscribers = nil)
+      @_event_subscribers = event_subscribers if event_subscribers
+    end
+
+    def event_subscribers
+      @_event_subscribers || EntityStore::Config.event_subscribers
+    end
+
     def publish(entity_type, event)
-      publish_to_feed entity_type, event
+      publish_to_feed(entity_type, event)
 
-      subscribers_to(event.receiver_name).each do |s| send_to_subscriber s, event.receiver_name, event end
-      subscribers_to_all.each do |s| send_to_subscriber s, ALL_METHOD, event end
+      subscribers_to(event.receiver_name).each { |s| send_to_subscriber(s, event.receiver_name, event) }
+      subscribers_to_all.each { |s| send_to_subscriber(s, ALL_METHOD, event) }
     end
 
     def send_to_subscriber subscriber, receiver_name, event
@@ -19,18 +27,48 @@ module EntityStore
     end
 
     def subscribers_to(event_name)
-      subscribers.select { |s| s.instance_methods.include?(event_name.to_sym) }
+      subscriber_lookup[event_name.to_sym].dup
     end
 
     def subscribers_to_all
-      subscribers.select { |s| s.instance_methods.include?(ALL_METHOD) }
+      subscribers_to(ALL_METHOD)
+    end
+
+    def subscriber_lookup_cache
+      @@lookup_cache ||= Hash.new
+    end
+
+    def subscriber_lookup
+      return generate_subscriber_lookup unless EntityStore::Config.cache_event_subscribers
+
+      @lookup ||= begin
+        lookup_cache_key = event_subscribers.map(&:to_s).join
+
+        if subscriber_lookup_cache[lookup_cache_key]
+          subscriber_lookup_cache[lookup_cache_key]
+        else
+          subscriber_lookup_cache[lookup_cache_key] = generate_subscriber_lookup
+        end
+      end
+    end
+
+    def generate_subscriber_lookup
+      lookup = Hash.new { |h, k| h[k] = Array.new }
+
+      subscribers.each do |s|
+        s.instance_methods.each do |m|
+          lookup[m] << s
+        end
+      end
+
+      lookup
     end
 
     def subscribers
-      EntityStore::Config.event_subscribers.map do |subscriber|
+      event_subscribers.map do |subscriber|
         case subscriber
         when String
-          Utils.get_type_constant(subscriber)
+          EntityStore::Config.load_type(subscriber)
         else
           subscriber
         end
@@ -46,17 +84,17 @@ module EntityStore
     end
 
     # Public - replay events of a given type to a given subscriber
-    # 
+    #
     # since             - Time reference point
     # type              - String type name of event
-    # subscriber        - Class of the subscriber to replay events to 
-    # 
+    # subscriber        - Class of the subscriber to replay events to
+    #
     # Returns nothing
     def replay(since, type, subscriber)
       max_items = 100
       event_data_objects = feed_store.get_events(since, type, max_items)
 
-      while event_data_objects.count > 0 do 
+      while event_data_objects.count > 0 do
         event_data_objects.each do |event_data_object|
           begin
             event = EntityStore::Config.load_type(event_data_object.type).new(event_data_object.attrs)

data/lib/entity_store/not_found.rb

@@ -1,7 +1,7 @@
 module EntityStore
   class NotFound < StandardError
-    def initialise(id)
+    def initialize(id)
       super("no item with id #{id} could be found")
     end
   end
-end
+end

data/lib/entity_store/store.rb

@@ -2,10 +2,19 @@ module EntityStore
   class Store
     include Logging
 
+    def initialize(storage_client = nil, event_bus = nil)
+      @_storage_client = storage_client if storage_client
+      @_event_bus = event_bus if event_bus
+    end
+
     def storage_client
       @_storage_client ||= EntityStore::Config.store
     end
 
+    def event_bus
+      @_event_bus ||= EventBus.new
+    end
+
     def add(entity)
       entity.id = storage_client.add_entity(entity)
       add_events(entity)
@@ -31,8 +40,10 @@ module EntityStore
           entity.id = storage_client.add_entity(entity)
         end
 
-        add_events(entity) do
-          snapshot_entity(entity) if entity.snapshot_due?
+        added_events = add_events(entity)
+
+        if entity.snapshot_due? || added_events >= Config.snapshot_threshold
+          snapshot_entity(entity)
         end
 
         # publish version increment signal event to the bus
@@ -44,6 +55,33 @@ module EntityStore
       raise e
     end
 
+    # Upsert an entity where events have existed previously
+    # for example when migrating data
+    #
+    # Please note this method requires that the events expose their id property
+    # as a method named _id.
+    #
+    def upsert(entity)
+      unless entity.pending_events.empty?
+        entity.version = entity.pending_events.map(&:entity_version).max || 1
+
+        if entity.id
+          storage_client.save_entity(entity)
+        else
+          entity.id = storage_client.add_entity(entity)
+        end
+
+        upsert_events(entity)
+
+        # publish version increment signal event to the bus
+        event_bus.publish(entity.type, entity.generate_version_incremented_event)
+      end
+      entity
+    rescue => e
+      log_error "Store#upsert error: #{e.inspect} - #{entity.inspect}", e
+      raise e
+    end
+
     def snapshot_entity(entity)
       log_info { "Store#snapshot_entity : Snapshotting #{entity.id}"}
       storage_client.snapshot_entity(entity)
@@ -69,9 +107,22 @@ module EntityStore
       end
       storage_client.add_events(items)
 
-      yield if block_given?
+      items.each { |e| event_bus.publish(entity.type, e) }
+
+      entity.clear_pending_events
+      items.count
+    end
+
+    def upsert_events(entity)
+      items = entity.pending_events.map do |event|
+        event.entity_id ||= entity.id.to_s
+        event.entity_version ||= entity.version
+        event
+      end
+
+      filtered_items = storage_client.upsert_events(items)
 
-      items.each {|e| event_bus.publish(entity.type, e) }
+      filtered_items.each { |e| event_bus.publish(entity.type, e) }
 
       entity.clear_pending_events
     end
@@ -146,10 +197,6 @@ module EntityStore
       @_storage_client = nil
     end
 
-    def event_bus
-      @_event_bus ||= EventBus.new
-    end
-
     # Public: returns an array representing a full audit trail for the entity.
     # After each event is applied the state of the entity is rendered.
     # Optionally accepts a block which should return true or false to indicate

data/lib/entity_store/version.rb

@@ -1,3 +1,3 @@
 module EntityStore
-  VERSION = "1.2.0".freeze
+  VERSION = "1.5.0".freeze
 end

data/lib/entity_store.rb

@@ -1,6 +1,4 @@
 module EntityStore
-
-  require_relative 'entity_store/utils'
   require_relative 'entity_store/logging'
   require_relative 'entity_store/config'
   require_relative 'entity_store/time_factory'

data/spec/entity_store/entity_spec.rb

@@ -84,7 +84,7 @@ describe Entity do
       subject { DummyEntity.new(1) }
 
       it "should raise a readable error" do
-        expect { subject }.to raise_error(RuntimeError, "Do not know how to create DummyEntity from Fixnum")
+        expect { subject }.to raise_error(RuntimeError, /\ADo not know how to create DummyEntity from (Integer|Fixnum)\z/)
       end
     end
   end

data/spec/entity_store/store_spec.rb

@@ -74,6 +74,39 @@ describe Store do
 
   end
 
+  describe "#upsert_events" do
+    before(:each) do
+      @entity = DummyEntityForStore.new(:name => random_string)
+      @entity.id = random_string
+      @entity.version = random_integer
+      @entity.pending_events << double(Event, :entity_id => @entity.id, :entity_version => @entity.version)
+      @entity.pending_events << double(Event, :entity_id => @entity.id, :entity_version => @entity.version)
+      @entity.pending_events << double(Event, :entity_id => @entity.id, :entity_version => @entity.version)
+      @storage_client = double("StorageClient", :upsert_events => filtered_events)
+      @store = Store.new
+      @store.stub(:storage_client) { @storage_client }
+      @event_bus = double(EventBus, :publish => true)
+      @store.stub(:event_bus) { @event_bus}
+    end
+
+    subject { @store.upsert_events(@entity) }
+
+    let(:filtered_events) { @entity.pending_events.take(2) }
+
+    it "adds each of the events" do
+      @storage_client.should_receive(:upsert_events).with(@entity.pending_events)
+      subject
+    end
+
+    it "publishes each event to the EventBus" do
+      filtered_events.each do |e|
+        @event_bus.should_receive(:publish).with(@entity.type, e)
+      end
+      subject
+    end
+
+  end
+
   describe "#save" do
 
     before(:each) do
@@ -81,7 +114,7 @@ describe Store do
       @entity = DummyEntityForStore.new(:id => random_string)
       @storage_client = double("StorageClient", :save_entity => true)
       @store = Store.new
-      @store.stub(:add_events).and_yield
+      @store.stub(:add_events) { |entity| entity.pending_events.count }
       @store.stub(:storage_client) { @storage_client }
       @entity.stub(:pending_events) { [ double('Event') ] }
     end
@@ -161,8 +194,23 @@ describe Store do
           subject
         end
       end
-    end
 
+      context "when flushed events exceeds snapshotting threshold" do
+        before(:each) do
+          @entity.version = 1
+          @entity.stub(:pending_events) do
+            (1..EntityStore::Config.snapshot_threshold).map do
+              double('Event')
+            end
+          end
+        end
+
+        it "should snapshot the entity" do
+          @storage_client.should_receive(:snapshot_entity).with(@entity)
+          subject
+        end
+      end
+    end
   end
 
   describe "getters" do

data/spec/entity_store_spec.rb

@@ -26,7 +26,17 @@ class DummyEntitySubscriber
   end
 
   def dummy_entity_name_set(event)
-    DummyEntitySubscriber.event_name = event.name
+    self.class.event_name = event.name
+  end
+end
+
+class AnotherEntitySubscriber
+  class << self
+    attr_accessor :event_name
+  end
+
+  def dummy_entity_name_set(event)
+    self.class.event_name = event.name
   end
 end
 
@@ -80,6 +90,49 @@ class DummyStore
   end
 end
 
+describe "creation without static instances" do
+  let(:store) do
+    storage_client = DummyStore.new
+    Store.new(storage_client, event_bus)
+  end
+
+  let(:event_bus) do
+    event_subscribers = []
+    event_subscribers << AnotherEntitySubscriber
+
+    EventBus.new(event_subscribers)
+  end
+
+  before do
+    EntityStore::Config.setup do |config|
+      config.store = DummyStore.new
+      config.event_subscribers << DummyEntitySubscriber
+    end
+  end
+
+  context "when save entity" do
+    let(:name) { random_string }
+    before(:each) do
+      @entity = DummyEntity.new
+      @entity.set_name name
+      @id = store.save @entity
+    end
+
+    it "does not publish event to the non configured subscriber" do
+      DummyEntitySubscriber.event_name.should_not eq(name)
+    end
+    it "publishes event to the subscriber" do
+      AnotherEntitySubscriber.event_name.should eq(name)
+    end
+    it "is retrievable with the events applied" do
+      store.get(@entity.id).name.should eq(name)
+    end
+    it "is not retrievable from the static store instance" do
+      EntityStore::Store.new.get(@entity.id).should eq(nil)
+    end
+ end
+end
+
 describe "end to end" do
   before(:each) do
     EntityStore::Config.setup do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: entity_store
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Adam Bird
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson
@@ -57,7 +57,6 @@ files:
 - lib/entity_store/not_found.rb
 - lib/entity_store/store.rb
 - lib/entity_store/time_factory.rb
-- lib/entity_store/utils.rb
 - lib/entity_store/version.rb
 - lib/tasks/entity_store.rake
 - spec/entity_store/config_spec.rb
@@ -87,8 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Event sourced entity store with a replaceable body

data/lib/entity_store/utils.rb

@@ -1,8 +0,0 @@
-module EntityStore
-  module Utils
-    def self.get_type_constant(type_name)
-      type_name.split('::').inject(Object) { |obj, name| obj.const_get(name) }
-    end
-  end
-end
-