sandthorn 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1a17a62b61cd04ee60ba16439ae0d5b93ffd179
-  data.tar.gz: 7ee6bcb37e9016d254c2ed32dcefb45831e55f8b
+  metadata.gz: 738faf44676674ac1da5b4591cfa857fa39196d2
+  data.tar.gz: b908878bd176b73a8a7aa5bf42173af2b28cbe79
 SHA512:
-  metadata.gz: 7b9bdd8af7ca4e12d2924786328675264f60411a066b069bab152ab0a54bdecf2db3ea3bb0e69a4419c9b0114782d3e3ba753fc48e020f8c0315ca2ec6168017
-  data.tar.gz: 3584ac990d2df159a15ed211d43a7ef0c17abf966599efedbc27fbde9d5e727920e0c8bbc2add4f6b3f315fe398f068a94b4d7c3a2a327546f619bce55e240aa
+  metadata.gz: 6e8d654e0dad2df6b94227088dfdebabdebdd5ca3eebfd68dfbffc29a9d0d437d5b8edcddc2ef1d90e036bc9a2170cf3749df6b0c206535dfcea132b20e631b7
+  data.tar.gz: f35b3ccf742865f59a910475423e78c778b9db9c6ee4d976b22de9dd426040379a59d89b8f816b33245685da9124b3285d32467ebffabcf8ae95fca3bf5e442c

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 2.1.0
   - 2.1.1
   - 2.0.0
+sudo: false

data/README.md

