elasticsearch_record 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c479344b27eac6994fc17c6607f42221b093ddfc5f6db36b88994f25f2a0e56
-  data.tar.gz: 884ba24246d3ab9ef3500546bca84dcb3eaea184ac20bcfde6a2713e0a6def79
+  metadata.gz: 32688db9e3220d919f454f7c4c9445b006d43299d66322f4586af9d426fdc907
+  data.tar.gz: 9169c9110e662d647f7eddeddae7fa3497a03ad36486d85c001e762af5c756df
 SHA512:
-  metadata.gz: 554ca0302d07210beef1f8bcb4b49f65b9e734122ccbbfb4a44d619d7697d1e5ec4b4164890beacaab4106654e5cdb7c817adf81d5953d46ed9f600b395e8018
-  data.tar.gz: 2a6a3579a00f2734c623f364a1eea5ba9802896a122c74ea4503764c63ad0294f16279b02cf3ce0f6a8d924ef3cb15004c2e2a933e90f22d311f4cbae067597c
+  metadata.gz: 9221a04be02abcb7d8f36da24f3b7e2d061b778233b8190bb14b906bf54b2a8d881a870f9c0b1b65d90b3ff2418fe8ee21d828b35dceac85b2f8bc766677c73c
+  data.tar.gz: a1b4e64cf4a8c33d8ce3aaeb89fedd5b7847a648a1dcfccc2b15ecfba0f99d0fbf9a0c94237edcd6ef0feb8d4ef40889ab00c2b8a6bc50773b4982cd5e326149

data/.yardopts

