sandthorn 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: eb2833dc0d8dfa96bc80089a176f2718040f1107f0305232840e3009232511bb
-  data.tar.gz: 1c57a94df6798dfa32a1050d105bec05ccf30e08876c0a50aa610e3f7be3ce11
+SHA1:
+  metadata.gz: 6972dfa7eb47e800f74d28d1680403c805bb8f81
+  data.tar.gz: 5ff2d842c430fb11fe405f071698053163e943c6
 SHA512:
-  metadata.gz: f21f398f4bbfc6ed3e23be70e294f5fbabfec60d1ed69bb03b8efd0f047d2131d9d225f4dd9794a24d45661ad6200b85364b54c50590825f0fa4bf9eb1d6759d
-  data.tar.gz: 027501a879da6025ffd51511e88b8affb9eb21e2e493086e143cab1faaa50e462142771a423a1e93f0d7b31f81da381869f7cfbebe5caf8a82880863c9ac9b4d
+  metadata.gz: be7b451226e349e592599358cec26170fa32651b7b9cc27044a083a017b901ef5fe977b5c8e0673be89a167e99871538da1c4b90df32d088444e0f878f75bc5d
+  data.tar.gz: f3d545cd1be566ec4870e625ef99cdaa95a78d986308339a329fb251c504399349da9867ba073518e1c83996cea7947cdc10d22c05e5d8b573f4d63fac895650

data/.travis.yml

@@ -2,7 +2,5 @@ language: ruby
 rvm:
   - 2.4.1
   - 2.3.4
-  - 2.2.6
-  - 2.1.10
-  - 2.0.0
+  - 2.2.7
 sudo: false

data/README.md

@@ -241,6 +241,50 @@ end
 
 In this case, the resulting events from the commands `new` and `mark` will have the trace `{ip: :127.0.0.1}` attached to them.
 
+### `Sandthorn::AggregateRoot.unsaved_events?`
+
+Check if there are unsaved events attached to the aggregate.
+
+```ruby
+board = Board.new
+board.mark :o, 0, 1
+board.unsaved_events?
+=> true
+```
+
+## Snapshot
+
+If there is a lot of events saved to an aggregate it can take some time to reload the current state of the aggregate via the `.find` method. This is because all events belonging to the aggregate has to be fetched and iterated one by one to build its current state. The snapshot functionality makes it possible to store the current aggregate state and re-use it when loading the aggregate. The snapshot is used as a cache where only the events that has occurred after the snapshot has to be fetched and used to build the current state of the aggregate.
+
+There is one global snapshot store where all snapshots are stored independent on aggregate_type. To enable snapshot on a aggregate_type the Class has to be added to the `snapshot_types` Array when configuring Sandthorn. The aggregate will now be stored to the snapshot_store on every `.save` and when using `.find` it will look for a snapshot of the requested aggregate.
+
+Currently its only possible to store the snapshots in memory, so be careful not draining your applications memory space.
+
+
+```ruby
+
+class Board
+  include Sandthorn::AggregateRoot
+end
+
+Sandthorn.configure do |c|
+  c.snapshot_types = [Board]
+end
+```
+
+Its also possible to take manual snapshots without enabling snapshots on the aggregate_type.
+
+```ruby
+board = Board.new
+board.save
+
+# Save snapshot of the board aggregate
+Sandthorn.save_snapshot board
+
+# Get snapshot
+snapshot = Sandthorn.find_snapshot board.aggregate_id
+```
+
 ## 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)

data/lib/sandthorn.rb

@@ -2,6 +2,7 @@ require "sandthorn/version"
 require "sandthorn/errors"
 require "sandthorn/aggregate_root"
 require "sandthorn/event_stores"
+require "sandthorn/snapshot_store"
 require 'yaml'
 require 'securerandom'
 
@@ -10,6 +11,7 @@ module Sandthorn
     extend Forwardable
 
     def_delegators :configuration, :event_stores
+    def_delegators :configuration, :snapshot_store
 
     def default_event_store
       event_stores.default_store
@@ -39,12 +41,17 @@ module Sandthorn
       event_store_for(aggregate_type).all(aggregate_type)
     end
 
-    def find aggregate_id, aggregate_type
-      event_store_for(aggregate_type).find(aggregate_id, aggregate_type)
+    def find aggregate_id, aggregate_type, after_aggregate_version = 0
+      event_store_for(aggregate_type).find(aggregate_id, aggregate_type, after_aggregate_version)
     end
 
-    def save_snapshot(aggregate)
-      raise "Not Implemented"
+    def save_snapshot aggregate
+      raise Errors::SnapshotError, "Can't take snapshot on object with unsaved events" if aggregate.unsaved_events?
+      snapshot_store.save aggregate.aggregate_id, aggregate
+    end
+
+    def find_snapshot aggregate_id
+      return snapshot_store.find aggregate_id
     end
 
     def find_event_store(name)
@@ -84,6 +91,16 @@ module Sandthorn
         @event_stores.map_types data
       end
 
+      def snapshot_store
+        @snapshot_store ||= SnapshotStore.new
+      end
+
+      def snapshot_types= aggregate_types
+        aggregate_types.each do |aggregate_type|
+          aggregate_type.snapshot(true)
+        end
+      end
+
       alias_method :event_stores=, :event_store=
     end
   end

data/lib/sandthorn/aggregate_root_base.rb

@@ -29,6 +29,8 @@ module Sandthorn
           @aggregate_originating_version = @aggregate_current_event_version
         end
 
+        Sandthorn.save_snapshot self if self.class.snapshot
+
         self
       end
 
@@ -36,6 +38,10 @@ module Sandthorn
         other.respond_to?(:aggregate_id) && aggregate_id == other.aggregate_id
       end
 
+      def unsaved_events?
+        aggregate_events.any?
+      end
+
       def aggregate_trace args
         @aggregate_trace_information = args
         yield self if block_given?
@@ -70,9 +76,17 @@ module Sandthorn
           end
         end
 
+        def snapshot(value = nil)
+          if value
+            @snapshot = value
+          else
+            @snapshot
+          end
+        end
+
         def all
           Sandthorn.all(self).map { |events|
-            aggregate_build events
+            aggregate_build events, nil
           }
         end
 
@@ -83,12 +97,14 @@ module Sandthorn
 
         def aggregate_find aggregate_id
           begin
-            events = Sandthorn.find(aggregate_id, self)
-            unless events && !events.empty?
+            aggregate_from_snapshot = Sandthorn.find_snapshot(aggregate_id) if self.snapshot
+            current_aggregate_version = aggregate_from_snapshot.nil? ? 0 : aggregate_from_snapshot.aggregate_current_event_version
+            events = Sandthorn.find(aggregate_id, self, current_aggregate_version)
+            if aggregate_from_snapshot.nil? && events.empty?
               raise Errors::AggregateNotFound
             end
 
-            return aggregate_build events
+            return aggregate_build events, aggregate_from_snapshot
           rescue Exception
             raise Errors::AggregateNotFound
           end
@@ -111,8 +127,8 @@ module Sandthorn
 
         end
 
-        def aggregate_build events
-          aggregate = create_new_empty_aggregate
+        def aggregate_build events, aggregate_from_snapshot = nil
+          aggregate = aggregate_from_snapshot || create_new_empty_aggregate
 
           if events.any?
             current_aggregate_version = events.last[:aggregate_version]

data/lib/sandthorn/snapshot_store.rb

@@ -0,0 +1,17 @@
+module Sandthorn
+  class SnapshotStore
+  	def initialize
+      @store = Hash.new
+    end
+
+    attr_reader :store
+
+    def save key, value
+      @store[key] = value
+    end
+
+    def find key
+      @store[key]
+    end
+  end
+end

data/lib/sandthorn/version.rb

@@ -1,3 +1,3 @@
 module Sandthorn
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/sandthorn.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Sandthorn::VERSION
   spec.authors       = ["Lars Krantz", "Morgan Hallgren", "Jesper Josefsson"]
   spec.email         = ["lars.krantz@alaz.se", "morgan.hallgren@gmail.com", "jesper.josefsson@gmail.com"]
-  spec.description   = %q{Event sourcing gem}
+  spec.description   = %q{Event sourcing}
   spec.summary       = %q{Event sourcing gem}
   spec.homepage      = "https://github.com/Sandthorn/sandthorn"
   spec.license       = "MIT"

data/spec/aggregate_root_spec.rb

@@ -51,6 +51,17 @@ module Sandthorn
       end
     end
 
+    describe "::snapshot" do
+      let(:klass) { Class.new { include Sandthorn::AggregateRoot } }
+      it "is available as a class method" do
+        expect(klass).to respond_to(:snapshot)
+      end
+      it "sets the snapshot to true and returns it" do
+        klass.snapshot(true)
+        expect(klass.snapshot).to eq(true)
+      end
+    end
+
     describe "when get all aggregates from DirtyClass" do
       
       before(:each) do

