event_sorcerer 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79a912a68e2870c219ada44383c9dc31094153ed
-  data.tar.gz: a06601573292fe7dff5992c019c53123f1f9876d
+  metadata.gz: 58f7bb946b104e7e64a07a78e3bcb5271295aae6
+  data.tar.gz: b6fe6643e1f836722cdb917d24be90af205352a3
 SHA512:
-  metadata.gz: 5996d9ee1b0d9231bde34f0195be5dd1b5ad6f57a129f0dae508960fe1f9e18fa522cd6d368f7ca21149ba2c0350fb44d8b77371c5904cfb0e3c15fe2231d49f
-  data.tar.gz: e46130b30ffb009d7141dca1a358c4233467b9d796e5e40da343a880244897032d0699037ab00e4cff759f1482a4a10766697e85a8de378bb46e9baee96d675b
+  metadata.gz: 31129950df220d9672037b3bf205a4f3450e0ee81735024736058f40b12a1e00ba209d9cadec8f2003f66e281ae7fc724b0d99b668e3d0ab2e8969239061a624
+  data.tar.gz: 798db082c7343649a0c529a1ec3d91880cf00af0e9b87785d7f4277912f2b76d0154cccc42bb28a64c7bd2e4e6a1286a46c6233b458f691b7975e6eb77fa691c

data/README.md

@@ -2,6 +2,8 @@
 
 Generic event-sourcing scaffold.
 
