elastictastic 0.5.0 → 0.10.2

data/spec/examples/dirty_spec.rb

@@ -15,7 +15,7 @@ describe Elastictastic::Dirty do
   end
 
   before do
-    stub_elasticsearch_update('default', 'post', '1')
+    stub_es_update('default', 'post', '1')
   end
 
   context 'top-level attribute' do
@@ -71,6 +71,58 @@ describe Elastictastic::Dirty do
         post.should_not be_title_changed
       end
     end
+
+    context 'after change and reload' do
+      before do
+        post.title = 'hey guy'
+        stub_es_get('default', 'post', '1', 'title' => 'second title')
+        post.reload
+      end
+
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+    end
+
+    context 'changing it to the same thing' do
+      before do
+        post.title = 'first title'
+      end
+
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+
+      it 'should not have any changes' do
+        post.changes.should be_empty
+      end
+
+      it 'should not have the title attribute changed' do
+        post.should_not be_title_changed
+      end
+    end
+
+    context 'changing it twice' do
+      before do
+        post.title = 'second title'
+        post.title = 'third title'
+      end
+
+      it 'should keep track of original value' do
+        post.title_change.should == ['first title', 'third title']
+      end
+    end
+
+    context 'changing it to something else and then back' do
+      before do
+        post.title = 'second title'
+        post.title = 'first title'
+      end
+
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+    end
   end
 
   context 'single nested document' do
@@ -113,6 +165,12 @@ describe Elastictastic::Dirty do
         post.save
         post.author.should_not be_changed
       end
+
+      it 'should not be changed when setting it to the same thing' do
+        post.save
+        post.author.name = post.author.name
+        post.author.should_not be_changed
+      end
     end
 
     context 'with nested document replaced' do
@@ -129,6 +187,37 @@ describe Elastictastic::Dirty do
           ['Mat Brown', 'Barack Obama']
       end
     end
+
+    context 'with nested document replaced by nil' do
+      before do
+        post.author = Author.new(:name => 'Barack Obama')
+        post.save
+        post.author = nil
+      end
+
+      it 'should be changed' do
+        post.should be_changed
+      end
+
+      it 'should expose changes' do
+        post.changes['author'][0].name.should == 'Barack Obama'
+        post.changes['author'][1].should == nil
+      end
+
+      it 'should save properly' do
+        post.save!
+      end
+    end
+
+    context 'with nested document replaced by itself' do
+      before do
+        post.author = Author.new(:name => 'Mat Brown')
+      end
+
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+    end
   end
 
   context 'nested document collection' do
@@ -168,6 +257,33 @@ describe Elastictastic::Dirty do
         post.save
         post.comments.first.should_not be_changed
       end
+
+      it 'should not be changed when setting it to the same thing' do
+        post.save
+        post.comments.first.body = post.comments.first.body
+        post.should_not be_changed
+      end
+    end
+
+    context 'when nested document value set to same value' do
+      before do
+        post.comments.first.body = 'I like pizza'
+      end
+
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+    end
+
+    context 'when nested document value set to a different value and then back' do
+      before do
+        post.comments.first.body = 'I like lasagne'
+        post.comments.first.body = 'I like pizza'
+      end
+
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
     end
 
     context 'when document added' do
@@ -216,6 +332,17 @@ describe Elastictastic::Dirty do
       end
     end
 
+    context 'with document removed and then identical document added' do
+      before do
+        post.comments.delete(post.comments.first)
+        post.comments << Comment.new(:body => 'I like pizza')
+      end
+
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+    end
+
     context 'with collection replaced' do
       before do
         post.comments = [Comment.new(:body => 'I like lasagne')]
@@ -234,5 +361,37 @@ describe Elastictastic::Dirty do
         post.should_not be_changed
       end
     end
+
+    context 'with collection replaced with identical collection' do
+      before do
+        post.comments = [Comment.new(:body => 'I like pizza')]
+      end
+
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+    end
+
+    context 'with collection replaced by a different collection and then back to the original' do
+      before do
+        post.comments = [Comment.new(:body => 'I am the walrus')]
+        post.comments = [Comment.new(:body => 'I like pizza')]
+      end
+
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+    end
+
+    context 'with collection replaced and then populated with identical members' do
+      before do
+        post.comments = []
+        post.comments << Comment.new(:body => 'I like pizza')
+      end
+
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+    end
   end
 end

data/spec/examples/document_spec.rb

@@ -4,11 +4,11 @@ describe Elastictastic::Document do
   include Elastictastic::TestHelpers
 
   let(:last_request) { FakeWeb.last_request }
