sandthorn 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e61d651d859798c915aa2cce28faece11f1d4c7
-  data.tar.gz: 592053f9f191cc595b7ccb6a517da939f881fb02
+  metadata.gz: e447ae84df794de89797c576b53a8e958bf5836f
+  data.tar.gz: 175d7f6a64b7ec05ae870e1cf838be1d6ff90ce6
 SHA512:
-  metadata.gz: f7c6fd3e0611518d6ad6d6383bcd99a0b24bf09bca5ccc4f59da46299a83f6e4c19b503cfda4f656ecd813f4a56e3aa6381d3e55cd6abec427c7ce4a55d59564
-  data.tar.gz: f7b104d6f9302685981e39e9d21e9eff0bb60f74bffb5e0fd05717e1984d934e36c7751317c5e853046dad5ccb8b29a8b461838d6293f9fe4b683f7da2df019b
+  metadata.gz: 77c020e0af49d6ecc03314e879c22b76e361659648e6163dde7b090b897250b163ce7aeaaa440714eeba6ebd619b0e64b3ca20aafd501184ca9e795bd6c90476
+  data.tar.gz: 1cd42f78aa82b503676e22d469cd373edd6cda4f819716c7b0787392c8dfe9404aa950b201ec4aab036c2c6c852c298ebc3097891e59b0895e0923b1b8bab693

data/README.md

@@ -64,7 +64,7 @@ class Ship
   end
 end
 
-# Configure a driver
+# Configure one driver
 url = "sqlite://spec/db/sequel_driver.sqlite3"
 sql_event_store = SandthornDriverSequel.driver_from_url(url: url)
 Sandthorn.configure do |c|
@@ -72,6 +72,10 @@ Sandthorn.configure do |c|
 end
 
 # Or configure many drivers
