ruby_cqrs 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5defe0400414fa278a0716341c10d41dcf050a9
-  data.tar.gz: 303081f7864984adc5675514c0a3355538f67c5c
+  metadata.gz: 55315f0c54dfcba27b2e0bd0a40390cb6743906a
+  data.tar.gz: 6d462d0ff742db26e70c0d5d51f89418b9906f82
 SHA512:
-  metadata.gz: bb699d7dda967e16639dc5d28b640845941a6c0545ffb4108e9338242352b0bd7a92253ef3b8329d0717c37ca44eb85ffb559c7b0d4874b25d1b70c6b9611bd4
-  data.tar.gz: e975d958f11be45a15dc16b27ab410546d470a80d579dd60cdc94b5bb5a38a25665ac2f0658c7d7d74f8e973e5b8e68428ff28bca43586ccb463069b7e204230
+  metadata.gz: bccb7a15ecf97f11c1e11d6bb03bf0d1ba3099c5dd3d215762f145751f5990ddbc3670641b45f8dc19c52c075ca6d645fd9c8594cb0d76731c6b8eaf0b3ba820
+  data.tar.gz: c052bdfd8e7a7ac56b6b7918dc74bf5f97d068937fcca70cddd0d4a18fd520f049d9bfc71227c95b224bf4cff4dc829c056eb38330024b3ba22ea03a6aa888f3

data/lib/ruby_cqrs.rb

@@ -1,4 +1,3 @@
-require('ruby_cqrs/error')
 require('ruby_cqrs/guid')
 
 require('ruby_cqrs/data/event_store')

data/lib/ruby_cqrs/contracts.rb

@@ -0,0 +1,96 @@
+require 'contracts'
+
+module RubyCqrs
+  module Validation
+    include Contracts
+    include Contracts::Modules
+
+    class EventStore
+      def self.valid? val
+        val.is_a? RubyCqrs::Data::EventStore
+      end
+    end
+
+    class Event
+      def self.valid? val
+        val.is_a? RubyCqrs::Domain::Event
+      end
+    end
+
+    class TypeOfEvent
+      def self.valid? val
+        val < RubyCqrs::Domain::Event
+      end
+    end
+
+    class Snapshot
+      def self.valid? val
+        val.is_a? RubyCqrs::Domain::Snapshot
+      end
+    end
+
+    class Aggregate
+      def self.valid? val
+        val.is_a? RubyCqrs::Domain::Aggregate
+      end
+    end
+
+    class AggregateId
+      def self.valid? val
+        RubyCqrs::Guid.validate? val
+      end
+    end
+
+    AggregateChanges = ({ :events => ArrayOf[Event],
+                          :aggregate_id => AggregateId,
+                          :aggregate_type => String,
+                          :expecting_source_version => Or[0, Pos],
+                          :expecting_version => Pos })
+
+    AggregateChangesWithSnapshot = ({\
+                          :events => ArrayOf[Event],
+                          :aggregate_id => AggregateId,
+                          :aggregate_type => String,
+                          :expecting_source_version => Or[0, Pos],
+                          :expecting_version => Pos,
+                          :snapshot => {\
+                                 :state => Snapshot,
+                                 :state_type => String,
+                                 :version => Pos }})
+
+    AggregateState = ({\
+                          :aggregate_id => AggregateId,
+                          :aggregate_type => String,
+                          :events => ArrayOf[Event]})
+
+    AggregateStateWithSnapshot = ({\
+                        :aggregate_id => AggregateId,
+                        :aggregate_type => String,
+                        :snapshot => {\
+                                 :state => Snapshot,
+                                 :version => Pos },
+                        :events => ArrayOf[Event]})
+
+    SerializedAggregateState = ({\
+                          :aggregate_id => AggregateId,
+                          :aggregate_type => String,
+                          :events => ArrayOf[{\
+                                 :aggregate_id => AggregateId,
+                                 :event_type => String,
+                                 :version => Pos,
+                                 :data => String }]})
+
+    SerializedAggregateStateWithSnapshot = ({\
+                        :aggregate_id => AggregateId,
+                        :aggregate_type => String,
+                        :snapshot => {\
+                                 :state_type => String,
+                                 :version => Pos,
+                                 :data => String },
+                        :events => ArrayOf[{\
+                                 :aggregate_id => AggregateId,
+                                 :event_type => String,
+                                 :version => Pos,
+                                 :data => String }]})
+  end
+end