@@ -23,7 +23,7 @@ If you have been following [Uncle Bob](http://blog.8thlight.com/uncle-bob/2014/0
 Check out examples of Sandthorn:
 
 * [Examples](https://github.com/Sandthorn/sandthorn_examples) including a product shop and TicTacToe game.
-* Live [demo](http://demo.sandthorn.org) comparing Active Record and Sandthorn.
+* Live [demo](http://infinite-mesa-8629.herokuapp.com/) comparing Active Record and Sandthorn.
 
 ## How do I use Sandthorn?
 
@@ -119,12 +119,15 @@ Or install it yourself as:
 
 # Configuring Sandthorn
 
-Sandthorn relies on a driver is specific to the data storage that you are using. This means Sandthorn can be used with any data storage given that a driver exists.
+## Driver
+
+Sandthorn relies on a driver that is specific to the data storage that you are using. This means Sandthorn can be used with any data storage given that a driver exists.
 
 To setup a driver you need to add it to your project's Gemfile and configure it in your application code.
 
     gem 'sandthorn_driver_sequel'
 
+
 The driver is configured when your application launches. Here's an example of how to do it using the Sequel driver and a sqlite3 database.
 
 ```ruby
@@ -147,6 +150,36 @@ SandthornDriverSequel.migrate_db url: url
 
 Optionally, when using Sandthorn in your tests you can configure it in a `spec_helper.rb` which is then required by your test suites [example](https://github.com/Sandthorn/sandthorn_examples/blob/master/sandthorn_tictactoe/spec/spec_helper.rb#L20-L30). Note that the Sequel driver accepts a special parameter to empty the database between each test.
 
+The Sequel driver is the only production-ready driver to date.
+
+
+## Map aggregate types to event stores
+
+Its possible to map aggregate_types to events stores from the configuration setup. This makes it possible to work with data from different stores that are using the same context, and will override any event_store setting within an aggregate.
+
+```ruby
+url_foo = "sqlite://spec/db/sequel_driver_foo.sqlite3"
+driver_foo = SandthornDriverSequel.driver_from_url(url: url_foo)
+
+url_bar = "sqlite://spec/db/sequel_driver_bar.sqlite3"
+driver_bar = SandthornDriverSequel.driver_from_url(url: url_bar)
+
+class AnAggregate
+  Include Sandthorn::AggregateRoot
+end
+
+class AnOtherAggregate
+  Include Sandthorn::AggregateRoot
+end
+
+Sandthorn.configure do |conf|
+  conf.event_stores = { foo: driver_foo, bar: driver_bar }
+  conf.map_types = { foo: [AnAggregate], bar: [AnOtherAggregate] }
+end
+```
+
+## Data serialization / deserialization
+
 Its possible to configure how events and snapshots are serialized / deserialized. The default are YAML but can be overloaded in the configure block.
 
 ```ruby
@@ -158,10 +191,11 @@ Sandthorn.configure do |conf|
 end
 ```
 
-The Sequel driver is the only production-ready driver to date.
 
 # Usage
 
+## Aggregate Root
+
 Any object that should have event sourcing capability must include the methods provided by `Sandthorn::AggregateRoot`. These make it possible to `commit` events and `save` changes to an aggregate. Use the `include` directive as follows:
 
 ```ruby
@@ -251,6 +285,30 @@ 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.
 
+## 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 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.
+
+```ruby
+require 'sandthorn/bounded_context'
+
+module TicTacToe
+  include Sandthorn::BoundedContext
+
+  class Board
+    include Sandthorn::AggregateRoot
+  end
+end
+
+Sandthorn.configure do |conf|
+  conf.event_stores = { foo: driver_foo}
+  conf.map_types = { foo: TicTacToe.aggregate_types }
+end
+
+TicTacToe.aggregate_types -> [TicTacToy::Board]
+```
 
 # Development
 

data/lib/sandthorn/bounded_context.rb

@@ -0,0 +1,39 @@
+module Sandthorn
+  module BoundedContext
+    module ClassMethods
+      def aggregate_types
+        @aggregate_list = p_aggregate_types(self)
+      end
+
+      private
+      
+      def p_aggregate_types(bounded_context_module)
+        return [] unless bounded_context_module.respond_to?(:constants)
+        
+        classes = classes_in(bounded_context_module)
+        aggregate_list = classes.select { |item| item.include?(Sandthorn::AggregateRoot) }
+        modules = modules_in(bounded_context_module, classes)
+        
+        aggregate_list += modules.flat_map { |m| p_aggregate_types(m) }
+        
+        aggregate_list
+      end
+
+      def classes_in(namespace)
+        namespace.constants.map(&namespace.method(:const_get)).grep(Class)
+      end
+
+      def modules_in(namespace, classes)
+        namespace.constants.map(&namespace.method(:const_get)).grep(Module).delete_if do |m| 
+          classes.include?(m) || m == Sandthorn::BoundedContext::ClassMethods
+        end
+      end
+    end
+
+    extend ClassMethods
+    
+    def self.included( other )
+      other.extend( ClassMethods )
+    end
+  end
+end

data/lib/sandthorn/event_stores.rb

@@ -40,6 +40,12 @@ module Sandthorn
       store_map.values
     end
 
+    def map_types(hash)
+      hash.each_pair do |event_store, aggregate_types|
+        map_aggregate_types_to_event_store(aggregate_types, event_store)
+      end
+    end
+
     private
 
     attr_reader :store_map
@@ -60,5 +66,15 @@ module Sandthorn
       store.respond_to?(:get_events)
     end
 
+    def map_aggregate_type_to_event_store(aggregate_type, event_store)
+      aggregate_type.event_store(event_store)
+    end
+
+    def map_aggregate_types_to_event_store(aggregate_types = [], event_store)
+      aggregate_types.each do |aggregate_type|
+        map_aggregate_type_to_event_store(aggregate_type, event_store)
+      end
+    end
+
   end
 end

data/lib/sandthorn/version.rb

@@ -1,3 +1,3 @@
 module Sandthorn
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/spec/bounded_context_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'sandthorn/bounded_context'
+
+module Sandthorn
+  describe BoundedContext do
+    it 'should respond to `aggregate_types`' do
+      expect(BoundedContext).to respond_to(:aggregate_types)
+    end
+  end
+
+  describe "::aggregate_types" do
+    module TestModule
+      include Sandthorn::BoundedContext
+      class AnAggregate 
+        include Sandthorn::AggregateRoot
+      end
+
+      class NotAnAggregate
+      end
+
+      module Deep
+        class DeepAggregate
+          include Sandthorn::AggregateRoot
+        end
+      end
+    end
+
+    it "aggregate_types should include AnAggregate" do
+      expect(TestModule.aggregate_types).to include(TestModule::AnAggregate)
+    end
+
+    it "aggregate_types should not include NotAnAggregate" do
+      expect(TestModule.aggregate_types).not_to include(TestModule::NotAnAggregate)
+    end
+
+    it "aggregate_types should include DeepAnAggregate in a nested Module" do
+      expect(TestModule.aggregate_types).to include(TestModule::Deep::DeepAggregate)
+    end
+  end
+end

data/spec/event_stores_spec.rb

@@ -4,6 +4,13 @@ module Sandthorn
   describe EventStores do
     let(:stores) { EventStores.new }
 
+    before do
+      class AnAggregate 
+        include Sandthorn::AggregateRoot
+      end
+    end
+    
+
     describe "#initialize" do
       context "when given a single event_store" do
         it "sets it as the default event store" do
@@ -77,5 +84,35 @@ module Sandthorn
         expect(stores[:foo]).to eq(store)
       end
     end
+
+    describe "#map_types" do
+
+      context "map two events stores" do
+        
+        class AnAggregate1
+          include Sandthorn::AggregateRoot
+        end
+
+        class AnAggregate2
+          include Sandthorn::AggregateRoot
+        end
+
+        before do
+          store = double
+          stores.add(:foo, store)
+          stores.add(:bar, store)
+          stores.map_types(foo: [AnAggregate1], bar: [AnAggregate2])
+        end
+
+        it "should map event_store foo to AnAggregate1" do
+          expect(AnAggregate1.event_store).to eq(:foo)
+        end
+
+        it "should map event_store bar to AnAggregate2" do
+          expect(AnAggregate2.event_store).to eq(:bar)
+        end
+      end
+    end
+
   end
 end

data/spec/get_events_spec.rb

@@ -6,7 +6,7 @@ end
 
 class AnotherAggregate
   include Sandthorn::AggregateRoot
-  event_store :other
+  event_store :should_override_this
 end
 
 describe Sandthorn do
@@ -66,6 +66,7 @@ describe Sandthorn do
     url = "sqlite://spec/db/other_db.sqlite3"
     driver = SandthornDriverSequel.driver_from_url(url: url)
     Sandthorn.event_stores.add(:other, driver)
+    Sandthorn.event_stores.map_types(other: [AnotherAggregate])
     migrator = SandthornDriverSequel::Migration.new url: url
     SandthornDriverSequel.migrate_db url: url
     migrator.send(:clear_for_test)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sandthorn
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Lars Krantz
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,6 +192,7 @@ files:
 - 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.rb
 - lib/sandthorn/event_inspector.rb
@@ -202,6 +203,7 @@ files:
 - spec/aggregate_root_spec.rb
 - spec/aggregate_snapshot_spec.rb
 - spec/benchmark_spec.rb
+- spec/bounded_context_spec.rb
 - spec/complex_aggregate_spec.rb
 - spec/db/sequel_driver.sqlite3_old
 - spec/different_driver_spec.rb
@@ -243,6 +245,7 @@ test_files:
 - spec/aggregate_root_spec.rb
 - spec/aggregate_snapshot_spec.rb
 - spec/benchmark_spec.rb
+- spec/bounded_context_spec.rb
 - spec/complex_aggregate_spec.rb
 - spec/db/sequel_driver.sqlite3_old
 - spec/different_driver_spec.rb