akasha 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01eaf484143fe6572ed3efe8338c2b2fb1251bf2
+  data.tar.gz: 99b1cfb52b4cb781dd83b2c711d22cbb1ff27ace
+SHA512:
+  metadata.gz: f67f3ffbe4d1e75c4c514cff8770f8d8aa95948bafc8241bd1161d27e660765d2de0036d6578e7be60a3cc05f8bd1899400ad24b4461cc85d2b5fd36095ec3a0
+  data.tar.gz: 447548998189e251c818d4ab8dfb88b71b85e31aa5e70934d22fa6498b8703ba269ca331d71dde6c0f2936330b231c23dbfaf341b0533a78dabec0b98970e898

data/.gitignore

@@ -0,0 +1 @@
+/pkg

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Gem's dependencies in akasha.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    akasha (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  akasha!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  timecop
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Marcin Bilski
+
+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,75 @@
+# Akasha
+
+A budding CQRS library for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'akasha'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install akasha
+
+## Usage
+
+```ruby
+require 'akasha'
+
+
+class User < Akasha::Aggregate
+  def sign_up(email, password)
+    changeset << Akasha::Event.new(:user_signed_up, email: email, password: password)
+  end
+
+  def on_user_signed_up(email:, password:, **_)
+    @email = email
+    @password = password
+  end
+end
+
+def initialize
+   repository = Akasha::Repository.new(Akasha::Storage::MemoryEventStore.new)
+   Akasha::Aggregate.connect!(repository)
+end
+
+def handle_sign_up_command(params)
+  user = User.find_or_create(params[:id])
+  user.email = params[:email]
+  user.password = params[:password]
+  user.save!
+end
+```
+
+> Currently, only memory-based repository is supported.
+
+## Next steps
+
+- [ ] Command routing (default and user-defined)
+- [ ] EventHandler (relying only on Eventstore)
+- [ ] HTTP Eventstore storage backend
+- [ ] Namespacing for events and aggregates
+- [ ] Version-based concurrency
+- [ ] Rake task for running EventHandlers
+- [ ] Socket-based Eventstore storage backend
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bilus/akasha.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/akasha.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'akasha/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'akasha'
+  spec.version       = Akasha::VERSION
+  spec.authors       = ['Marcin Bilski']
+  spec.email         = ['marcin@tooploox.com']
+
+  spec.summary       = %q{CQRS library for Ruby}
+  spec.description   = %q{A simple CQRS library for Ruby.}
+  spec.homepage      = "https://github.com/bilus/akasha"
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'timecop'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "akasha"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/akasha.rb

@@ -0,0 +1,4 @@
+require 'akasha/event'
+require 'akasha/aggregate'
+require 'akasha/repository'
+require 'akasha/storage/memory_event_store'

data/lib/akasha/aggregate.rb

@@ -0,0 +1,42 @@
+require_relative 'changeset'
+require_relative 'aggregate/syntax_helpers'
+
+module Akasha
+  # CQRS Aggregate base class.
+  #
+  # Usage:
+  #
+  # class User < Akasha::Aggregate
+  #   def sign_up(email, password)
+  #     changeset << Akasha::Event.new(:user_signed_up, email: email, password: password)
+  #   end
+  #
+  #   def on_user_signed_up(email:, password:, **_)
+  #     @email = email
+  #     @password = password
+  #   end
+  # end
+  class Aggregate
+    include SyntaxHelpers
+
+    attr_reader :changeset
+
+    def initialize(id)
+      @changeset = Changeset.new(id)
+    end
+
+    # Replay events, building up the state of the aggregate.
+    # Used by Repository.
+    def apply_events(events)
+      events.each do |event|
+        send(event_handler(event), event.data)
+      end
+    end
+
+    private
+
+    def event_handler(event)
+      :"on_#{event.name}"
+    end
+  end
+end

data/lib/akasha/aggregate/syntax_helpers.rb

@@ -0,0 +1,45 @@
+module Akasha
+  # Adds syntax sugar to aggregates.
+  #
+  # Initialize using the `connect!` method:
+  #      repository = Akasha::Repository.new(Akasha::Storage::MemoryEventStore.new)
+  #      Aggregate.connect!(repository)
+  #
+  # Example usage:
+  #      item = Item.find_or_create('item-1')
+  #      ... modify item ..
+  #      item.save!
+  #
+  module SyntaxHelpers
+    def self.included(base)
+      base.include(InstanceMethods)
+      base.extend(ClassMethods)
+    end
+
+    # Aggregate class methods.
+    module ClassMethods
+      # Connects to a repository.
+      def connect!(repository)
+        @@repository = repository
+      end
+
+      # Returns repository or nil if `connect!` not called.
+      def repository
+        @@repository
+      end
+
+      # Creates and loads the aggregate.
+      def find_or_create(id)
+        @@repository.load_aggregate(self, id)
+      end
+    end
+
+    # Aggregate instance methods.
+    module InstanceMethods
+      # Saves the aggregate.
+      def save!
+        self.class.repository.save_aggregate(self)
+      end
+    end
+  end
+end

