sandthorn 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 264411828ceee4ea1915efe3f722133d514b4bf2
-  data.tar.gz: ec65529f45578093403dd4fc53042ea98b527594
+  metadata.gz: 29159ff3ce6f7b8393363e2bf740c3a37d57a2b2
+  data.tar.gz: 9b1053c87fb402b1887acb6bc8a0fd6faee71ebf
 SHA512:
-  metadata.gz: 0d6ddfdf0147881f3d2346f7eee7d25a2d8c63e497d93bae583a94b49f78d34790ce16aa611aece9fdfcb179f70026cd095708c974b40828678ff7c3b87354cd
-  data.tar.gz: 40747fe40ae47821bef14ff855876861a2d2c76d7a69749d363282cc9f3c2eb291d07b188d1793f8c04fde83f2175a5473b3d56884e2b45166f73ea37a1b7ad9
+  metadata.gz: e5cf43faad3a61d3fe307c1598701e99644c7f2d7ea57aa336cd6f22fe9b4c6d707406657ee824619baf0b32ff5418500b46649ace7e1cefa25092529a739b7c
+  data.tar.gz: 2802ac2bf37494ff1ddd4cfd050057e070ddad9422ccee0f9078be37c12c2772bf3402ca7cee6ce92839c042df04df996b658cf3b50bbd1376e60231e590440f

data/README.md

@@ -222,9 +222,9 @@ In this exampel the `events` method will generate a method called `marked`, this
 ```ruby
 class Board
   include Sandthorn::AggregateRoot
-  
+
   events :marked
-  
+
   def mark player, pos_x, pos_y
     # change some state
     marked(player) do
@@ -235,6 +235,43 @@ class Board
 end
 ```
 
+### `Sandthorn::AggregateRoot::constructor_events`
+
+Before version 0.13.0 the only initial event on an aggregate were `new`. With the `constructor_events` its possible to be more specific on how an aggregate came to be.
+
+```ruby
+class Board
+  include Sandthorn::AggregateRoot
+
+  # creates a private class method `board_created`
+  contructor_events :board_created
+
+  def self.create name
+
+    board_created(name) do
+      @name = name
+    end
+  end
+end
+```
+
+### `Sandthorn::AggregateRoot::stateless_events`
+
+Calling `stateless_events` creates public class methods. The first argument is an `aggregate_id`. The resulting event is attached to the referenced aggregate. The rest of the arguments are optional and are stored in the method_args of the event.
+
+When creating a stateless event, the corresponding aggregate is never loaded. The event is appendend to the aggregate's event stream.
+
+```ruby
+class Board
+  include Sandthorn::AggregateRoot
+
+  stateless_events :player_went_to_toilet
+
+end
+
+Board.player_went_to_toilet "board_aggregate_id", player_id, time
+```
+
 ### `Sandthorn::AggregateRoot::default_attributes`
 
 Its possible to add a default_attributes method on an aggregate and set default values to new and already created aggregates.
