realm-core 0.7.1 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7384c47348b48ded26a37ce232e0ccb357a8a6e7e1f25667d614f9dc37a8af2
-  data.tar.gz: 0b4ae6a517da7377f458111447453423652b35166fadbb60df74337727d68068
+  metadata.gz: 48d73715170e2bfb91f817fe7f09816980939bfd51d56e061a088908af40dd08
+  data.tar.gz: bde68574affd81f8eaecb821921c6dba91fe151eaa9b1703cdf31fff14e934cf
 SHA512:
-  metadata.gz: 4aa7ec7d85ce6777b58d13f6bf3ff691e83901124951f7ebb38b60c2fbf929bf58b6daec23631f8308147be8614f7ed82edce045855620de9ba6b05abab424b0
-  data.tar.gz: ca2605753e57f0290a2b834f455389dfcc57a0ad51515b7fdc0b75c4daf2a166d32c9039aea45ce09a9995d3807beb0ac8ae97b38c2b9682658e6d28f0237cb1
+  metadata.gz: ff5149ff935de4a9599679f6daf246af8c43a06b3fab9d35f941a5c7d84b05b6557b4ed13487b56f127afaabe7a4868a8900d918004214f0ab13ba359763db5f
+  data.tar.gz: 681487eb34d5d79f090eb505966fda04406f917051b4bd5bd8fc0aa9df7d285b5dd7e5083ffc4bcd3f71d1f93b94c21fc1c8200f6c74aca1883baff2b80ac700

data/README.md

