elasticsearch_record 1.0.2 → 1.1.0

data/lib/elasticsearch_record/relation/query_clause_tree.rb

@@ -3,7 +3,7 @@
 module ElasticsearchRecord # :nodoc:
   module Relation
     class QueryClauseTree
-      delegate :any?, :empty?, :key?, :each, to: :predicates
+      delegate :any?, :empty?, :key?, :keys, :each, to: :predicates
 
       def self.empty
         @empty ||= new({}).freeze
@@ -39,6 +39,12 @@ module ElasticsearchRecord # :nodoc:
         QueryClauseTree.new(dups)
       end
 
+      def [](key)
+        return nil unless key?(key)
+
+        dupredicates[key]
+      end
+
       def +(other)
         dups = dupredicates
 
@@ -52,6 +58,17 @@ module ElasticsearchRecord # :nodoc:
       end
 
       def -(other)
+        # check for provided :tree
+        if other.key == :tree
+          scope = self
+
+          (scope.keys & other.keys).each do |key|
+            scope -= other[key]
+          end
+
+          return scope
+        end
+
         dups = dupredicates
 
         if key?(other.key)
@@ -79,6 +96,26 @@ module ElasticsearchRecord # :nodoc:
           predicates == other.predicates
       end
 
+      def or(other)
+        left = self - other
+        common = self - left
+        right = other - common
+
+        if left.empty? || right.empty?
+          common
+        else
+          key = other.keys[0]
+
+          left = left[key]
+          right = right[key]
+
+          or_clause = Arel::Nodes::Or.new(left, right)
+
+          common.predicates[key] = ElasticsearchRecord::Relation::QueryClause.new(key, [Arel::Nodes::Grouping.new(or_clause)])
+          common
+        end
+      end
+
       protected
 
       attr_reader :predicates

data/lib/elasticsearch_record/relation/query_methods.rb

@@ -223,6 +223,12 @@ module ElasticsearchRecord
         self
       end
 
+      def or!(other)
+        self.query_clause = self.query_clause.or(other.query_clause)
+
+        super(other)
+      end
+
       def unscope!(*args)
         # :nodoc:
         self.unscope_values += args

data/lib/elasticsearch_record/relation/result_methods.rb

@@ -4,11 +4,11 @@ module ElasticsearchRecord
       # aggregate pluck provided columns.
       # returns a hash of values for each provided column
       #
-      # Person.agg_pluck(:name)
-      # => {"name" => ['David', 'Jeremy', 'Jose']}
+      #   Person.agg_pluck(:name)
+      #   #> {"name" => ['David', 'Jeremy', 'Jose']}
       #
-      # Person.agg_pluck(:id, :name)
-      # => {"id" => ['11', '2', '5'], "name" => ['David', 'Jeremy', 'Jose']}
+      #   Person.agg_pluck(:id, :name)
+      #   #> {"id" => ['11', '2', '5'], "name" => ['David', 'Jeremy', 'Jose']}
       #
       # @param [Array] column_names
       # @return [Hash]
@@ -32,11 +32,11 @@ 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.
       #
-      # Person.composite(:name)
-      # => {"David" => 10, "Jeremy" => 1, "Jose" => 24}
+      #   Person.composite(:name)
+      #   #> {"David" => 10, "Jeremy" => 1, "Jose" => 24}
       #
-      # Person.composite(:name, :age)
-      # => {
+      #   Person.composite(:name, :age)
+      #   #> {
       #       {name: "David", age: "16"} => 3,
       #       {name: "David", age: "18"} => 6,
       #       {name: "David", age: "20"} => 1,
@@ -89,7 +89,7 @@ module ElasticsearchRecord
       # @param [String] keep_alive - how long to keep alive (for each single request) - default: '1m'
       # @param [Integer] batch_size - how many results per query (default: 1000 - this means at least 10 queries before reaching the +max_result_window+)
       def pit_results(keep_alive: '1m', batch_size: 1000)
-        raise ArgumentError, "Batch size cannot be above the 'max_result_window' (#{klass.connection.max_result_window}) !" if batch_size > klass.connection.max_result_window
+        raise ArgumentError, "Batch size cannot be above the 'max_result_window' (#{klass.max_result_window}) !" if batch_size > klass.max_result_window
 
         # check if a limit or offset values was provided
         results_limit  = limit_value ? limit_value : Float::INFINITY
