realm-rom 0.7.0 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4726882d01a80b82479b77ce4e5dc356147f2ce85bd6dc896330238ff12ddd27
-  data.tar.gz: b8842e600b7883a4b3b20b96beceb20841b00bf624e7ebfa91db3f0b75c52ab4
+  metadata.gz: 631dd7891edbda2e66cc9d812434d1a2036197f80be79e25ea061d2f37b8f2d6
+  data.tar.gz: 7d71ebd4ebc9d465fb36ee1d7b93b87d30166c635569aed0b0df9a1a425e3f08
 SHA512:
-  metadata.gz: d6c4791cdb46382952d50369174255fff517fb823c6ddc8222bf05751e84324a63f5385a964b84aa4a41aea879b619fc15999e3a1661174aafb659af47756400
-  data.tar.gz: 712acbcc76bb72823a998b2fe69ca69273fec5c2ff6f2f61893b092e4297f053098983dfdd39374edbdf4315222b13d38d6b8b0baf2a77416e844b8bd2387f72
+  metadata.gz: b9a81123cb1e55f7c9173a2d4edd8e0da6a30d15f606d74789f64c7fb52aab3ff9f64fc4629371938ee1fd076d5557c48187f2a1bb6e23c982e7d2b573216901
+  data.tar.gz: c2d44929520091709e83469ff68b2cdc52995eb5faa22dd4be223d7a083309b12597b4260f4063bfa23f7af978fd65654910282e2fd219ca9737301df7eaa668

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-rom
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.3
 platform: ruby
 authors:
 - developers@reevoo.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: realm-core
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !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: pg
   requirement: !ruby/object:Gem::Requirement
@@ -122,24 +136,33 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: 
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/realm-rom.rb
-- lib/realm/rom/gateway.rb
-- lib/realm/rom/plugin.rb
-- lib/realm/rom/rake_tasks.rb
-- lib/realm/rom/read_only_relation_wrapper.rb
-- lib/realm/rom/read_only_repository_wrapper.rb
-- lib/realm/rom/repository.rb
-homepage: 
+- README.md
+- Rakefile
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,8 +177,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: ROM SQL persistence plugin for Realm
 test_files: []

data/lib/realm-rom.rb

@@ -1,8 +0,0 @@
-# rubocop:disable Naming/FileName
-# frozen_string_literal: true
-
-Dir[File.join(File.dirname(__FILE__), 'realm', '**', '*.rb')].sort.each do |f|
-  require f
-end
-
-# rubocop:enable Naming/FileName

data/lib/realm/rom/gateway.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require 'rom'
-require 'realm/health_status'
-require 'active_support/core_ext/string'
-
-module Realm
-  module ROM
-    class Gateway
-      def initialize(url:, root_module:, class_path:, migration_path:, **)
-        @url = url
-        @root_module = root_module
-        @class_path = class_path
-        @migration_path = migration_path
-      end
-
-      def health
-        issues = []
-        issues << 'Cannot connect to db' unless default_gateway.connection.test_connection
-        issues << 'Pending migrations' if default_gateway.migrator.pending?
-        HealthStatus.from_issues(issues)
-      end
-
-      def method_missing(...)
-        client.send(...)
-      end
-
-      def respond_to_missing?(...)
-        client.respond_to?(...)
-      end
-
-      private
-
-      def client
-        @client ||= ::ROM.container(config)
-      end
-
-      def config
-        ::ROM::Configuration.new(:sql, @url, **config_options).tap do |config|
-          config.auto_registration(@class_path, namespace: @root_module.to_s)
-        end
-      end
-
-      def config_options
-        { search_path: @root_module.to_s.underscore, migrator: { path: @migration_path } }
-      end
-
-      def default_gateway
-        client.gateways[:default]
-      end
-    end
-  end
-end

data/lib/realm/rom/plugin.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'realm/plugin'
-require_relative 'gateway'
-
-module Realm
-  module ROM
-    class Plugin < Realm::Plugin
-      def self.setup(config, container)
-        return unless config.persistence_gateway[:type] == :rom
-
-        gateway = Gateway.new(config.persistence_gateway)
-        container.register('persistence.gateway', gateway)
-        container.register(:rom, gateway) # for backward compatibility as we access it a lot in tests
-      end
-    end
-  end
-end

