elasticsearch-model 6.1.1 → 7.2.1

data/spec/elasticsearch/model/indexing_spec.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 'spec_helper'
 
 describe Elasticsearch::Model::Indexing do
@@ -84,10 +101,8 @@ describe Elasticsearch::Model::Indexing do
       expect(DummyIndexingModel.mappings).to be_a(Elasticsearch::Model::Indexing::Mappings)
     end
 
-    it 'raises an exception when there is no type passed to the #initialize method' do
-      expect {
-        Elasticsearch::Model::Indexing::Mappings.new
-      }.to raise_exception(ArgumentError)
+    it 'does not raise an exception when there is no type passed to the #initialize method' do
+      expect(Elasticsearch::Model::Indexing::Mappings.new)
     end
 
     it 'should be convertible to a hash' do
@@ -98,7 +113,7 @@ describe Elasticsearch::Model::Indexing do
       expect(Elasticsearch::Model::Indexing::Mappings.new(:mytype, { foo: 'bar' }).as_json).to eq(expected_mapping_hash)
     end
 
-    context 'when specific mappings are defined' do
+    context 'when a type is specified' do
 
       let(:mappings) do
         Elasticsearch::Model::Indexing::Mappings.new(:mytype)
@@ -113,6 +128,65 @@ describe Elasticsearch::Model::Indexing do
         expect(mappings.to_hash[:mytype][:properties][:foo][:type]).to eq('boolean')
       end
 
+      it 'uses text as the default field type' do
+        expect(mappings.to_hash[:mytype][:properties][:bar][:type]).to eq('text')
+      end
+
+      context 'when the \'include_type_name\' option is specified' do
+
+        let(:mappings) do
+          Elasticsearch::Model::Indexing::Mappings.new(:mytype, include_type_name: true)
+        end
+
+        before do
+          mappings.indexes :foo, { type: 'boolean', include_in_all: false }
+        end
+
+        it 'creates the correct mapping definition' do
+          expect(mappings.to_hash[:mytype][:properties][:foo][:type]).to eq('boolean')
+        end
+
+        it 'sets the \'include_type_name\' option' do
+          expect(mappings.to_hash[:mytype][:include_type_name]).to eq(true)
+        end
+      end
+    end
+
+    context 'when a type is not specified' do
+
+      let(:mappings) do
+        Elasticsearch::Model::Indexing::Mappings.new
+      end
+
+      before do
+        mappings.indexes :foo, { type: 'boolean', include_in_all: false }
+        mappings.indexes :bar
+      end
+
+      it 'creates the correct mapping definition' do
+        expect(mappings.to_hash[:properties][:foo][:type]).to eq('boolean')
+      end
+
+      it 'uses text as the default type' do
+        expect(mappings.to_hash[:properties][:bar][:type]).to eq('text')
+      end
+    end
+
+    context 'when specific mappings are defined' do
+
+      let(:mappings) do
+        Elasticsearch::Model::Indexing::Mappings.new(:mytype, include_type_name: true)
+      end
+
+      before do
+        mappings.indexes :foo, { type: 'boolean', include_in_all: false }
+        mappings.indexes :bar
+      end
+
+      it 'creates the correct mapping definition' do
+        expect(mappings.to_hash[:mytype][:properties][:foo][:type]).to eq('boolean')
+      end
+
       it 'uses text as the default type' do
         expect(mappings.to_hash[:mytype][:properties][:bar][:type]).to eq('text')
       end
@@ -169,6 +243,10 @@ describe Elasticsearch::Model::Indexing do
           expect(mappings.to_hash[:mytype][:properties][:foo_nested_as_symbol][:properties]).not_to be_nil
           expect(mappings.to_hash[:mytype][:properties][:foo_nested_as_symbol][:fields]).to be_nil
         end
+
+        it 'defines the settings' do
+          expect(mappings.to_hash[:mytype][:include_type_name]).to be(true)
+        end
       end
     end
 
