elasticsearch-model 0.1.9 → 7.1.1

data/spec/elasticsearch/model/module_spec.rb

@@ -0,0 +1,94 @@
+# 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
+
+  describe '#client' do
+
+    it 'should have a default' do
+      expect(Elasticsearch::Model.client).to be_a(Elasticsearch::Transport::Client)
+    end
+  end
+
+  describe '#client=' do
+
+    before do
+      Elasticsearch::Model.client = 'Foobar'
+    end
+
+    it 'should allow the client to be set' do
+      expect(Elasticsearch::Model.client).to eq('Foobar')
+    end
+  end
+
+  describe 'mixin' do
+
+    before(:all) do
+      class ::DummyIncludingModel; end
+      class ::DummyIncludingModelWithSearchMethodDefined
+        def self.search(query, options={})
+          "SEARCH"
+        end
+      end
+
+      DummyIncludingModel.__send__ :include, Elasticsearch::Model
+      DummyIncludingModelWithSearchMethodDefined.__send__ :include, Elasticsearch::Model
+    end
+
+    after(:all) do
+      remove_classes(DummyIncludingModel, DummyIncludingModelWithSearchMethodDefined)
+    end
+
+    it 'should include and set up the proxy' do
+      expect(DummyIncludingModel).to respond_to(:__elasticsearch__)
+      expect(DummyIncludingModel.new).to respond_to(:__elasticsearch__)
+    end
+
+    it 'should delegate methods to the proxy' do
+      expect(DummyIncludingModel).to respond_to(:search)
+      expect(DummyIncludingModel).to respond_to(:mapping)
+      expect(DummyIncludingModel).to respond_to(:settings)
+      expect(DummyIncludingModel).to respond_to(:index_name)
+      expect(DummyIncludingModel).to respond_to(:document_type)
+      expect(DummyIncludingModel).to respond_to(:import)
+    end
+
+    it 'should not interfere with existing methods' do
+      expect(DummyIncludingModelWithSearchMethodDefined.search('foo')).to eq('SEARCH')
+    end
+  end
+
+  describe '#settings' do
+
+    it 'allows access to the settings' do
+      expect(Elasticsearch::Model.settings).to eq({})
+    end
+
+    context 'when settings are changed' do
+
+      before do
+        Elasticsearch::Model.settings[:foo] = 'bar'
+      end
+
+      it 'persists the changes' do
+        expect(Elasticsearch::Model.settings[:foo]).to eq('bar')
+      end
+    end
+  end
+end

data/spec/elasticsearch/model/multimodel_spec.rb

@@ -0,0 +1,72 @@
+# 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
+
+  let(:multimodel) do
+    Elasticsearch::Model::Multimodel.new(model_1, model_2)
+  end
+
+  let(:model_1) do
+    double('Foo', index_name: 'foo_index', document_type: 'foo', to_ary: nil)
+  end
+
+  let(:model_2) do
+    double('Bar', index_name: 'bar_index', document_type: 'bar', to_ary: nil)
+  end
+
+  it 'has an index name' do
+    expect(multimodel.index_name).to eq(['foo_index', 'bar_index'])
+  end
+
+  it 'has an document type' do
+    expect(multimodel.document_type).to eq(['foo', 'bar'])
+  end
+
+  it 'has a client' do
+    expect(multimodel.client).to eq(Elasticsearch::Model.client)
+  end
+
+  describe 'the model registry' do
+
+    before(:all) do
+
+      class JustAModel
+        include Elasticsearch::Model
+      end
+
+      class JustAnotherModel
+        include Elasticsearch::Model
+      end
+    end
+
+    after(:all) do
+      remove_classes(JustAModel, JustAnotherModel)
+    end
+
+    let(:multimodel) do
+      Elasticsearch::Model::Multimodel.new
+    end
+
+    it 'includes model in the registry' do
+      expect(multimodel.models).to include(JustAModel)
+      expect(multimodel.models).to include(JustAnotherModel)
+    end
+  end
+end

data/spec/elasticsearch/model/naming_spec.rb