data/lib/realm/rom/rake_tasks.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require 'rake'
-require 'active_support/core_ext/string'
-
-module Realm
-  module ROM
-    module RakeTasks
-      # rubocop:disable Metrics/AbcSize, Metrics/BlockLength, Metrics/MethodLength
-      def self.setup(engine_name, engine_root: Rails.root.join('engines', engine_name.to_s),
-                     db_url: ENV['DATABASE_URL'])
-        return unless db_url
-
-        options = { search_path: engine_name.to_s, migrator: { path: "#{engine_root}/db/migrate" } }
-        config = ::ROM::Configuration.new(:sql, db_url, options)
-        gateway = config.gateways[:default]
-
-        Rake.application.in_namespace(:db) do
-          Rake::Task.define_task(:init_schema) do
-            gateway.run "CREATE SCHEMA IF NOT EXISTS \"#{engine_name}\""
-            puts "<= #{engine_name}:db:init_schema executed"
-          end
-
-          Rake::Task.define_task(:drop_schema) do
-            gateway.run "DROP SCHEMA \"#{engine_name}\" CASCADE"
-            puts "<= #{engine_name}:db:drop_schema executed"
-          end
-
-          Rake.application.last_description = 'Perform migration reset (full erase and migration up)'
-          Rake::Task.define_task(:reset) do
-            gateway.run_migrations(target: 0)
-            gateway.run_migrations
-            puts "<= #{engine_name}:db:reset executed"
-          end
-
-          Rake.application.last_description = 'Migrate the database (options [version_number])]'
-          Rake::Task.define_task(:migrate, %i[version]) do |_, args|
-            version = args[:version]
-
-            if version.nil?
-              gateway.run_migrations
-              puts "<= #{engine_name}:db:migrate executed"
-            else
-              gateway.run_migrations(target: version.to_i)
-              puts "<= #{engine_name}:db:migrate version=[#{version}] executed"
-            end
-          end
-
-          Rake.application.last_description = 'Perform migration down (removes all tables)'
-          Rake::Task.define_task(:clean) do
-            gateway.run_migrations(target: 0)
-            puts "<= #{engine_name}:db:clean executed"
-          end
-
-          Rake.application.last_description = 'Create a migration (parameters: NAME, VERSION)'
-          Rake::Task.define_task(:create_migration, %i[name version]) do |_, args|
-            name, version = args.values_at(:name, :version)
-
-            if name.nil?
-              puts "No NAME specified. Example usage:
-                `rake #{engine_name}:db:create_migration[create_users]`"
-              exit
-            end
-
-            path = gateway.migrator.create_file(*[name, version].compact)
-            puts "<= migration file created #{path}"
-          end
-        end
-      end
-      # rubocop:enable Metrics/AbcSize, Metrics/BlockLength, Metrics/MethodLength
-    end
-  end
-end

data/lib/realm/rom/read_only_relation_wrapper.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'rom-sql'
-require 'realm/persistence'
-
-module Realm
-  module ROM
-    class ReadOnlyRelationWrapper
-      FORBIDDEN_METHODS = (::ROM::SQL::Relation::Writing.instance_methods(false) + [:command]).freeze
-
-      def initialize(relation)
-        @relation = relation
-      end
-
-      def method_missing(symbol, *args)
-        raise Persistence::RelationIsReadOnly, @relation if FORBIDDEN_METHODS.include?(symbol)
-
-        @relation.send(symbol, *args)
-      end
-
-      def respond_to_missing?(symbol)
-        !FORBIDDEN_METHODS.include?(symbol) && @relation.respond_to?(symbol)
-      end
-    end
-  end
-end

data/lib/realm/rom/read_only_repository_wrapper.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require 'realm/persistence'
-require_relative 'read_only_relation_wrapper'
-
-module Realm
-  module ROM
-    class ReadOnlyRepositoryWrapper
-      def initialize(repo)
-        @repo = repo.clone
-        @repo.define_singleton_method(:root) { ReadOnlyRelationWrapper.new(super()) }
-      end
-
-      def method_missing(name, *args, &block)
-        @repo.send(name, *args, &block)
-      rescue Persistence::RelationIsReadOnly
-        raise Persistence::RepositoryIsReadOnly, @repo
-      end
-
-      def respond_to_missing?(*args)
-        @repo.respond_to?(*args)
-      end
-    end
-  end
-end

data/lib/realm/rom/repository.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/string'
-require 'rom-repository'
-require 'rom-sql'
-require 'realm/error'
-require_relative 'read_only_repository_wrapper'
-
-module Realm
-  module ROM
-    class Repository < ::ROM::Repository::Root
-      # Prevents leaking of persistence details into business logic
-      class Isolated
-        def initialize(repo)
-          @repo = repo
-        end
-
-        def method_missing(*args, &block)
-          result = @repo.send(*args, &block)
-          result.is_a?(::ROM::Relation) ? result.to_a : result
-        rescue ::ROM::SQL::UniqueConstraintError
-          raise Realm::UniqueConstraintError
-        end
-
-        def respond_to_missing?(*args)
-          @repo.respond_to?(*args)
-        end
-      end
-
-      def self.new(*)
-        Isolated.new(super)
-      end
-
-      def self.repo_name(value = :not_provided)
-        @repo_name = value.to_sym unless value == :not_provided
-        @repo_name = name.demodulize.underscore unless defined?(@repo_name)
-        @repo_name
-      end
-
-      def readonly
-        @readonly ||= ROM::ReadOnlyRepositoryWrapper.new(self)
-      end
-    end
-  end
-end