elasticsearch_record 3.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df21aa38516f4e56830e16ffcff4164b65541a869e3964771771eacdf4e8ad16
-  data.tar.gz: 7ba579e28c1a85e7f890654c99c675eb60dd2fddf1b1eb877b0967e17f1d7097
+  metadata.gz: a4f850e5600056256b188825cc8ca7067b4928014a09b05bb18ed37fb648478f
+  data.tar.gz: 19cec69e3a5a67752f8c94a2b22968e29dd5edf7166e4e205903164387e8606f
 SHA512:
-  metadata.gz: cb521dc265ec3a517ebda7b8b6e60b5471b1411bd8f04d6be72098e95177e32af06267bc9a2e2881699d0f7f317c3bf1ef77b6613d9657df6ac7347affa80cf9
-  data.tar.gz: 981b0955f21d2260d794cc1946ed560fa70d0e429b5c0bc97d2c9c5b29b396af471cd8d6460929fa451913ad44f7d9992c9b8c0d8a6cd6a7035c338147161138
+  metadata.gz: 076f2df28822bba0a2148d2e3043cb403cb04d388c5034056eb7e298004694707b2e2b8c003257f8da4dc5d1bea80ae5bce8b851244cd146232b381ecc35543e
+  data.tar.gz: 91a406efac0912da2f2427120b0cf1fdbf1ae78166b9853c3af6099b6e19fd4aa09aebf962840f01345d4b32a523a1fd74706f827f86b0804a0f8ffef2199392

data/README.md

@@ -16,8 +16,8 @@ _ElasticsearchRecord is a ActiveRecord adapter and provides similar functionalit
 
 **PLEASE NOTE:**
 
-- This is the `main`-branch, which supports rails **7.2** _(see section 'Rails_Versions' for supported versions)_
-- supports ActiveRecord ~> 7.2 + Elasticsearch >= 7.17
+- This is the `main`-branch, which supports rails **8.1** _(see section 'Rails_Versions' for supported versions)_
+- supports ActiveRecord ~> 8.1 + Elasticsearch >= 7.17
 - added features up to Elasticsearch `8.17.1` _(tested against `8.19.14`)_
 - _ES|QL_ queries _(`TYPE_ESQL` / the `esql.query` gate)_ require **Elasticsearch >= 8.11**, where the feature became
   generally available. All other features remain available from Elasticsearch `7.17`.
@@ -28,15 +28,30 @@ _ElasticsearchRecord is a ActiveRecord adapter and provides similar functionalit
 
 Supported rails versions:
 