data/lib/ruby_cqrs/data/in_memory_event_store.rb

@@ -1,26 +1,23 @@
+require 'contracts'
+require_relative '../contracts'
+
 module RubyCqrs
   module Data
     class InMemoryEventStore
       include EventStore
+      include Contracts
+      include Contracts::Modules
 
+      Contract None => Any
       def initialize
         @aggregate_store = {}
         @event_store = {}
         @snapshot_store = {}
       end
 
-      # the returned format is as bellow
-      # { :aggregate_id => some_aggregtate_id(uuid),
-      #   :aggregate_type => the full qualified name of the aggregate type(string),
-      #   :events => [ {:aggregate_id => the aggregate_id of the event belongs to(uuid),
-      #                 :event_type => the full qualified name of the event type(string),
-      #                 :version => the version number of the event(integer),
-      #                 :data => protobuf encoded content of the event object(string)}, ..., {} ],
-      #   :snapshot => { :state_type => the full qualified name of the snapshot type(string),
-      #                  :version => the version number of the aggregate when snapshot(integer),
-      #                  :data => protobuf encoded content of the snapshot object(string)} }
-      # the snapshot object could be null; and the events array should return events which has a version
-      # number greater than the version number of the returning snapshot, if any.
+      Contract Validation::AggregateId, Any\
+               => Or[Validation::SerializedAggregateState,\
+                     Validation::SerializedAggregateStateWithSnapshot]
       def load_by guid, command_context
         key = guid.to_sym
         state = { :aggregate_id => guid,
@@ -35,8 +32,8 @@ module RubyCqrs
         state
       end
 
-      # the changes are defined as an array of aggregate change,
-      # each change's format is identical to what above load_by returns
+      Contract Or[ArrayOf[Validation::SerializedAggregateState],\
+                  ArrayOf[Validation::SerializedAggregateStateWithSnapshot]], Any => nil
       def save changes, command_context
         changes.each do |change|
           key = change[:aggregate_id].to_sym

data/lib/ruby_cqrs/data/serialization.rb

@@ -2,8 +2,8 @@ require 'active_support/inflector'
 require 'beefcake'
 
 module RubyCqrs
-  class ObjectNotEncodableError < Error; end
-  class ObjectNotDecodableError < Error; end
+  class ObjectNotEncodableError < StandardError; end
+  class ObjectNotDecodableError < StandardError; end
 
   module Data
     module Encodable

data/lib/ruby_cqrs/domain/aggregate.rb

@@ -1,10 +1,16 @@
 require 'active_support/inflector'
+require 'contracts'
+require_relative '../contracts'
 
 module RubyCqrs
   module Domain
     module Aggregate
+      include Contracts
+      include Contracts::Modules
+
       attr_reader :aggregate_id, :version
 
+      Contract None => Any
       def initialize
         @aggregate_id = Guid.create
         @version = 0
@@ -14,12 +20,13 @@ module RubyCqrs
         super
       end
 
+      Contract Pos => Bool
       def is_version_conflicted? client_side_version
         client_side_version != @source_version
       end
 
     private
-
+      Contract Or[Validation::AggregateState, Validation::AggregateStateWithSnapshot] => nil
       def load_from state
         sorted_events = state[:events].sort { |x, y| x.version <=> y.version }
         @aggregate_id = state[:aggregate_id]
@@ -28,8 +35,10 @@ module RubyCqrs
           apply(event)
           @source_version += 1
         end
+        nil
       end
 
+      Contract Or[Validation::AggregateState, Validation::AggregateStateWithSnapshot] => nil
       def try_apply_snapshot_in state
         if state.has_key? :snapshot and self.is_a? Snapshotable
           self.send :apply_snapshot, state[:snapshot][:state]
@@ -37,8 +46,10 @@ module RubyCqrs
           @source_version = state[:snapshot][:version]
           self.send(:reset_countdown, state[:events].size)
         end
+        nil
       end
 
+      Contract None => Or[nil, Validation::AggregateChanges, Validation::AggregateChangesWithSnapshot]
       def get_changes
         return nil unless @pending_events.size > 0
         changes = {
@@ -53,6 +64,7 @@ module RubyCqrs
         changes
       end
 
+      Contract Validation::AggregateChanges => nil
       def try_extract_snapshot_into changes
         snapshot_state = self.send :take_a_snapshot\
           if self.is_a? Snapshotable and self.send(:should_take_a_snapshot?)
@@ -63,39 +75,50 @@ module RubyCqrs
                                  :version => @version }
           self.send :set_snapshot_taken
         end
+        nil
       end
 
+      Contract None => nil
       def commit
         @pending_events = []
         @source_version = @version
         if self.is_a? Snapshotable and self.send :should_reset_snapshot_countdown?
           self.send(:reset_countdown, 0)
         end
+        nil
       end
 
+      Contract Validation::Event => nil
       def raise_event(event)
-        raise NotADomainEventError unless event.is_a? Event
         apply(event)
         update_dispatch_detail_for(event)
         @pending_events << event
+        nil
       end
 
+      Contract Validation::Event => nil
       def update_dispatch_detail_for(event)
         event.instance_variable_set(:@aggregate_id, @aggregate_id)
         event.instance_variable_set(:@version, @version)
+        nil
       end
 
+      Contract Validation::Event => nil
       def apply(event)
         dispatch_handler_for(event)
         self.send(:snapshot_countdown) if self.is_a? Snapshotable
         @version += 1
+        nil
       end
 
+      Contract Validation::Event => nil
       def dispatch_handler_for(event)
         target = retrieve_handler_for(event.class)
         self.send(target, event)
+        nil
       end
 
+      Contract Validation::TypeOfEvent => Symbol
       def retrieve_handler_for(event_type)
         @event_handler_cache[event_type] ||= begin
           stripped_event_type_name = event_type.to_s.demodulize.underscore

data/lib/ruby_cqrs/domain/aggregate_repository.rb

@@ -1,19 +1,28 @@
 require 'active_support/inflector'
 require_relative '../guid'
+require 'contracts'
+require_relative '../contracts'
 
 module RubyCqrs
-  class AggregateNotFoundError < Error; end
-  class AggregateConcurrencyError < Error; end
-  class AggregateDuplicationError < Error; end
+  class AggregateNotFoundError < StandardError; end
+  class AggregateConcurrencyError < StandardError; end
+  class AggregateDuplicationError < StandardError; end
 
   module Domain
     class AggregateRepository
+      include Contracts
+      include Contracts::Modules
       include RubyCqrs::Data::Decodable
 
-      def find_by aggregate_id
-        raise ArgumentError if aggregate_id.nil?
-        raise ArgumentError unless Guid.validate? aggregate_id
+      Contract Validation::EventStore, Any => Any
+      def initialize event_store, command_context
+        raise ArgumentError unless event_store.is_a? Data::EventStore
+        @event_store = event_store
+        @command_context = command_context
+      end
 
+      Contract Validation::AggregateId => Validation::Aggregate
+      def find_by aggregate_id
         state = @event_store.load_by(aggregate_id, @command_context)
         raise AggregateNotFoundError if (state.nil? or state[:aggregate_type].nil? or\
                                     ((state[:events].nil? or state[:events].empty?) and state[:snapshot].nil?))
@@ -21,21 +30,19 @@ module RubyCqrs
         create_instance_from state
       end
 
-      def save one_or_many_aggregate
-        raise ArgumentError if one_or_many_aggregate.nil?
-        return delegate_persistence_of [ one_or_many_aggregate ] if one_or_many_aggregate.is_a? Aggregate
-
-        raise ArgumentError unless one_or_many_aggregate.is_a? Enumerable and one_or_many_aggregate.size > 0
-        delegate_persistence_of one_or_many_aggregate
+      Contract Validation::Aggregate => nil
+      def save one_aggregate
+        delegate_persistence_of [ one_aggregate ]
       end
 
-    private
-      def initialize event_store, command_context
-        raise ArgumentError unless event_store.is_a? Data::EventStore
-        @event_store = event_store
-        @command_context = command_context
+      Contract ArrayOf[Validation::Aggregate] => nil
+      def save many_aggregate
+        delegate_persistence_of many_aggregate
       end
 
+    private
+      Contract Or[Validation::SerializedAggregateState,\
+                  Validation::SerializedAggregateStateWithSnapshot] => Validation::Aggregate
       def create_instance_from state
         try_decode_serialized_from state
         instance = state[:aggregate_type].constantize.new
@@ -43,6 +50,7 @@ module RubyCqrs
         instance
       end
 
+      Contract ArrayOf[Validation::Aggregate] => nil
       def delegate_persistence_of aggregates
         verify_uniqueness_of aggregates
 
@@ -57,11 +65,16 @@ module RubyCqrs
         nil
       end
 
+      Contract ArrayOf[Validation::Aggregate] => nil
       def verify_uniqueness_of aggregates
         uniq_array =  aggregates.uniq { |aggregate| aggregate.aggregate_id }
         raise AggregateDuplicationError unless uniq_array.size == aggregates.size
+        nil
       end
 
+      Contract ArrayOf[Validation::Aggregate] =>\
+        Or[ ArrayOf[Validation::SerializedAggregateState],\
+            ArrayOf[Validation::SerializedAggregateStateWithSnapshot]]
       def prep_changes_for aggregates
         to_return = []
         aggregates.inject(to_return) do |product, aggregate|
@@ -74,12 +87,16 @@ module RubyCqrs
         to_return
       end
 
+      Contract Or[Validation::SerializedAggregateState,\
+                  Validation::SerializedAggregateStateWithSnapshot] => nil
       def try_decode_serialized_from state
         state[:snapshot] = decode_snapshot_state_from state[:snapshot]\
           if state.has_key? :snapshot
 
         state[:events] = state[:events].map { |event_record| decode_event_from event_record }\
           if state[:events].size > 0
+
+        nil
       end
 
       def decode_snapshot_state_from snapshot_record
@@ -94,6 +111,8 @@ module RubyCqrs
         decoded_event
       end
 
+      Contract Or[Validation::AggregateChanges,\
+                  Validation::AggregateChangesWithSnapshot] => nil
       def try_encode_serializable_in change
         if change.has_key? :snapshot
           encoded_snapshot = encode_data_from change[:snapshot][:state]
@@ -110,6 +129,8 @@ module RubyCqrs
               :version => event.version }
           }
         end