@@ -0,0 +1,203 @@
+# 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
+
+  before(:all) do
+    class ::DummyNamingModel
+      extend ActiveModel::Naming
+
+      extend  Elasticsearch::Model::Naming::ClassMethods
+      include Elasticsearch::Model::Naming::InstanceMethods
+    end
+
+    module ::MyNamespace
+      class DummyNamingModelInNamespace
+        extend ActiveModel::Naming
+
+        extend  Elasticsearch::Model::Naming::ClassMethods
+        include Elasticsearch::Model::Naming::InstanceMethods
+      end
+    end
+  end
+
+  after(:all) do
+    remove_classes(DummyNamingModel, MyNamespace)
+  end
+
+  it 'returns the default index name' do
+    expect(DummyNamingModel.index_name).to eq('dummy_naming_models')
+    expect(DummyNamingModel.new.index_name).to eq('dummy_naming_models')
+  end
+
+  it 'returns the sanitized defualt index name for namespaced models' do
+    expect(::MyNamespace::DummyNamingModelInNamespace.index_name).to eq('my_namespace-dummy_naming_model_in_namespaces')
+    expect(::MyNamespace::DummyNamingModelInNamespace.new.index_name).to eq('my_namespace-dummy_naming_model_in_namespaces')
+  end
+
+  it 'returns nil' do
+    expect(DummyNamingModel.document_type).to be_nil
+    expect(DummyNamingModel.new.document_type).to be_nil
+  end
+
+  describe '#index_name' do
+
+    context 'when the index name is set on the class' do
+
+      before do
+        DummyNamingModel.index_name 'foobar'
+      end
+
+      it 'sets the index_name' do
+        expect(DummyNamingModel.index_name).to eq('foobar')
+      end
+    end
+
+    context 'when the index name is set on an instance' do
+
+      before do
+        instance.index_name 'foobar_d'
+      end
+
+      let(:instance) do
+        DummyNamingModel.new
+      end
+
+      it 'sets the index name on the instance' do
+        expect(instance.index_name).to eq('foobar_d')
+      end
+
+      context 'when the index name is set with a proc' do
+
+        before do
+          modifier = 'r'
+          instance.index_name Proc.new{ "foobar_#{modifier}" }
+        end
+
+        it 'sets the index name on the instance' do
+          expect(instance.index_name).to eq('foobar_r')
+        end
+      end
+    end
+  end
+
+  describe '#index_name=' do
+
+    before do
+      DummyNamingModel.index_name = 'foobar_index_S'
+    end
+
+    it 'changes the index name' do
+      expect(DummyNamingModel.index_name).to eq('foobar_index_S')
+    end
+
+    context 'when the method is called on an instance' do
+
+      let(:instance) do
+        DummyNamingModel.new
+      end
+
+      before do
+        instance.index_name = 'foobar_index_s'
+      end
+
+      it 'changes the index name' do
+        expect(instance.index_name).to eq('foobar_index_s')
+      end
+
+      it 'does not change the index name on the class' do
+        expect(DummyNamingModel.index_name).to eq('foobar_index_S')
+      end
+    end
+
+    context 'when the index name is changed with a proc' do
+
+      before do
+        modifier2 = 'y'
+        DummyNamingModel.index_name = Proc.new{ "foobar_index_#{modifier2}" }
+      end
+
+      it 'changes the index name' do
+        expect(DummyNamingModel.index_name).to eq('foobar_index_y')
+      end
+    end
+  end
+
+  describe '#document_type' do
+
+    it 'returns nil' do
+      expect(DummyNamingModel.document_type).to be_nil
+    end
+
+    context 'when the method is called with an argument' do
+
+      before do
+        DummyNamingModel.document_type 'foo'
+      end
+
+      it 'changes the document type' do
+        expect(DummyNamingModel.document_type).to eq('foo')
+      end
+    end
+
+    context 'when the method is called on an instance' do
+
+      let(:instance) do
+        DummyNamingModel.new
+      end
+
+      before do
+        instance.document_type 'foobar_d'
+      end
+
+      it 'changes the document type' do
+        expect(instance.document_type).to eq('foobar_d')
+      end
+    end
+  end
+
+  describe '#document_type=' do
+
+    context 'when the method is called on the class' do
+
+      before do
+        DummyNamingModel.document_type = 'foo_z'
+      end
+
+      it 'changes the document type' do
+        expect(DummyNamingModel.document_type).to eq('foo_z')
+      end
+    end
+
+    context 'when the method is called on an instance' do
+
+      let(:instance) do
+        DummyNamingModel.new
+      end
+
+      before do
+        instance.document_type = 'foobar_b'
+      end
+
+      it 'changes the document type' do
+        expect(instance.document_type).to eq('foobar_b')
+      end
+    end
+  end
+end

