elasticsearch-model 5.1.0 → 6.1.0

data/spec/elasticsearch/model/module_spec.rb

@@ -0,0 +1,101 @@
+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
+    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
+
+    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

@@ -0,0 +1,55 @@
+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_inheritance_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+describe 'naming inheritance' do
+
+  context 'without using proxy' do
+    before(:all) do
+      TestBase = Class.new do
+        extend ActiveModel::Naming
+
+        extend  Elasticsearch::Model::Naming::ClassMethods
+        include Elasticsearch::Model::Naming::InstanceMethods
+      end
+
+      Animal = Class.new TestBase do
+        extend ActiveModel::Naming
+
+        extend  Elasticsearch::Model::Naming::ClassMethods
+        include Elasticsearch::Model::Naming::InstanceMethods
+
+        index_name "mammals"
+        document_type "mammal"
+      end
+
+      Dog = Class.new Animal
+
+      module ::MyNamespace
+        Dog = Class.new Animal
+      end
+
+      Cat = Class.new Animal do
+        extend ActiveModel::Naming
+
+        extend  Elasticsearch::Model::Naming::ClassMethods
+        include Elasticsearch::Model::Naming::InstanceMethods
+
+        index_name "cats"
+        document_type "cat"
+      end
+
+    end
+
+    after(:all) do
+      remove_classes(TestBase, Animal, MyNamespace, Cat)
+    end
+
+    around(:all) do |example|
+      original_value = Elasticsearch::Model.inheritance_enabled
+      Elasticsearch::Model.inheritance_enabled = true
+      example.run
+      Elasticsearch::Model.inheritance_enabled = original_value
+    end
+
+    describe '#index_name' do
+
+      it 'returns the default index name' do
+        expect(TestBase.index_name).to eq('test_bases')
+        expect(TestBase.new.index_name).to eq('test_bases')
+      end
+
+      it 'returns the explicit index name' do
+        expect(Animal.index_name).to eq('mammals')
+        expect(Animal.new.index_name).to eq('mammals')
+
+        expect(Cat.index_name).to eq('cats')
+        expect(Cat.new.index_name).to eq('cats')
+      end
+
+      it 'returns the ancestor index name' do
+        expect(Dog.index_name).to eq('mammals')
+        expect(Dog.new.index_name).to eq('mammals')
+      end
+
+      it 'returns the ancestor index name for namespaced models' do
+        expect(::MyNamespace::Dog.index_name).to eq('mammals')
+        expect(::MyNamespace::Dog.new.index_name).to eq('mammals')
+      end
+    end
+
+    describe '#document_type' do
+
+      it 'returns nil' do
+        expect(TestBase.document_type).to eq('_doc')
+        expect(TestBase.new.document_type).to eq('_doc')
+      end
+
+      it 'returns the explicit document type' do
+        expect(Animal.document_type).to eq('mammal')
+        expect(Animal.new.document_type).to eq('mammal')
+
+        expect(Cat.document_type).to eq('cat')
+        expect(Cat.new.document_type).to eq('cat')
+      end
+
+      it 'returns the ancestor document type' do
+        expect(Dog.document_type).to eq('mammal')
+        expect(Dog.new.document_type).to eq('mammal')
+      end
+
+      it 'returns the ancestor document type for namespaced models' do
+        expect(::MyNamespace::Dog.document_type).to eq('mammal')
+        expect(::MyNamespace::Dog.new.document_type).to eq('mammal')
+      end
+    end
+  end
+
+  context 'when using proxy' do
+    before(:all) do
+      TestBase = Class.new do
+        extend ActiveModel::Naming
+
+        include Elasticsearch::Model
+      end
+
+      Animal = Class.new TestBase do
+        index_name "mammals"
+        document_type "mammal"
+      end
+
+      Dog = Class.new Animal
+
+      module MyNamespace
+        Dog = Class.new Animal
+      end
+
+      Cat = Class.new Animal do
+        index_name "cats"
+        document_type "cat"
+      end
+    end
+
+    after(:all) do
+      remove_classes(TestBase, Animal, MyNamespace, Cat)
+    end
+
+    around(:all) do |example|
+      original_value = Elasticsearch::Model.settings[:inheritance_enabled]
+      Elasticsearch::Model.settings[:inheritance_enabled] = true
+      example.run
+      Elasticsearch::Model.settings[:inheritance_enabled] = original_value
+    end
+
+    describe '#index_name' do
+
+      it 'returns the default index name' do
+        expect(TestBase.index_name).to eq('test_bases')
+      end
+
+      it 'returns the explicit index name' do
+        expect(Animal.index_name).to eq('mammals')
+
+        expect(Cat.index_name).to eq('cats')
+      end
+
+      it 'returns the ancestor index name' do
+        expect(Dog.index_name).to eq('mammals')
+      end
+
+      it 'returns the ancestor index name for namespaced models' do
+        expect(::MyNamespace::Dog.index_name).to eq('mammals')
+      end
+    end
+
+    describe '#document_type' do
+
+      it 'returns nil' do
+        expect(TestBase.document_type).to eq('_doc')
+      end
+
+      it 'returns the explicit document type' do
+        expect(Animal.document_type).to eq('mammal')
+
+        expect(Cat.document_type).to eq('cat')
+      end
+
+      it 'returns the ancestor document type' do
+        expect(Dog.document_type).to eq('mammal')
+      end
+
+      it 'returns the ancestor document type for namespaced models' do
+        expect(::MyNamespace::Dog.document_type).to eq('mammal')
+      end
+    end
+  end
+end

data/spec/elasticsearch/model/naming_spec.rb

@@ -0,0 +1,186 @@
+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 the document type' do
+    expect(DummyNamingModel.document_type).to eq('_doc')
+    expect(DummyNamingModel.new.document_type).to eq('_doc')
+  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 the document type' do
+      expect(DummyNamingModel.document_type).to eq('_doc')
+    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,107 @@
+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,66 @@
+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