+
+        nil
       end
 
       def encode_data_from obj

data/lib/ruby_cqrs/domain/event.rb

@@ -1,9 +1,10 @@
 module RubyCqrs
-  class NotADomainEventError < Error; end
+  class NotADomainEventError < StandardError; end
 
   module Domain
     module Event
       include RubyCqrs::Data::Encodable
+
       attr_reader :aggregate_id, :version
     end
   end

data/lib/ruby_cqrs/domain/snapshot.rb

@@ -1,5 +1,5 @@
 module RubyCqrs
-  class NotADomainSnapshotError < Error; end
+  class NotADomainSnapshotError < StandardError; end
 
   module Domain
     module Snapshot

data/lib/ruby_cqrs/version.rb

@@ -1,3 +1,3 @@
 module RubyCqrs # :nodoc:
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/spec/{unit → lib/ruby_cqrs/data}/in_memory_event_store_spec.rb

@@ -1,4 +1,4 @@
-require_relative('../spec_helper')
+require_relative('../../../spec_helper')
 
 describe RubyCqrs::Data::InMemoryEventStore do
   let(:command_context) {}

data/spec/{unit → lib/ruby_cqrs/data}/serialization_spec.rb

@@ -1,4 +1,5 @@
-require_relative('../spec_helper')
+require_relative('../../../spec_helper')
+
 describe 'decoder & encoder' do
   let(:unsupported_obj) { SomeDomain::FifthEvent.new }
   let(:unsupported_obj_type) { SomeDomain::FifthEvent.name }

