elasticsearch_record 1.8.0 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 401d762b20a8e30d4a1b75231e1f3b10f9740ddaad711314fb9a83956442a49c
-  data.tar.gz: 1d8b9eb52e869e2b2ac7f9f2805d7aa95e36414335aca58bc5785b6983548cb2
+  metadata.gz: bbb80c1852041338e02e17314a2a70e852db077e2724383fe05d1990dc5c601e
+  data.tar.gz: 5d1f2b445e83e602b16ac571b8b3824784490f9c365a304b4be06aaa02620cb2
 SHA512:
-  metadata.gz: e8369142becb328fc7ea2c52f45e7b86c4b38405123ff7b39e57fbefb5d8c8fac4e13fbda4416181200f8c789e4fcfbcbf57f29d212bb1ff2f8d4d2974e9176c
-  data.tar.gz: 9cd8458bfd6583d665544310f57c1bbf45468ff431c9597656258db427495185a67a0cb0c0a03f963f315b88e2181167df8dbac5cc9d5d3db32eecd96dce8511
+  metadata.gz: 80ac0419ba02c1d7cc563446067caff43f7ee5b1a92c1155b5d3c2871652b06d5a8998aae4da6ee5c44289c7579a87b1346c15ae15630c11ab8cded34412e524
+  data.tar.gz: 1559d1ab3873e002c867c88726358a4d1c3f875e087f8b37ec58d9c8ee196fc757490c246409c1bc32871e9210b617e6c48473c7fe6fe68e97ab47e66da010ec

data/README.md

@@ -14,8 +14,10 @@ _ElasticsearchRecord is a ActiveRecord adapter and provides similar functionalit
 
 **PLEASE NOTE:**
 
-- This is the `main`-branch, which only supports rails **7.1** _(see section 'Rails_Versions' for supported versions)_
+- This is the `main`-branch, which currently supports rails **7.1** _(see section 'Rails_Versions' for supported versions)_
 - supports ActiveRecord ~> 7.1 + Elasticsearch >= 7.17
+- added features up to Elasticsearch `8.16.1`
+- tested with Elasticsearch `8.15.2`
 
 -----
 
@@ -44,11 +46,11 @@ https://github.com/ruby-smart/elasticsearch_record/tree/rails-7-0-stable
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'elasticsearch_record'
+gem 'elasticsearch_record', '~> 1.8'
 
-# alternatives
+# alternative
 gem 'elasticsearch_record', git: 'https://github.com/ruby-smart/elasticsearch_record', branch: 'rails-7-1-stable'
-gem 'elasticsearch_record', git: 'https://github.com/ruby-smart/elasticsearch_record', branch: 'rails-7-0-stable'
+gem 'elasticsearch_record', git: 'https://github.com/ruby-smart/elasticsearch_record', branch: 'rails-70-stable'
 
 ```
 
@@ -88,7 +90,7 @@ To raise an exception while using transactions on a ElasticsearchRecord model, t
 However enabling this flag will surely fail transactional tests _(prevent this with 'use_transactional_tests=false')_
 
 ```ruby
-# config/initializers/elasticsearch_record.yml
+# config/initializers/elasticsearch_record.rb
 
 # enable transactional exceptions
 ElasticsearchRecord.error_on_transaction = true

data/docs/CHANGELOG.md

@@ -1,10 +1,30 @@
 # ElasticsearchRecord - CHANGELOG
 
+## [1.8.2] - 2024-11-26
+* [fix] `ElasticsearchRecord::Relation::QueryMethods#build_query_clause` to raise an exception on `nil` assignments
+* [fix] `Arel::Visitors::ElasticsearchBase#compile` to always reset temporary assignments _(causes missing assignments after a query-build-exception)_
+* [fix] `Arel::Nodes::SelectAgg` to not merge nil-values
+* [add] elasticsearch mapping type _(semantic_text)_
+
+## [1.8.1] - 2024-05-07
+* [add] new elasticsearch mapping types _(percolator, geo, vector, texts, ...)_
+* [ref] `ElasticsearchRecord::Relation#limit` to detect `Float::INFINITY` to also set the **max_result_window**
+* [fix] `ElasticsearchRecord::SchemaMigration` only returning the first ten migrations (broke migrated migrations)
+* [fix] `ElasticsearchRecord::Relation::CalculationMethods#calculate` method incompatibility - renamed to `#calculate_aggregation` (+ alias to `#calculate`)
+* [fix] `ElasticsearchRecord::ModelApi#bulk` method not correctly generating data for 'delete'
+
 ## [1.8.0] - 2024-01-10
 * [ref] major method & dependency refactoring for `rails 7.1` - _(Does **NOT** work with rails 7.0)_
 * [add] new repository branch `rails-7-1-stable` to support different rails version
 * [ref] gemspec to lock on rails 7.1
 
