elasticsearch_record 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9bd7858c5e59826439234e17437d5b8ff62eebbced936a5effee9da19159de5e
+  data.tar.gz: ae5d249a7d888363381bee306184c40979445aea26c5e1eec98ac94e11009e88
+SHA512:
+  metadata.gz: 23d1062c88940694455c0ef93b7fa7f9c648b20011ed69125234304b9e5e1f61a3ccffa87967af8b757fac7e9846c66051b3517b210d3a91f3e41d71ccd7c057
+  data.tar.gz: c975c08bfe47faa8b098f7a457ceb828a8314e3a51c0e0554caa6f73d08b85ce168b4ca3466a54f392336debdae5c44ddebe267c83bda1eb2ee94c9f2b059362

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in elasticsearch_record.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    elasticsearch_record (0.1.0)
+      activerecord (~> 7.0.0)
+      elasticsearch (~> 8.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    elastic-transport (8.1.0)
+      faraday (< 3)
+      multi_json
+    elasticsearch (8.4.0)
+      elastic-transport (~> 8)
+      elasticsearch-api (= 8.4.0)
+    elasticsearch-api (8.4.0)
+      multi_json
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.3)
+    multi_json (1.15.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  elasticsearch_record!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.21)
+
+BUNDLED WITH
+   2.3.18

data/README.md

