ruby_cqrs 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0bff53f5c549da4478fd01b6c2cbfcf37f2c113
-  data.tar.gz: 6b699a6579e93f27d6af1f0305a90f941bddf1d9
+  metadata.gz: a5f70e7b70c21215981195e374595fce852f0d94
+  data.tar.gz: 5312d18d87f660591396ca99cc120edb5e63bfb1
 SHA512:
-  metadata.gz: 54d999384f32a945152bf47b482562212a660bb824f0dac7c0495b5d7461adac974919931ec37ad73a8d18a01e619f9097318e23a5898336ef598c119aebd8b6
-  data.tar.gz: 885545a8f2118cee2aa1957967b011225a6360607bd5669307c260d06baf05c7eccbc640fb288521ec39f39df7cba7fc0b01fd993f2bca3304caa3029ee4fb4a
+  metadata.gz: 95dbd4d1ebc007450eba00a2f7bc4e8cf2dd47b439299bed29ee1bea5138b09e3058a68528f214345ae7cfdca02df8b78dead78037e810e5f6dcc5fb1a694a41
+  data.tar.gz: 0f4ea2e1eea528a598fa1e34a760994a51276e79c929a7078767ae7e5a4c31afffe5fad7c732ce1c9988618dd5a78a98e029a4ea955ced1c6a30550902dbea37

data/README.md

