elastictastic 0.5.0

data/spec/examples/bulk_persistence_strategy_spec.rb

@@ -0,0 +1,233 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Elastictastic::BulkPersistenceStrategy do
+  include Elastictastic::TestHelpers
+
+  let(:last_request) { FakeWeb.last_request }
+  let(:bulk_requests) do
+    last_request.body.split("\n").map do |request|
+      JSON.parse(request)
+    end
+  end
+
+  describe 'create without ID' do
+    let(:post) { Post.new }
+
+    before do
+      stub_elasticsearch_bulk(
+        'create' => { '_index' => 'default', '_type' => 'post', '_id' => '123', '_version' => 1, 'ok' => true }
+      )
+      Elastictastic.bulk do
+        post.title = 'Bulky'
+        post.save
+      end
+    end
+
+    it 'should send bulk request' do
+      last_request.path.should == '/_bulk'
+    end
+
+    it 'should send index operation' do
+      bulk_requests.should == [
+        { 'create' => { '_index' => 'default', '_type' => 'post' }},
+        post.elasticsearch_doc
+      ]
+    end
+
+    it 'should set ID' do
+      post.id.should == '123'
+    end
+
+    it 'should set persisted' do
+      post.should be_persisted
+    end
+
+    it 'should have final newline' do
+      last_request.body[-1].should == "\n"
+    end
+  end
+
+  describe 'before bulk operation completes' do
+    let(:post) { Post.new }
+
+    around do |example|
+      Elastictastic.bulk do
+        example.run
+        # have to do this here because the before/after hooks run inside the
+        # around hook
+        stub_elasticsearch_bulk(
+          'create' => { '_index' => 'default', '_type' => 'post', '_id' => '123', '_version' => 1, 'ok' => true }
+        )
+      end
+    end
+
+    it 'should not set ID' do
+      post.save
+      post.id.should be_nil
+    end
+
+    it 'should not set persisted' do
+      post.should be_transient
+    end
+
+    it 'should not allow you to call save again on transient document' do
+      post.save
+      expect { post.save }.to raise_error(Elastictastic::OperationNotAllowed)
+    end
+  end
+
+  describe 'creating multiple' do
+    let(:posts) { Array.new(2) { Post.new }}
+
+    before do
+      stub_elasticsearch_bulk(
+        { 'create' => { '_index' => 'default', '_type' => 'post', '_id' => '123', '_version' => 1, 'ok' => true }},
+        { 'create' => { '_index' => 'default', '_type' => 'post', '_id' => '124', '_version' => 1, 'ok' => true }}
+      )
+      Elastictastic.bulk { posts.each { |post| post.save }}
+    end
+
+    it 'should send both create operations' do
+      bulk_requests.should == posts.map do |post|
+        [
+          { 'create' => { '_index' => 'default', '_type' => 'post' }},
+          post.elasticsearch_doc
+        ]
+      end.flatten
+    end
+
+    it 'should set IDs' do
+      posts.map { |post| post.id }.should == %w(123 124)
+    end
+  end
+
+  describe 'create with ID set' do
+    let(:post) do
+      Post.new.tap do |post|
+        post.id = '123'
+        post.title = 'bulky'
+      end
+    end
+
+    before do
+      stub_elasticsearch_bulk(
+        'create' => { '_index' => 'default', '_type' => 'post', '_id' => '123', '_version' => 1, 'ok' => true }
+      )
+      Elastictastic.bulk { post.save }
+    end
+
+    it 'should send ID in request to create' do
+      bulk_requests.should == [
+        { 'create' => { '_index' => 'default', '_type' => 'post', '_id' => '123' }},
+        post.elasticsearch_doc
+      ]
+    end
+
+    it 'should set object persistent' do
+      post.should be_persisted
+    end
+
+    it 'should retain ID' do
+      post.id.should == '123'
+    end
+  end
+
+  describe '#update' do
+    let(:post) do
+      Post.new.tap do |post|
+        post.id = '123'
+        post.persisted!
+      end
+    end
+
+    before do
+      stub_elasticsearch_bulk(
+        'index' => { '_index' => 'default', '_type' => 'post', '_id' => '123', '_version' => 1, 'ok' => true }
+      )
+    end
+
+    it 'should send update' do
+      Elastictastic.bulk { post.save }
+
+      bulk_requests.should == [
+        { 'index' => { '_index' => 'default', '_type' => 'post', '_id' => '123' }},
+        post.elasticsearch_doc
+      ]
+    end
+  end
+
+  describe 'destroy' do
+    let(:post) do
+      Post.new.tap do |post|
+        post.id = '123'
+        post.title = 'bulky'
+        post.persisted!
+      end
+    end
+
+    before do
+      stub_elasticsearch_bulk(
+        'destroy' => { '_index' => 'default', '_type' => 'post', '_id' => '123', '_version' => 1, 'ok' => true }
+      )
+      Elastictastic.bulk { post.destroy }
+    end
+
+    it 'should send destroy' do
+      bulk_requests.should == [
+        { 'delete' => { '_index' => 'default', '_type' => 'post', '_id' => '123' }}
+      ]
+    end
+
+    it 'should mark record as not persistent' do
+      post.should_not be_persisted
+    end
+  end
+
+  shared_examples_for 'block with error' do
+    it 'should not run bulk operation' do
+      error_proc.call rescue nil
+      last_request.should_not be
+    end
+
+    it 'should return to individual persistence strategy' do
+      error_proc.call rescue nil
+      stub_elasticsearch_create('default', 'post')
+      Post.new.save
+      last_request.path.should == '/default/post'
+    end
+  end
+
+  describe 'with uncaught exception raised' do
+    let :error_proc  do
+      lambda do
+        Elastictastic.bulk do
+          Post.new.save
+          raise
+        end
+      end
+    end
+
+    it 'should propagate error up' do
+      expect(&error_proc).to raise_error(RuntimeError)
+    end
+
+    it_should_behave_like 'block with error'
+  end
+
+  describe 'raising CancelBulkOperation' do
+    let :error_proc do
+      lambda do
+        Elastictastic.bulk do
+          Post.new.save
+          raise Elastictastic::CancelBulkOperation
+        end
+      end
+    end
+
+    it 'should not propagate error' do
+      expect(&error_proc).not_to raise_error
+    end
+
+    it_should_behave_like 'block with error'
+  end
+end