+### Rails 8.1:
+_(since gem version 5.0)_
+
+https://github.com/ruby-smart/elasticsearch_record/tree/rails-8-1-stable
+
+[![rails-7-1-stable](https://img.shields.io/badge/rails-8.1.stable-orange.svg)](https://github.com/ruby-smart/elasticsearch_record/tree/rails-8-1-stable)
+
+### Rails 8.0:
+_(since gem version 4.0)_
+
+https://github.com/ruby-smart/elasticsearch_record/tree/rails-8-0-stable
+
+[![rails-7-1-stable](https://img.shields.io/badge/rails-8.0.stable-orange.svg)](https://github.com/ruby-smart/elasticsearch_record/tree/rails-8-0-stable)
+
+
 ### Rails 7.2:
-_(since gem version 2.1)_
+_(since gem version 3.0)_
 
 https://github.com/ruby-smart/elasticsearch_record/tree/rails-7-2-stable
 
 [![rails-7-1-stable](https://img.shields.io/badge/rails-7.2.stable-orange.svg)](https://github.com/ruby-smart/elasticsearch_record/tree/rails-7-2-stable)
 
 ### Rails 7.1:
-_(since gem version 1.8)_
+_(since gem version 2.0)_
 
 https://github.com/ruby-smart/elasticsearch_record/tree/rails-7-1-stable
 

data/docs/CHANGELOG.md

@@ -1,5 +1,20 @@
 # ElasticsearchRecord - CHANGELOG
 
+## [5.0.0] - 2026-09-10
+* [add] **BREAKING**: requires `activerecord ~> 8.1.0`
+* [add] `Relation::ValueMethods#limit!` - keeps the `'__max__'` & `Float::INFINITY` limits, which rails now casts through `Integer()`
+* [add] specs for `SchemaStatements#new_column_from_field` resolving the cast type upfront
+* [ref] `Elasticsearch::Column#initialize` takes `cast_type` as 2nd positional argument
+* [ref] `SchemaStatements#lookup_cast_type_from_column` -> `#lookup_multicast_cast_type` - resolves from a `sql_type` and is called upfront
+* [ref] `DatabaseStatements#internal_execute` guards writes through `#write_query?` & `#ensure_writes_are_allowed`
+* [ref] `StatementCache::PartialQuery#initialize` takes the `retryable:` flag
+
+## [4.0.0] - 2026-09-08
+* [add] **BREAKING**: requires `activerecord ~> 8.0.0`
+* [add] `ElasticsearchRecord::Result#indexed_rows` - rails 8.0 instantiates records through this method instead of iterating the result set itself.
+* [ref] `ElasticsearchAdapter#log` resolves the instrumenter through `#instrumenter` instead of the former `@instrumenter` ivar
+* [ref] `ActiveRecord::ConnectionAdapters::Elasticsearch::SchemaDumper` remove redundant blank lines
+
 ## [3.0.0] - 2026-09-08
 * [add] **BREAKING**: requires `activerecord ~> 7.2.0`
 * [add] `Quoting::ClassMethods#quote_column_name` & `#quote_table_name` - identifier quoting is class-level & mandatory now

data/elasticsearch_record.gemspec

@@ -14,7 +14,7 @@ DESC
 
   spec.homepage              = "https://github.com/ruby-smart/elasticsearch_record"
   spec.license               = "MIT"
-  spec.required_ruby_version = ">= 3.1.0"
+  spec.required_ruby_version = ">= 3.2.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
   spec.metadata["homepage_uri"]      = spec.homepage
@@ -32,7 +32,7 @@ DESC
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activerecord', '~> 7.2.0'
+  spec.add_dependency 'activerecord', '~> 8.1.0'
   spec.add_dependency 'elasticsearch', '>= 7.17'
 
   spec.add_development_dependency 'coveralls_reborn', '~> 0.25'

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

@@ -7,14 +7,14 @@ module ActiveRecord
 
         attr_reader :virtual, :fields, :properties, :meta, :enabled
 
-        def initialize(name, default, sql_type_metadata = nil, virtual: false, fields: nil, properties: nil, meta: nil, enabled: nil, **kwargs)
+        def initialize(name, cast_type, default, sql_type_metadata = nil, virtual: false, fields: nil, properties: nil, meta: nil, enabled: nil, **kwargs)
           @virtual    = virtual
           @fields     = fields.presence || []
           @properties = properties.presence || []
           @meta       = meta.presence || {}
           @enabled    = enabled.nil? ? true : enabled
 
-          super(name, default, sql_type_metadata, true, nil, **kwargs)
+          super(name, cast_type, default, sql_type_metadata, true, nil, **kwargs)
         end
 
         # returns comment from meta

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

@@ -160,7 +160,7 @@ module ActiveRecord
             raise ActiveRecord::StatementInvalid, 'Unable to execute! Provided query is invalid.' unless query.valid?
 
             # checks for write query - raises an exception if connection is locked to readonly ...
-            check_if_write_query(query)
+            ensure_writes_are_allowed(query) if write_query?(query)
 
             api(query.gate, query.query_arguments, name, async: async, allow_retry: allow_retry, materialize_transactions: materialize_transactions)
           end

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

@@ -151,14 +151,12 @@ module ActiveRecord
             end
 
             tbl.puts "  end"
-            tbl.puts
 
             tbl.rewind
             stream.print tbl.read
           rescue => e
             stream.puts "# Could not dump table #{table.inspect} because of following #{e.class}"
             stream.puts "#   #{e.message}"
-            stream.puts
           ensure
             self.table_name = nil
           end

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

@@ -226,6 +226,8 @@ module ActiveRecord
           def new_column_from_field(_table_name, field, _definitions)
             ActiveRecord::ConnectionAdapters::Elasticsearch::Column.new(
               field["name"],
+              # the cast type is resolved upfront and stored on the column
+              lookup_multicast_cast_type(field["type"]),
               field["null_value"],
               fetch_type_metadata(field["type"]),
               meta: field['meta'],
@@ -236,13 +238,13 @@ module ActiveRecord
             )
           end
 
-          # lookups from building the @columns_hash.
+          # resolves the cast type of the provided +sql_type+ and wraps it into a +MulticastValue+.
           # since Elasticsearch has the "feature" to provide multicast values on any type, we need to fetch them ...
           # you know, ES can return an integer or an array of integers for any column ...
-          # @param [ActiveRecord::ConnectionAdapters::Elasticsearch::Column] column
+          # @param [String] sql_type
           # @return [ActiveRecord::ConnectionAdapters::Elasticsearch::Type::MulticastValue]
-          def lookup_cast_type_from_column(column)
-            type_map.lookup(:multicast_value, super)
+          def lookup_multicast_cast_type(sql_type)
+            type_map.lookup(:multicast_value, lookup_cast_type(sql_type))
           end
 
           # Returns a array of tables primary keys.

data/lib/active_record/connection_adapters/elasticsearch_adapter.rb

@@ -114,8 +114,8 @@ module ActiveRecord # :nodoc:
           # this special Type is required to parse a ES-value into the +nested_type+, array or hash.
           # For arrays & hashes it tries to cast the values with the provided +nested_type+
           # but falls back to provided value if cast fails.
-          # This type cannot be accessed through the mapping and is only called @ #lookup_cast_type_from_column
-          # @see ActiveRecord::ConnectionAdapters::Elasticsearch::SchemaStatements#lookup_cast_type_from_column
+          # This type cannot be accessed through the mapping and is only called @ #lookup_multicast_cast_type
+          # @see ActiveRecord::ConnectionAdapters::Elasticsearch::SchemaStatements#lookup_multicast_cast_type
           m.register_type :multicast_value do |_type, nested_type|
             ActiveRecord::ConnectionAdapters::Elasticsearch::Type::MulticastValue.new(nested_type: nested_type)
           end
@@ -384,7 +384,9 @@ module ActiveRecord # :nodoc:
       # @raise [Exception] any exception encountered during execution, after translation.
       # @return [void]
       def log(gate, arguments, name = 'QUERY', async: false, statistics: nil, &block)
-        @instrumenter.instrument(
+        # +instrumenter+ instead of the former +@instrumenter+ ivar - the abstract adapter
+        # resolves it per execution context now
+        instrumenter.instrument(
           "query.elasticsearch_record",
           gate: gate,
           name: name,

data/lib/elasticsearch_record/gem_version.rb

@@ -7,7 +7,7 @@ module ElasticsearchRecord
   end
 
   module VERSION
-    MAJOR = 3
+    MAJOR = 5
     MINOR = 0
     TINY  = 0
     PRE   = nil

data/lib/elasticsearch_record/relation/value_methods.rb

@@ -43,6 +43,14 @@ module ElasticsearchRecord
         @values[:aggs] = value
       end
 
+      # overwrite the +limit!+ method, since the default implementation casts the provided value
+      # through +Integer()+ before it reaches the +limit_value=+ setter - which would raise
+      # for our special values ('__max__' & +Float::INFINITY+).
+      def limit!(value)
+        self.limit_value = value
+        self
+      end
+
       # overwrite the limit_value setter, to provide a special behaviour of auto-setting the +max_result_window+.
       def limit_value=(limit)
         if limit == '__max__' || limit == Float::INFINITY || (limit.nil? && delegate_query_nil_limit?)

data/lib/elasticsearch_record/result.rb

@@ -172,6 +172,16 @@ module ElasticsearchRecord
       n ? computed_results.last(n) : computed_results.last
     end
 
+    # Returns the rows to instantiate records from - ActiveRecord resolves them through this
+    # method instead of iterating the result set itself.
+    # Each element is a Hash keyed by column / metadata name and therefore already provides the
+    # read surface of +ActiveRecord::Result::IndexedRow+ (+key?+, +[]+, +fetch+, +keys+, ...).
+    # used by +ActiveRecord+
+    # @return [Array<Hash>]
+    def indexed_rows # :nodoc:
+      computed_results
+    end
+
     # used by ActiveRecord
     def cancel # :nodoc:
       self

data/lib/elasticsearch_record/statement_cache.rb

@@ -4,8 +4,9 @@ module ElasticsearchRecord
   class StatementCache < ActiveRecord::StatementCache
 
     class PartialQuery < ActiveRecord::StatementCache::PartialQuery # :nodoc:
-      def initialize(values)
-        @values = values
+      def initialize(values, retryable:)
+        @values    = values
+        @retryable = retryable
         # no need to create indexes
       end
 
@@ -77,8 +78,8 @@ module ElasticsearchRecord
       end
     end
 
-    def self.partial_query(values)
-      PartialQuery.new(values)
+    def self.partial_query(...)
+      PartialQuery.new(...)
     end
 
     def self.partial_query_collector

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch_record
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Tobias Gonsior
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 8.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 8.1.0
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
@@ -228,7 +228,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="