opensearch-ruby 2.1.0 → 3.0.0

data/lib/opensearch/dsl/search/highlight.rb

@@ -0,0 +1,117 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      # Wraps the `highlight` part of a search definition
+      #
+      #
+      class Highlight
+        include BaseComponent
+
+        def initialize(*args, &block)
+          @value = args.pop || {}
+          super
+        end
+
+        # Specify the fields to highlight
+        #
+        # @example
+        #
+        #     search do
+        #       highlight do
+        #         fields [:title, :body]
+        #         field  :comments.body if options[:comments]
+        #       end
+        #     end
+        #
+        def fields(value_or_name)
+          value = case value_or_name
+                  when Hash
+                    value_or_name
+                  when Array
+                    value_or_name.each_with_object({}) do |item, sum|
+                      sum.update item.to_sym => {}
+                    end
+                  end
+
+          (@value[:fields] ||= {}).update value
+          self
+        end
+
+        # Specify a single field to highlight
+        #
+        # @example
+        #
+        #     search do
+        #       highlight do
+        #         field :title, fragment_size: 0
+        #         field :body if options[:comments]
+        #       end
+        #     end
+        #
+        def field(name, options = {})
+          (@value[:fields] ||= {}).update name.to_sym => options
+        end
+
+        # Specify the opening tags for the highlighted snippets
+        #
+        def pre_tags(*value)
+          @value[:pre_tags] = value.flatten
+        end; alias pre_tags= pre_tags
+
+        # Specify the closing tags for the highlighted snippets
+        #
+        def post_tags(*value)
+          @value[:post_tags] = value.flatten
+        end; alias post_tags= post_tags
+
+        # Specify the `encoder` option for highlighting
+        #
+        def encoder(value)
+          @value[:encoder] = value
+        end; alias encoder= encoder
+
+        # Specify the `tags_schema` option for highlighting
+        #
+        def tags_schema(value)
+          @value[:tags_schema] = value
+        end; alias tags_schema= tags_schema
+
+        # Convert the definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash
+          call
+          @hash = @value
+          @hash
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/options.rb

@@ -0,0 +1,80 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      # Wraps the "extra" options of a search definition
+      #
+      #
+      class Options
+        DSL_METHODS = %i[
+          _source
+          fields
+          script_fields
+          fielddata_fields
+          rescore
+          explain
+          version
+          indices_boost
+          track_scores
+          min_score
+          track_total_hits
+        ]
+
+        def initialize(*_args)
+          @hash = {}
+        end
+
+        # Defines a method for each valid search definition option
+        #
+        DSL_METHODS.each do |name|
+          define_method name do |*args|
+            @hash[name] = args.pop
+          end
+
+          define_method name.to_s.gsub(/^_(.*)/, '\1') do |*args|
+            @hash[name] = args.pop
+          end
+        end
+
+        # Returns true when there are no search options defined
+        #
+        def empty?
+          @hash.empty?
+        end
+
+        # Convert the definition to a Hash
+        #
+        # @return [Hash]
+        #
+        def to_hash(_options = {})
+          @hash
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/bool.rb

@@ -0,0 +1,110 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A compound query which matches documents based on combinations of queries
+        #
+        # @example Defining a bool query with multiple conditions
+        #
+        #     search do
+        #       query do
+        #         bool do
+        #           must do
+        #             term category: 'men'
+        #           end
+        #
+        #           must do
+        #             term size:  'xxl'
+        #           end
+        #
+        #           should do
+        #             term color: 'red'
+        #           end
+        #
+        #           must_not do
+        #             term manufacturer: 'evil'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a working example.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-bool-query.html
+        #
+        class Bool
+          include BaseComponent
+
+          option_method :minimum_should_match
+          option_method :boost
+
+          def must(*args, &block)
+            @hash[name][:must] ||= []
+            value = args.empty? ? Query.new(*args, &block).to_hash : args.first.to_hash
+            @hash[name][:must].push(value).flatten! unless @hash[name][:must].include?(value)
+            self
+          end
+
+          def must_not(*args, &block)
+            @hash[name][:must_not] ||= []
+            value = args.empty? ? Query.new(*args, &block).to_hash : args.first.to_hash
+            @hash[name][:must_not].push(value).flatten! unless @hash[name][:must_not].include?(value)
+            self
+          end
+
+          def should(*args, &block)
+            @hash[name][:should] ||= []
+            value = args.empty? ? Query.new(*args, &block).to_hash : args.first.to_hash
+            @hash[name][:should].push(value).flatten! unless @hash[name][:should].include?(value)
+            self
+          end
+
+          def filter(*args, &block)
+            @hash[name][:filter] ||= []
+            if (filter = block ? Filter.new(*args, &block) : args.first)
+              @hash[name][:filter] << filter.to_hash
+            end
+            self
+          end
+
+          def to_hash
+            @hash[name].update(@args.to_hash) if @args.respond_to?(:to_hash)
+
+            if @block
+              call
+            else
+              @hash[name] = @args unless @args.nil? || @args.empty?
+            end
+            @hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/boosting.rb

