sandthorn 0.10.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 567a5ca0b81764696a4a80323cabeca004109fc6
-  data.tar.gz: 90db28c455cc71ae90df453771b48b15d53a453e
+  metadata.gz: 3a2f65aa6777c6570a39697fe0dd6edcbc5fe17d
+  data.tar.gz: 0a72c05d0fef7caf7c752bb24472a643b51b2854
 SHA512:
-  metadata.gz: 3499edfb4c94c63c5d2a82954e125e274109697ad0101a33c484959971f6b8d07e0c57b6573197e7758328f45460cf34debaf7e0bb9244bab05329ddb14b55ac
-  data.tar.gz: 83bb3743729b952d596f4b6583343fb055933ef480f137e60734753aceee7cf9acc9ce8a5e06e72a3e0894d0c665b5b3eb58c2f4a73288e7d4fe7b9f66311053
+  metadata.gz: a3afc677df878cb3ae51f27e3b2beb37e82d549992a0915ffcedeccdcfcbe058780b525d4c593d508495063fa2e093e74d0252846bc3bcd7fd6ccb3e3236ea66
+  data.tar.gz: 3b6a3637a931aedab5c8b1a18f76100b945ee9e84fe8dc83a0f44322e8c91cb927b40d3335720a6b08fefab0465918c4be09304915fe641cef3843b2e64f37b5

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sandthorn.gemspec
-gemspec
+gemspec

data/README.md

@@ -182,20 +182,21 @@ Sandthorn.configure do |conf|
 end
 ```
 
-## Data serialization / deserialization
+## Data serialization
 
-Its possible to configure how events and snapshots are serialized / deserialized. The default are YAML but can be overloaded in the configure block.
+Its possible to configure how events and snapshots are serialized. Since version `0.11.0` of Sandthorn the serialization of events and snapshots is the responsibility of the driver. This means drivers can have different serialization mechanism, independent of each other.
+
+The default serializer of the Sequel driver is YAML.
+
+Here's how to use the Oj gem to serialize data in the Sequel driver:
 
 ```ruby
-Sandthorn.configure do |conf|
-  conf.serializer = Proc.new { |data| Oj::dump(data) }
-  conf.deserializer = Proc.new { |data| Oj::load(data) }
-  conf.snapshot_serializer = Proc.new { |data| Oj::dump(data) }
-  conf.snapshot_deserializer = Proc.new { |data| Oj::load(data) }
-end
+oj_driver = SandthornDriverSequel.driver_from_connection(connection: Sequel.sqlite) { |conf|
+  conf.event_serializer = Proc.new { |data| Oj::dump(data) }
+  conf.event_deserializer = Proc.new { |data| Oj::load(data) }
+}
 ```
 
-
 # Usage
 
 ## Aggregate Root
@@ -238,7 +239,7 @@ end
 
 Its possible to add a default_attributes method on an aggregate and set default values to new and already created aggregates.
 
-The default_attributes method will be run before initialize on Class.new and before the events when an aggregate is rebuilt. This will make is possible to add default attributes to an aggregate during its hole life cycle.
+The `default_attributes` method will be run before initialize on Class.new and before the events when an aggregate is rebuilt. This will make is possible to add default attributes to an aggregate during its hole life cycle.
 
 ```ruby
 def default_attributes

data/lib/sandthorn.rb

@@ -10,7 +10,7 @@ module Sandthorn
   class << self
     extend Forwardable
 
-    def_delegators :configuration, :event_stores, :serialize, :deserialize, :serialize_snapshot, :deserialize_snapshot
+    def_delegators :configuration, :event_stores
 
     def default_event_store
       event_stores.default_store
@@ -28,8 +28,6 @@ module Sandthorn
       @configuration ||= Configuration.new
     end
 
-    
-
     def generate_aggregate_id
       SecureRandom.uuid
     end
@@ -46,12 +44,8 @@ module Sandthorn
       event_store_for(aggregate_type).get_aggregate_events_from_snapshot aggregate_id
     end
 
