elastictastic 0.5.0

data/spec/examples/observing_spec.rb

@@ -0,0 +1,141 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Elastictastic::Observing do
+  include Elastictastic::TestHelpers
+
+  let(:id) { '123' }
+  let(:post) { Post.new }
+  let(:persisted_post) do
+    Post.new.tap do |post|
+      post.elasticsearch_hit = { '_id' => id, '_index' => 'default' }
+    end
+  end
+
+  before do
+    stub_elasticsearch_create('default', 'post')
+    stub_elasticsearch_update('default', 'post', id)
+    stub_elasticsearch_destroy('default', 'post', id)
+    Elastictastic.config.observers = [:post_observer]
+    Elastictastic.config.instantiate_observers
+  end
+
+  context 'on create' do
+    let(:observers) { post.observers_that_ran }
+
+    before do
+      post.save
+    end
+
+    it 'should run before_create' do
+      observers.should include(:before_create)
+    end
+
+    it 'should run after_create' do
+      observers.should include(:after_create)
+    end
+
+    it 'should run before_save' do
+      observers.should include(:before_save)
+    end
+
+    it 'should run after_save' do
+      observers.should include(:after_save)
+    end
+
+    it 'should not run before_update' do
+      observers.should_not include(:before_update)
+    end
+
+    it 'should not run after_update' do
+      observers.should_not include(:after_update)
+    end
+
+    it 'should not run before_destroy' do
+      observers.should_not include(:before_destroy)
+    end
+    
+    it 'should not run after_destroy' do
+      observers.should_not include(:after_destroy)
+    end
+  end
+
+  context 'on update' do
+    let(:observers) { persisted_post.observers_that_ran }
+
+    before do
+      persisted_post.save
+    end
+
+    it 'should not run before_create' do
+      observers.should_not include(:before_create)
+    end
+
+    it 'should not run after_create' do
+      observers.should_not include(:after_create)
+    end
+
+    it 'should run before_update' do
+      observers.should include(:before_update)
+    end
+
+    it 'should run after_update' do
+      observers.should include(:after_update)
+    end
+
+    it 'should run before_save' do
+      observers.should include(:before_save)
+    end
+
+    it 'should run after_save' do
+      observers.should include(:after_save)
+    end
+
+    it 'should not run before_destroy' do
+      observers.should_not include(:before_destroy)
+    end
+
+    it 'should not run after_destroy' do
+      observers.should_not include(:after_destroy)
+    end
+  end
+
+  context 'on destroy' do
+    let(:observers) { persisted_post.observers_that_ran }
+
+    before do
+      persisted_post.destroy
+    end
+
+    it 'should not run before_create' do
+      observers.should_not include(:before_create)
+    end
+
+    it 'should not run after_create' do
+      observers.should_not include(:after_create)
+    end
+
+    it 'should not run before_update' do
+      observers.should_not include(:before_update)
+    end
+
+    it 'should not run after_update' do
+      observers.should_not include(:after_update)
+    end
+
+    it 'should not run before_save' do
+      observers.should_not include(:before_save)
+    end
+
+    it 'should not run after_save' do
+      observers.should_not include(:after_save)
+    end
+
+    it 'should run before_destroy' do
+      observers.should include(:before_destroy)
+    end
+
+    it 'should run after_destroy' do
+      observers.should include(:after_destroy)
+    end
+  end
+end

data/spec/examples/parent_child_spec.rb