+url = "sqlite://spec/db/sequel_driver.sqlite3"
+sql_event_store = SandthornDriverSequel.driver_from_url(url: url)
+url_two = "sqlite://spec/db/sequel_driver_two.sqlite3"
+other_store = SandthornDriverSequel.driver_from_url(url: url_two)
 
 Sandthorn.configure do |c|
   c.event_stores = {
@@ -208,6 +212,28 @@ end
 
 All objects that include `Sandthorn::AggregateRoot` is provided with an `aggregate_id` which is a [UUID](http://en.wikipedia.org/wiki/Universally_unique_identifier).
 
+### `Sandthorn::AggregateRoot::events`
+
+An abstraction over `commit` that creates events methods that can be used from within a command method.
+
+In this exampel the `events` method will generate a method called `marked`, this method take *args as input that will result in the method argument on the event. It also take a block that will be executed before the event is commited and is used to groups the state changes to the event (but is only optional right now).
+
+```ruby
+class Board
+  include Sandthorn::AggregateRoot
+  
+  events :marked
+  
+  def mark player, pos_x, pos_y
+    # change some state
+    marked(player) do
+      @pos_x = pos_x
+      @pos_y = pos_y
+    end
+  end
+end
+```
+
 ### `Sandthorn::AggregateRoot.commit`
 
 It is required that an event is commited to the aggregate to be stored as an event. `commit` extracts the object's delta and locally caches the state changes that has been applied to the aggregate. Commonly, commit is called when an event is applied. In [CQRS](http://martinfowler.com/bliki/CQRS.html), events are named using past tense.
@@ -225,6 +251,8 @@ end
 
 `commit` determines the state changes by monitoring the object's readable fields.
 
+Since version 0.10.0 of Sandthorn the concept `events` have been introduced to abstract away the usage of `commit`. Commit still works as before but we think that the `events` abstraction makes the aggregate more readable. 
+
 ### `Sandthorn::AggregateRoot.save`
 
 Once one or more commits have been applied to an aggregate it should be saved. This means all commited events will be persisted by the specific Sandthorn driver. `save` is called by the owning object.

data/lib/sandthorn/aggregate_root.rb

@@ -1,11 +1,13 @@
+require 'sandthorn/aggregate_root_base'
 require 'sandthorn/aggregate_root_marshal'
 
 module Sandthorn
   module AggregateRoot
-    include Sandthorn::AggregateRoot::Marshal
+    include Base
+    include Marshal
 
     def self.included(base)
-      base.extend(Sandthorn::AggregateRoot::Base::ClassMethods)
+      base.extend(Base::ClassMethods)
     end
   end
 end

data/lib/sandthorn/aggregate_root_base.rb

@@ -48,27 +48,8 @@ module Sandthorn
       end
 
       def commit *args
-        aggregate_attribute_deltas = get_delta
-
-        method_name = caller_locations(1,1)[0].label.gsub(/block ?(.*) in /, "")
-        increase_current_aggregate_version!
-        data = {
-          method_name: method_name,
-          method_args: args,
-          attribute_deltas: aggregate_attribute_deltas
-        }
-        trace_information = @aggregate_trace_information
-        unless trace_information.nil? || trace_information.empty?
-          data.merge!({ trace: trace_information })
-        end
-
-        @aggregate_events << ({
-          aggregate_version: @aggregate_current_event_version,
-          event_name: method_name,
-          event_args: data
-        })
-
-        self
+        event_name = caller_locations(1,1)[0].label.gsub(/block ?(.*) in /, "")
+        commit_with_event_name(event_name, args)
       end
 
       alias :record_event :commit
@@ -150,6 +131,16 @@ module Sandthorn
           aggregate
         end
 
+        def events(*event_names)
+          event_names.each do |name|
+            define_method(name) do |*args, &block|
+              block.call() if block
+              commit_with_event_name(name, args)
+            end
+            private name.to_s
+          end
+        end
+
         private
 
         def build_instance_vars_from_events events
@@ -220,6 +211,29 @@ module Sandthorn
         @aggregate_id = aggregate_id
       end
 
+      def commit_with_event_name(event_name, *args)
+        aggregate_attribute_deltas = get_delta
+
+        increase_current_aggregate_version!
+        data = {
+          method_name: event_name,
+          method_args: args,
+          attribute_deltas: aggregate_attribute_deltas
+        }
+        trace_information = @aggregate_trace_information
+        unless trace_information.nil? || trace_information.empty?
+          data.merge!({ trace: trace_information })
+        end
+
+        @aggregate_events << ({
+          aggregate_version: @aggregate_current_event_version,
+          event_name: event_name,
+          event_args: data
+        })
+
+        self
+      end
+
     end
   end
 end

data/lib/sandthorn/aggregate_root_marshal.rb

@@ -1,9 +1,6 @@
-require "sandthorn/aggregate_root_base"
-
 module Sandthorn
   module AggregateRoot
     module Marshal 
-      include Sandthorn::AggregateRoot::Base
 
       def aggregate_initialize *args
         @aggregate_attribute_deltas = []

data/lib/sandthorn/version.rb

@@ -1,3 +1,3 @@
 module Sandthorn
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

data/spec/aggregate_events_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+module Sandthorn
+  class EventsSpec
+    include AggregateRoot
+
+    events :name_changed, :some_other_event, :third_event
+    attr_reader :name
+
+    def change_name(name)
+      if @name != name
+        name_changed(name) { @name = name }
+      end
+    end
+
+    def some_other one, two
+      some_other_event one, two
+    end
+
+    def old_way_event event_params
+      commit event_params
+    end
+  end
+
+  describe "::events" do
+
+    let(:subject) do
+      EventsSpec.new.extend EventInspector
+    end
+
+    it "should not expose events methods" do
+      expect(subject).not_to respond_to(:name_changed)
+    end
+    
+    it "should make the events methods private" do
+      expect(subject.private_methods).to include(:name_changed)
+    end
+
+    describe ".change_name" do
+    
+      before do
+        subject.change_name "new name"
+      end
+
+      it "should set the name instance variable" do
+        expect(subject.name).to eql "new name"
+      end
+    
+      it "should store the event params as methods args" do
+        expect(subject.has_event?(:name_changed)).to be_truthy
+      end
+
+      it "should store the args to the event" do
+        expect(subject.aggregate_events[1][:event_args][:method_args][0][0]).to eql("new name")
+      end
+    end
+
+    describe ".some_other" do
+    
+      before do
+        subject.some_other 1, 2
+      end
+    
+      it "should store the event" do
+        expect(subject.has_event?(:some_other_event)).to be_truthy
+      end
+
+      it "should store the args to the event" do
+        expect(subject.aggregate_events[1][:event_args][:method_args][0]).to eql([1,2])
+      end
+    end
+
+    describe ".old_way_event" do
+      
+      before do
+        subject.old_way_event "hej"
+      end
+
+      it "should store the event the old way" do
+        expect(subject.has_event?(:old_way_event)).to be_truthy
+      end
+
+      it "should store the args to the event" do
+        expect(subject.aggregate_events[1][:event_args][:method_args][0][0]).to eql("hej")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -30,6 +30,10 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
   config.before(:each) { sqlite_store_setup }
+
+  config.after(:each) do
+    Sandthorn.event_stores.default_store.driver.instance_variable_get(:@db).disconnect
+  end
 end
 
 def spec_db

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sandthorn
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Lars Krantz
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -200,6 +200,7 @@ files:
 - lib/sandthorn/version.rb
 - sandthorn.gemspec
 - spec/aggregate_delta_spec.rb
+- spec/aggregate_events_spec.rb
 - spec/aggregate_root_spec.rb
 - spec/aggregate_snapshot_spec.rb
 - spec/benchmark_spec.rb
@@ -236,12 +237,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Event sourcing gem
 test_files:
 - spec/aggregate_delta_spec.rb
+- spec/aggregate_events_spec.rb
 - spec/aggregate_root_spec.rb
 - spec/aggregate_snapshot_spec.rb
 - spec/benchmark_spec.rb