data/spec/elasticsearch/model/proxy_spec.rb

@@ -0,0 +1,124 @@
+# 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
+
+  before(:all) do
+    class ::DummyProxyModel
+      include Elasticsearch::Model::Proxy
+
+      def self.foo
+        'classy foo'
+      end
+
+      def bar
+        'insta barr'
+      end
+
+      def as_json(options)
+        {foo: 'bar'}
+      end
+    end
+
+    class ::DummyProxyModelWithCallbacks
+      def self.before_save(&block)
+        (@callbacks ||= {})[block.hash] = block
+      end
+
+      def changes_to_save
+        {:foo => ['One', 'Two']}
+      end
+    end
+
+    DummyProxyModelWithCallbacks.__send__ :include, Elasticsearch::Model::Proxy
+  end
+
+  after(:all) do
+    remove_classes(DummyProxyModel, DummyProxyModelWithCallbacks)
+  end
+
+  it 'sets up a proxy method on the class' do
+    expect(DummyProxyModel).to respond_to(:__elasticsearch__)
+  end
+
+  it 'sets up a proxy method on instances' do
+    expect(DummyProxyModel.new).to respond_to(:__elasticsearch__)
+  end
+
+  it 'sets up hooks for before_save callbacks' do
+    expect(DummyProxyModelWithCallbacks).to respond_to(:before_save)
+  end
+
+  it 'delegates methods to the target' do
+    expect(DummyProxyModel.__elasticsearch__).to respond_to(:foo)
+    expect(DummyProxyModel.__elasticsearch__.foo).to eq('classy foo')
+    expect(DummyProxyModel.new.__elasticsearch__).to respond_to(:bar)
+    expect(DummyProxyModel.new.__elasticsearch__.bar).to eq('insta barr')
+
+    expect {
+      DummyProxyModel.__elasticsearch__.xoxo
+    }.to raise_exception(NoMethodError)
+
+    expect {
+      DummyProxyModel.new.__elasticsearch__.xoxo
+    }.to raise_exception(NoMethodError)
+  end
+
+  it 'returns the proxy class from an instance proxy' do
+    expect(DummyProxyModel.new.__elasticsearch__.class.class).to eq(Elasticsearch::Model::Proxy::ClassMethodsProxy)
+  end
+
+  it 'returns the origin class from an instance proxy' do
+    expect(DummyProxyModel.new.__elasticsearch__.klass).to eq(DummyProxyModel)
+  end
+
+  it 'delegates #as_json from the proxy to the target' do
+    expect(DummyProxyModel.new.__elasticsearch__.as_json).to eq(foo: 'bar')
+  end
+
+  it 'includes the proxy in the inspect string' do
+    expect(DummyProxyModel.__elasticsearch__.inspect).to match(/PROXY/)
+    expect(DummyProxyModel.new.__elasticsearch__.inspect).to match(/PROXY/)
+  end
+
+  context 'when instances are cloned' do
+
+    let!(:model) do
+      DummyProxyModel.new
+    end
+
+    let!(:model_target) do
+      model.__elasticsearch__.target
+    end
+
+    let!(:duplicate) do
+      model.dup
+    end
+
+    let!(:duplicate_target) do
+      duplicate.__elasticsearch__.target
+    end
+
+    it 'resets the proxy target' do
+      expect(model).not_to eq(duplicate)
+      expect(model).to eq(model_target)
+      expect(duplicate).to eq(duplicate_target)
+    end
+  end
+end