@@ -1,4 +1,6 @@
 --embed-mixins
 --markup=markdown
 --files docs/*.*
---plugin relative_markdown_links
+--plugin relative_markdown_links
+--plugin activesupport-concern
+--exclude lib/elasticsearch_record/patches

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elasticsearch_record (1.2.0)
+    elasticsearch_record (1.2.1)
       activerecord (~> 7.0.0)
       elasticsearch (~> 8.4)
 
@@ -56,6 +56,8 @@ GEM
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
+    yard-activesupport-concern (0.0.1)
+      yard (>= 0.8)
 
 PLATFORMS
   x86_64-linux
@@ -65,6 +67,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   yard (~> 0.9)
+  yard-activesupport-concern (~> 0.0.1)
 
 BUNDLED WITH
    2.3.18

data/README.md

@@ -136,7 +136,7 @@ scope.where(kind: :undefined).offset(10).update_all(name: "New Name")
 ### 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.
+Using it by default with a Hash, the method decides itself to either add a filter, or must_not clause.
 
 _Hint: If not provided through ```#kind```-method a default kind **:bool** will be used._
 ```ruby
@@ -209,6 +209,8 @@ total = scope.total
 - aggs_only!
 - total_only!
 
+_see simple documentation about these methods @ [rubydoc](https://rubydoc.info/gems/elasticsearch_record/ElasticsearchRecord/Relation/QueryMethods)_
+
 ### Available calculation methods
 - percentiles
 - percentile_ranks
@@ -219,6 +221,8 @@ total = scope.total
 - sum
 - calculate
 
+_see simple documentation about these methods @ [rubydoc](https://rubydoc.info/gems/elasticsearch_record/ElasticsearchRecord/Relation/CalculationMethods)_
+
 ### Available result methods
 - aggregations
 - buckets
@@ -231,6 +235,8 @@ total = scope.total
 - point_in_time
 - pit_results
 
+_see simple documentation about these methods @ [rubydoc](https://rubydoc.info/gems/elasticsearch_record/ElasticsearchRecord/Relation/ResultMethods)_
+
 ### Additional methods 
 - to_query
 

data/docs/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ElasticsearchRecord - CHANGELOG
 
+## [1.2.1] - 2022-12-12
+* [add] `ActiveRecord::ConnectionAdapters::Elasticsearch::SchemaStatements#access_id_fielddata?` which checks the clusters setting 'indices.id_field_data.enabled' to determinate if a general sorting on the +_id+-field is possible or not.
+* [add] `ElasticsearchRecord::Relation#ordered_relation` which overwrites the original method to check against the `#access_id_fielddata?` method
+* [fix] default order by '_id' causes an exception if clusters 'indices.id_field_data.enabled' is disabled
+* [fix] subfield where-condition `where('field.subfield', 'value')` was transformed into a nested 'join-table' hash
+* [fix] yardoc docs & generation
+
 ## [1.2.0] - 2022-12-02
 * [add] `ElasticsearchRecord::SchemaMigration` to fix connection-related differences (like table_name_prefix, table_name_suffix)
 * [add] connection (config-related) 'table_name_prefix' & 'table_name_suffix' - now will be forwarded to all related models & schema-tables

data/elasticsearch_record.gemspec

@@ -39,4 +39,5 @@ DESC
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rake', "~> 13.0"
   spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
 end

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

@@ -341,7 +341,7 @@ module ActiveRecord
           end
 
           # overwrite original methods to provide a elasticsearch version
-          def update_table_definition(name, base = self, **options) # :nodoc:
+          def update_table_definition(name, base = self, **options)
             ::ActiveRecord::ConnectionAdapters::Elasticsearch::UpdateTableDefinition.new(base, name, **options)
           end
 
@@ -361,11 +361,26 @@ module ActiveRecord
             table_settings(table_name).dig('index', 'max_result_window').presence || 10000
           end
 
+          # returns true if the cluster option 'id_field_data' is enabled or not configured.
+          # This is required to check if a general sorting on the +_id+-field is possible or not. 
+          # @return [Boolean]
+          def access_id_fielddata?
+            @access_id_fielddata = begin
+                                     status = self.cluster_settings['indices.id_field_data.enabled']
+                                     # for cluster version lower 7.6 this might not configured.
+                                     status = (cluster_info[:version] < "7.6") if status.nil?
+
+                                     status
+                                   end if @access_id_fielddata.nil?
+
+            @access_id_fielddata
+          end
+
           # Returns basic information about the cluster.
           # @return [Hash{Symbol->Unknown}]
           def cluster_info
             @cluster_info ||= begin
-                                response = api(:core, :info, {}, 'CLUSTER')
+                                response = api(:core, :info, {}, 'CLUSTER INFO')
 
                                 {
                                   name:           response.dig('name'),
@@ -377,9 +392,16 @@ module ActiveRecord
                               end
           end
 
+          # returns a hash of current set, none-default settings in flat
+          # @return [Hash]
+          def cluster_settings
+            settings = api(:cluster, :get_settings, { flat_settings: true }, 'CLUSTER SETTINGS')
+            settings['persistent'].merge(settings['transient'])
+          end
+
           # transforms provided schema-type to a sql-type
+          # overwrite original methods to provide a elasticsearch version
           # @param [String, Symbol] type
-          # @param [String]
           def type_to_sql(type, **)
             return '' if type.blank?
 

data/lib/elasticsearch_record/gem_version.rb

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

data/lib/elasticsearch_record/relation/core_methods.rb

@@ -95,6 +95,28 @@ module ElasticsearchRecord
           responses
         end
       end
+
+      # overwrite original methods to provide a elasticsearch version:
+      # checks against the +#access_id_fielddata?+ to ensure the Elasticsearch Cluster allows access on the +_id+ field.
+      def ordered_relation
+        # resolve valid primary_key (either not the '_id' or +access_id_fielddata?+ is enabled)
+        valid_primary_key = if primary_key != '_id' || klass.connection.access_id_fielddata?
+               primary_key
+             else
+               nil
+             end
+
+        # slightly changed original methods content
+        if order_values.empty? && (implicit_order_column || valid_primary_key)
+          if implicit_order_column && valid_primary_key && implicit_order_column != valid_primary_key
+            order(table[implicit_order_column].asc, table[valid_primary_key].asc)
+          else
+            order(table[implicit_order_column || valid_primary_key].asc)
+          end
+        else
+          self
+        end
+      end
     end
   end
 end

data/lib/elasticsearch_record/relation/query_methods.rb

@@ -14,7 +14,7 @@ module ElasticsearchRecord
 
       # sets or overwrites the query kind (e.g. compound queries -> :bool, :boosting, :constant_score, ...).
       # Also other query kinds like :intervals, :match, ... are allowed.
-      # As an alternative you can also call the #query(<kind>,{argument}) method.
+      # Alternatively the +#query+-method can also be used to provide a kind with arguments.
       # @param [String, Symbol] value - the kind
       def kind(value)
         spawn.kind!(value)
@@ -59,6 +59,9 @@ module ElasticsearchRecord
         self
       end
 
+      # create or add an aggregation to the query.
+      # @example
+      #   aggregate(:total, { sum: {field: :amount})
       def aggregate(*args)
         check_if_method_has_arguments!(__callee__, args)
         spawn.aggregate!(*args)
@@ -66,7 +69,7 @@ module ElasticsearchRecord
 
       alias_method :aggs, :aggregate
 
-      def aggregate!(opts, *rest)
+      def aggregate!(opts, *rest) # :nodoc:
         case opts
         when Symbol, String
           self.aggs_clause += build_query_clause(opts, rest)
@@ -81,60 +84,71 @@ module ElasticsearchRecord
         self
       end
 
+      # add a whole query 'node' to the query.
+      # @example
+      #   query(:bool, {filter: ...})
       def query(*args)
         check_if_method_has_arguments!(__callee__, args)
         spawn.query!(*args)
       end
 
-      def query!(kind, opts, *rest)
+      def query!(kind, opts, *rest) # :nodoc:
         kind!(kind)
         self.query_clause += build_query_clause(opts.keys[0], opts.values[0], rest)
         self
       end
 
+      # adds a +filter+ clause.
+      # @example
+      #   filter({terms: ...})
       def filter(*args)
         check_if_method_has_arguments!(__callee__, args)
         spawn.filter!(*args)
       end
 
-      def filter!(opts, *rest)
-        # :nodoc:
+      def filter!(opts, *rest) # :nodoc:
         set_default_kind!
         self.query_clause += build_query_clause(:filter, opts, rest)
         self
       end
 
+      # adds a +must_not+ clause.
+      # @example
+      #   filter({terms: ...})
       def must_not(*args)
         check_if_method_has_arguments!(__callee__, args)
         spawn.must_not!(*args)
       end
 
-      def must_not!(opts, *rest)
-        # :nodoc:
+      def must_not!(opts, *rest) # :nodoc:
         set_default_kind!
         self.query_clause += build_query_clause(:must_not, opts, rest)
         self
       end
 
+      # adds a +must+ clause.
+      # @example
+      #   must({terms: ...})
       def must(*args)
         check_if_method_has_arguments!(__callee__, args)
         spawn.must!(*args)
       end
 
-      def must!(opts, *rest)
-        # :nodoc:
+      def must!(opts, *rest) # :nodoc:
         set_default_kind!
         self.query_clause += build_query_clause(:must, opts, rest)
         self
       end
 
+      # adds a +should+ clause.
+      # @example
+      #   should({terms: ...})
       def should(*args)
         check_if_method_has_arguments!(__callee__, args)
         spawn.should!(*args)
       end
 
-      def should!(opts, *rest)
-        # :nodoc:
+      def should!(opts, *rest) # :nodoc:
         set_default_kind!
         self.query_clause += build_query_clause(:should, opts, rest)
         self
@@ -142,7 +156,7 @@ module ElasticsearchRecord
 
       # creates a condition on the relation.
       # There are several possibilities to call this method.
-      #
+      # @example
       #   # create a simple 'term' condition on the query[:filter] param
       #     where({name: 'hans'})
       #     > query[:filter] << { term: { name: 'hans' } }
@@ -162,7 +176,7 @@ module ElasticsearchRecord
         super
       end
 
-      def where!(opts, *rest)
+      def where!(opts, *rest) # :nodoc:
         case opts
           # check the first provided parameter +opts+ and validate, if this is an alias for "must, must_not, should or filter"
           # if true, we expect the rest[0] to be a hash.
@@ -209,12 +223,13 @@ module ElasticsearchRecord
             )
           end
 
-          # force set default kind
+          # force set default kind, if not previously set
           set_default_kind!
 
           # builds predicates from opts (transforms this in a more unreadable way but is required for nested assignment & binds ...)
-          parts = predicate_builder.build_from_hash(opts) do |table_name|
-            lookup_table_klass_from_join_dependencies(table_name)
+          parts = opts.map do |key,value|
+            # builds and returns a new Arel Node from provided key/value pair
+            predicate_builder[key,value]
           end
 
           self.where_clause += ::ActiveRecord::Relation::WhereClause.new(parts)

data/lib/elasticsearch_record/relation/result_methods.rb

@@ -4,6 +4,7 @@ module ElasticsearchRecord
       # aggregate pluck provided columns.
       # returns a hash of values for each provided column
       #
+      # @example
       #   Person.agg_pluck(:name)
       #   #> {"name" => ['David', 'Jeremy', 'Jose']}
       #
@@ -32,6 +33,7 @@ module ElasticsearchRecord
       # For a single column_name a hash with the distinct key and the +doc_count+ as value is returned.
       # For multiple column_names a hash with the distinct keys (as hash) and the +doc_count+ as value is returned.
       #
+      # @example
       #   Person.composite(:name)
       #   #> {"David" => 10, "Jeremy" => 1, "Jose" => 24}
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch_record
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Tobias Gonsior
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-activesupport-concern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 description: 'ElasticsearchRecord is a ActiveRecord adapter and provides similar functionality
   for Elasticsearch.