elasticsearch-dsl 0.1.6 → 0.1.10

data/spec/elasticsearch/dsl/search_spec.rb

@@ -0,0 +1,385 @@
+# 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.
+
+require 'spec_helper'
+
+describe Elasticsearch::DSL::Search do
+
+  include Elasticsearch::DSL
+
+  describe '#initialize' do
+
+    let(:s) do
+      search do
+        query do
+          match title: 'test'
+        end
+      end
+    end
+
+    let(:expected_hash) do
+      { query: { match: { title: 'test' } } }
+    end
+
+    it 'creates the search definition' do
+      expect(s.to_hash).to eq(expected_hash)
+    end
+  end
+
+  context 'when a block is provided' do
+
+    context 'when the top-level scope is accessed in the block' do
+
+      context 'when the method is accessed from within a \'query\' block' do
+
+        let(:s) do
+          def query_value
+            { title: 'test' }
+          end
+
+          search do
+            query do
+              match query_value
+            end
+          end
+        end
+
+        let(:expected_hash) do
+          { query: { match: { title: 'test' } } }
+        end
+
+        it 'allows access to the containing scope' do
+          expect(s.to_hash).to eq(expected_hash)
+        end
+      end
+
+      context 'when the method is accessed from within a \'base_component\' block' do
+
+        let(:s) do
+          def sort_field
+            :category
+          end
+
+          search do
+            query do
+              match title: 'test'
+            end
+            sort do
+              by sort_field, order: 'desc'
+            end
+          end
+        end
+
+        let(:expected_hash) do
+          { query: { match: { title: 'test' } }, sort: [{ category: { order: 'desc'} }] }
+        end
+
+        it 'allows access to the containing scope' do
+          expect(s.to_hash).to eq(expected_hash)
+        end
+      end
+
+      context 'when the method is accessed from within a \'_not\' block' do
+
+        let(:s) do
+          def term_field
+            :color
+          end
+
+          search do
+            query do
+              filtered do
+                filter do
+                  _not do
+                    term term_field => 'red'
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        let(:expected_hash) do
+          { query: { filtered: { filter: { not: { term: { color: 'red' } } } } } }
+        end
+
+        it 'allows access to the containing scope' do
+          expect(s.to_hash).to eq(expected_hash)
+        end
+      end
+
+      context 'when the method is accessed from within a \'aggregation\' block' do
+
+        let(:s) do
+          def sum_field
+            'clicks'
+          end
+
+          def aggregation_name
+            :sum_clicks
+          end
+
+          search do
+            aggregation :clicks_for_tag_one do
+              filter terms: { tags: ['one'] } do
+                aggregation aggregation_name do
+                  sum field: sum_field
+                end
+              end
+            end
+          end
+        end
+
+        let(:expected_hash) do
+          { aggregations: { clicks_for_tag_one: { filter: { terms: { tags: ['one'] } },
+                                                  aggregations: { sum_clicks: { sum: { field: 'clicks' } } } } } }
+        end
+
+        it 'allows access to the containing scope' do
+          expect(s.to_hash).to eq(expected_hash)
+        end
+      end
+
+      context 'when the method is accessed from within a \'filter\' block' do
+
+        let(:s) do
+
+          def not_clause(obj)
+            obj.instance_eval do
+              _not do
+                term color: 'red'
+              end
+            end
+          end
+
+          search do
+            query do
+              filtered do
+                filter do
+                  not_clause(self)
+                end
+              end
+            end
+          end
+        end
+
+        let(:expected_hash) do
+          { query: { filtered: { filter: { not: { term: { color: 'red' } } } } } }
+        end
+
+        it 'allows access to the containing scope' do
+          expect(s.to_hash).to eq(expected_hash)
+        end
+      end
+
+      context 'when the method is accessed from within a \'base_aggregation_component\' block' do
+
+        let(:s) do
+
+          def term_field
+            :body
+          end
+
+          search do
+            aggregation :interesting_terms do
+              significant_terms do
+                field :body
+              end
+            end
+          end
+        end
+
+        let(:expected_hash) do
+          { aggregations: { interesting_terms: { significant_terms: { field: :body } } } }
+        end
+
+        it 'allows access to the containing scope' do
+          expect(s.to_hash).to eq(expected_hash)
+        end
+      end
+
+      context 'when the method is accessed from within a \'base_compound_filter_component\' block' do
+
+        let(:s) do
+
+          def term_field
+            'red'
+          end
+
+          search do
+            query do
+              filtered do
+                filter do
+                  _and do
+                    term color: term_field
+                    term size: 'xxl'
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        let(:expected_hash) do
+          { query: { filtered: { filter: { and: [{ term: { color: 'red' } },
+                                                 { term: { size: 'xxl' } }] } } } }
+        end
+
+        it 'allows access to the containing scope' do
+          expect(s.to_hash).to eq(expected_hash)
+        end
+      end
+    end
+
+  context 'when other methods are used to construct the query' do
+
+    def bool_query(obj)
+      obj.instance_eval do
+        bool do
+          must do
+            match foo: 'bar'
+          end
+          filter do
+            term foo: 'bar'
+          end
+        end
+      end
+    end
+
+    let(:my_search) do
+      search do
+        query do
+          bool_query(self)
+        end
+      end
+    end
+
+    it 'allows the subquery to be defined on the calling scope' do
+      expect(my_search.to_hash).to eq(query: { bool: { filter: [{ term: { foo: 'bar' } }],
+                                                     must: [{ match: { foo: 'bar' } }] } })
+    end
+  end
+  end
+
+  describe '#collapse' do
+
+    let(:s) do
+      search do
+        query do
+          match title: 'test'
+        end
+        collapse :user do
+          max_concurrent_group_searches 4
+          inner_hits 'last_tweet' do
+            size 10
+            from 5
+            sort do
+              by :date, order: 'desc'
+              by :likes, order: 'asc'
+            end
+          end
+        end
+      end
+    end
+
+    let(:inner_hits_hash) do
+      { name: 'last_tweet',
+        size: 10,
+        from: 5,
+        sort: [ { date: { order: 'desc' } },
+                { likes: { order: 'asc' } }]
+      }
+    end
+
+    let(:expected_hash) do
+      { query: { match: { title: 'test' } },
+        collapse: { field: :user,
+                    max_concurrent_group_searches: 4,
+                    inner_hits: inner_hits_hash }  }
+    end
+
+    it 'sets the field name' do
+      expect(s.to_hash[:collapse][:field]).to eq(:user)
+    end
+
+    it 'sets the max_concurrent_group_searches option' do
+      expect(s.to_hash[:collapse][:max_concurrent_group_searches]).to eq(4)
+    end
+
+    it 'sets the inner_hits' do
+      expect(s.to_hash[:collapse][:inner_hits]).to eq(inner_hits_hash)
+    end
+
+    it 'constructs the correct hash' do
+      expect(s.to_hash).to eq(expected_hash)
+    end
+  end
+
+  describe '#collapse' do
+
+    let(:s) do
+      search do
+        query do
+          match title: 'test'
+        end
+        collapse :user do
+          max_concurrent_group_searches 4
+          inner_hits 'last_tweet' do
+            size 10
+            from 5
+            sort do
+              by :date, order: 'desc'
+              by :likes, order: 'asc'
+            end
+          end
+        end
+      end
+    end
+
+    let(:inner_hits_hash) do
+      { name: 'last_tweet',
+        size: 10,
+        from: 5,
+        sort: [ { date: { order: 'desc' } },
+               { likes: { order: 'asc' } }]
+      }
+    end
+
+    let(:expected_hash) do
+      { query: { match: { title: 'test' } },
+        collapse: { field: :user,
+                    max_concurrent_group_searches: 4,
+                    inner_hits: inner_hits_hash }  }
+    end
+
+    it 'sets the field name' do
+      expect(s.to_hash[:collapse][:field]).to eq(:user)
+    end
+
+    it 'sets the max_concurrent_group_searches option' do
+      expect(s.to_hash[:collapse][:max_concurrent_group_searches]).to eq(4)
+    end
+
+    it 'sets the inner_hits' do
+      expect(s.to_hash[:collapse][:inner_hits]).to eq(inner_hits_hash)
+    end
+
+    it 'constructs the correct hash' do
+      expect(s.to_hash).to eq(expected_hash)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# 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.
+
+require 'elasticsearch'
+require 'elasticsearch-dsl'
+
+RSpec.configure do |config|
+  config.formatter = 'documentation'
+  config.color = true
+end