-    def save_snapshot(
-        aggregate_type: missing_key(:aggregate_type),
-        aggregate_snapshot: missing_key(:aggregate_snapshot),
-        aggregate_id: missing_key(:aggregate_id)
-    )
-      event_store_for(aggregate_type).save_snapshot(aggregate_snapshot, aggregate_id)
+    def save_snapshot(aggregate)
+      event_store_for(aggregate.class).save_snapshot(aggregate)
     end
 
     def get_aggregate_list_by_type aggregate_type
@@ -62,8 +56,6 @@ module Sandthorn
       event_store = find_event_store(event_store)
       events = event_store.get_events aggregate_types: aggregate_types, take: take, after_sequence_number: after_sequence_number
       events.map do |event|
-        event[:event_args] = deserialize event[:event_data]
-        event.delete(:event_data)
         Event.new(event)
       end
     end
@@ -111,67 +103,10 @@ module Sandthorn
         @event_stores = EventStores.new(store)
       end
 
-      def serializer=(block)
-        @serializer = block if block.is_a? Proc
-      end
-
-      def deserializer=(block)
-        @deserializer = block if block.is_a? Proc
-      end
-
-      def serializer
-        @serializer || default_serializer
-      end
-
-      def deserializer
-        @deserializer || default_deserializer
-      end
-
-      def default_serializer
-        -> (data) { YAML.dump(data) }
-      end
-
-      def default_deserializer
-        -> (data) { YAML.load(data) }
-      end
-
-      def serialize(data)
-        serializer.call(data)
-      end
-
-      def deserialize(data)
-        deserializer.call(data)
-      end
-
-      def snapshot_serializer=(block)
-        @snapshot_serializer = block if block.is_a? Proc
-      end
-
-      def snapshot_deserializer=(block)
-        @snapshot_deserializer = block if block.is_a? Proc
-      end
-
-      def snapshot_serializer
-        @snapshot_serializer || default_serializer
-      end
-
-      def snapshot_deserializer
-        @snapshot_deserializer || default_deserializer
-      end
-
-      def serialize_snapshot(data)
-        snapshot_serializer.call(data)
-      end
-
-      def deserialize_snapshot data
-        snapshot_deserializer.call(data)
-      end
-
       def map_types= data
         @event_stores.map_types data
       end
 
-      
       alias_method :event_stores=, :event_store=
     end
   end

data/lib/sandthorn/aggregate_root_base.rb

@@ -10,6 +10,7 @@ module Sandthorn
       attr_reader :aggregate_trace_information
 
       alias :id :aggregate_id
+      alias :aggregate_version :aggregate_current_event_version
 
 
       def aggregate_base_initialize
@@ -19,12 +20,7 @@ module Sandthorn
       end
 
       def save