data/lib/akasha/changeset.rb

@@ -0,0 +1,17 @@
+module Akasha
+  # Represents changes to an aggregate, for example an array of
+  # events generated when handling a command.
+  class Changeset
+    attr_reader :aggregate_id, :events
+
+    def initialize(aggregate_id)
+      @aggregate_id = aggregate_id
+      @events = []
+    end
+
+    # Adds an event to the changeset.
+    def <<(event)
+      @events << event
+    end
+  end
+end

data/lib/akasha/event.rb

@@ -0,0 +1,22 @@
+require 'time'
+
+module Akasha
+  # Event contains all information pertaining to a single
+  # event recorded by the system.
+  class Event
+    attr_reader :name, :data, :created_at
+
+    def initialize(name, created_at = Time.now.utc, **data)
+      @name = name
+      @created_at = created_at
+      @data = data
+    end
+
+    def ==(other)
+      self.class == other.class &&
+        name == other.name &&
+        data == other.data &&
+        created_at == other.created_at
+    end
+  end
+end

data/lib/akasha/repository.rb

@@ -0,0 +1,39 @@
+module Akasha
+  # Aggregate repository.
+  # Not meant to be used directly (see aggregate/syntax_helpers.rb)
+  # See specs for usage.
+  class Repository
+    STREAM_NAME_SEP = '-'.freeze
+
+    def initialize(store)
+      @store = store
+    end
+
+    def load_aggregate(klass, id)
+      agg = klass.new(id)
+
+      start = 0
+      chunk_size = 100
+      stream(klass, id).read_events(start, chunk_size) do |events|
+        agg.apply_events(events)
+      end
+
+      agg
+    end
+
+    def save_aggregate(aggregate)
+      changeset = aggregate.changeset
+      stream(aggregate.class, changeset.aggregate_id).write_events(changeset.events)
+    end
+
+    private
+
+    def stream_name(aggregate_klass, aggregate_id)
+      "#{aggregate_klass}#{STREAM_NAME_SEP}#{aggregate_id}"
+    end
+
+    def stream(aggregate_klass, aggregate_id)
+      @store.streams[stream_name(aggregate_klass, aggregate_id)]
+    end
+  end
+end

data/lib/akasha/storage/memory_event_store.rb

@@ -0,0 +1,17 @@
+require_relative 'memory_event_store/stream'
+
+module Akasha
+  module Storage
+    # Memory-based event store.
+    class MemoryEventStore
+      # Access to streams
+      # Example:
+      #   store.streams['some-stream-name']
+      attr_reader :streams
+
+      def initialize
+        @streams = Hash.new { |streams, name| streams[name] = Stream.new }
+      end
+    end
+  end
+end

data/lib/akasha/storage/memory_event_store/stream.rb

@@ -0,0 +1,29 @@
+module Akasha
+  module Storage
+    class MemoryEventStore
+      # Memory-based event stream.
+      class Stream
+        def initialize
+          @events = []
+        end
+
+        # Appends events to the stream.
+        def write_events(events)
+          @events += events
+        end
+
+        # Reads events from the stream starting from `position` inclusive.
+        # If block given, reads all events from the position in chunks
+        # of `size`.
+        # If block not given, reads `size` events from the position.
+        def read_events(position, size, &block)
+          if block_given?
+            @events.lazy.drop(position).each_slice(size, &block)
+          else
+            @events[position..position + size]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/akasha/version.rb

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

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: akasha
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcin Bilski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
+description: A simple CQRS library for Ruby.
+email:
+- marcin@tooploox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- akasha.gemspec
+- bin/console
+- bin/setup
+- lib/akasha.rb
+- lib/akasha/aggregate.rb
+- lib/akasha/aggregate/syntax_helpers.rb
+- lib/akasha/changeset.rb
+- lib/akasha/event.rb
+- lib/akasha/repository.rb
+- lib/akasha/storage/memory_event_store.rb
+- lib/akasha/storage/memory_event_store/stream.rb
+- lib/akasha/version.rb
+homepage: https://github.com/bilus/akasha
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: CQRS library for Ruby
+test_files: []