@@ -0,0 +1,57 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which will decrease the score of documents matching the `negative` query
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         boosting do
+        #           positive terms: { amenities: ['wifi', 'pets'] }
+        #           negative terms: { amenities: ['pool'] }
+        #           negative_boost 0.5
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-boosting-query.html
+        #
+        class Boosting
+          include BaseComponent
+
+          option_method :positive
+          option_method :negative
+          option_method :negative_boost
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/common.rb

@@ -0,0 +1,62 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which executes the search for low frequency terms first, and high frequency ("common")
+        # terms second
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         common :body do
+        #           query 'shakespeare to be or not to be'
+        #         end
+        #       end
+        #     end
+        #
+        # This query is frequently used when a stopwords-based approach loses too much recall and/or precision.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-common-terms-query.html
+        #
+        class Common
+          include BaseComponent
+
+          option_method :query
+          option_method :cutoff_frequency
+          option_method :low_freq_operator
+          option_method :minimum_should_match
+          option_method :boost
+          option_method :analyzer
+          option_method :disable_coord
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/constant_score.rb

@@ -0,0 +1,90 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which wraps another query or filter and returns a constant score for matching documents
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         constant_score do
+        #           query do
+        #             match content: 'Twitter'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/ignoring-tfidf.html
+        #
+        class ConstantScore
+          include BaseComponent
+
+          option_method :boost
+
+          # DSL method for building the `query` part of the query definition
+          #
+          # @return [self]
+          #
+          def query(*args, &block)
+            @query = block ? @query = Query.new(*args, &block) : args.first
+            self
+          end
+
+          # DSL method for building the `filter` part of the query definition
+          #
+          # @return [self]
+          #
+          def filter(*args, &block)
+            @filter = block ? Filter.new(*args, &block) : args.first
+            self
+          end
+
+          # Converts the query definition to a Hash
+          #
+          # @return [Hash]
+          #
+          def to_hash
+            hash = super
+            if @query
+              _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query
+              hash[name].update(query: _query)
+            end
+            if @filter
+              _filter = @filter.respond_to?(:to_hash) ? @filter.to_hash : @filter
+              hash[name].update(filter: _filter)
+            end
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/dis_max.rb

@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which will score the documents based on the highest score of any individual specified query,
+        # not by summing the scores (as eg. a `bool` query would)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         dis_max do
+        #           queries [
+        #            { match: { title:   'albino' } },
+        #            { match: { content: 'elephant' } }
+        #           ]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/_best_fields.html
+        #
+        class DisMax
+          include BaseComponent
+
+          option_method :queries
+          option_method :boost
+          option_method :tie_breaker
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/exists.rb

@@ -0,0 +1,68 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # Returns documents that have at least one non-null value in the field.
+        #
+        # @example Find documents with non-empty "name" property
+        #
+        #     search do
+        #       query do
+        #         exists do
+        #           field 'name'
+        #         end
+        #       end
+        #     end
+        #
+        # @note The "Exists" query can be used as a "Missing" query in a "Bool" query "Must Not" context.
+        #
+        # @example Find documents with an empty "name" property
+        #
+        #     search do
+        #       query do
+        #         bool do
+        #           must_not do
+        #             exists do
+        #               field 'name'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class Exists
+          include BaseComponent
+
+          option_method :field
+        end
+      end
+    end
+  end
+end