fourth_dimensional 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11c3860996942f56fa43873961fdbbf82069813122122326a29d286d33455990
+  data.tar.gz: 42f4c00c835316f5e0fe04a42e699afb25ef758c5e4d6ed3a87242c9eccd2567
+SHA512:
+  metadata.gz: 55df185870d5e5f68b6cf6bd68c83b69e54ec1e3bc606e5568574387a95a441f7c4b75245f9f29e53d3d2916fb18a0b8d34b330a40e7581b80287cc22f9315c9
+  data.tar.gz: c7a17815b197d2a9767714a002b148e54c2fac6fdb7d3f4094ccd132308899d7e96dfd6f8fcb856eb0397ab6db00686cdba009c20b4d7e121a28c2450a9496f3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,15 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2
+deploy:
+  local-dir: ./doc
+  provider: pages
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  keep-history: true
+  on:
+    branch: master

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    fourth_dimensional (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rdoc (6.1.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sdoc (1.0.0)
+      rdoc (>= 5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  fourth_dimensional!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sdoc (~> 1.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,123 @@
+# Fourth Dimensional
+
+Fourth Dimensional is an event sourcing library to account for the state of a
+system in relation to time.
+
+This project is a lightweight dsl for commands and events for use with
+ActiveRecord. Eventually I'd like it to support Sequel as well.
+
+[RDoc][rdoc_url]
+
+[![Build Status]][travis_status]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fourth_dimensional'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fourth_dimensional
+
+## Usage
+
+This API is in flux, but here's the general idea.
+
+```ruby
+class PostAdded < FourthDimensional::Event
+  def title
+    data.fetch('title')
+  end
+
+  def body
+    data.fetch('body')
+  end
+
+  def published
+    data.fetch('published')
+  end
+end
+
+class AddPost < FourthDimensional::Command
+  attributes :title, :body, :published
+  validates_presence_of :title, :body
+end
+
+class PostCommandHandler < FourthDimensional::CommandHandler
+  on AddPost do |command|
+    with_aggregate(PostAggregate, command) do |post|
+      post.add(title: command.title,
+               body: command.body,
+               published: command.published)
+    end
+  end
+end
+
+class PostAggregate < FourthDimensional::AggregateRoot
+  def add(title:, body:, published:)
+    apply(PostAdded,
+      data: {
+        title: title,
+        body: body,
+        published: published
+      }
+    )
+  end
+end
+
+class PostProjector < FourthDimensional::RecordProjector
+  self.record_class = 'Post'
+
+  on PostAdded do |event|
+    record.title = event.title
+    record.body = event.body
+    record.published = event.published
+  end
+end
+
+def main
+  FourthDimensional.configure do |config|
+    config.event_handlers = [
+      PostCommandHandler,
+      PostProjector
+    ]
+  end
+
+  aggregate_id = SecureRandom.uuid
+
+  command = AddPost.new(aggregate_id: aggregate_id,
+                        title: 'post-title',
+                        body: 'post-body',
+                        published: true)
+
+  # persists command and event if successful
+  FourthDimensional.execute_commands(command)
+
+  post = Post.find(aggregate_id)
+  expect(post.title).to eq('post-title')
+  expect(post.body).to eq('post-body')
+  expect(post.published).to be_truthy
+end
+```
+
+## 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/baylorrae/fourth_dimensional.
+
+[rdoc_url]: https://baylorrae.com/fourth_dimensional
+
+[Build Status]: https://travis-ci.org/BaylorRae/fourth_dimensional.svg?branch=master
+[travis_status]: https://travis-ci.org/BaylorRae/fourth_dimensional

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "sdoc"
+require "rdoc/task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options << '--format=sdoc'
+  rdoc.options << '--github'
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+end
+
+task :default => [:spec, :rdoc]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fourth_dimensional"
+
+# 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/fourth_dimensional.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fourth_dimensional/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fourth_dimensional"
+  spec.version       = FourthDimensional::VERSION
+  spec.authors       = ["Baylor Rae'"]
+  spec.email         = ["baylor@thecodedeli.com"]
+
+  spec.summary       = %q{Fourth Dimensional is an event sourcing library to account for the state of a
+  system in relation to time.}
+  spec.description   = %q{Fourth Dimensional is an event sourcing library to account for the state of a
+  system in relation to time.}
+  spec.homepage      = "https://github.com/baylorrae/fourth_dimensional"
+
+  # 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.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sdoc", "~> 1.0"
+end

data/lib/fourth_dimensional/event.rb

@@ -0,0 +1,54 @@
+module FourthDimensional
+  # == FourthDimensional::Event
+  #
+  # Events act as a log primarily focused around an aggregate. When persisted it
+  # will use the underscored version of the class name as the +event_type+.
+  #
+  #   module Posts
+  #     PostAdded = Class.new(FourthDimensional::Event)
+  #   end
+  #
+  # It is recommended practice to add delegating methods to the attributes
+  # within +data+. These aliases will make it easier to see what's being stored
+  # from the codebase.
+  #
+  #   module Posts
+  #     class PostAdded < FourthDimensional::Event
+  #       def title
+  #         data.fetch('title')
+  #       end
+  #
+  #       def body
+  #         data.fetch('body')
+  #       end
+  #     end
+  #   end
+  class Event
+    attr_reader :aggregate_id
+
+    # hash of data with stringified keys
+    attr_reader :data, :metadata
+
+    # Initializes an event with the required +aggregate_id+ and optional +data+
+    # and +metadata+.
+    #
+    #   event = MyEvent.new(aggregate_id: '1-2-3')
+    #   event.aggregate_id # => '1-2-3'
+    #   event.data # => {}
+    #   event.metadata # => {}
+    #
+    # +data+ and +metadata+ should be hashes and the keys will transformed  into
+    # strings to accommodate deserializing the values from json.
+    #
+    #   event = MyEvent.new(aggregate_id: '1-2-3',
+    #                       data: { one: 1 },
+    #                       metadata: { two: 2 })
+    #   event.data # => { 'one' => 1 }
+    #   event.metadata # => { 'two' => 2 }
+    def initialize(aggregate_id:, data: nil, metadata: nil)
+      @aggregate_id = aggregate_id
+      @data = data || {}
+      @metadata = metadata || {}
+    end
+  end
+end

data/lib/fourth_dimensional/version.rb

@@ -0,0 +1,3 @@
+module FourthDimensional
+  VERSION = "0.1.0"
+end

data/lib/fourth_dimensional.rb

@@ -0,0 +1,7 @@
+require "fourth_dimensional/version"
+
+module FourthDimensional
+  class Error < StandardError; end
+
+  autoload :Event, 'fourth_dimensional/event'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: fourth_dimensional
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Baylor Rae'
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |-
+  Fourth Dimensional is an event sourcing library to account for the state of a
+    system in relation to time.
+email:
+- baylor@thecodedeli.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fourth_dimensional.gemspec
+- lib/fourth_dimensional.rb
+- lib/fourth_dimensional/event.rb
+- lib/fourth_dimensional/version.rb
+homepage: https://github.com/baylorrae/fourth_dimensional
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Fourth Dimensional is an event sourcing library to account for the state
+  of a system in relation to time.
+test_files: []