aggregate_root 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9abd38a1384a162a47c5d1f171c3baf04dcd3f3
-  data.tar.gz: 0e02fdbe90c01263f7eb37a437ff04a4be12ad45
+  metadata.gz: e5827865ed26ac8902ec51ad07999dfe644a7e6a
+  data.tar.gz: 85677640dc2d4062ab2e63e092db7a8afad77c9e
 SHA512:
-  metadata.gz: aac50706e44673a3fe21bd9cf1285ee80f497597b8b84819028c1f634cb9c01da64249bf4a7b2b7bb9691c439be1710bca2984cbc7cd33c4a4297f71fe5c276a
-  data.tar.gz: 54e6b55343965234660ce8ae8d1369c7681753b4281474944f1764849f6d9ad789261baf72692e2f116b6c54732739468f0f0ba66fa31f37e8d2553d36424951
+  metadata.gz: 1c09676af689188c5a282b6a96197687eb209aeb7fb4120907845a12dea2cdafd5063b6802f77bd0515f41f9012f3a40b891b20d3ec834679ab6f77e4da74684
+  data.tar.gz: 773e80cd3444a43139efdef6f0fb7df20e1db9d00c17abb19c9255d49396d49e11b51c527be6dc67c9212bcbbbeca6d58848304c5a02a9747658e66278c5f536

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.4.0 (28.10.2016)
+
+* Change: redesign whole gem from scratch making it easier to use
+          This is a breaking change!
+
 ### 0.3.6 (18.10.2016)
 
 * Change: ruby_event_store updated to 0.13.0
@@ -21,11 +26,11 @@
 ### 0.3.1 (24.06.2016)
 
 * Change: ruby_event_store updated to 0.9.0
-* Fix: Clarify Licensing terms - MIT licence it is from now
+* Fix: Clarify Licensing terms - MIT license it is from now
 
 ### 0.3.0 (21.06.2016)
 
-* Change: Replace RailsEventStore dependency with moer generic RubyEventStore
+* Change: Replace RailsEventStore dependency with more generic RubyEventStore
 
 ### 0.2.1 (21.03.2016)
 

data/CONTRIBUTING.md

@@ -16,7 +16,7 @@ Any kind of contribution is welcomed. Here is a few guidelines that we need cont
 ## Making Changes
 
 * Create a feature branch from where you want to base your work.
-* Do your work. Please try to keep your commits small and focussed.
+* Do your work. Please try to keep your commits small and focused.
 * Make sure you have added the necessary tests for your changes.
 * Push your changes to a feature branch in your fork of the repository.
 * Submit a pull request to the AggregateRoot repository.

data/README.md

@@ -27,13 +27,7 @@ AggregateRoot.configure do |config|
 end
 ```
 
-Remember that this is only a default event store used by `AggregateRoot::Repository` when no event store is given in constructor parameters.
-You could always set any event store client (must match interface) when creating `AggregateRoot::Repository`.
-
-```ruby
-repository = AggregateRoot::Repository.new(YourOwnEventStore.new)
-# do you work here...
-```
+Remember that this is only a default event store used by `AggregateRoot` module when no event store is given in `load` / `store` methods parameters.
 
 To use [RailsEventStore](https://github.com/arkency/rails_event_store/) add to Gemfile:
 
@@ -51,12 +45,7 @@ It is important to assign `id` at initializer - it will be used as a event store
 
 ```ruby
 class Order
-  include AggregateRoot::Base
-
-  def initialize(id = generate_id)
-    self.id = id
-    # any other code here
-  end
+  include AggregateRoot
 
   # ... more later
 end
@@ -71,12 +60,11 @@ OrderExpired   = Class.new(RailsEventStore::Event)
 
 ```ruby
 class Order
-  include AggregateRoot::Base
+  include AggregateRoot
   HasBeenAlreadySubmitted = Class.new(StandardError)
   HasExpired              = Class.new(StandardError)
 
-  def initialize(id = generate_id)
-    self.id = id
+  def initialize
     self.state = :new
     # any other code here
   end
@@ -84,7 +72,7 @@ class Order
   def submit
     raise HasBeenAlreadySubmitted if state == :submitted
     raise HasExpired if state == :expired
-    apply OrderSubmitted.new(delivery_date: Time.now + 24.hours)
+    apply OrderSubmitted.new(data: {delivery_date: Time.now + 24.hours})
   end
 
   def expire
@@ -107,9 +95,8 @@ end
 #### Loading an aggregate root object from event store
 
 ```ruby
-repository = ArggregateRoot::Repository.new
-order = Order.new(ORDER_ID)
-repository.load(order)
+stream_name = "Order$123"
+order = Order.new.load(stream_name)
 ```
 
 Load gets all domain event stored for the aggregate in event store and apply them
@@ -118,19 +105,19 @@ in order to given aggregate to rebuild aggregate's state.
 #### Storing an aggregate root's changes in event store
 
 ```ruby