data/spec/examples/callbacks_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Elastictastic::Callbacks do
+  include Elastictastic::TestHelpers
+
+  let(:MyModel) do
+    Class.new do
+      def self.name
+        'MyModel'
+      end
+
+      include Elastictastic::Document
+
+      before_save :before_save_ran!
+      before_create :before_create_ran!
+      before_update :before_update_ran!
+      before_destroy :before_destroy_ran!
+      
+      def hooks_that_ran
+        @hooks_that_ran ||= Set[]
+      end
+
+      def has_run_hook?(hook)
+        hooks_that_ran.include?(hook.to_sym)
+      end
+
+      private
+
+      def method_missing(method, *args, &block)
+        if method.to_s =~ /^(.*)_ran!$/
+          hooks_that_ran << $1.to_sym
+        else
+          super
+        end
+      end
+    end
+  end
+
+  let(:id) { '123' }
+  let(:instance) { MyModel().new }
+  let(:persisted_instance) do
+    MyModel().new.tap do |instance|
+      instance.elasticsearch_hit = { '_id' => id, '_index' => 'default' }
+    end
+  end
+
+  before do
+    stub_elasticsearch_create('default', 'my_model')
+    stub_elasticsearch_update('default', 'my_model', id)
+    stub_elasticsearch_destroy('default', 'my_model', id)
+  end
+
+  describe '#before_save' do
+
+    it 'should run before create' do
+      instance.save
+      instance.should have_run_hook(:before_save)
+    end
+
+    it 'should run before update' do
+      persisted_instance.save
+      persisted_instance.should have_run_hook(:before_save)
+    end
+  end
+
+  describe '#before_create' do
+    it 'should run before create' do
+      instance.save
+      instance.should have_run_hook(:before_create)
+    end
+
+    it 'should run before update' do
+      persisted_instance.save
+      persisted_instance.should_not have_run_hook(:before_create)
+    end
+  end
+
+  describe '#before_update' do
+    it 'should not run before create' do
+      instance.save
+      instance.should_not have_run_hook :before_update
+    end
+
+    it 'should run before update' do
+      persisted_instance.save
+      persisted_instance.should have_run_hook(:before_update)
+    end
+  end
+
+  describe '#before_destroy' do
+    it 'should run before destroy' do
+      persisted_instance.destroy
+      persisted_instance.should have_run_hook(:before_destroy)
+    end
+  end
+end

data/spec/examples/dirty_spec.rb