+[![Code Climate](https://codeclimate.com/github/SebastianEdwards/event_sorcerer/badges/gpa.svg)](https://codeclimate.com/github/SebastianEdwards/event_sorcerer)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/event_sorcerer.rb

@@ -8,6 +8,7 @@ require 'event_sorcerer/argument_hashifier'
 require 'event_sorcerer/event'
 require 'event_sorcerer/event_applicator'
 require 'event_sorcerer/event_store'
+require 'event_sorcerer/event_stream'
 require 'event_sorcerer/message_bus'
 require 'event_sorcerer/no_unit_of_work'
 require 'event_sorcerer/unit_of_work'

data/lib/event_sorcerer/aggregate.rb

@@ -15,7 +15,7 @@ module EventSorcerer
       base.extend(ClassMethods)
       base.class.extend(Forwardable)
       base.class.send :def_delegators, :EventSorcerer, :event_store,
-                                                       :unit_of_work
+                      :unit_of_work
     end
 
     # Public: Class methods to be extended onto the including class.
@@ -24,7 +24,11 @@ module EventSorcerer
       #
       # Returns an Array of AggregateProxy objects.
       def all
-        event_store.get_ids_for_type(self.name).map { |id| find(id) }
+        with_all_loaders_for_type do |loaders|
+          loaders.map(&:load).each do |aggregate|
+            unit_of_work.store_aggregate(aggregate)
+          end
+        end
       end
 
       # Public: An array of symbols representing the names of the methods which
@@ -64,8 +68,10 @@ module EventSorcerer
           return unit_of_work.fetch_aggregate(id)
         end
 
-        AggregateLoader.new(self, id).load.tap do |aggregate|
-          unit_of_work.store_aggregate(aggregate)
+        with_loader_for_id(id) do |loader|
+          loader.load.tap do |aggregate|
+            unit_of_work.store_aggregate(aggregate)
+          end
         end
       end
 
@@ -79,8 +85,10 @@ module EventSorcerer
           return unit_of_work.fetch_aggregate(id)
         end
 
-        AggregateLoader.new(self, id, false).load.tap do |aggregate|
-          unit_of_work.store_aggregate(aggregate)
+        with_loader_for_id(id, false) do |loader|
+          loader.load.tap do |aggregate|
+            unit_of_work.store_aggregate(aggregate)
+          end
         end
       end
 
@@ -94,6 +102,61 @@ module EventSorcerer
           unit_of_work.store_aggregate(aggregate)
         end
       end
+
+      private
+
+      # Private: Grabs the event streams for the aggregate class and yields
+      #          them to a given block.
+      #
+      # block - the block to yield the event stream to.
+      #
+      # Returns the return value of the given block.
+      def with_all_event_streams_for_type(&block)
+        yield event_store.read_event_streams_for_type(name)
+      end
+
+      # Private: Creates AggregateLoaders for an ID and yields it to a given
+      #          block.
+      #
+      # prohibit_new - value of the prohibit_new flag to be passed to loaders.
+      # block        - the block to yield the event stream to.
+      #
+      # Returns the return value of the given block.
+      def with_all_loaders_for_type(prohibit_new = true, &block)
+        with_all_event_streams_for_type do |streams|
+          loaders = streams.map do |stream|
+            AggregateLoader.new(self, stream.id, stream.events,
+                                stream.current_version, prohibit_new)
+          end
+
+          yield loaders
+        end
+      end
+
+      # Private: Grabs the event stream for an ID and yields it to a given
+      #          block.
+      #
+      # id    - the ID of the aggregate to get the event stream for.
+      # block - the block to yield the event stream to.
+      #
+      # Returns the return value of the given block.
+      def with_event_stream_for_id(id, &block)
+        yield event_store.read_event_stream(id)
+      end
+
+      # Private: Creates an AggregateLoader for an ID and yields it to a given
+      #          block.
+      #
+      # id    - the ID of the aggregate to get the event stream for.
+      # block - the block to yield the event stream to.
+      #
+      # Returns the return value of the given block.
+      def with_loader_for_id(id, prohibit_new = true, &block)
+        with_event_stream_for_id(id) do |stream|
+          yield AggregateLoader.new(self, stream.id, stream.events,
+                                    stream.current_version, prohibit_new)
+        end
+      end
     end
   end
 end

data/lib/event_sorcerer/aggregate_loader.rb

@@ -3,18 +3,17 @@ module EventSorcerer
   class AggregateLoader
     extend Forwardable
 
-    # Public: Shortcut to access the global event_store.
-    def_delegators :EventSorcerer, :event_store
-
     # Public: Creates a new AggregateLoader instance.
     #
     # klass        - class for the aggregate to be loaded.
     # id           - id for the aggregate to be loaded.
     # prohibit_new - whether or not to raise an error if aggregate not existing.
-    def initialize(klass, id, prohibit_new = true)
+    def initialize(klass, id, events, version, prohibit_new = true)
+      @events       = events
       @id           = id
       @klass        = klass
       @prohibit_new = prohibit_new
+      @version      = version
     end
 
     # Public: Wraps and returns aggregate in a proxy.
@@ -29,6 +28,9 @@ module EventSorcerer
 
     private
 
+    # Private: Returns array of Events to hydrate with.
+    attr_reader :events
+
     # Private: Returns the id for the aggregate to be loaded.
     attr_reader :id
 
@@ -38,6 +40,9 @@ module EventSorcerer
     # Private: Returns whether new aggregates will be allowed.
     attr_reader :prohibit_new
 
+    # Private: Returns current version of aggregate.
+    attr_reader :version
+
     # Private: Memorizes and returns a new instance of an aggregate. Applies
     #          existing events from the event store.
     def aggregate
@@ -49,19 +54,12 @@ module EventSorcerer
       end
     end
 
-    # Private: Memorizes and returns the existing events from the event store.
-    def events
-      @events ||= event_store.read_events(id)
-    end
-
+    # Private: Checks whether the aggregate is completely new.
+    #
+    # Returns true if aggregate is new.
+    # Returns false if aggregate is not new.
     def new_aggregate?
       !version || version == 0
     end
-
-    # Private: Memorizes and returns the current version number from the event
-    #          store.
-    def version
-      @version ||= event_store.get_current_version(id)
-    end
   end
 end

data/lib/event_sorcerer/event_store.rb

@@ -44,8 +44,8 @@ module EventSorcerer
       fail NotImplementedError
     end
 
-    # Public: Retrieve the events for a specified aggregate. Should be
-    #         defined in a subclass.
+    # Public: Retrieve the events for a specified aggregate. Should be defined
+    #         in a subclass.
     #
     # _aggregate_id - UUID of the aggregate as a String.
     #
@@ -54,6 +54,39 @@ module EventSorcerer
       fail NotImplementedError
     end
 
+    # Public: Retrieve the event stream for a specified aggregate. Should be
+    #         defined in a subclass.
+    #
+    # aggregate_id - UUID of the aggregate as a String.
+    #
+    # Returns an EventStream
+    def read_event_stream(aggregate_id)
+      EventStream.new(aggregate_id, read_events(aggregate_id),
+                      get_current_version(aggregate_id))
+    end
+
+    # Public: Retrieve the event stream for all aggregates of a given type.
+    #         Optionally can be defined in subclass to optimize loading these
+    #         aggregates with a minimum of external calls.
+    #
+    # klass - Text representation of aggregate class.
+    #
+    # Returns an Array.
+    def read_event_streams_for_type(klass)
+      read_multiple_event_streams get_ids_for_type(klass)
+    end
+
+    # Public: Retrieve the events for multiple aggregates. Optionally can be
+    #         defined in subclass to optimize loading multiple aggregates with
+    #         a minimum of external calls.
+    #
+    # aggregate_ids - Array of UUIDs of the aggregates as Strings.
+    #
+    # Returns an Array.
+    def read_multiple_event_streams(aggregate_ids)
+      aggregate_ids.map { |id| read_event_stream id }
+    end
+
     # Public: Ensures events appended within the given block are done so
     #         atomically. Should be defined in a subclass.
     #

data/lib/event_sorcerer/event_stream.rb

@@ -0,0 +1,5 @@
+module EventSorcerer
+  # Public: Simple value object representing an event stream.
+  class EventStream < Struct.new(:id, :events, :current_version)
+  end
+end

data/lib/event_sorcerer/version.rb

@@ -1,4 +1,4 @@
 # Public: Defines a constant for the current version number.
 module EventSorcerer
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_sorcerer
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Sebastian Edwards
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,6 +130,7 @@ files:
 - lib/event_sorcerer/event.rb
 - lib/event_sorcerer/event_applicator.rb
 - lib/event_sorcerer/event_store.rb
+- lib/event_sorcerer/event_stream.rb
 - lib/event_sorcerer/message_bus.rb
 - lib/event_sorcerer/no_unit_of_work.rb
 - lib/event_sorcerer/unit_of_work.rb