@@ -264,7 +301,7 @@ 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. 
+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`
 
@@ -328,7 +365,7 @@ In this case, the resulting events from the commands `new` and `mark` will have
 
 ## Bounded Context
 
-A bounded context is a system divider that split large systems into smaller parts. [Bounded Context by Martin Fowler](http://martinfowler.com/bliki/BoundedContext.html) 
+A bounded context is a system divider that split large systems into smaller parts. [Bounded Context by Martin Fowler](http://martinfowler.com/bliki/BoundedContext.html)
 
 A module can include `Sandthorn::BoundedContext` and all aggregates within the module can be retreived via the ::aggregate_types method on the module. A use case is to use it when Sandthorn is configured and setup all aggregates in a bounded context to a driver.
 

data/lib/sandthorn/aggregate_root_base.rb

@@ -6,7 +6,6 @@ module Sandthorn
       attr_reader :aggregate_events
       attr_reader :aggregate_current_event_version
       attr_reader :aggregate_originating_version
-      attr_reader :aggregate_stored_serialized_object
       attr_reader :aggregate_trace_information
 
       alias :id :aggregate_id
@@ -72,8 +71,8 @@ module Sandthorn
         end
 
         def all
-          Sandthorn.all(self).map { |events| 
-            aggregate_build events 
+          Sandthorn.all(self).map { |events|
+            aggregate_build events
           }
         end
 
@@ -116,7 +115,7 @@ module Sandthorn
           end
 
           if events.any?
-            current_aggregate_version = events.last[:aggregate_version] 
+            current_aggregate_version = events.last[:aggregate_version]
             aggregate.send :set_orginating_aggregate_version!, current_aggregate_version
             aggregate.send :set_current_aggregate_version!, current_aggregate_version
           end
@@ -131,6 +130,37 @@ module Sandthorn
           aggregate
         end
 
+
+
+        def stateless_events(*event_names)
+          event_names.each do |name|
+            define_singleton_method name do |aggregate_id, *args|
+              event = build_event(name.to_s, args, [], nil)
+              Sandthorn.save_events([event], aggregate_id, self)
+              return aggregate_id
+
+            end
+          end
+        end
+
+        def constructor_events(*event_names)
+          event_names.each do |name|
+            define_singleton_method name do |*args, &block|
+
+              create_new_empty_aggregate.tap  do |aggregate|
+                aggregate.aggregate_base_initialize
+                aggregate.aggregate_initialize
+                aggregate.send :set_aggregate_id, Sandthorn.generate_aggregate_id
+                aggregate.instance_eval(&block) if block
+                aggregate.send :commit_with_event_name, name.to_s, args
+                return aggregate
+              end
+
+            end
+            self.singleton_class.class_eval { private name.to_s }
+          end
+        end
+
         def events(*event_names)
           event_names.each do |name|
             define_method(name) do |*args, &block|
@@ -143,6 +173,26 @@ module Sandthorn
 
         private
 
+        def build_event name, args, attribute_deltas, aggregate_version, trace_information = nil
+
+          data = {
+            method_name: name,
+            method_args: args,
+            attribute_deltas: attribute_deltas
+          }
+
+          unless trace_information.nil? || trace_information.empty?
+            data.merge!({ trace: trace_information })
+          end
+
+          return {
+            aggregate_version: aggregate_version,
+            event_name: name,
+            event_args: data
+          }
+
+        end
+
         def build_instance_vars_from_events events
           events.each_with_object({}) do |event, instance_vars|
             event_args = event[:event_args]

data/lib/sandthorn/version.rb

@@ -1,3 +1,3 @@
 module Sandthorn
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/spec/constructor_events_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+module Sandthorn
+  class ConstructorEventsSpec
+    include AggregateRoot
+
+    constructor_events :created_event
+    attr_reader :name
+
+
+    def self.create name
+      created_event(name) { @name = name }
+    end
+
+  end
+
+  describe "::constructor_events" do
+
+    let(:subject) do
+      ConstructorEventsSpec.create("name").save
+    end
+
+    context "interface" do
+
+      it "should not expose constructor_events methods" do
+        expect(subject).not_to respond_to(:created_event)
+      end
+
+      it "should create the constructor event on the class" do
+        expect(ConstructorEventsSpec.private_methods).to include(:created_event)
+      end
+
+    end
+  end
+
+  describe "::create" do
+    let(:aggregate_id) do
+      a = ConstructorEventsSpec.create("create_name")
+      a.save
+      a.aggregate_id
+    end
+
+    it "should create an ConstructorEventsSpec aggregate" do
+      expect(ConstructorEventsSpec.find(aggregate_id)).to be_a ConstructorEventsSpec
+    end
+
+    it "should set instance variable in aggregate" do
+      expect(ConstructorEventsSpec.find(aggregate_id).name).to eql "create_name"
+    end
+
+    it "should have created an created_event" do
+      expect(Sandthorn.get_aggregate_events(ConstructorEventsSpec, aggregate_id).first[:event_name]).to eql "created_event"
+    end
+
+    it "should have set the method_args to create_name" do
+      expect(Sandthorn.get_aggregate_events(ConstructorEventsSpec, aggregate_id).first[:event_args][:method_args].first).to eql "create_name"
+    end
+
+    it "should have set the attribute_delta name" do
+      expect(Sandthorn.get_aggregate_events(ConstructorEventsSpec, aggregate_id).first[:event_args][:attribute_deltas].last[:attribute_name]).to eql "name"
+      expect(Sandthorn.get_aggregate_events(ConstructorEventsSpec, aggregate_id).first[:event_args][:attribute_deltas].last[:new_value]).to eql "create_name"
+    end
+  end
+end

data/spec/default_attributes_spec.rb

@@ -1,14 +1,28 @@
 require 'spec_helper'
 
-class DefaultAttributes
-  include Sandthorn::AggregateRoot
-  def initialize 
-  end
-end
+# class DefaultAttributes
+#   include Sandthorn::AggregateRoot
+#   def initialize
+#   end
+# end
 
 
 describe "when the initialize-method changes" do
 
+  before do
+    class DefaultAttributes
+      include Sandthorn::AggregateRoot
+      def initialize
+      end
+    end
+
+  end
+
+  #Make sure the DefaultAttributes class are reset on every test
+  after do
+    Object.send(:remove_const, :DefaultAttributes)
+  end
+
   it "should not have an array attribute on first version of the DefaultAttributes class" do
     aggregate = DefaultAttributes.new
     expect(aggregate.respond_to?(:array)).to be_falsy
@@ -20,20 +34,33 @@ describe "when the initialize-method changes" do
       DefaultAttributes.class_eval do
         attr_reader :array
         define_method :default_attributes, lambda { @array = [] }
+        define_method :add_item, lambda { |item|
+          @array << item
+          commit
+        }
       end
     end
 
-    it "should have set the array attribute to [] on rebuilt " do
+    it "should have an set the array attribute to [] on new" do
+      add_default_attributes
+      aggregate = DefaultAttributes.new
+      expect(aggregate.array).to eql []
+    end
+
+    it "should have set the array attribute to [] on rebuilt when attribute is intruduced after `new`" do
       aggregate = DefaultAttributes.new
       add_default_attributes
       rebuilt_aggregate = DefaultAttributes.aggregate_build(aggregate.aggregate_events)
       expect(rebuilt_aggregate.array).to eql []
     end
 
-    it "should have an set the array attribute to [] on new" do
+    it "should set the array attribute to ['banana'] on rebuilt" do
       add_default_attributes
       aggregate = DefaultAttributes.new
-      expect(aggregate.array).to eql []
+      aggregate.add_item 'banana'
+      rebuilt_aggregate = DefaultAttributes.aggregate_build(aggregate.aggregate_events)
+      expect(rebuilt_aggregate.array).to eql ['banana']
     end
+
   end
 end

data/spec/stateless_events_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+module Sandthorn
+  class StatelessEventsSpec
+    include AggregateRoot
+
+    stateless_events :one_event, :some_other_event
+    attr_reader :name
+
+    def initialize name
+      @name = name
+    end
+
+  end
+
+  describe "::stateless_events" do
+
+    context "interface" do
+
+      it "should expose stateless_events methods" do
+        expect(StatelessEventsSpec).to respond_to(:one_event)
+      end
+
+    end
+
+    context "when adding a stateless event to an existing aggregate" do
+
+      let(:subject) do
+        StatelessEventsSpec.new("name").save
+      end
+
+      before do
+        StatelessEventsSpec.one_event(subject.aggregate_id, args, 1)
+      end
+
+      let(:args) do
+        {first: "first", other: [1,2,3]}
+      end
+
+      let(:last_event) do
+        Sandthorn.get_aggregate_events(StatelessEventsSpec, subject.aggregate_id).last
+      end
+
+      let(:reloaded_subject) do
+        StatelessEventsSpec.find subject.aggregate_id
+      end
+
+      it "should add one_event last on the aggregate" do
+        expect(last_event[:event_name]).to eql "one_event"
+      end
+
+      it "should not have any deltas in event" do
+        expect(last_event[:event_args][:attribute_deltas]).to eql []
+      end
+
+      it "should store event arguments" do
+        expect(last_event[:event_args][:method_args].first).to eql(args)
+        expect(last_event[:event_args][:method_args].last).to eql(1)
+      end
+
+      it "should have same name attribute after reload" do
+        expect(subject.name).to eql(reloaded_subject.name)
+      end
+    end
+
+    context "when adding stateless_events to none existing aggregate" do
+
+      before do
+        StatelessEventsSpec.one_event(aggregate_id, "argument_data")
+      end
+
+      let(:aggregate_id) {"none_existing_aggregate_id"}
+
+      let(:events) do
+        Sandthorn.get_aggregate_events(StatelessEventsSpec, aggregate_id)
+      end
+
+      it "should store the stateless event as the first event" do
+        expect(events.length).to be 1
+      end
+
+      it "should have correct aggregate_id in event" do
+        expect(events.first[:aggregate_id]).to eql aggregate_id
+      end
+
+      it "should have event name one_event" do
+        expect(events.first[:event_name]).to eql "one_event"
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sandthorn
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Lars Krantz
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,6 +206,7 @@ files:
 - spec/benchmark_spec.rb
 - spec/bounded_context_spec.rb
 - spec/complex_aggregate_spec.rb
+- spec/constructor_events_spec.rb
 - spec/db/sequel_driver.sqlite3_old
 - spec/default_attributes_spec.rb
 - spec/different_driver_spec.rb
@@ -216,6 +217,7 @@ files:
 - spec/initialize_signature_change_spec.rb
 - spec/sandthorn_spec.rb
 - spec/spec_helper.rb
+- spec/stateless_events_spec.rb
 - spec/support/custom_matchers.rb
 - spec/tracing_spec.rb
 homepage: ''
@@ -250,6 +252,7 @@ test_files:
 - spec/benchmark_spec.rb
 - spec/bounded_context_spec.rb
 - spec/complex_aggregate_spec.rb
+- spec/constructor_events_spec.rb
 - spec/db/sequel_driver.sqlite3_old
 - spec/default_attributes_spec.rb
 - spec/different_driver_spec.rb
@@ -260,6 +263,7 @@ test_files:
 - spec/initialize_signature_change_spec.rb
 - spec/sandthorn_spec.rb
 - spec/spec_helper.rb
+- spec/stateless_events_spec.rb
 - spec/support/custom_matchers.rb
 - spec/tracing_spec.rb
 has_rdoc: