snapshot_aggregate_root 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d356e58389d1bb33fdd4462cb9b2df873d94c83e
+  data.tar.gz: 558e2953a0d60cbd5880b9d18748e3f33f7a8fd3
+SHA512:
+  metadata.gz: afbf998b72579cae65db5451109cb5fa8173c0963e2782f2553b1e0adc774ad386f42b665f268344df43a5d4ed59bb150d995738517255807d10028068f9c916
+  data.tar.gz: 4ba0fda9221166df43c470d99065f4283251626bc5a02700577c9536f06341dbaf1e18a8661c46e35c802fc9df6b20a4865a10456f6a9a6bb58bf42b0d384abb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'safe_ruby_event_store', path: '../safe_ruby_event_store'

data/README.md

@@ -0,0 +1,34 @@
+# SnapshotAggregateRoot
+
+An extension of https://github.com/arkency/aggregate_root with support for concurrent writers.
+
+## Usage
+
+### Snapshots
+
+Snapshots are created automatically as required by the `#store` method.  Implementations of this class must implement
+2 methods.
+
+* `#build_snapshot`
+* `#apply_snapshot(snapshot)`
+
+Optionally Implementations may also override
+
+* `#snapshot_threshold` - Override how often snapshots are taken
+* `#requires_snapshot?`- Provide a custom implementation for when snapshots a required
+
+
+### Concurrent Writers
+
+In order to be safe for current writes snapshot aggregate root exposes a `#with_write_context(stream_name, event_store:)` method. This method loads the aggregate, applies the block, then stores the events within a mutex so that only one concurrent writer can execute the block.  Event handlers are triggered after the command is complete
+
+The entire command handler for a snapshot aggregate root should be executed within this block eg.
+
+```
+  def apply_command(command)
+    SomeAggregate.new.with_write_context(command.aggregate_id) do |aggregate|
+      aggregate.do_command(command)
+    end
+  end
+```
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/snapshot_aggregate_root.rb

@@ -0,0 +1,113 @@
+require 'active_support/inflector'
+require 'snapshot_aggregate_root/version'
+require 'snapshot_aggregate_root/configuration'
+require 'snapshot_aggregate_root/default_apply_strategy'
+
+module SnapshotAggregateRoot
+  attr_accessor :events_since_snapshot
+
+  def apply(event)
+    apply_strategy.(self, event)
+    unpublished_events << event
+  end
+
+  def with_lock(stream_name, event_store: default_event_store, &block)
+    event_store.with_lock(stream_name, &block)
+  end
+
+  def with_write_context(stream_name, event_store: default_event_store)
+    with_lock(stream_name, event_store: event_store) do
+      load(stream_name, event_store: event_store)
+      yield self
+      store(stream_name, event_store: event_store)
+    end
+    notify(event_store: event_store)
+  end
+
+  def load(stream_name, event_store: default_event_store)
+    @loaded_from_stream_name = stream_name
+
+    snapshot = event_store.last_stream_snapshot(stream_name)
+    if snapshot
+      apply_snapshot(snapshot)
+      events = event_store.read_events_forward(stream_name, start: snapshot.event_id, count: 0)
+    else
+      events = event_store.read_events_forward(stream_name, count: 0)
+    end
+
+    events.each(&method(:apply))
+    self.events_since_snapshot = events.count
+    @unpublished_events = nil
+    self
+  end
+
+  def store(stream_name = loaded_from_stream_name, event_store: default_event_store)
+    self.events_since_snapshot += @unpublished_events.count
+    unpublished_events.each do |event|
+      event_store.append_to_stream(event, stream_name: stream_name)
+      unnotified_events.push(event)
+    end
+    @unpublished_events = nil
+    if requires_snapshot?
+      snapshot!(stream_name, event_store: event_store)
+    end
+  end
+
+  def notify(event_store: )
+    unnotified_events.each do |event|
+      event_store.notify_subscribers(event)
+    end
+    @unnotified_events = nil
+  end
+
+  def events_since_snapshot
+    @events_since_snapshot || 0
+  end
+
+  private
+
+  attr_reader :loaded_from_stream_name
+
+  # This method must be implemented by consumers of this module
+  #
+  # Returns an Event
+  def build_snapshot
+    raise "build_snapshot not implemented in #{self}"
+  end
+
+  # This method must be implemented by consumers of this module
+  #
+  # Returns an Event
+  def apply_snapshot(snapshot)
+    raise "apply_snapshot not implemented in #{self}"
+  end
+
+  def requires_snapshot?
+    events_since_snapshot >= snapshot_threshold
+  end
+
+  def snapshot_threshold
+    50
+  end
+
+  def snapshot!(stream_name, event_store:)
+    event = build_snapshot
+    event_store.publish_snapshot(event, stream_name: stream_name)
+  end
+
+  def unpublished_events
+    @unpublished_events ||= []
+  end
+
+  def unnotified_events
+    @unnotified_events ||= []
+  end
+
+  def apply_strategy
+    DefaultApplyStrategy.new
+  end
+
+  def default_event_store
+    SnapshotAggregateRoot.configuration.default_event_store
+  end
+end

data/lib/snapshot_aggregate_root/configuration.rb

@@ -0,0 +1,14 @@
+module SnapshotAggregateRoot
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :default_event_store
+  end
+end

data/lib/snapshot_aggregate_root/default_apply_strategy.rb

@@ -0,0 +1,25 @@
+module SnapshotAggregateRoot
+  MissingHandler = Class.new(StandardError)
+
+  class DefaultApplyStrategy
+    def initialize(strict: true)
+      @strict = strict
+    end
+
+    def call(aggregate, event)
+      name = handler_name(event)
+      if aggregate.respond_to?(name, true)
+        aggregate.method(name).call(event)
+      else
+        raise MissingHandler.new("Missing handler method #{name} on aggregate #{aggregate.class}") if strict
+      end
+    end
+
+    private
+    attr_reader :strict
+
+    def handler_name(event)
+      "apply_#{event.class.name.demodulize.underscore}"
+    end
+  end
+end

data/lib/snapshot_aggregate_root/version.rb

@@ -0,0 +1,3 @@
+module SnapshotAggregateRoot
+  VERSION = '0.5.0'
+end

data/snapshot_aggregate_root.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snapshot_aggregate_root/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'snapshot_aggregate_root'
+  spec.version       = SnapshotAggregateRoot::VERSION
+  spec.licenses      = ['MIT']
+  spec.authors       = ['Gareth Andrew']
+  spec.email         = ['gingerhendrix@gmail.com']
+
+  spec.summary       = %q{Event sourced aggregate root implementation with concurrent writer and snapshot support}
+  spec.description   = %q{Event sourced aggregate root implementation with concurrent writer and snapshot support}
+  spec.homepage      = 'https://github.com/gingerhendrix/snapshot_aggregate_root'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rails', '~> 4.2.1'
+  spec.add_development_dependency 'transaction_event_store_mongoid', '~> 0.0.1'
+
+  spec.add_dependency 'activesupport', '>= 3.0'
+  spec.add_dependency 'transaction_event_store', '~> 0.0.1'
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: snapshot_aggregate_root
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Gareth Andrew
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: transaction_event_store_mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: transaction_event_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: Event sourced aggregate root implementation with concurrent writer and
+  snapshot support
+email:
+- gingerhendrix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/snapshot_aggregate_root.rb
+- lib/snapshot_aggregate_root/configuration.rb
+- lib/snapshot_aggregate_root/default_apply_strategy.rb
+- lib/snapshot_aggregate_root/version.rb
+- snapshot_aggregate_root.gemspec
+homepage: https://github.com/gingerhendrix/snapshot_aggregate_root
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Event sourced aggregate root implementation with concurrent writer and snapshot
+  support
+test_files: []