-  let(:last_request_body) { JSON.parse(last_request.body) }
+  let(:last_request_body) { Elastictastic.json_decode(last_request.body) }
 
   describe '#save' do
     context 'new object' do
-      let!(:id) { stub_elasticsearch_create('default', 'post') }
+      let!(:id) { stub_es_create('default', 'post') }
       let(:post) { Post.new }
 
       before do
@@ -25,27 +25,48 @@ describe Elastictastic::Document do
       end
 
       it 'should send document in the body' do
-        last_request.body.should == post.elasticsearch_doc.to_json
+        last_request.body.should == Elastictastic.json_encode(post.elasticsearch_doc)
       end
 
       it 'should populate ID of model object' do
         post.id.should == id
       end
 
+      it 'should populate version' do
+        post.version.should == 1
+      end
+
       it 'should mark object as persisted' do
         post.should be_persisted
       end
     end # context 'new object'
 
+    context 'new object with routing' do
+      let!(:id) { stub_es_create('default', 'photo') }
+      let(:photo) { Photo.new(:post_id => '123') }
+
+      before do
+        photo.save
+      end
+
+      it 'should send routing param' do
+        last_request_uri.query.split('&').should include('routing=123')
+      end
+    end
+
     context 'new object with ID' do
       let(:post) { Post.new.tap { |post| post.id = '123' }}
 
       context 'with unique id' do
         before do
-          stub_elasticsearch_create('default', 'post', post.id)
+          stub_es_create('default', 'post', post.id)
           post.save
         end
 
+        it 'should populate version' do
+          post.version.should == 1
+        end
+
         it 'should send PUT request' do
           last_request.method.should == 'PUT'
         end
@@ -55,18 +76,17 @@ describe Elastictastic::Document do
         end
 
         it 'should send document in body' do
-          last_request.body.should == post.elasticsearch_doc.to_json
+          last_request.body.should == Elastictastic.json_encode(post.elasticsearch_doc)
         end
       end # context 'with unique ID'
 
       context 'with duplicate ID' do
         before do