@@ -1,8 +1,8 @@
-[![Build Status](https://travis-ci.org/iravench/ruby_cqrs.svg?branch=master)](https://travis-ci.org/iravench/ruby_cqrs) [![Code Climate](https://codeclimate.com/github/iravench/ruby_cqrs/badges/gpa.svg)](https://codeclimate.com/github/iravench/ruby_cqrs) [![Test Coverage](https://codeclimate.com/github/iravench/ruby_cqrs/badges/coverage.svg)](https://codeclimate.com/github/iravench/ruby_cqrs)
+[![Gem Version](https://badge.fury.io/rb/ruby_cqrs.svg)](http://badge.fury.io/rb/ruby_cqrs) [![Build Status](https://travis-ci.org/iravench/ruby_cqrs.svg?branch=master)](https://travis-ci.org/iravench/ruby_cqrs) [![Code Climate](https://codeclimate.com/github/iravench/ruby_cqrs/badges/gpa.svg)](https://codeclimate.com/github/iravench/ruby_cqrs) [![Test Coverage](https://codeclimate.com/github/iravench/ruby_cqrs/badges/coverage.svg)](https://codeclimate.com/github/iravench/ruby_cqrs)
 
 # RubyCqrs
 
-A Ruby implementation of CQRS, using event sourcing.
+A Ruby implementation of CQRS, using event sourcing. go wiki cqrs for more information.
 
 ## Installation
 

data/lib/ruby_cqrs/domain/aggregate.rb

@@ -23,14 +23,14 @@ module RubyCqrs
       def load_from state
         sorted_events = state[:events].sort { |x, y| x.version <=> y.version }
         @aggregate_id = state[:aggregate_id]
-        try_load_snapshot_from state
+        try_apply_snapshot_in state
         sorted_events.each do |event|
           apply(event)
           @source_version += 1
         end
       end
 
-      def try_load_snapshot_from state
+      def try_apply_snapshot_in state
         if state.has_key? :snapshot and self.is_a? Snapshotable
           self.send :apply_snapshot, state[:snapshot][:state]
           @version = state[:snapshot][:version]
@@ -42,7 +42,7 @@ module RubyCqrs
       def get_changes
         return nil unless @pending_events.size > 0
         changes = {
-          :events => @pending_events,
+          :events => @pending_events.dup,
           :aggregate_id => @aggregate_id,
           :aggregate_type => self.class.name,
           :expecting_source_version => @source_version,

data/lib/ruby_cqrs/domain/aggregate_repository.rb

@@ -37,7 +37,7 @@ module RubyCqrs
       end
 
       def create_instance_from state
-        try_decode_from state
+        try_decode_serialized_from state
         instance = state[:aggregate_type].constantize.new
         instance.send(:load_from, state)
         instance
@@ -68,17 +68,17 @@ module RubyCqrs
           raise ArgumentError unless aggregate.is_a? Aggregate
           aggregate_change = aggregate.send(:get_changes)
           next if aggregate_change.nil?
-          try_encode_from aggregate_change
+          try_encode_serializable_in aggregate_change
           product << aggregate_change
         end
         to_return
       end
 
-      def try_decode_from state
+      def try_decode_serialized_from state
         state[:snapshot] = decode_snapshot_state_from state[:snapshot]\
           if state.has_key? :snapshot
 
-        state[:events].map! { |event_record| decode_event_from event_record }\
+        state[:events] = state[:events].map { |event_record| decode_event_from event_record }\
           if state[:events].size > 0
       end
 
@@ -94,7 +94,7 @@ module RubyCqrs
         decoded_event
       end
 
-      def try_encode_from change
+      def try_encode_serializable_in change
         if change.has_key? :snapshot
           encoded_snapshot = encode_data_from change[:snapshot][:state]
           change[:snapshot] = { :state_type => change[:snapshot][:state_type],

data/lib/ruby_cqrs/version.rb

@@ -1,3 +1,3 @@
 module RubyCqrs # :nodoc:
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/feature/basic_usage_spec.rb

@@ -1,25 +1,29 @@
 require_relative('../spec_helper.rb')
 
+# after installing the gem, require its features
+require('ruby_cqrs')
 # define your domain object
 class Customer
-  # mark as a domain object
+  # mark your domain object as an aggregate
   include RubyCqrs::Domain::Aggregate
-  # makr as snapshotable
-  # the default setting is when more 30 events are raised
-  # after the last snapshot is taken, a new snapshot is generated
-  # change the default by defining SNAPSHOT_THRESHOLD = 20(or other number)
+  # optionally, also makr as snapshotable in order to avoid heavy events reading pressure
+  # if your aggregate won't be generating much events, you can just ignore this
+  # the default setting is thant when over 30 events get raised after the last snapshot taken,
+  # a new snapshot will be generated upon calling aggregate_repository.save
+  # change this default value by defining SNAPSHOT_THRESHOLD = 20(or other number)
   include RubyCqrs::Domain::Snapshotable
 
   attr_reader :name, :credit
 
   # unfortunately, you should not try to define your own initialize method
-  # at the time being, it could potentially cause error when the aggregate
-  # repository try to load your domain object back.
+  # at the time being, it could potentially cause error with aggregate_repository
+  # when it tries to instantiate an aggregate back to live.
+  # Still looking for better way to do this.
 
-  # define your domain object's behaviors
+  # define domain behaviors
   def create_profile name, credit
-    # again, this is like your normal initialize method,
-    # it should get called only once...
+    # again, this one method kinda serve as your normal initialize method here,
+    # which means it should be called once only
     raise RuntimeError.new('the profile has already been created') unless @name.nil?
     raise AgumentError if name.nil?
     raise AgumentError if credit < 100
@@ -36,9 +40,8 @@ class Customer
   end
 
 private
-  # when an event is raised or replayed,
-  # these methods will get called automatically,
-  # manage the domain object's internal state here
+  # when an event gets raised or replayed, these on_ methods will be called automatically,
+  # with the events's detail information, you can manage the aggregate's internal state
   def on_customer_created customer_created
     @name = customer_created.name
     @credit = customer_created.credit
@@ -48,9 +51,9 @@ private
     @credit -= product_ordered.cost
   end
 
-  # when a domain object is marked as snapshotable,
-  # you must implement these two methods to record the object's vital state
-  # and apply the snapshot in order to restore your object's data respectively
+  # when an aggregate is marked as snapshotable,
+  # following two methods must be implemented in order to record and restore
+  # the aggregate's vital state respectively,
   def take_a_snapshot
     CustomerSnapshot.new(:name => @name, :credit => @credit)
   end
@@ -61,10 +64,10 @@ private
   end
 end
 
-# define a snapshot to keep all vital state of your domain object
-# the repository will use the latest snapshot it can find
-# and events happened after the snapshot has been taken
-# to recreate your domain object
+# define a snapshot to keep all vital state
+# the repository will look for the latest snapshot it can find, plus
+# all events happened right after when that particular snapshot gets taken
+# in order to revive your aggregate instance
 class CustomerSnapshot
   include Beefcake::Message
   include RubyCqrs::Domain::Snapshot
@@ -73,7 +76,9 @@ class CustomerSnapshot
   required :credit,    :int32,  2
 end
 
-# defined the events your domain object will raise
+# defined the events your aggregate will raise
+# your domain's event collection can be defined in a way easy to share among teams
+# which enables smooth integration through event logs
 class CustomerCreated
   include RubyCqrs::Domain::Event
   include Beefcake::Message
@@ -89,15 +94,19 @@ class ProductOrdered
   required :cost,       :int32,  1
 end
 
-# here goes the spec of how you can use the domain object
+# here goes the spec of how you can use previously defined aggregate objects
 describe 'Your awesome customer domain objects powered by ruby_cqrs' do
-  # a context related to the command, which is specific to your problem domain
-  # normally, when a command arrives, one or more domain objects are created or loaded
+  # a context related to a command, which is specific to your problem domain
+  # normally, when the command arrives, one or more domain objects are activated
   # in order to fulfill the command's request
+  #
+  # a command context then encapsulates any information which could be of importance
+  # but not part of your current domain, you can later choose to persist all or
+  # part of the context to support further processing or integration.
   let(:command_context) {}
-  # you should implement your own event_store in order to persist your aggregate state
-  # you should read about the InMemoryEventStore implementation
-  # and make sure your response with correct data format
+  # you should implement your own event_store in order to persist aggregate state
+  # you can read about the InMemoryEventStore implementation
+  # to understand the data format pass in and out
   let(:event_store) { RubyCqrs::Data::InMemoryEventStore.new }
   # every time when a command arrives,
   # an aggregate repository gets created with related command context and event_store implementation
@@ -160,7 +169,7 @@ describe 'Your awesome customer domain objects powered by ruby_cqrs' do
     (1..30).each { lucy.order_product(10) }
     repository.save lucy
 
-    # well, you just have to trust a snapshot has been generated :)
+    # well, you'll just have to trust me a snapshot has been generated :)
   end
 
   it 'finds an old customer instance back from snapshot' do
@@ -168,7 +177,7 @@ describe 'Your awesome customer domain objects powered by ruby_cqrs' do
     repository.save lucy
     lucy_reload = repository.find_by lucy.aggregate_id
 
-    # again, it's been loaded from a snapshot ;)
+    # again, a snapshot has been applied to gain you a bit performance boost ;)
 
     expect(lucy_reload.name).to eq('Lucy')
     expect(lucy_reload.credit).to eq(700)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_cqrs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Raven Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -107,7 +107,7 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: ruby_cqrs-0.2.0
+summary: ruby_cqrs-0.2.1
 test_files:
 - spec/feature/basic_usage_spec.rb
 - spec/feature/snapshot_spec.rb