+## [1.7.3] - 2024-05-07 _(no gem release)_
+* [add] new elasticsearch mapping types _(percolator, geo, vector, texts, ...)_
+* [ref] `ElasticsearchRecord::Relation#limit` to detect `Float::INFINITY` to also set the **max_result_window**
+* [fix] `ElasticsearchRecord::SchemaMigration` only returning the first ten migrations (broke migrated migrations)
+* [fix] `ElasticsearchRecord::Relation::CalculationMethods#calculate` method incompatibility - renamed to `#calculate_aggregation` (+ alias to `#calculate`)
+* [fix] `ElasticsearchRecord::ModelApi#bulk` method not correctly generating data for 'delete'
+
 ## [1.7.2] - 2024-01-10
 * [ref] gemspec to lock on rails 7.0
 

data/lib/active_record/connection_adapters/elasticsearch/schema_definitions/column_methods.rb

@@ -8,11 +8,20 @@ module ActiveRecord
 
         included do
           # see @ ::ActiveRecord::ConnectionAdapters::ElasticsearchAdapter::NATIVE_DATABASE_TYPES.keys
-          define_column_methods :string, :blob, :datetime, :bigint, :json, :binary, :boolean, :keyword,
-                                :constant_keyword, :wildcard, :long, :integer, :short, :byte, :double, :float,
-                                :half_float, :scaled_float, :unsigned_long, :date, :object, :flattened, :nested,
+          define_column_methods :string, :blob, :datetime, :bigint, :json,
+                                :binary, :boolean,
+                                :keyword, :constant_keyword, :wildcard,
+                                :long, :integer, :short, :byte, :double, :float, :half_float, :scaled_float, :unsigned_long,
+                                :date, :date_nanos,
+                                :alias,
+                                :object, :flattened, :nested, :join,
                                 :integer_range, :float_range, :long_range, :double_range, :date_range, :ip_range,
-                                :ip, :version, :text
+                                :ip, :version, :murmur3,
+                                :aggregate_metric_double, :histogram,
+                                :text, :match_only_text, :completion, :search_as_you_type, :token_count, :semantic_text,
+                                :dense_vector, :sparse_vector, :rank_feature, :rank_features,
+                                :geo_point, :geo_shape, :point, :shape,
+                                :percolator
 
           # Appends a primary key definition to the table definition.
           # Can be called multiple times, but this is probably not a good idea.

data/lib/arel/nodes/select_agg.rb

@@ -9,7 +9,7 @@ module Arel # :nodoc: all
       end
 
       def right
-        return expr[1].reduce({}) { |m, data| m.merge(data) } if expr[1].is_a?(Array)
+        return expr[1].reduce({}) { |m, data| data ? m.merge(data) : m } if expr[1].is_a?(Array)
 
         expr[1]
       end

data/lib/arel/visitors/elasticsearch_base.rb

@@ -27,11 +27,6 @@ module Arel # :nodoc: all
       def initialize(connection)
         super()
         @connection = connection
-
-        # required for nested assignment.
-        # see +#assign+ method
-        @nested      = false
-        @nested_args = []
       end
 
       def dispatch_as(mode)
@@ -45,6 +40,13 @@ module Arel # :nodoc: all
       end
 
       def compile(node, collector = Arel::Collectors::ElasticsearchQuery.new)
+        # IMPORTANT: To prevent persistent assigned variables due *accept* exceptions, those must be 'reset' before each compile.
+        #
+        # required for nested assignment.
+        # see +#assign+ method
+        @nested      = false
+        @nested_args = []
+
         # we don't need to forward the collector each time - we just set it and always access it, when we need.
         self.collector = collector
 

