realm-rom 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4726882d01a80b82479b77ce4e5dc356147f2ce85bd6dc896330238ff12ddd27
+  data.tar.gz: b8842e600b7883a4b3b20b96beceb20841b00bf624e7ebfa91db3f0b75c52ab4
+SHA512:
+  metadata.gz: d6c4791cdb46382952d50369174255fff517fb823c6ddc8222bf05751e84324a63f5385a964b84aa4a41aea879b619fc15999e3a1661174aafb659af47756400
+  data.tar.gz: 712acbcc76bb72823a998b2fe69ca69273fec5c2ff6f2f61893b092e4297f053098983dfdd39374edbdf4315222b13d38d6b8b0baf2a77416e844b8bd2387f72

data/lib/realm-rom.rb

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

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

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

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

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

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

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

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: realm-rom
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- developers@reevoo.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: realm-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rom-sql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: ROM SQL persistence plugin for Realm
+test_files: []