data/spec/{unit → lib/ruby_cqrs/domain}/aggregate_repository_spec.rb

@@ -1,4 +1,4 @@
-require_relative('../spec_helper')
+require_relative('../../../spec_helper')
 
 describe RubyCqrs::Domain::AggregateRepository do
   let(:unsorted_event_records) { [
@@ -23,29 +23,7 @@ describe RubyCqrs::Domain::AggregateRepository do
   let(:repository) { RubyCqrs::Domain::AggregateRepository.new event_store, command_context }
   let(:aggregate_type) { SomeDomain::AggregateRoot }
 
-  describe '#new' do
-    context 'when expecting arguments' do
-      it 'raises ArgumentError when the first argument is not an descendant from EventStore' do
-        expect { RubyCqrs::Domain::AggregateRepository.new Object.new, command_context }.to raise_error ArgumentError
-      end
-
-      it 'is initialized with an EventStore instance and an CommandContext instance' do
-        RubyCqrs::Domain::AggregateRepository.new event_store, command_context
-      end
-    end
-  end
-
   describe '#find_by' do
-    context 'when expecting arguments' do
-      it 'raises ArgumentError when aggregate_id is nil' do
-        expect { repository.find_by nil }.to raise_error ArgumentError
-      end
-
-      it 'raises ArgumentError when aggregate_id is not a valid guid' do
-        expect { repository.find_by 'some_invalid_guid' }.to raise_error ArgumentError
-      end
-    end
-
     it "delegates the actual data loading to the EventStore instance's #load_by" do
       expect(event_store).to receive(:load_by) do |some_guid, some_command_context|
         expect(some_guid).to be_a_valid_uuid
@@ -94,20 +72,6 @@ describe RubyCqrs::Domain::AggregateRepository do
   end
 
   describe '#save' do
-    context 'when expecting arguments' do
-      it 'raises ArgumentError when given 0 or nil argument or an 0 length enumerable' do
-        expect { repository.save }.to raise_error ArgumentError
-        expect { repository.save nil }.to raise_error ArgumentError
-        expect { repository.save [] }.to raise_error ArgumentError
-      end
-      it 'raises ArgumentError when the first argument is not an descendant from AggregateBase' do
-        expect { repository.save Object.new }.to raise_error ArgumentError
-      end
-      it 'raises ArgumentError when the first argument is not an enumerable of AggregateBase' do
-        expect { repository.save [ Object.new ] }.to raise_error ArgumentError
-      end
-    end
-
     describe 'during the saving process' do
       context 'when saving a single aggregate' do
         context 'when the aggregate has not been changed' do

data/spec/{unit → lib/ruby_cqrs/domain}/aggregate_spec.rb

@@ -1,9 +1,14 @@
-require_relative('../spec_helper')
+require_relative('../../../spec_helper')
 
 describe RubyCqrs::Domain::Aggregate do
   let(:aggregate_id) { SomeDomain::AGGREGATE_ID }
   let(:aggregate) { SomeDomain::AggregateRoot.new }
+  let(:aggregate_type) { SomeDomain::AggregateRoot.name }
   let(:unsorted_events) { [ SomeDomain::SecondEvent.new, SomeDomain::FirstEvent.new ] }
+  let(:state) {{
+    :aggregate_id => aggregate_id,
+    :aggregate_type => aggregate_type,
+    :events => unsorted_events }}
 
   describe '#new' do
     it 'has aggregate_id initilized as a valid uuid' do
@@ -20,10 +25,6 @@ describe RubyCqrs::Domain::Aggregate do
   end
 
   describe '#raise_event' do
-    it 'raise NotADomainEventError when raising an object that is not a proper event' do
-      expect { aggregate.fire_weird_stuff }.to raise_error(RubyCqrs::NotADomainEventError)
-    end
-
     context 'after raising an event' do
       it 'has version increased by 1' do
         original_version = aggregate.version
@@ -47,7 +48,6 @@ describe RubyCqrs::Domain::Aggregate do
   end
 
   describe '#is_version_conflicted?' do
-    let(:state) { { :aggregate_id => aggregate_id, :events => unsorted_events } }
     let(:loaded_aggregate) { aggregate.send(:load_from, state); aggregate; }
 
     it 'returns true when supplied client side version does not match the server side persisted source_version' do
@@ -86,7 +86,6 @@ describe RubyCqrs::Domain::Aggregate do
   end
 
   describe '#load_from' do
-    let(:state) { { :aggregate_id => aggregate_id, :events => unsorted_events } }
     let(:loaded_aggregate) { aggregate.send(:load_from, state); aggregate; }
 
     context 'when loading events' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_cqrs
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Raven Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2015-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -52,6 +52,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 description: a ruby implementation of cqrs, using event sourcing
 email:
 - ravenchen.cn@gmail.com
@@ -63,6 +77,7 @@ files:
 - License.txt
 - README.md
 - lib/ruby_cqrs.rb
+- lib/ruby_cqrs/contracts.rb
 - lib/ruby_cqrs/data/event_store.rb
 - lib/ruby_cqrs/data/in_memory_event_store.rb
 - lib/ruby_cqrs/data/serialization.rb
@@ -71,18 +86,17 @@ files:
 - lib/ruby_cqrs/domain/event.rb
 - lib/ruby_cqrs/domain/snapshot.rb
 - lib/ruby_cqrs/domain/snapshotable.rb
-- lib/ruby_cqrs/error.rb
 - lib/ruby_cqrs/guid.rb
 - lib/ruby_cqrs/version.rb
 - spec/feature/basic_usage_spec.rb
 - spec/feature/snapshot_spec.rb
 - spec/fixture/typical_domain.rb
+- spec/lib/ruby_cqrs/data/in_memory_event_store_spec.rb
+- spec/lib/ruby_cqrs/data/serialization_spec.rb
+- spec/lib/ruby_cqrs/domain/aggregate_repository_spec.rb
+- spec/lib/ruby_cqrs/domain/aggregate_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
-- spec/unit/aggregate_repository_spec.rb
-- spec/unit/aggregate_spec.rb
-- spec/unit/in_memory_event_store_spec.rb
-- spec/unit/serialization_spec.rb
 homepage: https://github.com/iravench/ruby_cqrs
 licenses:
 - MIT
@@ -107,14 +121,14 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: ruby_cqrs-0.2.2
+summary: ruby_cqrs-0.2.3
 test_files:
 - spec/feature/basic_usage_spec.rb
 - spec/feature/snapshot_spec.rb
 - spec/fixture/typical_domain.rb
+- spec/lib/ruby_cqrs/data/in_memory_event_store_spec.rb
+- spec/lib/ruby_cqrs/data/serialization_spec.rb
+- spec/lib/ruby_cqrs/domain/aggregate_repository_spec.rb
+- spec/lib/ruby_cqrs/domain/aggregate_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
-- spec/unit/aggregate_repository_spec.rb
-- spec/unit/aggregate_spec.rb
-- spec/unit/in_memory_event_store_spec.rb
-- spec/unit/serialization_spec.rb

data/lib/ruby_cqrs/error.rb

@@ -1,3 +0,0 @@
-module RubyCqrs
-  class Error < RuntimeError; end
-end