@@ -0,0 +1,238 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Elastictastic::Dirty do
+  include Elastictastic::TestHelpers
+
+  let(:post) do
+    Post.new.tap do |post|
+      post.elasticsearch_hit = {
+        '_id' => '1',
+        '_type' => 'post',
+        '_index' => 'default',
+        '_source' => source
+      }
+    end
+  end
+
+  before do
+    stub_elasticsearch_update('default', 'post', '1')
+  end
+
+  context 'top-level attribute' do
+    let(:source) { { 'title' => 'first title' } }
+
+    context 'with no attribute changed' do
+      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 'with title attribute changed' do
+      before do
+        post.title = 'hey guy'
+      end
+
+      it 'should be changed' do
+        post.should be_changed
+      end
+
+      it 'should expose change' do
+        post.changes[:title].should == ['first title', 'hey guy']
+      end
+
+      it 'should have the title attribute changed' do
+        post.should be_title_changed
+      end
+    end
+
+    context 'after change and save' do
+      before do
+        post.title = 'hey guy'
+        post.save
+      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
+  end
+
+  context 'single nested document' do
+    let(:source) { { 'author' => { 'name' => 'Mat Brown' }} }
+
+    context 'with nothing changed' do
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+    end
+
+    context 'with nested document attribute changed' do
+      before do
+        post.author.name = 'Barack Obama'
+      end
+
+      it 'should be changed' do
+        post.should be_changed
+      end
+
+      it 'should mark association as changed' do
+        post.changed.should == %w(author)
+      end
+
+      it 'should return *_changed? for the association' do
+        post.should be_author_changed
+      end
+
+      it 'should have change' do
+        change = post.changes['author']
+        change.map { |author| author.name }.should == ['Mat Brown', 'Barack Obama']
+      end
+
+      it 'should not be changed after save' do
+        post.save
+        post.should_not be_changed
+      end
+
+      it 'should not have changed nested document after save' do
+        post.save
+        post.author.should_not be_changed
+      end
+    end
+
+    context 'with nested document replaced' do
+      before do
+        post.author = Author.new(:name => 'Barack Obama')
+      end
+
+      it 'should be changed' do
+        post.should be_changed
+      end
+
+      it 'should expose changes' do
+        post.changes['author'].map { |author| author.name }.should ==
+          ['Mat Brown', 'Barack Obama']
+      end
+    end
+  end
+
+  context 'nested document collection' do
+    let(:source) { { 'comments' => [{ 'body' => 'I like pizza' }] } }
+
+    let(:mapped_changes) do
+      post.changes['comments'].map do |change|
+        change.map { |comment| comment.body }
+      end
+    end
+
+    context 'with nothing changed' do
+      it 'should not be changed' do
+        post.should_not be_changed
+      end
+    end
+
+    context 'when document changed' do
+      before do
+        post.comments.first.body = 'I like lasagne'
+      end
+
+      it 'should be changed' do
+        post.should be_changed
+      end
+
+      it 'should expose changed document' do
+        mapped_changes.should == [['I like pizza'], ['I like lasagne']]
+      end
+
+      it 'should not be changed after save' do
+        post.save
+        post.should_not be_changed
+      end
+
+      it 'should not have changed nested document after save' do
+        post.save
+        post.comments.first.should_not be_changed
+      end
+    end
+
+    context 'when document added' do
+      before do
+        post.comments << Comment.new(:body => 'Lasagne is better')
+      end
+
+      it 'should be changed' do
+        post.should be_changed
+      end
+
+      it 'should expose new document' do
+        mapped_changes.should == [
+          ['I like pizza'],
+          ['I like pizza', 'Lasagne is better']
+        ]
+      end
+
+      it 'should not be changed after save' do
+        post.save
+        post.should_not be_changed
+      end
+
+      it 'should not have changed nested documents after save' do
+        post.save
+        post.comments.each { |comment| comment.should_not be_changed }
+      end
+    end
+
+    context 'when document removed' do
+      before do
+        post.comments.delete(post.comments.first)
+      end
+
+      it 'should be changed' do
+        post.should be_changed
+      end
+
+      it 'should show changes' do
+        mapped_changes.should == [['I like pizza'], []]
+      end
+
+      it 'should not be changed after save' do
+        post.save
+        post.should_not be_changed
+      end
+    end
+
+    context 'with collection replaced' do
+      before do
+        post.comments = [Comment.new(:body => 'I like lasagne')]
+      end
+
+      it 'should be changed' do
+        post.should be_changed
+      end
+
+      it 'should expose changes' do
+        mapped_changes.should == [['I like pizza'], ['I like lasagne']]
+      end
+
+      it 'should not be changed after save' do
+        post.save
+        post.should_not be_changed
+      end
+    end
+  end
+end