realm-core 0.7.3 → 0.7.4

data/lib/realm/persistence.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Realm
+  class Persistence
+    class InvalidPersistanceType < Realm::Error; end
+    class Conflict < Realm::Error; end
+
+    class RelationIsReadOnly < Realm::Error
+      def initialize(relation, msg: "Cannot write using read-only relation #{relation.class}")
+        super(msg)
+      end
+    end
+
+    class RepositoryIsReadOnly < Realm::Error
+      def initialize(repo, msg: "Cannot write using read-only repository #{repo.class}")
+        super(msg)
+      end
+    end
+
+    def self.setup(...)
+      new(...).setup
+    end
+
+    def initialize(container, repositories)
+      @container = container
+      @repositories = repositories
+    end
+
+    def setup
+      register_repos
+    end
+
+    private
+
+    def gateway
+      @gateway ||= @container.resolve('persistence.gateway')
+    end
+
+    def register_repos
+      @repositories.each do |repo_class|
+        @container.register_factory(repo_class, gateway, as: "#{repo_class.name.demodulize.underscore}_repo")
+      end
+    end
+
+    def constantize(*parts)
+      return parts[0] unless parts[0].is_a?(String)
+
+      parts.join('::').safe_constantize
+    end
+  end
+end

data/lib/realm/persistence/repository_query_handler_adapter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Realm
+  class Persistence
+    class QueryCannotModifyState < Realm::Error; end
+
+    class RepositoryQueryHandlerAdapter
+      def initialize(repo)
+        @repo = repo.respond_to?(:readonly) ? repo.readonly : repo
+      end
+
+      def call(action:, params: {}, **)
+        raise CannotHandleAction.new(self, action) unless @repo.respond_to?(action)
+
+        @repo.send(action, **params)
+      rescue RepositoryIsReadOnly
+        raise QueryCannotModifyState
+      end
+    end
+  end
+end

data/lib/realm/plugin.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Realm
+  class Plugin
+    class << self
+      def plugin_name(value = :not_provided)
+        @plugin_name = value.to_sym unless value == :not_provided
+        @plugin_name = name.split('::')[-2].underscore.to_sym unless defined?(@plugin_name)
+        @plugin_name
+      end
+
+      def setup(_config, _container)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/realm/query_handler.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Realm
+  class QueryHandler < Realm::ActionHandler
+  end
+end

data/lib/realm/runtime.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Realm
+  class Runtime
+    delegate :query, :run, :run_as_job, :wait_for_jobs, to: :dispatcher
+    delegate :trigger, :add_listener, to: :event_router
+    delegate :[], to: :context
+    attr_reader :container
+
+    def initialize(container = Container.new)
+      @container = Container[container]
+    end
+
+    def context
+      @context ||= Context.new(@container)
+    end
+
+    def session(context = {})
+      context.blank? ? self : Session.new(self, context)
+    end
+
+    def worker(*args)
+      MultiWorker.new(event_router.try(:workers, *args) || [])
+    end
+
+    def health
+      component_statuses = container.each_with_object({}) do |(name, component), map|
+        map[name] = component.health if component.respond_to?(:health) && !component.is_a?(Runtime)
+      end
+      HealthStatus.combine(component_statuses)
+    end
+
+    # Get all active messaging queues. For maintenance purpose only.
+    # TODO: Introduce component container and allow to call those method directly on components instead of
+    # polluting runtime
+    # Example: engine.realm.components.find(type: Realm::EventRouter::SNSGateway).try(:active_queues)
+    def active_queues
+      event_router.try(:active_queues) || []
+    end
+
+    private
+
+    def dispatcher
+      @dispatcher ||= container.create(Dispatcher, self)
+    end
+
+    def event_router
+      @container[EventRouter]
+    end
+  end
+end

data/lib/realm/runtime/session.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Realm
+  class Runtime
+    class Session
+      delegate :query, :run, :run_as_job, :wait_for_jobs, to: :dispatcher
+      delegate :add_listener, :trigger, :worker, to: :@runtime
+      delegate :[], to: :context
+      attr_reader :context
+
+      def initialize(runtime, context)
+        @runtime = runtime
+        @context = runtime.context.merge(context)
+      end
+
+      def session(context = {})
+        context.blank? ? self : self.class.new(self, context)
+      end
+
+      def container
+        @runtime.container
+      end
+
+      private
+
+      def dispatcher
+        @dispatcher ||= container.create(Dispatcher, self)
+      end
+    end
+  end
+end

data/lib/realm/types.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'dry-types'
+
+module Realm
+  module Types
+    include Dry.Types()
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: realm-core
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - developers@reevoo.com
@@ -170,8 +170,41 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
-- Rakefile
+- 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:
 licenses:
 - MIT

data/README.md

@@ -1,40 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-# 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'