sandthorn 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c7be6683c105bcc9b6c0366a63d191c15260735
+  data.tar.gz: be5e8b9362f8ec00c1fa2949532c5064f81784e4
+SHA512:
+  metadata.gz: 064291bac86efb3730d596afd4079dc3d71085f2974aa036df707594561886761a85f3ff73bcaec9d5cfc24cfb47c712b0a4a3263e2c636da9a3079dda319c1a
+  data.tar.gz: a28989f9f69f112666b7e21c5b81c01f952451b3141d79012df97ab01964ebe462e28fd74bb9d2bfc897fa520112b07b8d8796c726036598fdd9fb43929efa84

data/.autotest

@@ -0,0 +1,3 @@
+Autotest.add_hook :initialize do |at|
+    %w{.git spec/db}.each {|exception| at.add_exception(exception)}
+end

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+*.sqlite3
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/.ruby-gemset

@@ -0,0 +1 @@
+sandthorn

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    sandthorn (0.0.1)
+      dirty_hashy
+      uuidtools
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.16)
+    autotest-standalone (4.5.11)
+    awesome_print (1.2.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    dirty_hashy (0.2.1)
+      activesupport
+    gem-release (0.7.1)
+    i18n (0.6.9)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.9.0)
+    pg (0.17.1)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-doc (0.6.0)
+      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)
+    sandthorn_driver_sequel (1.0.5)
+      pg
+      sequel
+    sequel (4.8.0)
+    slop (3.5.0)
+    sqlite3 (1.3.9)
+    thread_safe (0.2.0)
+      atomic (>= 1.1.7, < 2)
+    tzinfo (0.3.39)
+    uuidtools (2.1.4)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest-standalone
+  awesome_print
+  bundler (~> 1.3)
+  gem-release
+  pry
+  pry-doc
+  rake
+  rspec
+  sandthorn!
+  sandthorn_driver_sequel
+  sqlite3

data/Gemfile.lock.old

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Sandthorn Event Sourcing
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+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/README.md