@@ -180,7 +258,7 @@ describe Elasticsearch::Model::Indexing do
       end
 
       let(:expected_mappings_hash) do
-        { _doc: { foo: "boo", bar: "bam", properties: {} } }
+        { foo: "boo", bar: "bam", properties: {} }
       end
 
       it 'sets the mappings' do
@@ -196,7 +274,25 @@ describe Elasticsearch::Model::Indexing do
         end
 
         it 'sets the mappings' do
-          expect(DummyIndexingModel.mapping.to_hash[:_doc][:properties][:foo][:type]).to eq('boolean')
+          expect(DummyIndexingModel.mapping.to_hash[:properties][:foo][:type]).to eq('boolean')
+        end
+      end
+
+      context 'when the class has a document_type' do
+
+        before do
+          DummyIndexingModel.instance_variable_set(:@mapping, nil)
+          DummyIndexingModel.document_type(:mytype)
+          DummyIndexingModel.mappings(foo: 'boo')
+          DummyIndexingModel.mappings(bar: 'bam')
+        end
+
+        let(:expected_mappings_hash) do
+          { mytype: { foo: "boo", bar: "bam", properties: {} } }
+        end
+
+        it 'sets the mappings' do
+          expect(DummyIndexingModel.mappings.to_hash).to eq(expected_mappings_hash)
         end
       end
     end
@@ -322,7 +418,7 @@ describe Elasticsearch::Model::Indexing do
         expect(instance).to receive(:client).and_return(client)
         expect(instance).to receive(:as_indexed_json).and_return('JSON')
         expect(instance).to receive(:index_name).and_return('foo')
-        expect(instance).to receive(:document_type).and_return('bar')
+        expect(instance).to receive(:document_type).twice.and_return('bar')
         expect(instance).to receive(:id).and_return('1')
       end
 
@@ -362,7 +458,7 @@ describe Elasticsearch::Model::Indexing do
       before do
         expect(instance).to receive(:client).and_return(client)
         expect(instance).to receive(:index_name).and_return('foo')
-        expect(instance).to receive(:document_type).and_return('bar')
+        expect(instance).to receive(:document_type).twice.and_return('bar')
         expect(instance).to receive(:id).and_return('1')
       end
 
@@ -506,7 +602,7 @@ describe Elasticsearch::Model::Indexing do
         before do
           expect(instance).to receive(:client).and_return(client)
           expect(instance).to receive(:index_name).and_return('foo')
-          expect(instance).to receive(:document_type).and_return('bar')
+          expect(instance).to receive(:document_type).twice.and_return('bar')
           expect(instance).to receive(:id).and_return('1')
           instance.instance_variable_set(:@__changed_model_attributes, { author: 'john' })
         end
@@ -563,36 +659,6 @@ describe Elasticsearch::Model::Indexing do
         expect(DummyIndexingModel.index_exists?).to be(false)
       end
     end
-
-    context 'when the index API raises an error' do
-
-      let(:client) do
-        double('client').tap do |cl|
-          expect(cl).to receive(:indices).and_raise(StandardError)
-        end
-      end
-
-      it 'returns false' do
-        expect(DummyIndexingModel.index_exists?).to be(false)
-      end
-    end
-
-    context 'when the indices.exists API raises an error' do
-
-      let(:client) do
-        double('client', indices: indices)
-      end
-
-      let(:indices) do
-        double('indices').tap do |ind|
-          expect(ind).to receive(:exists).and_raise(StandardError)
-        end
-      end
-
-      it 'returns false' do
-        expect(DummyIndexingModel.index_exists?).to be(false)
-      end
-    end
   end
 
   describe '#delete_index!' do
@@ -610,9 +676,13 @@ describe Elasticsearch::Model::Indexing do
     end
 
     context 'when the index is not found' do
+      let(:logger) { nil }
+      let(:transport) do
+        Elasticsearch::Transport::Client.new(logger: logger)
+      end
 
       let(:client) do
-        double('client', indices: indices, transport: double('transport', { logger: nil }))
+        double('client', indices: indices, transport: transport)
       end
 
       let(:indices) do