-repository = ArggregateRoot::Repository.new
-order = Order.new(ORDER_ID)
-repository.load(order)
+stream_name = "Order$123"
+order = Order.new.load(stream_name)
 order.submit
-repository.store(order)
+order.store
 ```
 
 Store gets all unpublished aggregate's domain events (created by executing a domain logic method like `submit`)
-and publish them in order of creation to event store.
+and publish them in order of creation to event store. If `stream_name` is not specified events will be stored
+in the same stream from which order has been loaded.
 
 #### Resources
 
-There're already few blogposts about building an event sourced applications wth [rails_event_store](https://github.com/arkency/rails_event_store) and aggregate_root gems:
+There're already few blog posts about building an event sourced applications with [rails_event_store](https://github.com/arkency/rails_event_store) and aggregate_root gems:
 
 * [Why use Event Sourcing](http://blog.arkency.com/2015/03/why-use-event-sourcing/)
 * [The Event Store for Rails developers](http://blog.arkency.com/2015/04/the-event-store-for-rails-developers/)

data/lib/aggregate_root.rb

@@ -1,5 +1,43 @@
+require 'active_support/inflector'
 require 'aggregate_root/version'
-require 'aggregate_root/repository'
 require 'aggregate_root/configuration'
-require 'aggregate_root/base'
 require 'aggregate_root/default_apply_strategy'
+
+module AggregateRoot
+  def apply(event)
+    apply_strategy.(self, event)
+    unpublished_events << event
+  end
+
+  def load(stream_name, event_store: default_event_store)
+    @loaded_from_stream_name = stream_name
+    events = event_store.read_stream_events_forward(stream_name)
+    events.each do |event|
+      apply(event)
+    end
+    @unpublished_events = nil
+    self
+  end
+
+  def store(stream_name = loaded_from_stream_name, event_store: default_event_store)
+    unpublished_events.each do |event|
+      event_store.publish_event(event, stream_name: stream_name)
+    end
+    @unpublished_events = nil
+  end
+
+  private
+  attr_reader :loaded_from_stream_name
+
+  def unpublished_events
+    @unpublished_events ||= []
+  end
+
+  def apply_strategy
+    DefaultApplyStrategy.new
+  end
+
+  def default_event_store
+    AggregateRoot.configuration.default_event_store
+  end
+end

data/lib/aggregate_root/default_apply_strategy.rb

@@ -1,7 +1,7 @@
 module AggregateRoot
   class DefaultApplyStrategy
     def call(aggregate, event)
-      event_name_processed = event.class.to_s.underscore.gsub('/','_')
+      event_name_processed = event.class.name.demodulize.underscore
       aggregate.method("apply_#{event_name_processed}").call(event)
     end
   end

data/lib/aggregate_root/version.rb

@@ -1,3 +1,3 @@
 module AggregateRoot
-  VERSION = '0.3.6'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aggregate_root
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Arkency
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,10 +140,8 @@ files:
 - Rakefile
 - aggregate_root.gemspec
 - lib/aggregate_root.rb
-- lib/aggregate_root/base.rb
 - lib/aggregate_root/configuration.rb
 - lib/aggregate_root/default_apply_strategy.rb
-- lib/aggregate_root/repository.rb
 - lib/aggregate_root/version.rb
 homepage: ''
 licenses:

data/lib/aggregate_root/base.rb

@@ -1,35 +0,0 @@
-require 'active_support/inflector'
-
-module AggregateRoot
-  module Base
-    attr_reader :id
-
-    def apply(event)
-      apply_event(event)
-      unpublished_events << event
-    end
-
-    def apply_old_event(event)
-      apply_event(event)
-    end
-
-    def unpublished_events
-      @unpublished_events ||= []
-    end
-
-    private
-    attr_writer :id
-
-    def apply_strategy
-      DefaultApplyStrategy.new
-    end
-
-    def apply_event(event)
-      apply_strategy.(self, event)
-    end
-
-    def generate_uuid
-      SecureRandom.uuid
-    end
-  end
-end

data/lib/aggregate_root/repository.rb

@@ -1,26 +0,0 @@
-module AggregateRoot
-  class Repository
-    def initialize(event_store = default_event_store)
-      @event_store = event_store
-    end
-
-    def store(aggregate)
-      aggregate.unpublished_events.each do |event|
-        event_store.publish_event(event, stream_name: aggregate.id)
-      end
-    end
-
-    def load(aggregate)
-      events = event_store.read_stream_events_forward(aggregate.id)
-      events.each do |event|
-        aggregate.apply_old_event(event)
-      end
-    end
-
-    attr_accessor :event_store
-
-    def default_event_store
-      AggregateRoot.configuration.default_event_store
-    end
-  end
-end