data/spec/elasticsearch/model/response/aggregations_spec.rb

@@ -0,0 +1,83 @@
+# 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
+
+  before(:all) do
+    class OriginClass
+      def self.index_name;    'foo'; end
+      def self.document_type; 'bar'; end
+    end
+  end
+
+  after(:all) do
+    remove_classes(OriginClass)
+  end
+
+  let(:response_document) do
+    {
+        'aggregations' => {
+            'foo' => {'bar' => 10 },
+            'price' => { 'doc_count' => 123,
+                         'min' => { 'value' => 1.0},
+                         'max' => { 'value' => 99 }
+            }
+        }
+    }
+  end
+
+  let(:search) do
+    Elasticsearch::Model::Searching::SearchRequest.new(OriginClass, '*').tap do |request|
+      allow(request).to receive(:execute!).and_return(response_document)
+    end
+  end
+
+  let(:aggregations) do
+    Elasticsearch::Model::Response::Response.new(OriginClass, search).aggregations
+  end
+
+  describe 'method delegation' do
+
+    it 'delegates methods to the response document' do
+      expect(aggregations.foo).to be_a(Hashie::Mash)
+      expect(aggregations.foo.bar).to be(10)
+    end
+  end
+
+  describe '#doc_count' do
+
+    it 'returns the doc count value from the response document' do
+      expect(aggregations.price.doc_count).to eq(123)
+    end
+  end
+
+  describe '#min' do
+
+    it 'returns the min value from the response document' do
+      expect(aggregations.price.min.value).to eq(1)
+    end
+  end
+
+  describe '#max' do
+
+    it 'returns the max value from the response document' do
+      expect(aggregations.price.max.value).to eq(99)
+    end
+  end
+end

data/spec/elasticsearch/model/response/base_spec.rb

@@ -0,0 +1,107 @@
+# 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
+
+  before(:all) do
+    class DummyBaseClass
+      include Elasticsearch::Model::Response::Base
+    end
+
+    class OriginClass
+      def self.index_name;    'foo'; end
+      def self.document_type; 'bar'; end
+    end
+  end
+
+  after(:all) do
+    remove_classes(DummyBaseClass, OriginClass)
+  end
+
+  let(:response_document) do
+    { 'hits' => { 'total' => 123, 'max_score' => 456, 'hits' => [] } }
+  end
+
+  let(:search) do
+    Elasticsearch::Model::Searching::SearchRequest.new(OriginClass, '*').tap do |request|
+      allow(request).to receive(:execute!).and_return(response_document)
+    end
+  end
+
+  let(:response) do
+    Elasticsearch::Model::Response::Response.new(OriginClass, search)
+  end
+
+  let(:response_base) do
+    DummyBaseClass.new(OriginClass, response)
+  end
+
+  describe '#klass' do
+
+    it 'returns the class' do
+      expect(response.klass).to be(OriginClass)
+    end
+  end
+
+  describe '#response' do
+
+    it 'returns the response object' do
+      expect(response_base.response).to eq(response)
+    end
+  end
+
+  describe 'response document' do
+
+    it 'returns the response document' do
+      expect(response_base.response.response).to eq(response_document)
+    end
+  end
+
+  describe '#total' do
+
+    it 'returns the total' do
+      expect(response_base.total).to eq(123)
+    end
+  end
+
+  describe '#max_score' do
+
+    it 'returns the total' do
+      expect(response_base.max_score).to eq(456)
+    end
+  end
+
+  describe '#results' do
+
+    it 'raises a NotImplemented error' do
+      expect {
+        response_base.results
+      }.to raise_exception(Elasticsearch::Model::NotImplemented)
+    end
+  end
+
+  describe '#records' do
+
+    it 'raises a NotImplemented error' do
+      expect {
+        response_base.records
+      }.to raise_exception(Elasticsearch::Model::NotImplemented)
+    end
+  end
+end