@@ -182,6 +182,12 @@ module ElasticsearchRecord
         spawn.aggs_only!.resolve('Aggregations').aggregations
       end
 
+      # returns the response aggregations and resolve the buckets as key->value hash.
+      # @return [ActiveSupport::HashWithIndifferentAccess, Hash]
+      def buckets
+        spawn.aggs_only!.resolve('Buckets').buckets
+      end
+
       # returns the RAW hits for the current query
       # @return [Array]
       def hits

data/lib/elasticsearch_record/result.rb

@@ -48,9 +48,8 @@ module ElasticsearchRecord
       response.key?('hits') ? response['hits'].with_indifferent_access : {}
     end
 
-    # Returns the RAW values from the hits - aka. +rows+.
+    # Returns the RAW +_source+ data from each hit - aka. +rows+.
     # PLEASE NOTE: The array will only contain the RAW data from each +_source+ (meta info like '_score' is not included)
-    # The +rows+ alias use used by the ActiveRecord ConnectionAdapters and must not be removed!
     # @return [Array]
     def results
       return [] unless response['hits']
@@ -58,6 +57,7 @@ module ElasticsearchRecord
       response['hits']['hits'].map { |result| result['_source'] }
     end
 
+    # The +rows+ alias is used by the ActiveRecord ConnectionAdapters and must not be removed!
     alias_method :rows, :results
 
     # returns the response RAW aggregations hash.
@@ -66,6 +66,31 @@ module ElasticsearchRecord
       response.key?('aggregations') ? response['aggregations'].with_indifferent_access : {}
     end
 
+    # returns the (nested) bucket values (and aggregated values) from the response aggregations.
+    # @return [ActiveSupport::HashWithIndifferentAccess]
+    def buckets
+      # aggregations are already a hash with key => data, but to prevent reference manipulation on the hash
+      # we have to create a new one here...
+      aggregations.reduce({}) { |buckets, (key, agg)|
+        # check if this agg has a bucket
+        if agg.key?(:buckets)
+          buckets[key] = agg[:buckets].reduce({}) { |m, b|
+            # buckets can be a Hash or Array (of Hashes)
+            bucket_key, bucket = b.is_a?(Hash) ? [b[:key], b] : b
+            m[bucket_key]      = bucket.except(:key, :doc_count).transform_values { |val| val[:value] }
+
+            m
+          }
+        elsif agg.key?(:value)
+          buckets[key] = agg[:value]
+        elsif agg.key?(:values)
+          buckets[key] = agg[:values]
+        end
+
+        buckets
+      }.with_indifferent_access
+    end
+
     # Returns true if this result set includes the column named +name+.
     # used by ActiveRecord
     def includes_column?(name)
@@ -119,9 +144,10 @@ module ElasticsearchRecord
       n ? computed_results.last(n) : computed_results.last
     end
 
-    # used by ActiveRecord
-    def result # :nodoc:
-      self
+    # returns the response result string
+    # @return [String]
+    def result
+      response['result'] || ''
     end
 
     # used by ActiveRecord
@@ -176,6 +202,7 @@ module ElasticsearchRecord
       return self.response['total'] if self.response.key?('total')
       return self.response['hits']['total']['value'] if self.response.key?('hits')
       return self.response['aggregations'].count if self.response.key?('aggregations')
+      return self.response['_shards']['total'] if self.response.key?('_shards')
 
       0
     end

data/lib/elasticsearch_record/statement_cache.rb

@@ -37,7 +37,8 @@ module ElasticsearchRecord
           if ActiveModel::Attribute === value
             value = value.value_for_database
           end