-          stub_elasticsearch_create(
-            'default', 'post', '123',
-            :body => {
-              'error' => 'DocumentAlreadyExistsEngineException[[post][2] [post][1]]: document already exists',
-              'status' => 409
-            }.to_json
+          stub_request_json(
+            :put,
+            match_es_resource('default', 'post', '123', '_create'),
+            'error' => 'DocumentAlreadyExistsEngineException[[post][2] [post][1]]: document already exists',
+            'status' => 409
           )
         end
 
@@ -90,6 +110,16 @@ describe Elastictastic::Document do
       end # context 'with duplicate ID'
     end # context 'new object with ID'
 
+    context 'new object with ID with routing' do
+      let(:photo) { Photo.new(:id => 'abc', :post_id => '123') }
+
+      it 'should include routing param when saving' do
+        stub_es_create('default', 'photo', 'abc')
+        photo.save
+        last_request_uri.query.split('&').should include('routing=123')
+      end
+    end
+
     shared_examples_for 'persisted object' do
       describe 'identity attributes' do
         it 'should not allow setting of ID' do
@@ -99,7 +129,7 @@ describe Elastictastic::Document do
 
       describe '#save' do
         before do
-          stub_elasticsearch_update('default', 'post', post.id)
+          stub_es_update('default', 'post', post.id)
           post.title = 'Fun Factories for Fickle Ferrets'
           post.save
         end
@@ -108,19 +138,23 @@ describe Elastictastic::Document do
           last_request.method.should == 'PUT'
         end
 
-        it "should send to document's resource path" do
-          last_request.path.should == "/default/post/#{post.id}"
+        it "should send to document's resource path with version" do
+          last_request.path.should == "/default/post/#{post.id}?version=1"
         end
 
         it "should send document's body in request" do
-          last_request.body.should == post.elasticsearch_doc.to_json
+          last_request.body.should == Elastictastic.json_encode(post.elasticsearch_doc)
+        end
+
+        it 'should populate new version' do
+          post.version.should == 2
         end
       end # describe '#save'
     end # shared_examples_for 'persisted object'
 
     context 'object after save' do
       let(:post) do
-        stub_elasticsearch_create('default', 'post')
+        stub_es_create('default', 'post')
         Post.new.tap { |post| post.save }
       end
 
@@ -131,12 +165,33 @@ describe Elastictastic::Document do
       let(:post) do
         Post.new.tap do |post|
           post.id = '123'
+          post.version = 1
           post.persisted!
         end
       end
 
       it_should_behave_like 'persisted object'
     end # context 'existing persisted object'
+
+    context 'persisted object with routing' do
+      let(:photo) do
+        Photo.new.tap do |photo|
+          photo.id = 'abc'
+          photo.post_id = '123'
+          photo.version = 1
+          photo.persisted!
+        end
+      end
+
+      before do
+        stub_es_update('default', 'photo', 'abc')
+        photo.save!
+      end
+
+      it 'should include routing param' do
+        last_request_uri.query.split('&').should include('routing=123')
+      end
+    end
   end # describe '#save'
 
   describe '#destroy' do
@@ -149,7 +204,7 @@ describe Elastictastic::Document do
       end
 
       before do
-        stub_elasticsearch_destroy('default', 'post', '123')
+        stub_es_destroy('default', 'post', '123')
         @result = post.destroy
       end
 
@@ -170,6 +225,26 @@ describe Elastictastic::Document do
       end
     end # context 'existing persisted object'
 
+    context 'persisted object with routing' do
+      let(:photo) do
+        Photo.new.tap do |photo|
+          photo.id = 'abc'
+          photo.post_id = '123'
+          photo.version = 1
+          photo.persisted!
+        end
+      end
+
+      before do
+        stub_es_destroy('default', 'photo', 'abc')
+        photo.destroy
+      end
+
+      it 'should include routing param' do
+        last_request_uri.query.split('&').should include('routing=123')
+      end
+    end
+
     context 'transient object' do
       let(:post) { Post.new }
 
@@ -187,16 +262,9 @@ describe Elastictastic::Document do
       end
 
       before do
-        stub_elasticsearch_destroy(
+        stub_es_destroy(
           'default', 'post', '123',
-          :body => {
-            'ok' => true,
-            'found' => false,
-            '_index' => 'default',
-            '_type' => 'post',
-            '_id' => '123',
-            '_version' => 0
-          }.to_json
+          'found' => false
         )
         @result = post.destroy
       end
@@ -207,10 +275,32 @@ describe Elastictastic::Document do
     end # describe 'non-existent persisted object'
   end # describe '#destroy'
 
+  describe '#reload' do
+    context 'with persisted object' do
+      let :post do
+        Post.new.tap do |post|
+          post.id = '1'
+          post.title = 'Title'
+          post.persisted!
+        end
+      end
+
+      before do
+        stub_es_get('default', 'post', '1', 'title' => 'Title')
+        post.title = 'Something'
+        post.reload
+      end
+
+      it 'should reset changed attributes' do
+        post.title.should == 'Title'
+      end
+    end
+  end
+
   describe '::destroy_all' do
     describe 'with default index' do
       before do
-        stub_elasticsearch_destroy_all('default', 'post')
+        stub_es_destroy_all('default', 'post')
         Post.destroy_all
       end
 
@@ -225,7 +315,7 @@ describe Elastictastic::Document do
 
     describe 'with specified index' do
       before do
-        stub_elasticsearch_destroy_all('my_index', 'post')
+        stub_es_destroy_all('my_index', 'post')
         Post.in_index('my_index').destroy_all
       end
 
@@ -242,13 +332,13 @@ describe Elastictastic::Document do
       end
 
       it 'should send mapping to ES' do
-        last_request.body.should == Post.mapping.to_json
+        last_request.body.should == Elastictastic.json_encode(Post.mapping)
       end
     end # shared_examples_for 'put mapping'
 
     context 'with default index' do
       before do
-        stub_elasticsearch_put_mapping('default', 'post')
+        stub_es_put_mapping('default', 'post')
         Post.sync_mapping
       end
 
@@ -261,7 +351,7 @@ describe Elastictastic::Document do
 
     context 'with specified index' do
       before do
-        stub_elasticsearch_put_mapping('my_cool_index', 'post')
+        stub_es_put_mapping('my_cool_index', 'post')
         Post.in_index('my_cool_index').sync_mapping
       end
 
@@ -278,7 +368,7 @@ describe Elastictastic::Document do
     shared_examples_for 'single document lookup' do
       context 'when document is found' do
         before do
-          stub_elasticsearch_get(
+          stub_es_get(
             index, 'post', '1',
           )
         end
@@ -287,6 +377,10 @@ describe Elastictastic::Document do
           post.should be_a(Post)
         end
 
+        it 'should populate version' do
+          post.version.should == 1
+        end
+
         it 'should request specified fields if specified' do
           scope.fields('name', 'author.name').find(1)
           last_request.path.should == "/#{index}/post/1?fields=name%2Cauthor.name"
@@ -301,7 +395,7 @@ describe Elastictastic::Document do
 
       context 'when document is not found' do
         before do
-          stub_elasticsearch_get(index, 'post', '1', nil)
+          stub_es_get(index, 'post', '1', nil)
         end
 
         it 'should return nil' do
@@ -313,7 +407,7 @@ describe Elastictastic::Document do
     shared_examples_for 'multi document single index lookup' do
 
       before do
-        stub_elasticsearch_mget(index, 'post', '1', '2')
+        stub_es_mget(index, 'post', '1', '2')
         posts
       end
 
@@ -370,82 +464,12 @@ describe Elastictastic::Document do
       it_should_behave_like 'single document lookup'
       it_should_behave_like 'multi document single index lookup'
 
-      describe 'multi-index multi-get' do
-        before do
-          stub_elasticsearch_mget(
-            nil,
-            nil,
-            ['1', 'default'], ['2', 'my_index'], ['3', 'my_index']
-          )
-          posts
-        end
-
-        describe 'with no options' do
-          let(:posts) { Post.find('default' => '1', 'my_index' => %w(2 3)) }
-
-          it 'should send request to base path' do
-            last_request.path.should == '/_mget'
-          end
-
-          it 'should request ids with type and index' do
-            last_request_body.should == {
-              'docs' => [{
-                '_id' => '1',
-                '_type' => 'post',
-                '_index' => 'default'
-              }, {
-                '_id' => '2',
-                '_type' => 'post',
-                '_index' => 'my_index'
-              }, {
-                '_id' => '3',
-                '_type' => 'post',
-                '_index' => 'my_index'
-              }]
-            }
-          end
-
-          it 'should return docs with IDs' do
-            posts.map(&:id).should == %w(1 2 3)
-          end
-
-          it 'should set proper indices' do
-            posts.map { |post| post.index.name }.should ==
-              %w(default my_index my_index)
-          end
-        end # context 'with no options' 
-
-        context 'with fields specified' do
-          let(:posts) { Post.fields('title').find('default' => '1', 'my_index' => %w(2 3)) }
-
-          it 'should inject fields into each identifier' do
-            last_request_body.should == {
-              'docs' => [{
-                '_id' => '1',
-                '_type' => 'post',
-                '_index' => 'default',
-                'fields' => %w(title)
-              }, {
-                '_id' => '2',
-                '_type' => 'post',
-                '_index' => 'my_index',
-                'fields' => %w(title)
-              }, {
-                '_id' => '3',
-                '_type' => 'post',
-                '_index' => 'my_index',
-                'fields' => %w(title)
-              }]
-            }
-          end
-        end
-      end # describe 'multi-index multi-get'
 
       context 'when documents are missing' do
         let(:posts) { Post.find('1', '2') }
 
         before do
-          stub_elasticsearch_mget('default', 'post', '1' => {}, '2' => nil)
+          stub_es_mget('default', 'post', '1' => {}, '2' => nil)
         end
 
         it 'should only return docs that exist' do
@@ -462,15 +486,49 @@ describe Elastictastic::Document do
       it_should_behave_like 'single document lookup'
       it_should_behave_like 'multi document single index lookup'
     end # context 'with specified index'
+
+    context 'with routing specified' do
+      context 'single document lookup' do
+        it 'should specify routing' do
+          stub_es_get('default', 'photo', 'abc')
+          Photo.routing('123').find('abc')
+          last_request_uri.query.split('&').should include('routing=123')
+        end
+
+        it 'should complain if routing required but not specified' do
+          expect { Photo.find('abc') }.
+            to raise_error(Elastictastic::MissingParameter)
+        end
+      end
+    end
   end # describe '::find'
 
-  describe '::new_from_elasticsearch_hit' do
+  describe '::exists?' do
+    it 'should return true if document exists' do
+      stub_es_head('my_index', 'post', 1, true)
+      Post.in_index('my_index').exists?(1).should be_true
+    end
+
+    it 'should return false if document does not exist' do
+      stub_es_head('my_index', 'post', 1, false)
+      Post.in_index('my_index').exists?(1).should be_false
+    end
+
+    it 'should send routing when given' do
+      stub_es_head('my_index', 'post', 1, true)
+      Post.in_index('my_index').routing('my_route').exists?(1)
+      last_request_uri.query.split('&').should include('routing=my_route')
+    end
+  end
+
+  describe '#elasticsearch_hit=' do
     context 'with full _source' do
       let :post do
         Post.new.tap do |post|
           post.elasticsearch_hit = {
             '_id' => '1',
             '_index' => 'my_index',
+            '_version' => 2,
             '_source' => {
               'title' => 'Testy time',
               'tags' => %w(search lucene),
@@ -494,6 +552,10 @@ describe Elastictastic::Document do
         post.index.name.should == 'my_index'
       end
 
+      it 'should populate version' do
+        post.version.should == 2
+      end
+
       it 'should mark document perisistent' do
         post.should be_persisted
       end