data/spec/snapshot_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+module Sandthorn
+  module Snapshot
+    class KlassOne
+      include Sandthorn::AggregateRoot
+      snapshot true
+    end
+
+    class KlassTwo
+      include Sandthorn::AggregateRoot
+    end
+
+    class KlassThree
+      include Sandthorn::AggregateRoot
+    end
+
+    describe "::snapshot" do
+      before do
+        Sandthorn.configure do |c|
+          c.snapshot_types = [KlassTwo]
+        end
+      end
+      it "snapshot should be enabled on KlassOne and KlassTwo but not KlassThree" do
+        expect(KlassOne.snapshot).to be_truthy
+        expect(KlassTwo.snapshot).to be_truthy
+        expect(KlassThree.snapshot).not_to be_truthy
+      end
+    end
+
+    describe "find snapshot on snapshot enabled aggregate" do
+      let(:klass) { KlassOne.new.save }
+
+      it "should find on snapshot enabled Class" do
+        copy = KlassOne.find klass.aggregate_id
+        expect(copy.aggregate_version).to eql(klass.aggregate_version)
+      end
+
+      it "should get saved snapshot" do
+        copy = Sandthorn.find_snapshot klass.aggregate_id
+        expect(copy.aggregate_version).to eql(klass.aggregate_version)
+      end
+
+    end
+
+    describe "save and find snapshot on snapshot disabled aggregate" do
+      let(:klass) { KlassThree.new.save }
+
+      it "should not find snapshot" do
+        snapshot = Sandthorn.find_snapshot klass.aggregate_id
+        expect(snapshot).to be_nil
+      end
+
+      it "should save and get saved snapshot" do
+        Sandthorn.save_snapshot klass
+        snapshot = Sandthorn.find_snapshot klass.aggregate_id
+        expect(snapshot).not_to be_nil
+
+        #Check by key on the snapshot_store hash
+        expect(Sandthorn.snapshot_store.store.has_key?(klass.aggregate_id)).to be_truthy
+        
+      end
+
+    end
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -45,17 +45,13 @@ end
 def url
   "sqlite://spec/db/sequel_driver.sqlite3"
 end
+
 def sqlite_store_setup
 
   SandthornDriverSequel.migrate_db url: url
-
-  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) }
-  end
   
   Sandthorn.configure do |c|
-    c.event_store = driver
+    c.event_store = SandthornDriverSequel.driver_from_url(url: url)
   end
  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sandthorn
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Lars Krantz
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -166,7 +166,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-description: Event sourcing gem
+description: Event sourcing
 email:
 - lars.krantz@alaz.se
 - morgan.hallgren@gmail.com
@@ -182,20 +182,18 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock.old
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/sandthorn.rb
 - lib/sandthorn/aggregate_root.rb
 - lib/sandthorn/aggregate_root_base.rb
 - lib/sandthorn/aggregate_root_marshal.rb
-- lib/sandthorn/aggregate_root_snapshot.rb
 - lib/sandthorn/bounded_context.rb
 - lib/sandthorn/errors.rb
 - lib/sandthorn/event_inspector.rb
 - lib/sandthorn/event_stores.rb
+- lib/sandthorn/snapshot_store.rb
 - lib/sandthorn/version.rb
 - sandthorn.gemspec
 - spec/aggregate_delta_spec.rb
@@ -209,6 +207,7 @@ files:
 - spec/default_attributes_spec.rb
 - spec/event_stores_spec.rb
 - spec/initialize_signature_change_spec.rb
+- spec/snapshot_spec.rb
 - spec/spec_helper.rb
 - spec/stateless_events_spec.rb
 - spec/support/custom_matchers.rb
@@ -233,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Event sourcing gem
@@ -249,6 +248,7 @@ test_files:
 - spec/default_attributes_spec.rb
 - spec/event_stores_spec.rb
 - spec/initialize_signature_change_spec.rb
+- spec/snapshot_spec.rb
 - spec/spec_helper.rb
 - spec/stateless_events_spec.rb
 - spec/support/custom_matchers.rb

data/Gemfile.lock.old

@@ -1,54 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sandthorn (0.0.1)
-      upptec_event_sequel_driver (~> 1.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    autotest-standalone (4.5.11)
-    awesome_print (1.2.0)
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    gem-release (0.7.1)
-    method_source (0.8.2)
-    pg (0.17.1)
-    pry (0.9.12.6)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    pry-doc (0.5.1)
-      pry (>= 0.9)
-      yard (>= 0.8)
-    rake (10.1.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    sequel (4.7.0)
-    slop (3.4.7)
-    sqlite3 (1.3.9)
-    upptec_event_sequel_driver (1.2.2)
-      pg
-      sequel
-    yard (0.8.7.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  autotest-standalone
-  awesome_print
-  bundler (~> 1.3)
-  gem-release
-  pry
-  pry-doc
-  rake
-  rspec
-  sandthorn!
-  sqlite3

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Lars Krantz
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/sandthorn/aggregate_root_snapshot.rb

@@ -1,22 +0,0 @@
-module Sandthorn
-  module AggregateRootSnapshot
-    attr_reader :aggregate_snapshot
-
-    def snapshot
-      aggregate_snapshot!
-      save_snapshot
-      self
-    end
-
-    def aggregate_snapshot!
-      if @aggregate_events.count > 0
-        raise Errors::SnapshotError,
-          "Can't take snapshot on object with unsaved events"
-      end
-    end
-
-    def save_snapshot
-      Sandthorn.save_snapshot(self)
-    end
-  end
-end