-        aggregate_events.each do |event|
-          event[:event_data] = Sandthorn.serialize event[:event_args]
-          event[:event_args] = nil #Not send extra data over the wire
-        end
-
-        unless aggregate_events.empty?
+        if aggregate_events.any?
           Sandthorn.save_events(
             aggregate_events,
             aggregate_id,
@@ -90,26 +86,17 @@ module Sandthorn
           unless events && !events.empty?
             raise Sandthorn::Errors::AggregateNotFound
           end
-          
-          if first_event_snapshot?(events)
-            transformed_snapshot_event = events.first.merge(event_args: Sandthorn.deserialize_snapshot(events.first[:event_data]))
-            events.shift
-          end
 
-          transformed_events = events.map do |e|
-            e.merge(event_args: Sandthorn.deserialize(e[:event_data]))
-          end
-          aggregate_build ([transformed_snapshot_event] + transformed_events).compact
+          aggregate_build events
         end
 
         def new *args, &block
-
-          aggregate = allocate
+          aggregate = create_new_empty_aggregate()
           aggregate.aggregate_base_initialize
           aggregate.aggregate_initialize
 
           aggregate.default_attributes
-          aggregate.send :initialize, *args, &block 
+          aggregate.send :initialize, *args, &block
           aggregate.send :set_aggregate_id, Sandthorn.generate_aggregate_id
 
           aggregate.aggregate_trace @@aggregate_trace_information do |aggr|
@@ -119,27 +106,26 @@ module Sandthorn
 
         end
 
-
-
         def aggregate_build events
-          current_aggregate_version = 0
-
           if first_event_snapshot?(events)
-            aggregate = start_build_from_snapshot events
-            current_aggregate_version = aggregate.aggregate_originating_version
+            aggregate = events.first[:aggregate]
             events.shift
           else
             aggregate = create_new_empty_aggregate
           end
 
+          if events.any?
+            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
+
           attributes = build_instance_vars_from_events events
-          current_aggregate_version = events.last[:aggregate_version] unless events.empty?
           aggregate.send :clear_aggregate_events
+
           aggregate.default_attributes
-          aggregate.send :set_orginating_aggregate_version!, current_aggregate_version
-          aggregate.send :set_current_aggregate_version!, current_aggregate_version
           aggregate.send :aggregate_initialize
-          
+
           aggregate.send :set_instance_variables!, attributes
           aggregate
         end
@@ -159,7 +145,6 @@ module Sandthorn
         def build_instance_vars_from_events events
           events.each_with_object({}) do |event, instance_vars|
             event_args = event[:event_args]
-            event_name = event[:event_name]
             attribute_deltas = event_args[:attribute_deltas]
             unless attribute_deltas.nil?
               deltas = attribute_deltas.each_with_object({}) do |delta, acc|
@@ -171,11 +156,7 @@ module Sandthorn
         end
 
         def first_event_snapshot? events
-          events.first[:event_name].to_sym == :aggregate_set_from_snapshot
-        end
-
-        def start_build_from_snapshot events
-          snapshot = events.first[:event_args][0]
+          events.first[:aggregate]
         end
 
         def create_new_empty_aggregate

data/lib/sandthorn/aggregate_root_snapshot.rb

@@ -13,39 +13,10 @@ module Sandthorn
         raise Errors::SnapshotError,
           "Can't take snapshot on object with unsaved events"
       end
-
-      @aggregate_snapshot = {
-        event_name: "aggregate_set_from_snapshot",
-        event_args: [self],
-        aggregate_version: @aggregate_current_event_version
-      }
     end
 
     def save_snapshot
-      unless aggregate_snapshot
-        raise Errors::SnapshotError, "No snapshot has been created!"
-      end
-      @aggregate_snapshot[:event_data] = Sandthorn.serialize_snapshot @aggregate_snapshot[:event_args]
-      @aggregate_snapshot[:event_args] = nil
-      Sandthorn.save_snapshot(aggregate_snapshot: @aggregate_snapshot, aggregate_id: @aggregate_id, aggregate_type: self.class)
-      @aggregate_snapshot = nil
-    end
-    private
-    def aggregate_create_event_when_extended
-      self.aggregate_snapshot!
-      vars = extract_relevant_aggregate_instance_variables
-      vars.each do |var_name|
-        value = instance_variable_get var_name
-        dump = Marshal.dump(value)
-        store_aggregate_instance_variable var_name, dump
-      end
-
-      @aggregate_snapshot[:event_data] = Sandthorn
-        .serialize_snapshot aggregate_snapshot[:event_args]
-
-      @aggregate_snapshot[:event_args] = nil
-      Sandthorn.save_snapshot aggregate_snapshot, aggregate_id
-      @aggregate_snapshot = nil
+      Sandthorn.save_snapshot(self)
     end
   end
 end

data/lib/sandthorn/version.rb

@@ -1,3 +1,3 @@
 module Sandthorn
-  VERSION = "0.10.3"
+  VERSION = "0.11.0"
 end

data/sandthorn.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "autotest-standalone"
   spec.add_development_dependency "sqlite3"  
   spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "sandthorn_driver_sequel", "~> 2.0"
+  spec.add_development_dependency "sandthorn_driver_sequel", ">= 3.0"
 end

data/spec/aggregate_root_spec.rb

@@ -87,7 +87,7 @@ module Sandthorn
         it "should set the values" do
           expect(subject.name).to eql "Mogge"
           expect(subject.sex).to eql "hen"
-          expect{subject.writer}.to raise_error
+          expect{subject.writer}.to raise_error NoMethodError
         end
       end
 
@@ -117,12 +117,12 @@ module Sandthorn
 
       context "when changing writer (attr_writer)" do
         it "should raise error" do
-          expect{dirty_object.change_writer "new_writer"}.to raise_error
+          expect{dirty_object.change_writer "new_writer"}.to raise_error NameError
         end
       end
 
       context "save" do
-        it "should not have events on aggregete after save" do
+        it "should not have events on aggregate after save" do
           expect(dirty_object.save.aggregate_events.length).to eql 0
         end
 
@@ -147,7 +147,7 @@ module Sandthorn
         end
 
         it "should raise error if trying to find id that not exist" do
-          expect{DirtyClass.find("666")}.to raise_error
+          expect{DirtyClass.find("666")}.to raise_error Sandthorn::Errors::AggregateNotFound
         end
       end
 

data/spec/aggregate_snapshot_spec.rb

@@ -185,17 +185,10 @@ describe 'when generating state on an aggregate root' do
     expect(@account.unpaid_interest_balance).to be > 1000
   end
 
-  it 'should store snapshot data in aggregate_snapshot' do
-    expect(@account.aggregate_snapshot).to be_a(Hash)
-  end
-
-  it 'should store aggregate_version in aggregate_snapshot' do
-    expect(@account.aggregate_snapshot[:aggregate_version]).to eql(@original_account.aggregate_current_event_version)
-  end
 
   it 'should be able to load up from snapshot' do
 
-    events = [@account.aggregate_snapshot]
+    events = [aggregate: @account]
     loaded = BankAccount.aggregate_build events
 
     expect(loaded.balance).to eql(@original_account.balance)
@@ -227,9 +220,7 @@ end
 
 describe 'when saving to repository' do
   let(:account) {a_test_account.extend Sandthorn::AggregateRootSnapshot}
-  it 'should raise an error if trying to save before creating a snapshot' do
-    expect(lambda {account.save_snapshot}).to raise_error (Sandthorn::Errors::SnapshotError)
-  end
+
   it 'should not raise an error if snapshot was created' do
     account.save
     account.aggregate_snapshot!
@@ -243,7 +234,7 @@ describe 'when saving to repository' do
   end
 
   it 'should raise error if trying to create snapshot before events are saved on object' do
-    expect(lambda {account.aggregate_snapshot!}).to raise_error
+    expect(lambda {account.aggregate_snapshot!}).to raise_error Sandthorn::Errors::SnapshotError
   end
 
   it 'should not raise an error if trying to create snapshot on object when events are saved' do

data/spec/spec_helper.rb

@@ -40,14 +40,17 @@ def spec_db
   "sqlite://spec/db/sequel_driver.sqlite3"
 end
 def sqlite_store_setup
-  url = spec_db 
-  driver = SandthornDriverSequel.driver_from_url(url: url)
+  url = spec_db
+
+  driver = SandthornDriverSequel.driver_from_url(url: url) do |conf|
+    conf.event_serializer       = Proc.new { |data| YAML::dump(data) }
+    conf.event_deserializer     = Proc.new { |data| YAML::load(data) }
+    conf.snapshot_serializer    = Proc.new { |data| YAML::dump(data) }
+    conf.snapshot_deserializer  = Proc.new { |data| YAML::load(data) }
+  end
+
   Sandthorn.configure do |c|
     c.event_store = driver
-    c.serializer = Proc.new { |data| YAML::dump(data) }
-    c.deserializer = Proc.new { |data| YAML::load(data) }
-    c.snapshot_serializer = Proc.new { |data| YAML::dump(data) }
-    c.snapshot_deserializer = Proc.new { |data| YAML::load(data) }
   end
   migrator = SandthornDriverSequel::Migration.new url: url
   SandthornDriverSequel.migrate_db url: url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sandthorn
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.11.0
 platform: ruby
 authors:
 - Lars Krantz
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,16 +156,16 @@ dependencies:
   name: sandthorn_driver_sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: Event sourcing gem
 email:
 - lars.krantz@alaz.se