-          connection.quote(value)
+          value
+          # connection.quote(value)
         elsif thing.is_a?(Hash)
           thing.transform_values { |val|
             deep_substitute_binds(val, binds, connection)

data/lib/elasticsearch_record.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# VERSION
 require_relative 'elasticsearch_record/version'
+require_relative "elasticsearch_record/errors"
 
 require 'active_record'
 
@@ -27,7 +27,6 @@ module ElasticsearchRecord
     autoload :Querying
     autoload :Query
     autoload :Result
-    autoload :SchemaMigration
     autoload :StatementCache
   end
 
@@ -59,6 +58,7 @@ end
 ActiveSupport.on_load(:active_record) do
   # load patches
   require 'elasticsearch_record/patches/active_record/relation_merger_patch'
+
   require 'elasticsearch_record/patches/arel/select_core_patch'
   require 'elasticsearch_record/patches/arel/select_manager_patch'
   require 'elasticsearch_record/patches/arel/select_statement_patch'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch_record
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Tobias Gonsior
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0.9'
 description: 'ElasticsearchRecord is a ActiveRecord adapter and provides similar functionality
   for Elasticsearch.
 
@@ -91,7 +91,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- ".ruby-version"
+- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -99,16 +99,30 @@ files:
 - docs/CHANGELOG.md
 - docs/CODE_OF_CONDUCT.md
 - docs/LICENSE.txt
+- elasticsearch_record.gemspec
 - lib/active_record/connection_adapters/elasticsearch/column.rb
 - lib/active_record/connection_adapters/elasticsearch/database_statements.rb
 - lib/active_record/connection_adapters/elasticsearch/quoting.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_creation.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions/attribute_methods.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions/column_methods.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions/create_table_definition.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_alias_definition.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_definition.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_mapping_definition.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_setting_definition.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions/update_table_definition.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_dumper.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_statements.rb
+- lib/active_record/connection_adapters/elasticsearch/table_statements.rb
 - lib/active_record/connection_adapters/elasticsearch/type.rb
 - lib/active_record/connection_adapters/elasticsearch/type/format_string.rb
 - lib/active_record/connection_adapters/elasticsearch/type/multicast_value.rb
 - lib/active_record/connection_adapters/elasticsearch/type/nested.rb
 - lib/active_record/connection_adapters/elasticsearch/type/object.rb
 - lib/active_record/connection_adapters/elasticsearch/type/range.rb
+- lib/active_record/connection_adapters/elasticsearch/unsupported_implementation.rb
 - lib/active_record/connection_adapters/elasticsearch_adapter.rb
 - lib/arel/collectors/elasticsearch_query.rb
 - lib/arel/nodes/select_agg.rb
@@ -116,9 +130,13 @@ files:
 - lib/arel/nodes/select_kind.rb
 - lib/arel/nodes/select_query.rb
 - lib/arel/visitors/elasticsearch.rb
+- lib/arel/visitors/elasticsearch_base.rb
+- lib/arel/visitors/elasticsearch_query.rb
+- lib/arel/visitors/elasticsearch_schema.rb
 - lib/elasticsearch_record.rb
 - lib/elasticsearch_record/base.rb
 - lib/elasticsearch_record/core.rb
+- lib/elasticsearch_record/errors.rb
 - lib/elasticsearch_record/extensions/relation.rb
 - lib/elasticsearch_record/gem_version.rb
 - lib/elasticsearch_record/instrumentation.rb
@@ -143,7 +161,6 @@ files:
 - lib/elasticsearch_record/relation/result_methods.rb
 - lib/elasticsearch_record/relation/value_methods.rb
 - lib/elasticsearch_record/result.rb
-- lib/elasticsearch_record/schema_migration.rb
 - lib/elasticsearch_record/statement_cache.rb
 - lib/elasticsearch_record/tasks/elasticsearch_database_tasks.rb
 - lib/elasticsearch_record/version.rb
@@ -155,6 +172,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/ruby-smart/elasticsearch_record
   source_code_uri: https://github.com/ruby-smart/elasticsearch_record
+  documentation_uri: https://rubydoc.info/gems/elasticsearch_record
   changelog_uri: https://github.com/ruby-smart/elasticsearch_record/blob/main/docs/CHANGELOG.md
 post_install_message:
 rdoc_options: []
@@ -171,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: ActiveRecord adapter for Elasticsearch

data/.ruby-version

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

data/lib/elasticsearch_record/schema_migration.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-require 'active_record/schema_migration'
-
-module ElasticsearchRecord
-  # temporary workaround
-  # toDo: fixme
-  class SchemaMigration < ActiveRecord::SchemaMigration # :nodoc:
-    class << self
-      def create_table
-        $stdout.puts "\n>>> 'create_table' elasticsearch is not supported - the following message is insignificant!"
-      end
-
-      def drop_table
-        $stdout.puts "\n>>> 'drop_table' elasticsearch is not supported - the following message is insignificant!"
-      end
-
-      def normalized_versions
-        []
-      end
-
-      def all_versions
-        []
-      end
-
-      def table_exists?
-        true
-      end
-    end
-  end
-end