@@ -0,0 +1,40 @@
+# Realm
+
+Domain layer framework following Domain-driven/CQRS design principles.
+
+[![Build status](https://badge.buildkite.com/346cce75f6c31e0a41bb98b198e85eb6b722243624459fad9c.svg)](https://buildkite.com/reevoo/realm)
+
+## Service layers
+
+We follow the standard MVC design pattern of Rails but giving the model layer more structure and guidance regarding where
+to put your code. The model is split into domain layer (using our [Realm](https://github.com/reevoo/smart-mono/tree/master/gems/realm) library)
+and persistence layer (using [ROM](https://rom-rb.org/) library). The individual components are explained in the following section.
+
+![Service layers](https://confluence-connect.gliffy.net/embed/image/d02d04b1-5e40-415f-b7ba-3a631efa9bf3.png?utm_medium=live&utm_source=custom)
+
+Advanced components are shown in lighter color, those will be needed only later on as the service domain logic grows.
+
+## Model layer components
+
+![Service external components](https://confluence-connect.gliffy.net/embed/image/c593fcc2-304e-47c3-8e3c-b0cc09e0ed54.png?utm_medium=live&utm_source=custom)
+
+Each service has one **domain** module which consists of multiple [**aggregate**](https://martinfowler.com/bliki/DDD_Aggregate.html) modules.
+Aggregate is a cluster of domain objects that can be treated as a single unit. The only way for outer world to communicate
+with aggregate is by **queries** and **commands**. Query exposes aggregate's internal state and command changes it.
+The state of an aggregate is represented by tree of **entities** with one being the aggregate root and zero or more dependent
+entities with *belongs_to* relation to the root entity. The state of an aggregate (entity tree) is persisted
+and retrieved by **repository**. There is generally one repository per aggregate unless we split the read/write
+(query/command) persistence model for that particular domain. The repository uses **relations** to access the database
+tables. Each relation class represents one table.
+
+
+## Where to put my code as it grows?
+
+TODO
+
+
+## Roadmap
+
+- [ ] Support Ruby 3
+- [ ] Make it work outside of Rails engines
+- [ ] Support multiple persistence gateways in one runtime

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Realm'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: realm-core
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.3
 platform: ruby
 authors:
 - developers@reevoo.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -150,52 +164,19 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/realm-core.rb
-- lib/realm.rb
-- lib/realm/action_handler.rb
-- lib/realm/action_handler/result.rb
-- lib/realm/builder.rb
-- lib/realm/command_handler.rb
-- lib/realm/config.rb
-- lib/realm/container.rb
-- lib/realm/context.rb
-- lib/realm/dependency.rb
-- lib/realm/dispatcher.rb
-- lib/realm/domain_resolver.rb
-- lib/realm/error.rb
-- lib/realm/event.rb
-- lib/realm/event_factory.rb
-- lib/realm/event_handler.rb
-- lib/realm/event_router.rb
-- lib/realm/event_router/gateway.rb
-- lib/realm/event_router/internal_loop_gateway.rb
-- lib/realm/health_status.rb
-- lib/realm/mixins/aggregate_member.rb
-- lib/realm/mixins/context_injection.rb
-- lib/realm/mixins/controller.rb
-- lib/realm/mixins/decorator.rb
-- lib/realm/mixins/dependency_injection.rb
-- lib/realm/mixins/reactive.rb
-- lib/realm/mixins/repository_helper.rb
-- lib/realm/multi_worker.rb
-- lib/realm/persistence.rb
-- lib/realm/persistence/repository_query_handler_adapter.rb
-- lib/realm/plugin.rb
-- lib/realm/query_handler.rb
-- lib/realm/runtime.rb
-- lib/realm/runtime/session.rb
-- lib/realm/types.rb
-homepage: 
+- README.md
+- Rakefile
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -210,8 +191,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Domain layer framework following Domain-driven/CQRS design principles
 test_files: []

data/lib/realm-core.rb

@@ -1,6 +0,0 @@
-# rubocop:disable Naming/FileName
-# frozen_string_literal: true
-
-require 'realm'
-
-# rubocop:enable Naming/FileName

data/lib/realm.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-Dir[File.join(File.dirname(__FILE__), 'realm', '**', '*.rb')].sort.each do |f|
-  require f
-end
-
-module Realm
-  class << self
-    # Setup realm in test/console
-    def setup(root_module, **options)
-      config = Realm::Config.new(root_module: root_module, **options)
-      Realm::Builder.setup(config)
-    end
-
-    # Bind realm in service/engine
-    def bind(root_module, **options)
-      setup(root_module, **options).tap do |builder|
-        root_module.define_singleton_method(:realm) { builder.runtime }
-      end
-    end
-  end
-end

data/lib/realm/action_handler.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry-validation'
-require 'active_support/core_ext/module/delegation'
-require 'realm/error'
-require 'realm/mixins/context_injection'
-require 'realm/mixins/repository_helper'
-require 'realm/mixins/aggregate_member'
-require_relative 'action_handler/result'
-
-module Realm
-  class ActionHandler
-    extend Mixins::ContextInjection::ClassMethods
-    include Mixins::AggregateMember
-    include Mixins::RepositoryHelper
-
-    class << self
-      attr_reader :contracts
-
-      def call(action: :handle, params: {}, runtime: nil)
-        new(runtime: runtime).(action: action, params: params)
-      end
-
-      protected
-
-      def require_permission(*names)
-        # TODO: implement
-      end
-
-      def contract(&block)
-        @method_contract = Class.new(Dry::Validation::Contract, &block).new
-      end
-
-      def contract_schema(&block)
-        contract { schema(&block) }
-      end
-
-      def contract_params(&block)
-        contract { params(&block) }
-      end
-
-      def contract_json(&block)
-        contract { json(&block) }
-      end
-
-      def method_added(method_name)
-        super
-        return unless defined?(@method_contract)
-
-        @contracts ||= {}
-        @contracts[method_name] = @method_contract
-        remove_instance_variable(:@method_contract)
-      end
-    end
-
-    def initialize(runtime: nil)
-      @runtime = runtime
-    end
-
-    def call(action: :handle, params: {})
-      # TODO: check permissions
-      raise CannotHandleAction.new(self, action) unless respond_to?(action)
-
-      safe_params = validate(action, params.to_h)
-      send(action, **safe_params)
-    end
-
-    protected
-
-    delegate :context, to: :@runtime
-
-    private
-
-    def validate(action, params)
-      contract = self.class.contracts && self.class.contracts[action]
-      return params unless contract
-
-      result = contract.(params)
-      raise Realm::InvalidParams, result if result.failure?
-
-      result.to_h
-    end
-  end
-end

data/lib/realm/action_handler/result.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Realm
-  class ActionHandler
-    # Tuple of label and value
-    class Result < Array
-      def self.[](first, second = nil)
-        return new(first, second).freeze if first.is_a?(Symbol) || first.is_a?(Realm::Event)
-
-        new(second || :ok, first).freeze
-      end
-
-      def label
-        self[0]
-      end
-
-      def event
-        label if label.is_a?(Realm::Event)
-      end
-
-      def value
-        self[1]
-      end
-
-      private
-
-      def initialize(label, value)
-        super([label, value])
-      end
-    end
-  end
-end

data/lib/realm/builder.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/string'
-require 'realm/container'
-require 'realm/runtime'
-require 'realm/domain_resolver'
-require 'realm/persistence'
-require 'realm/dispatcher'
-require 'realm/event_router'
-require 'realm/plugin'
-
-module Realm
-  class Builder
-    def self.setup(config)
-      new(config).setup
-    end
-
-    def initialize(config)
-      @config = config
-    end
-
-    def setup
-      logger.info("Setting up #{cfg.root_module} realm")
-      register_domain_resolver
-      register_event_router
-      register_runtime
-      register_logger
-      register_dependencies
-      setup_plugins
-      config_persistence
-      self
-    end
-
-    def runtime
-      @container.resolve(Runtime)
-    end
-
-    private
-
-    def register_domain_resolver
-      container.register_factory(DomainResolver, constantize(cfg.domain_module))
-    end
-
-    def register_event_router
-      return if cfg.event_gateways.empty?
-
-      container.register_factory(EventRouter, cfg.event_gateways, prefix: cfg.prefix)
-    end
-
-    def register_runtime
-      container.register_factory(Runtime, container)
-    end
-
-    def register_logger
-      container.register(:logger, logger)
-    end
-
-    def register_dependencies
-      container.register_all(**cfg.dependencies)
-    end
-
-    def setup_plugins
-      Plugin.descendants.each do |plugin|
-        plugin.setup(cfg, container) if cfg.plugins.include?(plugin.plugin_name)
-      end
-    end
-
-    def config_persistence
-      return unless cfg.persistence_gateway.present?
-
-      Persistence.setup(container, cfg.persistence_gateway[:repositories])
-    end
-
-    def constantize(*parts)
-      return parts[0] unless parts[0].is_a?(String)
-
-      parts.join('::').safe_constantize
-    end
-
-    def cfg
-      @config
-    end
-
-    def container
-      @container ||= Container.new
-    end
-
-    def logger
-      @logger ||= cfg.logger || (defined?(Rails) && Rails.logger) ||
-                  Logger.new($stdout, level: ENV.fetch('LOG_LEVEL', :info).to_sym)
-    end
-  end
-end

data/lib/realm/command_handler.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/module/delegation'
-require 'active_support/core_ext/string'
-require 'realm/action_handler'
-require 'realm/mixins/reactive'
-
-module Realm
-  class CommandHandler < Realm::ActionHandler
-    include Mixins::Reactive
-
-    def call(*)
-      gateway = context[:rom]&.gateways&.dig(:default)
-      gateway ? gateway.transaction { super } : super
-    end
-
-    protected
-
-    def result(first, second = nil)
-      Result[first, second]
-    end
-  end
-end