@@ -0,0 +1,216 @@
+# ElasticsearchRecord
+
+ActiveRecord functionality for Elasticsearch indexes & documents.
+
+_ElasticsearchRecord is a ActiveRecord-fork and tries to provide the same functionality for Elasticsearch._
+
+-----
+
+**PLEASE NOTE:**
+- This is still in **development**!
+- Specs & documentation will follow. 
+- You might experience BUGs and Exceptions...
+- Currently supports only ActiveRecord 7.0 + Elasticsearch 8.4 _(downgrade for rails 6.x is planned in future versions)_
+
+-----
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elasticsearch_record'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install elasticsearch_record
+
+
+## Features
+* CRUD: Reading and Writing Data as already used for ActiveRecord models ```create, update, delete```
+* Query-chaining through the Active Record Query Interface
+* Query interface with additional methods for ```filter, must, must_not, should```
+* Aggregation queries ```aggregate```
+* Instrumentation for ElasticsearchRecord
+
+## Contra - what it _(currently)_ can not
+* Query-based associations like 'has_one' through a single _(or multiple)_ queries - aka. joins
+* complex, combined or nested queries ```and, or, Model.arel ...```
+* Create mappings / schema through migrations _(so no create_table, update_column, ...)_
+* Schema dumps
+* Manage indexes and mappings
+
+
+## Setup
+
+### a) Update your **database.yml** and add a elasticsearch connection:
+```yml
+ # config/database.yml
+ 
+ development:
+   primary:
+    # <...>
+
+   # elasticsearch
+   elasticsearch:
+     adapter: elasticsearch
+     host: localhost:9200
+     user: elastic
+     password: '****'
+     log: true
+ 
+ production:
+   ...
+ 
+ test:
+   ...
+ 
+ 
+```
+
+### b) Require ```elasticsearch_record/instrumentation``` in your application.rb (if you want to...):
+```ruby
+# config/application.rb
+require_relative "boot"
+
+require "rails"
+# Pick the frameworks you want:
+
+# ...
+require 'elasticsearch_record/instrumentation'
+
+module Application
+   # ...
+end
+```
+
+### c) Create a model that inherits from ```ElasticsearchRecord::Base``` model.
+```ruby
+# app/models/application_elasticsearch_record.rb
+   
+class Search < ElasticsearchRecord::Base
+   
+end
+
+```
+
+### d) have FUN with your model:
+```ruby
+scope = Search.filter(term: {name: 'MyImportantObject'}).limit(5)
+obj = scope.take
+
+obj.update(name: "Not-So-Important")
+
+scope.where(kind: :undefined).offset(10).update_all(name: "New Name")
+
+```
+
+## Active Record Query Interface
+
+### Refactored ```where``` method:
+
+Different to the default where-method you can now use it in different ways.
+
+Using it by default with a Hash, the method decides itself to either add a filter, or must_not query.
+
+_Hint: If not overwritten through ```kind(...)``` a default kind **:bool** will be used._
+```ruby
+# use it by default
+Search.where(name: 'A nice object')
+# > filter: {term: {name: 'A nice object'}}
+
+# use it by default with an array
+Search.where(name: ['A nice object','or other object'])
+# > filter: {terms: {name: ['A nice object','or other object']}}
+
+# use it by default with nil
+Search.where(name: nil)
+# > must_not: { exists: { field: 'name' } }
+
+# -------------------------------------------------------------------
+
+# use it with a prefix
+Search.where(:should, term: {name: 'Mano'})
+# > should: {term: {name: 'Mano'}}
+```
+
+### Usage Examples
+```ruby
+# save a new record
+model = Search.new(name: "Cool object", kind: "open")
+model.save
+
+# find a record by id
+MyEsIndex.find_by_id("xyzAbc34")
+```
+
+### Useful chain methods
+- kind 
+- configure
+- aggregate
+- query
+- filter
+- must_not
+- must
+- should
+- aggregate
+
+### Useful calculation methods
+- percentiles
+- percentile_ranks
+- cardinality
+- average
+- minimum
+- maximum
+- sum
+- calculate
+
+### Useful result methods
+- aggregations
+- hits
+- results
+- total
+- msearch
+- agg_pluck
+- composite
+- point_in_time
+- pit_results
+
+### Additional methods 
+- to_query
+
+-----
+
+### Useful model-class attributes
+- index_base_name
+
+### Useful model methods
+- source_column_names
+- searchable_column_names
+- find_by_query
+- msearch
+
+
+## Docs
+
+[CHANGELOG](./docs/CHANGELOG.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [elasticsearch_record](https://github.com/ruby-smart/elasticsearch_record).
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](./docs/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+A copy of the [LICENSE](./docs/LICENSE.txt) can be found @ the docs.
+
+## Code of Conduct
+
+Everyone interacting in the project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [CODE OF CONDUCT](./docs/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/docs/CHANGELOG.md

@@ -0,0 +1,44 @@
+# ElasticsearchRecord - CHANGELOG
+
+## [1.0.0] - 2022-10-18
+* [add] patch for ```ActiveRecord::Relation::Merger``` - to support AR-relations
+* [add] ```ElasticsearchRecord::Relation#pit_results``` _offset_ & _yield_ support
+* [add] individual instrumentation names for ```ElasticsearchRecord::Relation``` result methods (like: #aggregations)
+* [rem] cleanup Debugging & logging
+* [fix] quoting for any values
+* [fix] calculation ```count``` method to support already known syntax (with column, distinct, limited, ...)
+* [fix] ```Arel::Nodes``` to support additional args (query, kind, aggs, ...)
+* [fix] _relation manager patch_ to not mash up different relations
+* [fix] ```ElasticsearchRecord``` total calculation for failed queries
+* [fix] ```ElasticsearchRecord::Relation#count``` to correctly _unscope_
+* [fix] ```Arel::Visitors::Elasticsearch```
+  * build query where-clauses without existing default query-"kind" 
+  * directly fail if a grouping _(visit_Arel_Nodes_Grouping)_ was provided
+  * forced _failed!_ state was not correctly claimed
+  * buggy _assign_-method for nested arrays
+* [fix] ```Arel::Collectors::ElasticsearchQuery```
+  * claim for _argument_
+  * delete key on _nil_ assign
+* [ref] simplify ```Arel::Collectors::ElasticsearchQuery``` (remove stack & scoping)
+* [ref] simplify ```Arel::Visitors::Elasticsearch``` to support binds (statement cache) and simple where predicates
+* [ref] rename ```ElasticsearchRecord::Query#arguments``` -> _#query_arguments_
+
+## [0.1.2] - 2022-09-23
+* [fix] Records / Elasticsearch index with additional 'id' fields not recognizing
+* [rem] unnecessary & overcomplicated .index_name_delimiter class attribute
+
+## [0.1.1] - 2022-09-22
+* [add] msearch for klass & relation
+* [fix] Gemfile (remove duplicated requirements)
+* [fix] gemspec (dependencies & descriptions)
+* [fix] loading requirements, remove unused code
+* [fix] quoting
+* [fix] arel collector
+* [fix] arel visitor sort & assignment
+* [ref] results builder for multiple responses
+* [ref] log_subscriber to hide index but show 'query time'
+* [ref] model_schema attributes
+
+## [0.1.0] - 2022-09-21
+* Initial commit
+* docs, version, structure

data/docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tg@reimbursement.institute. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/docs/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Tobias Gonsior
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/active_record/connection_adapters/elasticsearch/column.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module Elasticsearch
+      class Column < ConnectionAdapters::Column # :nodoc:
+
+        attr_reader :virtual, :fields
+
+        def initialize(name, default, sql_type_metadata = nil, null = true, default_function = nil, **kwargs)
+          @virtual = kwargs.delete(:virtual)
+          @fields  = kwargs.delete(:fields)
+          super(name, default, sql_type_metadata, null, default_function, **kwargs)
+        end
+
+        # returns true if this column is virtual.
+        # Virtual columns cannot be saved.
+        # @return [Boolean]
+        def virtual?
+          !!virtual
+        end
+
+        # returns true if this column has nested fields
+        # To receive the nested names just call +#fields+ on this object.
+        # @return [Boolean]
+        def fields?
+          fields.present?
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/elasticsearch/database_statements.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module Elasticsearch
+      module DatabaseStatements
+
+        # detects if a query is a write query.
+        # since we don't provide a simple string / hash we can now access the query-object and ask for it :)
+        # @see ActiveRecord::ConnectionAdapters::DatabaseStatements#write_query?
+        # @param [ElasticsearchRecord::Query] query
+        # @return [Boolean]
+        def write_query?(query)
+          query.write?
+        end
+
+        # gets called for all queries
+        # @param [ElasticsearchRecord::Query] query
+        # @param [String (frozen)] name
+        # @param [Array] binds
+        # @param [Boolean] prepare - used by the default AbstractAdapter - but not supported and therefore never used!
+        # @param [Boolean] async
+        # @return [ElasticsearchRecord::Result]
+        def exec_query(query, name = "QUERY", binds = [], prepare: false, async: false)
+          # validate the query
+          raise ActiveRecord::StatementInvalid, 'Unable to execute invalid query' unless query.valid?
+
+          # checks for write query - raises an exception if connection is locked to readonly ...
+          check_if_write_query(query)
+
+          build_result(
+            api(*query.gate, query.query_arguments, name, async: async),
+            columns: query.columns
+          )
+        end
+
+        # Executes insert +query+ statement in the context of this connection using
+        # +binds+ as the bind substitutes. +name+ is logged along with
+        # the executed +query+ arguments.
+        def exec_insert(query, name = nil, binds = [], _pk = nil, _sequence_name = nil)
+          exec_query(query, name, binds)
+        end
+
+        # Executes delete +query+ statement in the context of this connection using
+        # +binds+ as the bind substitutes. +name+ is logged along with
+        # the executed +query+ arguments.
+        # expects a integer as return.
+        # @return [Integer]
+        def exec_delete(query, name = nil, binds = [])
+          exec_query(query, name, binds).total
+        end
+
+        # Executes update +query+ statement in the context of this connection using
+        # +binds+ as the bind substitutes. +name+ is logged along with
+        # the executed +query+ arguments.
+        # expects a integer as return.
+        # @return [Integer]
+        def exec_update(query, name = nil, binds = [])
+          exec_query(query, name, binds).total
+        end
+
+        # executes a msearch for provided arels
+        # @return [ElasticsearchRecord::Result]
+        def select_multiple(arels, name = "Multi", async: false)
+          # transform arels to query objects
+          queries = arels.map { |arel| to_sql(arel_from_relation(arel)) }
+
+          # build new msearch query
+          query = ElasticsearchRecord::Query.new(
+            index: queries.first&.index,
+            type:  ElasticsearchRecord::Query::TYPE_MSEARCH,
+            body:  queries.map { |q| { search: q.body } })
+
+          exec_query(query, name, async: async)
+        end
+
+        # executes a count query for provided arel
+        # @return [Integer]
+        def select_count(arel, name = "Count", async: false)
+          query = to_sql(arel_from_relation(arel))
+
+          # build new count query from existing query
+          query = ElasticsearchRecord::Query.new(
+            index:     query.index,
+            type:      ElasticsearchRecord::Query::TYPE_COUNT,
+            body:      query.body,
+            arguments: query.arguments)
+
+          exec_query(query, name, async: async).response['count']
+        end
+
+        # # This is used in the StatementCache object. It returns an object that
+        # # can be used to query the database repeatedly.
+        # # @see ActiveRecord::ConnectionAdapters::DatabaseStatements#cacheable_query
+        # def cacheable_query(klass, arel) # :nodoc:
+        #   # the provided klass is a ActiveRecord::StatementCache and only supports SQL _(String)_ queries.
+        #   # We force overwrite this class with our own
+        #
+        #
+        #   ActiveRecord::StatementCache.partial_query_collector
+        #
+        #   raise "STOP HERE!!!!!!"
+        #   if prepared_statements
+        #     sql, binds = visitor.compile(arel.ast, collector)
+        #     query = klass.query(sql)
+        #   else
+        #     collector = klass.partial_query_collector
+        #     parts, binds = visitor.compile(arel.ast, collector)
+        #     query = klass.partial_query(parts)
+        #   end
+        #   [query, binds]
+        # end
+
+        # calls the +elasticsearch-api+ endpoints by provided namespace and action.
+        # if a block was provided it'll yield the response.body and returns the blocks result.
+        # otherwise it will return the response itself...
+        # @param [Symbol] namespace - the API namespace (e.g. indices, nodes, sql, ...)
+        # @param [Symbol] action - the API action to call in tha namespace
+        # @param [Hash] arguments - action arguments
+        # @param [String (frozen)] name - the logging name
+        # @param [Boolean] async - send async (default: false) - currently not supported
+        # @return [Elasticsearch::API::Response, Object]
+        def api(namespace, action, arguments = {}, name = 'API', async: false)
+          raise ::StandardError, 'ASYNC api calls are not supported' if async
+
+          # resolve the API target
+          target = namespace == :core ? @connection : @connection.__send__(namespace)
+
+          log("#{namespace}.#{action}", arguments, name, async: async) do
+            response = ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+              target.__send__(action, arguments)
+            end
+
+            if response.is_a?(::Elasticsearch::API::Response)
+              # reverse information for the LogSubscriber - shows the 'query-time' in the logs
+              # this works, since we use a referenced hash ...
+              arguments[:_qt] = response['took']
+
+              # raise timeouts
+              raise(ActiveRecord::StatementTimeout, "Elasticsearch api request failed due a timeout") if response['timed_out']
+            end
+
+            response
+          end
+        end
+      end
+    end
+  end
+end