@@ -0,0 +1,90 @@
+# Sandthorn Event Sourcing
+A ruby framwork for saving an object's state as a series of events, and tracking non state changing events.
+
+## What is Event Sourcing
+
+"Capture all changes to an application state as a sequence of events."
+[Event Sourcing](http://martinfowler.com/eaaDev/EventSourcing.html)
+
+## The short story
+
+Think of it as an object database where you not only what the new value of the attribute is but when and why it changed.
+_Example:_
+
+```ruby
+
+#Setup the Aggregate
+
+require 'sandthorn/aggregate_root_dirty_hashy' #the one available right now
+
+class Ship
+  include Sandthorn::AggregateRoot::DirtyHashy 
+	attr_reader :name
+
+	def initialize name: nil, shipping_company: nil
+		@name = name
+	end
+
+	# state-changing command
+	def rename! new_name: ""
+		unless new_name.empty? or new_name == name
+			@name = new_name
+			ship_was_renamed
+		end
+	end
+	private
+	# commit the event and state-change is automatically recorded.
+	def ship_was_renamed
+		commit
+	end
+end
+
+#Setup the framework with the sequel driver for persistance
+url = "path to sql" #Example sqlite://path/sequel_driver.sqlite3 
+catch_all_config = [ { driver: SandthornDriverSequel.driver_from_url(url: url) } ]
+Sandthorn.configuration = catch_all_config
+
+#migrate db schema for the sequel driver
+migrator = SandthornDriverSequel::Migration.new url: url
+SandthornDriverSequel.migrate_db url: url
+
+#Usage
+ship = Ship.new "Titanic"
+ship.rename! "Vasa"
+puts ship.aggregate_events
+ship.save
+
+new_ship = Ship.find ship.id
+puts ship.name
+.
+.
+
+For more info look at the specs.
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sandthorn'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sandthorn
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sandthorn.rb

@@ -0,0 +1,78 @@
+require "sandthorn/version"
+require "sandthorn/errors"
+require 'uuidtools'
+require 'yaml'
+
+module Sandthorn
+  class << self
+    def configuration= configuration
+      @configuration = configuration
+    end
+    def configuration
+      @configuration ||= []
+    end
+
+    def serialize data
+      #Marshal.dump(data)
+      YAML::dump(data)
+      #Oj.dump(data)
+      #MessagePack.pack(data, symbolize_keys: true)
+    end
+
+    def deserialize data
+      #Marshal.load(data)
+      YAML::load(data)
+      #Oj.load(data)
+      #MessagePack.unpack(data, symbolize_keys: true)
+    end
+
+    def generate_aggregate_id
+      UUIDTools::UUID.random_create.to_s
+    end
+
+    def get_aggregate_events aggregate_id, class_name
+      driver_for(class_name).get_aggregate_events aggregate_id, class_name
+    end
+
+    def save_events aggregate_events, originating_aggregate_version, aggregate_id, class_name
+      #begin
+      driver_for(class_name).save_events aggregate_events, originating_aggregate_version, aggregate_id, *class_name
+      #rescue UpptecEventSequelDriver::Errors::WrongAggregateVersionError => sequel_error
+      #  raise UpptecEventFramework::Errors::ConcurrencyError.new sequel_error.message
+      #end
+    end
+
+    def get_aggregate aggregate_id, class_name
+      driver_for(class_name).get_aggregate aggregate_id, class_name
+    end
+
+    def save_snapshot aggregate_snapshot, aggregate_id, class_name
+      driver_for(class_name).save_snapshot aggregate_snapshot, aggregate_id, class_name
+    end
+
+    private
+    def driver_for class_name, &block
+      driver = identify_driver_from_class class_name
+      block.call(driver) if block_given?
+      driver
+    end
+    def identify_driver_from_class class_name
+      matches = configuration.select do |conf| 
+        r = Regexp.new "^#{conf[:aggregate_pattern]}" 
+        pattern = class_name.to_s
+        conf[:aggregate_pattern].nil? || r.match(pattern)
+      end
+      raise Sandthorn::Errors::ConfigurationError.new "Aggregate class #{class_name} is not configured for EventStore" if matches.empty?
+      first_match = matches.first
+      first_match[:driver]
+      #UpptecEventSequelDriver.driver_from_url url: first_match[:url], context: first_match[:context]
+    end
+    # def drivers_for_class_names class_names: []
+    #   return all_drivers if class_names.empty?
+    #   class_names.map { |e| driver_for e }.uniq { |d| { url: d.url, context: d.context } }
+    # end
+    # def all_drivers
+    #   configuration.map { |e| UpptecEventSequelDriver.driver_from_url url: e[:url], context: e[:context]  }
+    # end
+  end
+end

data/lib/sandthorn/aggregate_root_base.rb

@@ -0,0 +1,186 @@
+module Sandthorn
+  module AggregateRoot
+    module Base
+
+      attr_reader :aggregate_id
+      attr_reader :aggregate_events
+      attr_reader :aggregate_current_event_version
+      attr_reader :aggregate_originating_version
+      attr_reader :aggregate_stored_serialized_object
+
+      alias :id :aggregate_id
+
+
+      def aggregate_base_initialize
+        @aggregate_current_event_version = 0
+        @aggregate_originating_version = 0
+        @aggregate_events = []
+      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?
+          Sandthorn.save_events( aggregate_events, aggregate_originating_version, aggregate_id, self.class.name)
+          @aggregate_events = []
+          @aggregate_originating_version = @aggregate_current_event_version
+        end
+        self
+      end
+
+      def commit *args
+        increase_current_aggregate_version!
+        method_name = caller[0][/`.*'/][1..-2]
+        aggregate_attribute_deltas = get_delta
+        
+        unless aggregate_attribute_deltas.empty?
+          data = {:method_name => method_name, :method_args => args, :attribute_deltas => aggregate_attribute_deltas}
+          data.merge!({trace: @aggregate_trace_information}) unless @aggregate_trace_information.nil? || @aggregate_trace_information.empty?
+          @aggregate_events << ({:aggregate_version => @aggregate_current_event_version, :event_name => method_name, :event_args => data})
+        end
+        self
+      end
+
+      alias :record_event :commit
+      
+
+      def all
+      end
+
+      def aggregate_trace args
+        @aggregate_trace_information = args
+        yield self
+        @aggregate_trace_information = nil
+      end
+
+      module ClassMethods
+
+        @@aggregate_trace_information = nil
+        def aggregate_trace args
+          @@aggregate_trace_information = args
+          @aggregate_trace_information = args
+          yield self
+          @@aggregate_trace_information = nil
+          @aggregate_trace_information = nil
+        end
+      
+        def find aggregate_id
+          class_name = self.respond_to?(:name) ? self.name : self.class # to be able to extend a string for example.
+          events = Sandthorn.get_aggregate(aggregate_id, class_name)
+          raise Sandthorn::Errors::AggregateNotFound unless events and !events.empty?
+
+          transformed_events = events.map { |e| e.merge(event_args: Sandthorn.deserialize(e[:event_data])) }
+          aggregate_build transformed_events
+        end
+
+        def new *args
+          aggregate = super
+          aggregate.aggregate_base_initialize
+          aggregate.aggregate_trace @@aggregate_trace_information do |aggr|
+            aggr.aggregate_initialize
+            aggr.send :set_aggregate_id, Sandthorn.generate_aggregate_id
+            aggr.send :commit, *args
+            return aggr
+          end
+        end
+
+
+        def aggregate_build events
+          first_event = events.first()
+          current_aggregate_version = 0
+          if first_event[:event_name] == "aggregate_set_from_snapshot"
+            aggregate = first_event[:event_args][0]
+            current_aggregate_version = aggregate.aggregate_originating_version
+            events.shift
+          # elsif first_event[:event_name] == "instance_extended_as_aggregate"
+          #   aggregate = first_event[:event_args][0]
+            #aggregate.extend AggregateRoot
+            # events.pop
+          else
+            new_args = events.first()[:event_args][:method_args]
+
+            if new_args.nil?
+              aggregate = new
+            else
+              aggregate = new *new_args
+            end
+            aggregate.send :aggregate_clear_current_event_version!
+          end
+
+          attributes = {}
+          events.each do |event|
+            event_args = event[:event_args]
+            event_name = event[:event_name]
+
+            if event_name == "aggregate_set_from_snapshot"
+              #aggregate.send event_name,*event_args
+              #set the attribute hash instead of instance varaibles directly
+              next
+            end
+            next if event_name == "instance_extended_as_aggregate"
+
+            attribute_deltas = event_args[:attribute_deltas]
+            if (event[:aggregate_version].nil? == false)
+              current_aggregate_version = event[:aggregate_version]
+            end
+
+            if !attribute_deltas.nil?
+              deltas = {}
+              attribute_deltas.each do |delta|
+                deltas[delta[:attribute_name]] = delta[:new_value]
+              end
+              attributes.merge! deltas
+            end
+          end
+          aggregate.send :clear_aggregate_events
+          aggregate.send :set_orginating_aggregate_version!, current_aggregate_version
+          aggregate.send :set_current_aggregate_version!, current_aggregate_version
+          aggregate.send :set_instance_variables!, attributes
+          aggregate
+        end
+      end
+      
+      private
+
+      def set_instance_variables! attributes
+        attributes.each_pair do |k,v|
+          self.instance_variable_set "@#{k}", v
+        end
+      end
+
+      def extract_relevant_aggregate_instance_variables
+        instance_variables.select { |i| i.to_s != "@hashy" && (!i.to_s.start_with?("@aggregate_") || i.to_s == "@aggregate_id") }
+      end
+
+      def set_orginating_aggregate_version! aggregate_version
+        @aggregate_originating_version = aggregate_version
+      end
+
+      def increase_current_aggregate_version!
+        @aggregate_current_event_version += 1
+      end
+
+      def set_current_aggregate_version! aggregate_version
+        @aggregate_current_event_version = aggregate_version
+      end
+
+      def clear_aggregate_events
+        @aggregate_events = []
+        @aggregate_attribute_deltas = []
+      end
+
+      def aggregate_clear_current_event_version!
+        @aggregate_current_event_version = 0
+      end
+
+      def set_aggregate_id aggregate_id
+        @aggregate_id = aggregate_id
+      end
+
+    end
+  end
+end