realm-elasticsearch 0.7.0 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bdbf9e0dd47a5bf591f0336e92461449ee4e10e460a277a114f1dd457eb77c5
-  data.tar.gz: b2c421396d4408724ae61918b62521cb6c1bf320450b246d9cd58f10bf321edd
+  metadata.gz: acda028de64439232c09263509ce32717e19e34b0845c6e40ee3da69f89f3ead
+  data.tar.gz: b05e2cb65596bbeacf951af3d14ef4cfd28e59bbb0c8cb62c37a3a6bd19509f4
 SHA512:
-  metadata.gz: 2cf0977b9f7a3962519ded00de041b7e0b8e3c9f54259a6907130bfed7ae3cfc1a825e92137477ccddf45dbbb690de8bbc291b5e4184ff5b5c7adb60cb1b250b
-  data.tar.gz: b7dcccfcbe26ce6cb68dee2176fd3489a05a2626ad8e77d1426a3d54879152d0329abe52f8b2128d1b17a5a51d608f0dab26665553c3427ff4ed69024ab9ad8c
+  metadata.gz: 5a0e53f266e2d48b0e21401e66c0d661682976fa954d1ae2db1e00a433403cb2845c925e0917e8ead489a8d8f2bdb2db28c3fec5e8af75c00eaf757f5b77a093
+  data.tar.gz: 99a15268d00a042d40d9753cbb99827923c693527d64c28cc62ddf1209860735d04b5093cf968287eb6aa3a5e565b36b9842c4cb11f2c520839e0510606c33a3

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-elasticsearch
 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: elasticsearch
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !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
@@ -94,22 +108,19 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/realm-elasticsearch.rb
-- lib/realm/elasticsearch/gateway.rb
-- lib/realm/elasticsearch/plugin.rb
-- lib/realm/elasticsearch/rake_tasks.rb
-- lib/realm/elasticsearch/repository.rb
-homepage: 
+- README.md
+- Rakefile
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,8 +135,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: Elasticsearch plugin for Realm
 test_files: []

data/lib/realm-elasticsearch.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/elasticsearch/gateway.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'typhoeus'
-require 'elasticsearch'
-require 'realm/health_status'
-require_relative 'repository'
-
-module Realm
-  module Elasticsearch
-    class Gateway
-      def initialize(url:, **options)
-        @url = url
-        @client_options = options.slice(:adapter, :retry_on_failure, :request_timeout)
-      end
-
-      def health
-        issues = []
-        index_names = Repository.subclasses.map(&:index_name)
-        begin
-          issues << 'One or more indexes missing' unless client.indices.exists(index: index_names)
-        rescue StandardError => e
-          issues << "Elasticsearch connection error: #{e.full_message}"
-        end
-        HealthStatus.from_issues(issues)
-      end
-
-      def method_missing(...)
-        client.send(...)
-      end
-
-      def respond_to_missing?(...)
-        client.respond_to?(...)
-      end
-
-      private
-
-      def client
-        @client ||= ::Elasticsearch::Client.new(default_config.merge(@client_options))
-      end
-
-      def default_config
-        {
-          url: @url,
-          adapter: :typhoeus,
-          retry_on_failure: 3,
-          request_timeout: 30,
-        }
-      end
-    end
-  end
-end

data/lib/realm/elasticsearch/plugin.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'realm/plugin'
-require_relative 'gateway'
-
-module Realm
-  module Elasticsearch
-    class Plugin < Realm::Plugin
-      def self.setup(config, container)
-        return unless config.persistence_gateway[:type] == :elasticsearch
-
-        container.register_factory(Gateway, **config.persistence_gateway, as: 'persistence.gateway')
-      end
-    end
-  end
-end