@@ -0,0 +1,308 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Elastictastic::ParentChild do
+  include Elastictastic::TestHelpers
+
+  describe 'mappings' do
+    it 'should put _parent in mapping' do
+      Post.mapping['post']['_parent'].should == { 'type' => 'blog' }
+    end
+  end
+
+  describe 'child instance' do
+    let(:post) { blog.posts.new }
+    let(:blog) do
+      stub_elasticsearch_create('default', 'blog')
+      Blog.new.tap { |blog| blog.save }
+    end
+
+    it 'should set parent' do
+      blog.posts.new.blog.should == blog
+    end
+
+    it 'should set parent when creating via class method' do
+      blog.posts.from_hash('title' => 'hey').blog.should == blog
+    end
+
+    describe 'discrete persistence' do
+      it 'should pass parent param on create' do
+        stub_elasticsearch_create('default', 'post')
+        post.save
+        URI.parse(FakeWeb.last_request.path).query.should == "parent=#{blog.id}"
+      end
+
+      it 'should pass parent param on update' do
+        stub_elasticsearch_create('default', 'post')
+        post.save
+        stub_elasticsearch_update('default', 'post', post.id)
+        post.save
+        URI.parse(FakeWeb.last_request.path).query.should == "parent=#{blog.id}"
+      end
+
+      it 'should pass parent on delete' do
+        stub_elasticsearch_create('default', 'post')
+        post = blog.posts.new
+        post.save
+        stub_elasticsearch_destroy('default', 'post', post.id)
+        post.destroy
+        URI.parse(FakeWeb.last_request.path).query.should == "parent=#{blog.id}"
+      end
+    end
+
+    describe 'bulk persistence' do
+      let(:bulk_requests) do
+        FakeWeb.last_request.body.split("\n").map do |line|
+          JSON.parse(line)
+        end
+      end
+
+      before do
+        stub_elasticsearch_bulk
+      end
+
+      it 'should pass parent param on create' do
+        post = blog.posts.new
+        Elastictastic.bulk { post.save }
+        bulk_requests.first.should == {
+          'create' => {
+            '_index' => 'default', '_type' => 'post', 'parent' => blog.id
+          }
+        }
+      end
+
+      it 'should pass parent param on update' do
+        post = blog.posts.new
+        post.id = '1'
+        post.persisted!
+        Elastictastic.bulk { post.save }
+        bulk_requests.first.should == {
+          'index' => {
+            '_index' => 'default',
+            '_type' => 'post',
+            '_id' => '1',
+            'parent' => blog.id
+          }
+        }
+      end
+
+      it 'should pass parent param on delete' do
+        post = blog.posts.new
+        post.id = '1'
+        post.persisted!
+        Elastictastic.bulk { post.destroy }
+        bulk_requests.first.should == {
+          'delete' => {
+            '_index' => 'default',
+            '_type' => 'post',
+            '_id' => '1',
+            'parent' => blog.id
+          }
+        }
+      end
+    end
+
+    it 'should set index' do
+      stub_elasticsearch_create('my_index', 'blog')
+      blog = Blog.in_index('my_index').new
+      blog.save
+      post = blog.posts.new
+      post.index.name.should == 'my_index'
+    end
+  end
+
+  describe 'collection proxies' do
+    let(:blog) do
+      stub_elasticsearch_create('my_index', 'blog')
+      Blog.in_index('my_index').new.tap { |blog| blog.save }
+    end
+    let(:posts) { blog.posts }
+
+    it 'should by default scope query to the parent' do
+      posts.params.should == { 'query' => { 'constant_score' => { 'filter' => { 'term' => { '_parent' => blog.id }}}}}
+    end
+
+    it 'should filter existing query' do
+      posts.query { query_string(:query => 'bacon') }.params['query'].should ==
+        {
+          'filtered' => {
+            'query' => { 'query_string' => { 'query' => 'bacon' }},
+            'filter' => { 'term' => { '_parent' => blog.id }}
+          }
+        }
+    end
+
+    it 'should retain other parts of scope' do
+      scope = posts.size(10)
+      scope.params['size'].should == 10
+    end
+
+    it 'should search correct index' do
+      stub_elasticsearch_scan('my_index', 'post', 100, { '_id' => '1' })
+      posts.to_a.first.id.should == '1'
+    end
+
+    it 'should set routing to parent ID on get' do
+      stub_elasticsearch_get('my_index', 'post', 1)
+      blog.posts.find(1)
+      URI.parse(FakeWeb.last_request.path).query.should == "routing=#{blog.id}"
+    end
+
+    it 'should set routing to parent ID on multiget' do
+      stub_elasticsearch_mget('my_index', 'post')
+      blog.posts.find(1, 2)
+      JSON.parse(FakeWeb.last_request.body).should == {
+        'docs' => [
+          { '_id' => 1, 'routing' => blog.id },
+          { '_id' => 2, 'routing' => blog.id }
+        ]
+      }
+    end
+
+    it 'should save transient instances when parent is saved' do
+      post = posts.new
+      stub_elasticsearch_update('my_index', 'blog', blog.id)
+      stub_elasticsearch_create('my_index', 'post')
+      blog.save
+      post.should be_persisted
+    end
+
+    it 'should not attempt to save transient instances that are pending for save in a bulk block' do
+      stub_elasticsearch_bulk(
+        { 'create' => { '_index' => 'my_index', '_type' => 'post', '_id' => '123', '_version' => 1, 'ok' => true }},
+        { 'index' => { '_index' => 'my_index', '_type' => 'blog', '_id' => blog.id, '_version' => 2, 'ok' => true }}
+      )
+      post = blog.posts.new
+      Elastictastic.bulk do
+        post.save
+        blog.save
+      end
+      request_statements =
+        FakeWeb.last_request.body.each_line.map { |line| JSON.parse(line) }
+      request_statements.length.should == 4
+    end
+
+    it 'should not save transient instances again' do
+      post = posts.new
+      stub_elasticsearch_update('my_index', 'blog', blog.id)
+      stub_elasticsearch_create('my_index', 'post')
+      blog.save
+      FakeWeb.clean_registry
+      stub_elasticsearch_update('my_index', 'blog', blog.id)
+      expect { blog.save }.to_not raise_error
+    end
+
+    it 'should populate parent when finding one' do
+      stub_elasticsearch_get('my_index', 'post', '1')
+      blog.posts.find('1').blog.should == blog
+    end
+
+    it 'should populate parent when finding many' do
+      stub_elasticsearch_mget('my_index', 'post', '1', '2')
+      blog.posts.find('1', '2').each do |post|
+        post.blog.should == blog
+      end
+    end
+
+    it 'should populate parent when retrieving first' do
+      stub_elasticsearch_search(
+        'my_index', 'post',
+        'total' => 1,
+        'hits' => { 'hits' => [{ '_id' => '2', 'index' => 'my_index', '_type' => 'post' }]}
+      )
+      blog.posts.first.blog.id.should == blog.id
+    end
+
+    it 'should populate parent when iterating over cursor' do
+      stub_elasticsearch_scan(
+        'my_index', 'post', 100,
+        '_id' => '1'
+      )
+      blog.posts.to_a.first.blog.should == blog
+    end
+
+    it 'should populate parent when paginating' do
+      stub_elasticsearch_search(
+        'my_index', 'post',
+        'hits' => {
+          'total' => 1,
+          'hits' => [{ '_id' => '1', '_type' => 'post', '_index' => 'my_index' }]
+        }
+      )
+      blog.posts.from(0).to_a.first.blog.should == blog
+    end
+
+    it 'should iterate over transient instances along with retrieved results' do
+      stub_elasticsearch_scan('my_index', 'post', 100, '_id' => '1')
+      post = blog.posts.new
+      posts = blog.posts.to_a
+      posts[0].id.should == '1'
+      posts[1].should == post
+    end
+
+    it 'should return transient instance as #first if no persisted results' do
+      stub_elasticsearch_search(
+        'my_index', 'post', 'hits' => { 'total' => 0, 'hits' => [] })
+      post = blog.posts.new
+      blog.posts.first.should == post
+    end
+
+    describe '#<<' do
+      let(:post) { Post.new }
+
+      before do
+        blog.posts << post
+      end
+
+      it 'should set parent of child object' do
+        post.blog.should == blog
+      end
+
+      it 'should not allow setting of a different parent' do
+        blog2 = Blog.new
+        expect { blog2.posts << post }.to raise_error(
+          Elastictastic::IllegalModificationError)
+      end
+
+      it 'should not allow setting of parent on already-persisted object' do
+        post = Post.new
+        post.persisted!
+        expect { blog.posts << post }.to raise_error(
+          Elastictastic::IllegalModificationError)
+      end
+    end
+  end
+
+  describe 'searching children directly' do
+    before do
+      stub_elasticsearch_search(
+        'default', 'post',
+        'hits' => {
+          'hits' => [
+            {
+              '_id' => '1', '_index' => 'default', '_type' => 'post',
+              '_source' => { 'title' => 'hey' },
+              'fields' => { '_parent' => '3' }
+            }
+          ]
+        }
+      )
+    end
+
+    let(:post) { Post.first }
+
+    it 'should provide access to parent' do
+      stub_elasticsearch_get('default', 'blog', '3')
+      post.blog.id.should == '3'
+    end
+
+    it 'should populate other fields from source' do
+      post.title.should == 'hey'
+    end
+
+    it 'should save post without dereferencing parent' do
+      stub_elasticsearch_update('default', 'post', post.id)
+      post.save
+      URI.parse(FakeWeb.last_request.path).query.should == 'parent=3'
+    end
+  end
+end