@@ -626,19 +696,17 @@ describe Elasticsearch::Model::Indexing do
       end
 
       context 'when the force option is true' do
-
         it 'deletes the index without raising an exception' do
           expect(DummyIndexingModelForRecreate.delete_index!(force: true)).to be_nil
         end
 
         context 'when the client has a logger' do
-
           let(:logger) do
             Logger.new(STDOUT).tap { |l| l.level = Logger::DEBUG }
           end
 
           let(:client) do
-            double('client', indices: indices, transport: double('transport', { logger: logger }))
+            double('client', indices: indices, transport: transport)
           end
 
           it 'deletes the index without raising an exception' do
@@ -738,8 +806,8 @@ describe Elasticsearch::Model::Indexing do
       context 'when options are not provided' do
 
         let(:expected_body) do
-          { mappings: { _doc: { properties: { foo: { analyzer: 'keyword',
-                                                     type: 'text' } } } },
+          { mappings: { properties: { foo: { analyzer: 'keyword',
+                                                     type: 'text' } } },
             settings: { index: { number_of_shards: 1 } } }
         end
 
@@ -789,8 +857,8 @@ describe Elasticsearch::Model::Indexing do
 
       before do
         expect(DummyIndexingModelForCreate).to receive(:client).and_return(client)
-        expect(DummyIndexingModelForCreate).to receive(:index_exists?).and_return(false)
         expect(DummyIndexingModelForCreate).to receive(:delete_index!).and_return(true)
+        expect(DummyIndexingModelForCreate).to receive(:index_exists?).and_return(false)
         expect(indices).to receive(:create).and_raise(Exception)
       end
 
@@ -810,8 +878,8 @@ describe Elasticsearch::Model::Indexing do
       end
 
       let(:expected_body) do
-        { mappings: { _doc: { properties: { foo: { analyzer: 'keyword',
-                                                   type: 'text' } } } },
+        { mappings: { properties: { foo: { analyzer: 'keyword',
+                                                   type: 'text' } } },
           settings: { index: { number_of_shards: 1 } } }
       end
 
@@ -846,7 +914,11 @@ describe Elasticsearch::Model::Indexing do
     end
 
     let(:client) do
-      double('client', indices: indices, transport: double('transport', { logger: nil }))
+      double('client', indices: indices, transport: transport)
+    end
+
+    let(:transport) do
+      Elasticsearch::Transport::Client.new(logger: nil)
     end
 
     let(:indices) do
@@ -858,9 +930,7 @@ describe Elasticsearch::Model::Indexing do
     end
 
     context 'when the force option is true' do
-
       context 'when the operation raises a NotFound exception' do
-
         before do
           expect(indices).to receive(:refresh).and_raise(NotFound)
         end
@@ -870,13 +940,16 @@ describe Elasticsearch::Model::Indexing do
         end
 
         context 'when the client has a logger' do
-
           let(:logger) do
             Logger.new(STDOUT).tap { |l| l.level = Logger::DEBUG }
           end
 
           let(:client) do
-            double('client', indices: indices, transport: double('transport', { logger: logger }))
+            double('client', indices: indices, transport: transport)
+          end
+
+          let(:transport) do
+            Elasticsearch::Transport::Client.new(logger: logger)
           end
 
           it 'does not raise an exception' do
@@ -891,7 +964,6 @@ describe Elasticsearch::Model::Indexing do
       end
 
       context 'when the operation raises another type of exception' do
-
         before do
           expect(indices).to receive(:refresh).and_raise(Exception)
         end
@@ -905,7 +977,6 @@ describe Elasticsearch::Model::Indexing do
     end
 
     context 'when an index name is provided in the options' do
-
       before do
         expect(indices).to receive(:refresh).with(index: 'custom-foo')
       end

data/spec/elasticsearch/model/module_spec.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 'spec_helper'
 
 describe Elasticsearch::Model do
@@ -5,7 +22,7 @@ describe Elasticsearch::Model do
   describe '#client' do
 
     it 'should have a default' do
-      expect(Elasticsearch::Model.client).to be_a(Elasticsearch::Transport::Client)
+      expect(Elasticsearch::Model.client).to be_a(Elasticsearch::Client)
     end
   end
 
@@ -31,6 +48,7 @@ describe Elasticsearch::Model do
       end
 
       DummyIncludingModel.__send__ :include, Elasticsearch::Model
+      DummyIncludingModelWithSearchMethodDefined.__send__ :include, Elasticsearch::Model
     end
 
     after(:all) do
@@ -72,30 +90,5 @@ describe Elasticsearch::Model do
         expect(Elasticsearch::Model.settings[:foo]).to eq('bar')
       end
     end
-
-    context 'when \'inheritance_enabled\' is set' do
-
-      around do |example|
-        original_value = Elasticsearch::Model.settings[:inheritance_enabled]
-        example.run
-        Elasticsearch::Model.settings[:inheritance_enabled] = original_value
-      end
-
-      context 'when \'inheritance_enabled\' is true' do
-
-        it 'warns with a deprecation message' do
-          expect(Elasticsearch::Model).to receive(:warn)
-          Elasticsearch::Model.inheritance_enabled = true
-        end
-      end
-
-      context 'when \'inheritance_enabled\' is false' do
-
-        it 'does not warn' do
-          expect(Elasticsearch::Model).not_to receive(:warn)
-          Elasticsearch::Model.inheritance_enabled = false
-        end
-      end
-    end
   end
 end

data/spec/elasticsearch/model/multimodel_spec.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 'spec_helper'
 
 describe Elasticsearch::Model::Multimodel do

data/spec/elasticsearch/model/naming_spec.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 'spec_helper'
 
 describe 'naming' do
@@ -34,9 +51,9 @@ describe 'naming' do
     expect(::MyNamespace::DummyNamingModelInNamespace.new.index_name).to eq('my_namespace-dummy_naming_model_in_namespaces')
   end
 
-  it 'returns the document type' do
-    expect(DummyNamingModel.document_type).to eq('_doc')
-    expect(DummyNamingModel.new.document_type).to eq('_doc')
+  it 'returns nil' do
+    expect(DummyNamingModel.document_type).to be_nil
+    expect(DummyNamingModel.new.document_type).to be_nil
   end
 
   describe '#index_name' do
@@ -124,8 +141,8 @@ describe 'naming' do
 
   describe '#document_type' do
 
-    it 'returns the document type' do
-      expect(DummyNamingModel.document_type).to eq('_doc')
+    it 'returns nil' do
+      expect(DummyNamingModel.document_type).to be_nil
     end
 
     context 'when the method is called with an argument' do

data/spec/elasticsearch/model/proxy_spec.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 'spec_helper'
 
 describe Elasticsearch::Model::Proxy do
@@ -14,6 +31,10 @@ describe Elasticsearch::Model::Proxy do
         'insta barr'
       end
 
+      def keyword_method(foo: 'default value')
+        foo
+      end
+
       def as_json(options)
         {foo: 'bar'}
       end
@@ -81,7 +102,6 @@ describe Elasticsearch::Model::Proxy do
   end
 
   context 'when instances are cloned' do
-
     let!(:model) do
       DummyProxyModel.new
     end
@@ -104,4 +124,9 @@ describe Elasticsearch::Model::Proxy do
       expect(duplicate).to eq(duplicate_target)
     end
   end
+
+  it 'forwards keyword arguments to target methods' do
+    expect(DummyProxyModel.new.__elasticsearch__.keyword_method(foo: 'bar')).to eq('bar')
+  end
+
 end

data/spec/elasticsearch/model/response/aggregations_spec.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 'spec_helper'
 
 describe Elasticsearch::Model::Response::Aggregations do

data/spec/elasticsearch/model/response/base_spec.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 'spec_helper'
 
 describe Elasticsearch::Model::Response::Base do