data/test/integration/search_aggregation_children_test.rb

@@ -1,3 +1,20 @@
+# 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.
+
 require 'test_helper'
 
 module Elasticsearch
@@ -6,50 +23,40 @@ module Elasticsearch
       include Elasticsearch::DSL::Search
 
       context "A children aggregation" do
-        startup do
-          Elasticsearch::Extensions::Test::Cluster.start(number_of_nodes: 1) if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running?(number_of_nodes: 1)
-        end
-
         setup do
-          @client.indices.create index: 'articles-test', body: {
-            mappings: {
-              article: {
-                properties: {
-                  title:    { type: 'text' },
-                  category: { type: 'keyword' }
-                }
-              },
-              comment: {
-                _routing: { required: true },
-                _parent:  { type: 'article' },
-                properties: {
-                  author: { type: 'keyword' }
-                }
+          @client.indices.create index: 'articles-and-comments', body: {
+              mappings: {
+                  properties: {
+                      title: {type: 'text'},
+                      category: {type: 'keyword'},
+                      join_field: {type: 'join', relations: {article: 'comment'}},
+                      author: {type: 'keyword'}
+                  }
               }
-            }
           }
-          @client.index index: 'articles-test', type: 'article', id: 1,
-                        body: { title: 'A', category: 'one'  }
-          @client.index index: 'articles-test', type: 'article', id: 2,
-                        body: { title: 'B', category: 'one'  }
-          @client.index index: 'articles-test', type: 'article', id: 3,
-                        body: { title: 'C', category: 'two'  }
 
-          @client.index index: 'articles-test', type: 'comment', parent: '1',
-                        body: { author: 'John' }
-          @client.index index: 'articles-test', type: 'comment', parent: '1',
-                        body: { author: 'Mary' }
-          @client.index index: 'articles-test', type: 'comment', parent: '2',
-                        body: { author: 'John' }
-          @client.index index: 'articles-test', type: 'comment', parent: '2',
-                        body: { author: 'Dave' }
-          @client.index index: 'articles-test', type: 'comment', parent: '3',
-                        body: { author: 'Ruth' }
-          @client.indices.refresh index: 'articles-test'
+          @client.index index: 'articles-and-comments', id: 1,
+                        body: { title: 'A', category: 'one', join_field: 'article' }
+          @client.index index: 'articles-and-comments', id: 2,
+                        body: { title: 'B', category: 'one', join_field: 'article' }
+          @client.index index: 'articles-and-comments', id: 3,
+                        body: { title: 'C', category: 'two', join_field: 'article' }
+
+          @client.index index: 'articles-and-comments', routing: '1',
+                        body: { author: 'John', join_field: { name: 'comment', parent: 1 } }
+          @client.index index: 'articles-and-comments', routing: '1',
+                        body: { author: 'Mary', join_field: { name: 'comment', parent: 1 } }
+          @client.index index: 'articles-and-comments', routing: '2',
+                        body: { author: 'John', join_field: { name: 'comment', parent: 2 } }
+          @client.index index: 'articles-and-comments', routing: '2',
+                        body: { author: 'Dave', join_field: { name: 'comment', parent: 2 } }
+          @client.index index: 'articles-and-comments', routing: '3',
+                        body: { author: 'Ruth', join_field: { name: 'comment', parent: 3 } }
+          @client.indices.refresh index: 'articles-and-comments'
         end
 
         should "return the top commenters per article category" do
-          response = @client.search index: 'articles-test', size: 0, body: search {
+          response = @client.search index: 'articles-and-comments', size: 0, body: search {
             aggregation :top_categories do
               terms field: 'category' do
                 aggregation :comments do

data/test/integration/search_aggregation_geo_test.rb

@@ -1,3 +1,20 @@
+# 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.
+
 require 'test_helper'
 
 module Elasticsearch
@@ -6,29 +23,23 @@ module Elasticsearch
       include Elasticsearch::DSL::Search
 
       context "A geo aggregation" do
-        startup do
-          Elasticsearch::Extensions::Test::Cluster.start(number_of_nodes: 1) if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running?(number_of_nodes: 1)
-        end
-
         setup do
           @client.indices.create index: 'venues-test', body: {
-            mappings: {
-              venue: {
-                properties: {
-                  location: { type: 'geo_point' }
-                }
+              mappings: {
+                  properties: {
+                      location: {type: 'geo_point'}
+                  }
               }
-            }
           }
-          @client.index index: 'venues-test', type: 'venue',
+          @client.index index: 'venues-test',
                         body: { name: 'Space', location: "38.886214,1.403889" }
-          @client.index index: 'venues-test', type: 'venue',
+          @client.index index: 'venues-test',
                         body: { name: 'Pacha', location: "38.9184427,1.4433646" }
-          @client.index index: 'venues-test', type: 'venue',
+          @client.index index: 'venues-test',
                         body: { name: 'Amnesia', location: "38.948045,1.408341" }
-          @client.index index: 'venues-test', type: 'venue',
+          @client.index index: 'venues-test',
                         body: { name: 'Privilege', location: "38.958082,1.408288" }
-          @client.index index: 'venues-test', type: 'venue',
+          @client.index index: 'venues-test',
                         body: { name: 'Es Paradis', location: "38.979071,1.307394" }
           @client.indices.refresh index: 'venues-test'
         end
@@ -55,7 +66,7 @@ module Elasticsearch
           assert_equal 1,       result['buckets'][0]['doc_count']
           assert_equal 'Pacha', result['buckets'][0]['top_venues']['hits']['hits'][0]['_source']['name']
 
-          assert_equal 2,       result['buckets'][1]['top_venues']['hits']['total']
+          assert_equal 2,       result['buckets'][1]['top_venues']['hits']['total']['value']
         end
 
         should "return the geohash grid distribution" do

data/test/integration/search_aggregation_nested_test.rb

@@ -1,3 +1,20 @@
+# 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.
+
 require 'test_helper'
 
 module Elasticsearch
@@ -6,37 +23,32 @@ module Elasticsearch
       include Elasticsearch::DSL::Search
 
       context "A nested aggregation" do
-        startup do
-          Elasticsearch::Extensions::Test::Cluster.start(number_of_nodes: 1) if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running?(number_of_nodes: 1)
-        end
-
         setup do
           @client.indices.create index: 'products-test', body: {
-            mappings: {
-              product: {
-                properties: {
-                  title: { type: 'text' },
-                  category: { type: 'keyword' },
-                  offers: {
-                    type: 'nested',
-                    properties: {
-                      name:  { type: 'text' },
-                      price: { type: 'double' }
-                    }
+              mappings: {
+                  properties: {
+                      title: {type: 'text'},
+                      category: {type: 'keyword'},
+                      offers: {
+                          type: 'nested',
+                          properties: {
+                              name: {type: 'text'},
+                              price: {type: 'double'}
+                          }
+                      }
                   }
-                }
               }
-            }
           }
-          @client.index index: 'products-test', type: 'product',
+
+          @client.index index: 'products-test',
                         body: { title: 'A',
                                 category: 'audio',
                                 offers: [ { name: 'A1', price: 100 }, { name: 'A2', price: 120 } ] }
-          @client.index index: 'products-test', type: 'product',
+          @client.index index: 'products-test',
                         body: { title: 'B',
                                 category: 'audio',
                                 offers: [ { name: 'B1', price: 200 }, { name: 'B2', price: 180 } ] }
-          @client.index index: 'products-test', type: 'product',
+          @client.index index: 'products-test',
                         body: { title: 'C',
                                 category: 'video',
                                 offers: [ { name: 'C1', price: 300 }, { name: 'C2', price: 350 } ] }