aggregate_root 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b7092c2b7985985ffa355189839d94ef36599f3
+  data.tar.gz: e421f24047e7491d6a0fc052d020224102ff7f16
+SHA512:
+  metadata.gz: 23493dde4e5a29af698b702d8c8f5cda809113ad1f7fa435dc8c508196e6c74d55eb41fb63a031431955944c615aa51498f1e9bb169849bad29cf9d04aee52e9
+  data.tar.gz: 7cee5df16ff7570043cd1a6f54d668abb27791a28718b9fd407f0c008d4040dfb6042e5fcf2bad815ca5cfd6d2120c02b1f00bc7c982c9192d03d3e2e6dfe35f

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### HEAD
+
+### 0.0.1 (28.01.2016)
+
+Initial release. Code extracted from RailsEventStore.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) Arkency
+
+Rails EventStore is an Open Source project licensed under the terms of
+the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.

data/README.md

@@ -0,0 +1,111 @@
+# AggregateRoot
+
+Event sourced (with Rails Event Store) aggregate root implementation.
+
+## Installation
+
+* Add following line to your application's Gemfile:
+
+```ruby
+gem 'aggregate_root'
+```
+
+## Usage
+
+To create a new aggregate domain object include `AggregateRoot::Base` module.
+It is important to assign `id` at initializer - it will be used as a event store stream name.
+
+```ruby
+class Order
+  include AggregateRoot::Base
+
+  def initialize(id = generate_id)
+    self.id = id
+    # any other code here
+  end
+
+  # ... more later
+end
+```
+
+#### Define aggregate logic
+
+```ruby
+OrderSubmitted = Class.new(RailsEventStore::Event)
+OrderExpired   = Class.new(RailsEventStore::Event)
+```
+
+```ruby
+class Order
+  include AggregateRoot::Base
+  HasBeenAlreadySubmitted = Class.new(StandardError)
+  HasExpired              = Class.new(StandardError)
+
+  def initialize(id = generate_id)
+    self.id = id
+    self.state = :new
+    # any other code here
+  end
+
+  def submit
+    raise HasBeenAlreadySubmitted if state == :submitted
+    raise HasExpired if state == :expired
+    apply OrderSubmitted.new(delivery_date: Time.now + 24.hours)
+  end
+
+  def expire
+    apply OrderExpired.new
+  end
+
+  private
+  attr_accessor :state
+
+  def apply_order_submitted(event)
+    self.state = :submitted
+  end
+
+  def apply_order_expired(event)
+    self.state = :expired
+  end
+end
+```
+
+#### Loading an aggregate root object from event store
+
+```ruby
+repository = ArggregateRoot::Repository.new
+order = Order.new(ORDER_ID)
+repository.load(order)
+```
+
+Load gets all domain event stored for the aggregate in event store and apply them
+in order to given aggregate to rebuild aggregate's state.
+
+#### Storing an aggregate root's changes in event store
+
+```ruby
+repository = ArggregateRoot::Repository.new
+order = Order.new(ORDER_ID)
+repository.load(order)
+order.submit
+repository.store(order)
+```
+
+Store gets all unpublished aggregate's domain events (created by executing a domain logic method like `submit`)
+and publish them in order of creation to event store.
+
+#### Resources
+
+There're already few blogposts about Rails EventStore. Check them out:
+
+* [Why use Event Sourcing](http://blog.arkency.com/2015/03/why-use-event-sourcing/)
+* [The Event Store for Rails developers](http://blog.arkency.com/2015/04/the-event-store-for-rails-developers/)
+* [Fast introduction to Event Sourcing for Ruby programmers](http://blog.arkency.com/2015/03/fast-introduction-to-event-sourcing-for-ruby-programmers/)
+
+## About
+
+<img src="http://arkency.com/images/arkency.png" alt="Arkency" width="20%" align="left" />
+
+Rails Event Store is funded and maintained by Arkency. Check out our other [open-source projects](https://github.com/arkency).
+
+You can also [hire us](http://arkency.com) or [read our blog](http://blog.arkency.com).

data/Rakefile

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

data/aggregate_root.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aggregate_root/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aggregate_root'
+  spec.version       = AggregateRoot::VERSION
+  spec.authors       = ['mpraglowski']
+  spec.email         = ['m@praglowski.com']
+
+  spec.summary       = %q{Event sourced (with Rails Event Store) aggregate root implementation}
+  spec.description   = %q{Event sourced (with Rails Event Store) aggregate root implementation}
+  spec.homepage      = ''
+
+  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_dependency 'rails_event_store', '>= 0.1.4'
+  spec.add_dependency 'activesupport', '>= 3.0'
+end

data/lib/aggregate_root.rb

@@ -0,0 +1,5 @@
+require 'rails_event_store'
+
+require 'aggregate_root/version'
+require 'aggregate_root/repository'
+require 'aggregate_root/base'

data/lib/aggregate_root/base.rb

@@ -0,0 +1,31 @@
+require 'active_support/inflector'
+
+module AggregateRoot
+  module Base
+    attr_reader :id
+
+    def apply(event)
+      apply_event(event)
+      unpublished_events << event
+    end
+
+    def apply_old_event(event)
+      apply_event(event)
+    end
+
+    def unpublished_events
+      @unpublished_events ||= []
+    end
+
+    private
+    attr_writer :id
+
+    def apply_event(event)
+      send("apply_#{event.event_type.underscore.gsub('/', '_')}", event)
+    end
+
+    def generate_uuid
+      SecureRandom.uuid
+    end
+  end
+end

data/lib/aggregate_root/repository.rb

@@ -0,0 +1,26 @@
+module AggregateRoot
+  class Repository
+    def initialize(event_store = default_event_store)
+      @event_store = event_store
+    end
+
+    def store(aggregate)
+      aggregate.unpublished_events.each do |event|
+        event_store.publish_event(event, aggregate.id)
+      end
+    end
+
+    def load(aggregate)
+      events = event_store.read_all_events(aggregate.id)
+      events.each do |event|
+        aggregate.apply_old_event(event)
+      end
+    end
+
+    attr_accessor :event_store
+
+    def default_event_store
+      RailsEventStore::Client.new
+    end
+  end
+end

data/lib/aggregate_root/version.rb

@@ -0,0 +1,3 @@
+module AggregateRoot
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: aggregate_root
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- mpraglowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-27 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: rails_event_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !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'
+description: Event sourced (with Rails Event Store) aggregate root implementation
+email:
+- m@praglowski.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- aggregate_root.gemspec
+- lib/aggregate_root.rb
+- lib/aggregate_root/base.rb
+- lib/aggregate_root/repository.rb
+- lib/aggregate_root/version.rb
+homepage: ''
+licenses: []
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Event sourced (with Rails Event Store) aggregate root implementation
+test_files: []