data/spec/examples/properties_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Elastictastic::Properties do
+  describe '::mapping' do
+    let(:mapping) { Post.mapping }
+    let(:properties) { mapping['post']['properties'] }
+
+    it 'should set basic field' do
+      properties.should have_key('title')
+    end
+
+    it 'should default type to string' do
+      properties['title']['type'].should == 'string'
+    end
+
+    it 'should force date format as date_time_no_millis' do
+      properties['published_at']['format'].should == 'date_time_no_millis'
+    end
+
+    it 'should accept options' do
+      properties['comments_count']['type'].should == 'integer'
+    end
+
+    it 'should set up multifield' do
+      properties['tags'].should == {
+        'type' => 'multi_field',
+        'fields' => {
+          'tags' => { 'type' => 'string', 'index' => 'analyzed' },
+          'non_analyzed' => { 'type' => 'string', 'index' => 'not_analyzed' }
+        }
+      }
+    end
+
+    it 'should map embedded object fields' do
+      properties['author']['properties']['id']['type'].should == 'integer'
+    end
+  end
+
+  describe '#elasticsearch_doc' do
+    let(:post) { Post.new }
+    let(:doc) { post.elasticsearch_doc }
+
+    it 'should return scalar properties' do
+      post.title = 'You know, for search.'
+      doc['title'].should == 'You know, for search.'
+    end
+
+    it 'should serialize dates to integers' do
+      time = Time.now
+      post.published_at = time
+      doc['published_at'].should == time.to_i * 1000 + time.usec / 1000
+    end
+
+    it 'should serialize an array of dates' do
+      time1, time2 = Time.now, Time.now + 60
+      post.published_at = [time1, time2]
+      doc['published_at'].should ==
+        [(time1.to_f * 1000).to_i, (time2.to_f * 1000).to_i]
+    end
+
+    it 'should not include unset values' do
+      doc.should_not have_key('title')
+    end
+
+    it 'should have embedded object properties' do
+      post.author = Author.new
+      post.author.name = 'Smedley Butler'
+      doc['author']['name'].should == 'Smedley Butler'
+    end
+
+    it 'should embed properties of arrays of embedded objects' do
+      authors = [Author.new, Author.new]
+      post.author = authors
+      authors[0].name = 'Smedley Butler'
+      authors[1].name = 'Harry S Truman'
+      doc['author'].should == [
+        { 'name' => 'Smedley Butler' },
+        { 'name' => 'Harry S Truman' }
+      ]
+    end
+
+    it 'should ignore missing embedded docs' do
+      doc.should_not have_key('author')
+    end
+  end
+
+  describe 'attributes' do
+    it 'should raise TypeError if improper type passed to embed setter' do
+      lambda { Post.new.author = Post.new }.should raise_error(TypeError)
+    end
+  end
+end