data/lib/elasticsearch_record/gem_version.rb

@@ -9,7 +9,7 @@ module ElasticsearchRecord
   module VERSION
     MAJOR = 1
     MINOR = 8
-    TINY  = 0
+    TINY  = 2
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/lib/elasticsearch_record/model_api.rb

@@ -269,8 +269,11 @@ module ElasticsearchRecord
 
       _connection.api(:core, :bulk, {
         index:   _index_name,
-        body:    if operation == :update
-                   data.map { |item| { operation => { _id: (item[:_id].presence || item['_id']), data: { doc: item.except(:_id, '_id') } } } }
+        body:    case operation
+                 when :update
+                   data.map { |item| { update: { _id: (item[:_id].presence || item['_id']), data: { doc: item.except(:_id, '_id') } } } }
+                 when :delete
+                   data.map { |item| { delete: { _id: (item[:_id].presence || item['_id']) } } }
                  else
                    data.map { |item| { operation => { _id: (item[:_id].presence || item['_id']), data: item.except(:_id, '_id') } } }
                  end,

data/lib/elasticsearch_record/relation/calculation_methods.rb

@@ -64,9 +64,12 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-boxplot-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name
+      # @return [Hash,nil]
       def boxplot(column_name)
-        calculate(:boxplot, column_name)
+        calculate_aggregation(:boxplot, column_name)
       end
 
       # A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.      #
@@ -83,9 +86,12 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name
+      # @return [Hash,nil]
       def stats(column_name)
-        calculate(:stats, column_name)
+        calculate_aggregation(:stats, column_name)
       end
 
       # A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.
@@ -102,9 +108,12 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-string-stats-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name
+      # @return [Hash,nil]
       def string_stats(column_name)
-        calculate(:string_stats, column_name)
+        calculate_aggregation(:string_stats, column_name)
       end
 
       # The matrix_stats aggregation is a numeric aggregation that computes the following statistics over a set of document fields:
@@ -118,9 +127,12 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-matrix-stats-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Array<Symbol|String>] column_names
+      # @return [Hash,nil]
       def matrix_stats(*column_names)
-        calculate(:matrix_stats, *column_names)
+        calculate_aggregation(:matrix_stats, *column_names)
       end
 
       # A multi-value metrics aggregation that calculates one or more
@@ -140,9 +152,12 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name
+      # @return [Hash,nil]
       def percentiles(column_name)
-        calculate(:percentiles, column_name, node: :values)
+        calculate_aggregation(:percentiles, column_name, node: :values)
       end
 
       # A multi-value metrics aggregation that calculates one or more
@@ -165,10 +180,13 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name
       # @param [Array] values
+      # @return [Hash,nil]
       def percentile_ranks(column_name, values)
-        calculate(:percentile_ranks, column_name, opts: { values: values }, node: :values)
+        calculate_aggregation(:percentile_ranks, column_name, opts: { values: values }, node: :values)
       end
 
       # Calculates the cardinality on a given column. Returns +0+ if there's no row.
@@ -178,9 +196,12 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name
+      # @return [Integer,nil]
       def cardinality(column_name)
-        calculate(:cardinality, column_name, node: :value)
+        calculate_aggregation(:cardinality, column_name, node: :value)
       end
 
       # Calculates the average value on a given column. Returns +nil+ if there's no row. See #calculate for examples with options.
@@ -189,9 +210,12 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name
+      # @return [Float,nil]
       def average(column_name)
-        calculate(:avg, column_name, node: :value)
+        calculate_aggregation(:avg, column_name, node: :value)
       end
 
       # Calculates the minimum value on a given column. The value is returned
@@ -202,9 +226,12 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name
+      # @return [Float,nil]
       def minimum(column_name)
-        calculate(:min, column_name, node: :value)
+        calculate_aggregation(:min, column_name, node: :value)
       end
 
       # Calculates the maximum value on a given column. The value is returned
@@ -215,9 +242,12 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name
+      # @return [Float,nil]
       def maximum(column_name)
-        calculate(:max, column_name, node: :value)
+        calculate_aggregation(:max, column_name, node: :value)
       end
 
       # This single-value aggregation approximates the median absolute deviation of its search results.
@@ -232,9 +262,12 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-median-absolute-deviation-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name
+      # @return [Float,nil]
       def median_absolute_deviation(column_name)
-        calculate(:median_absolute_deviation, column_name)
+        calculate_aggregation(:median_absolute_deviation, column_name)
       end
 
       # Calculates the sum of values on a given column. The value is returned
@@ -245,18 +278,27 @@ module ElasticsearchRecord
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html
       #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] column_name (optional)
+      # @return [Float,nil]
       def sum(column_name)
-        calculate(:sum, column_name, node: :value)
+        calculate_aggregation(:sum, column_name, node: :value)
       end
 
       # creates a aggregation with the provided metric (e.g. :sum) and columns.
       # returns the metric node (default: :value) from the aggregations result.
+      #
+      # @note returns *nil* on a *NullRelation*
+      #
       # @param [Symbol, String] metric
       # @param [Array<Symbol|String>] columns
       # @param [Hash] opts - additional arguments that get merged with the metric definition
       # @param [Symbol] node (default: nil)
-      def calculate(metric, *columns, opts: {}, node: nil)
+      def calculate_aggregation(metric, *columns, opts: {}, node: nil)
+        # prevent execution on a *NullRelation*
+        return if null_relation?
+
         metric_key = "calculate_#{metric}"
 
         # spawn a new aggregation and return the aggs
@@ -272,6 +314,8 @@ module ElasticsearchRecord
           response[metric_key]
         end
       end
+
+      alias_method :calculate, :calculate_aggregation
     end
   end
 end

data/lib/elasticsearch_record/relation/query_methods.rb

@@ -316,6 +316,12 @@ module ElasticsearchRecord
       end
 
       def build_query_clause(kind, data, rest = [])
+        # prevent empty data clauses
+        # e.g. [nil] - which will cause possible query-exceptions
+        if data.blank? || (data.is_a?(Array) && data.all?(&:blank?))
+          raise ArgumentError, "Unable to build query clause for '#{kind}' without any data @ #{klass.name}!"
+        end
+
         ElasticsearchRecord::Relation::QueryClause.new(kind, Array.wrap(data), rest.extract_options!)
       end
 

data/lib/elasticsearch_record/relation/result_methods.rb

@@ -132,11 +132,10 @@ module ElasticsearchRecord
             # resolve only data from hits->hits[{_source}]
             current_results        = if ids_only
                                        current_response['hits']['hits'].map { |result| result['_id'] }
-                                       # future with helper
-                                       # current_response['hits']['hits'].map.from_hash('_id')
                                      else
                                        current_response['hits']['hits'].map { |result| result['_source'].merge('_id' => result['_id']) }
                                      end
+
             current_results_length = current_results.length
 
             # check if we reached the required offset

data/lib/elasticsearch_record/relation/value_methods.rb

@@ -45,7 +45,7 @@ module ElasticsearchRecord
 
       # 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.nil? && delegate_query_nil_limit?)
+        if limit == '__max__' || limit == Float::INFINITY || (limit.nil? && delegate_query_nil_limit?)
           super(max_result_window)
         else
           super(limit)

data/lib/elasticsearch_record/schema_migration.rb

@@ -8,5 +8,15 @@ module ElasticsearchRecord
     def table_name
       "#{ElasticsearchRecord::Base.table_name_prefix}#{ElasticsearchRecord::Base.schema_migrations_table_name}#{ElasticsearchRecord::Base.table_name_suffix}"
     end
+
+    # overwrite method to fix the default limit (= 10) to support returning more than 10 migrations
+    def versions
+      sm = Arel::SelectManager.new(arel_table)
+      sm.project(arel_table[primary_key])
+      sm.order(arel_table[primary_key].asc)
+      sm.take(connection.max_result_window(table_name))
+
+      connection.select_values(sm, "#{self.class} Load")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch_record
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.2
 platform: ruby
 authors:
 - Tobias Gonsior
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: ActiveRecord adapter for Elasticsearch