data/lib/realm/elasticsearch/rake_tasks.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-
-module Realm
-  module Elasticsearch
-    module RakeTasks
-      class << self
-        def setup(engine_name, engine_root: nil, url: ENV['ELASTICSEARCH_URL'])
-          return unless url
-
-          client = ::Elasticsearch::Client.new(url: url)
-
-          Rake.application.in_namespace(:es) do
-            Rake::Task.define_task(:create_indexes) do
-              with_definitions(engine_name, engine_root) do |index, config|
-                client.indices.create(index: index, body: config) unless client.indices.exists(index: index)
-              end
-            end
-
-            Rake::Task.define_task(:drop_indexes) do
-              with_definitions(engine_name, engine_root) do |index, _config|
-                client.indices.delete(index: index) if client.indices.exists(index: index)
-              end
-            end
-          end
-        end
-
-        private
-
-        def with_definitions(engine_name, engine_root)
-          engine_root ||= Rails.root.join('engines', engine_name.to_s)
-          Dir.glob(File.join(engine_root, 'elasticsearch/indexes/*.yaml')).each do |path|
-            yield File.basename(path, '.yaml'), YAML.safe_load(File.read(path))
-          end
-        end
-      end
-    end
-  end
-end

data/lib/realm/elasticsearch/repository.rb

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-require 'active_support/core_ext/string'
-
-module Realm
-  module Elasticsearch
-    class Repository
-      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 self.index_name(value = :not_provided)
-        @index_name = value.to_sym unless value == :not_provided
-        @index_name = repo_name.pluralize unless defined?(@index_name)
-        @index_name
-      end
-
-      def initialize(client)
-        @client = client
-      end
-
-      def find(id:)
-        single(client.get(index: index_name, id: id))
-      rescue ::Elasticsearch::Transport::Transport::Errors::NotFound
-        nil
-      end
-
-      def all
-        multiple(raw_search(query: { match_all: {} }))
-      end
-
-      def create(id: nil, **attrs)
-        client.index(index: index_name, type: '_doc', id: id, body: attrs, refresh: refresh?)
-      rescue ::Elasticsearch::Transport::Transport::Errors::Conflict
-        raise Realm::Persistence::Conflict
-      end
-
-      def update(id:, **attrs)
-        raw_update(id, doc: attrs)
-      end
-
-      def upsert(id:, **attrs)
-        raw_update(id, doc: attrs, doc_as_upsert: true)
-      end
-
-      def delete(id:)
-        client.delete(index: index_name, type: '_doc', id: id, refresh: refresh?)
-        true
-      rescue ::Elasticsearch::Transport::Transport::Errors::NotFound
-        false
-      end
-
-      def search_by(params)
-        multiple(raw_search(query: { bool: { must: match_params(params) } }))
-      end
-
-      def delete_by(params)
-        client.delete_by_query(
-          index: index_name,
-          refresh: refresh?,
-          body: { query: {
-            bool: {
-              must: match_params(params),
-            },
-          } },
-        )
-      end
-
-      def raw_update(id, body = {})
-        client.update(index: index_name, type: '_doc', id: id, body: body, refresh: refresh?)
-      end
-
-      def raw_search(yaml: nil, options: {}, **body)
-        client.search(index: index_name, body: yaml ? YAML.safe_load(yaml) : body, **options)
-      end
-
-      def truncate!
-        client.delete_by_query(
-          index: index_name,
-          body: { query: { match_all: {} } },
-          conflicts: 'proceed',
-          refresh: refresh?,
-        )
-      end
-
-      private
-
-      attr_reader :client
-
-      def refresh?
-        # impacts performance so should be used only in TEST env
-        # TODO: remove dependency on Rails
-        defined?(::Rails) && ::Rails.env.test?
-      end
-
-      def single(result)
-        id = result['_id'].then { |i| i.to_i.positive? ? i.to_i : i }
-        result['_source'].merge(id: id).deep_symbolize_keys
-      end
-
-      def multiple(results)
-        docs = results.dig('hits', 'hits').map { |doc| single(doc) }
-        { docs: docs }
-      end
-
-      def match_params(params)
-        params.map { |(key, value)| { match: { key => value } } }
-      end
-
-      def index_name
-        self.class.index_name
-      end
-    end
-  end
-end