elasticsearch-model-extensions 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc9cef5c332c7100957fd86118f2bc7e3b441d1c
-  data.tar.gz: ca19391b4737aad8eeef5a31ce4f939bf41125a8
+  metadata.gz: 147bafb31fb754df6328f7fa3c2e27a5af454d06
+  data.tar.gz: dc047cf6c1423e9b3a45682737cee36869389f94
 SHA512:
-  metadata.gz: 6f33927f78adcf088dcd924a1961a131cd0d236db9fafc6be1fbc68a3d18788cdb4b0edd68dbd76e6261aed5dd39b844e533e1684ccbac6854350ee079ce43aa
-  data.tar.gz: eb90efb604e5244469a3b769d93f34ac1791240382686bd50ca8ce8db2c67f985cc15e3fe79962acbe1ff51fe68f51057aaa4809b14cca6c7ff58830e61fbe83
+  metadata.gz: 05d3f75d719269e736958c19e64cf3c19c16a3a89562f73e71c9c925023526dbc755487c67cd1d001ba2adc235ed765514f3dccd7d516641d3201c1c84ce8041
+  data.tar.gz: 33b5d02632d47fa7584ede224f6692c8f12604cd6f1ffff16c3d316e732fb4d26fef182ffc5cd1880b25e46860859b68915750540334f84e0e22163e1290f60e

data/.travis.yml

@@ -1,15 +1,20 @@
-bundler_args: --without development
+bundler_args: "--without development"
 language: ruby
 rvm:
-  - 2.1.2
-  - 2.1.3
-  - ruby-head
+- 2.1.2
+- 2.1.3
+- ruby-head
 matrix:
   allow_failures:
-    - rvm: ruby-head
+  - rvm: ruby-head
   fast_finish: true
 before_script:
-  - ls -la /usr/share/elasticsearch/bin/elasticsearch
-  - echo $PWD
+- ls -la /usr/share/elasticsearch/bin/elasticsearch
+- echo $PWD
 before_install: gem install bundler
-script: SERVER=launch TEST_CLUSTER_COMMAND=/usr/share/elasticsearch/bin/elasticsearch TEST_CLUSTER_PARAMS='-Des.default.path.conf=/etc/elasticsearch/ -Des.default.path.logs=/var/log/elasticsearch/' TEST_CLUSTER_PORT=19250 bundle exec rspec
+script: SERVER=launch TEST_CLUSTER_COMMAND=/usr/share/elasticsearch/bin/elasticsearch
+  TEST_CLUSTER_PARAMS='-Des.default.path.conf=/etc/elasticsearch/ -Des.default.path.logs=/var/log/elasticsearch/'
+  TEST_CLUSTER_PORT=19250 bundle exec rspec
+notifications:
+  slack:
+    secure: CjEsKopTHFKWCyouA988YJrtrqsPsCg4fFNrhuVNoOl8DRYC4D0FS/NwVKNEnchDjl9pz5YFkc5QCLaMGtG6ZgQVc9zdg0cDizbRIF9WI5ryOWamthvfdx54/EIJXtQxUTeono4SwieAkjXRGrWpNzdGxY4xs6Hdfwup/YYPdiI=

data/Gemfile

@@ -14,4 +14,5 @@ group :test, :development do
   gem 'sqlite3'
   gem 'elasticsearch-model'
   gem 'elasticsearch-extensions'
+  gem 'delayed_job_active_record', '~> 4.0.1'
 end

data/lib/elasticsearch/model/extensions/delayed_job/delete_document_job.rb

@@ -0,0 +1,23 @@
+require_relative 'document_job'
+
+module Elasticsearch
+  module Model
+    module Extensions
+      module DelayedJob
+
+        class DeleteDocumentJob < DocumentJob
+          def initialize(params)
+            super
+          end
+
+          def perform
+            try_with_record do |record|
+              record.__elasticsearch__.delete_document
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/model/extensions/delayed_job/document_job.rb

@@ -0,0 +1,56 @@
+require 'delayed_job'
+
+module Elasticsearch
+  module Model
+    module Extensions
+      module DelayedJob
+
+        class DocumentJob
+          def initialize(params)
+            record = params[:record]
+            @active_record = params[:active_record] || record.class
+            @id = params[:id] || record.id
+            @run_only_if = params[:run_only_if]
+          end
+
+          def max_attempts
+            10
+          end
+
+          def enqueue!
+            Delayed::Job.enqueue self
+          end
+
+          protected
+
+          def find_record_or_raise
+            @active_record.find(@id)
+          end
+
+          def record
+            begin
+              find_record_or_raise
+            rescue ActiveRecord::RecordNotFound => e
+              Rails.logger.info "#{self.class.name}: #{e.to_s}"
+              nil
+            end
+          end
+
+          def if_enabled_try_with_record(&block)
+            if @run_only_if.nil? || @run_only_if[0].send(@run_only_if[1])
+              try_with_record(&block)
+            end
+          end
+
+          def try_with_record
+            record.tap do |r|
+              yield r if r
+            end
+          end
+        end
+
+      end
+    end
+  end
+end
+

data/lib/elasticsearch/model/extensions/delayed_job/index_document_job.rb

@@ -0,0 +1,23 @@
+require_relative 'document_job'
+
+module Elasticsearch
+  module Model
+    module Extensions
+      module DelayedJob
+
+        class IndexDocumentJob < DocumentJob
+          def initialize(params)
+            super
+          end
+
+          def perform
+            try_with_record do |record|
+              record.__elasticsearch__.index_document
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/model/extensions/delayed_job/partially_update_document_job.rb

@@ -0,0 +1,24 @@
+require_relative 'document_job'
+
+module Elasticsearch
+  module Model
+    module Extensions
+      module DelayedJob
+
+        class PartiallyUpdateDocumentJob < DocumentJob
+          def initialize(params)
+            super(record: params[:record])
+            @changes = params[:changes]
+          end
+
+          def perform
+            try_with_record do |record|
+              record.partially_update_document(*@changes)
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/model/extensions/delayed_job.rb

@@ -0,0 +1,3 @@
+require_relative 'delayed_job/index_document_job'
+require_relative 'delayed_job/partially_update_document_job'
+require_relative 'delayed_job/delete_document_job'

data/lib/elasticsearch/model/extensions/version.rb

@@ -1,7 +1,7 @@
 module Elasticsearch
   module Model
     module Extensions
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/spec/integration_spec.rb

@@ -1,45 +1,75 @@
 require 'elasticsearch/model/extensions/all'
 
-RSpec.describe 'example' do
-  before :each do
-    ActiveRecord::Schema.define(:version => 1) do
-      create_table :articles do |t|
-        t.string :title
-        t.datetime :created_at, :default => 'NOW()'
-      end
+RSpec.shared_examples 'a normal elasticsearch-model object' do
+  describe 'a record creation' do
+    before(:each) do
+      ::Article.create(title: 'foo', created_at: Time.now)
+
+      ::Article.__elasticsearch__.refresh_index!
+    end
+
+    it 'makes the document searchable' do
+      expect(Article.search('foo').records.size).to eq(1)
     end
+  end
 
-    class ::Article < ActiveRecord::Base
-      include Elasticsearch::Model
-      include Elasticsearch::Model::Callbacks
+  describe 'a record update' do
+    before(:each) do
+      Article.first.update_attributes title: 'Test2'
 
-      settings index: {number_of_shards: 1, number_of_replicas: 0} do
-        mapping do
-          indexes :title, type: 'string', analyzer: 'snowball'
-          indexes :created_at, type: 'date'
-        end
-      end
+      Article.__elasticsearch__.refresh_index!
     end
 
-    Article.delete_all
-    Article.__elasticsearch__.create_index! force: true
+    it 'makes the document unsearchable using the old content' do
+      expect(Article.search('Test').records.size).to eq(0)
+    end
+
+    it 'makes the document searchable using the new content' do
+      expect(Article.search('Test2').records.size).to eq(1)
+    end
+  end
+
+  describe 'a record deletion' do
+    before(:each) do
+      Article.first.destroy
 
-    ::Article.create! title: 'Test'
-    ::Article.create! title: 'Testing Coding'
-    ::Article.create! title: 'Coding'
+      Article.__elasticsearch__.refresh_index!
+    end
 
-    Article.__elasticsearch__.refresh_index!
+    it 'makes the document unsearchable' do
+      expect(Article.search('Test').records.size).to eq(0)
+    end
   end
+end
+
+RSpec.describe 'integration' do
+  context 'with articles' do
+    before :each do
+      load 'setup/articles.rb'
+    end
 
-  after :each do
-    ActiveRecord::Schema.define(:version => 2) do
-      drop_table :articles
+    after :each do
+      ActiveRecord::Schema.define(:version => 2) do
+        drop_table :articles
+      end
     end
+
+    it_behaves_like 'a normal elasticsearch-model object'
   end
 
-  subject {
-    ::Article.create(title: 'foo', created_at: Time.now)
-  }
+  context 'with articles_with_comments_and_delayed_jobs' do
+    before(:each) do
+      load 'setup/articles_with_comments_and_delayed_jobs.rb'
+    end
 
-  it { is_expected.not_to be_nil }
+    after(:each) do
+      ActiveRecord::Schema.define(:version => 2) do
+        drop_table :articles
+        drop_table :comments
+        drop_table :delayed_jobs
+      end
+    end
+
+    it_behaves_like 'a normal elasticsearch-model object'
+  end
 end

data/spec/outer_document_updating_spec.rb

@@ -1,17 +1,6 @@
 require 'elasticsearch/model/extensions/all'
 
-RSpec.describe Elasticsearch::Model::Extensions::OuterDocumentUpdating do
-  before(:each) do
-    load 'setup/articles_with_comments.rb'
-  end
-
-  after :each do
-    ActiveRecord::Schema.define(:version => 2) do
-      drop_table :comments
-      drop_table :articles
-    end
-  end
-
+RSpec.shared_examples 'a document updates outer documents on changed' do
   describe 'an article' do
     def article
       ::Article.search('Comment1').records.first
@@ -30,6 +19,22 @@ RSpec.describe Elasticsearch::Model::Extensions::OuterDocumentUpdating do
       }
     end
 
+    context 'with a comment updated' do
+      before(:each) do
+        article.comments.first.update_attributes body: 'Comment3'
+
+        Article.__elasticsearch__.refresh_index!
+      end
+
+      specify {
+        expect(Article.search('Comment1').records.first).to be_nil
+      }
+
+      specify {
+        expect(Article.search('Comment3').records.first).not_to be_nil
+      }
+    end
+
     context 'when a comment destroyed' do
       before(:each) do
         article.comments.first.destroy
@@ -47,3 +52,36 @@ RSpec.describe Elasticsearch::Model::Extensions::OuterDocumentUpdating do
     end
   end
 end
+
+RSpec.describe Elasticsearch::Model::Extensions::OuterDocumentUpdating do
+  context 'having articles with comments' do
+    before(:each) do
+      load 'setup/articles_with_comments.rb'
+    end
+
+    after :each do
+      ActiveRecord::Schema.define(:version => 2) do
+        drop_table :comments
+        drop_table :articles
+      end
+    end
+
+    it_behaves_like 'a document updates outer documents on changed'
+  end
+
+  context 'having articles with comments and delayed jobs' do
+    before(:each) do
+      load 'setup/articles_with_comments_and_delayed_jobs.rb'
+    end
+
+    after :each do
+      ActiveRecord::Schema.define(:version => 2) do
+        drop_table :comments
+        drop_table :articles
+        drop_table :delayed_jobs
+      end
+    end
+
+    it_behaves_like 'a document updates outer documents on changed'
+  end
+end

data/spec/setup/articles.rb

@@ -0,0 +1,29 @@
+load 'setup/undefine.rb'
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :articles do |t|
+    t.string :title
+    t.datetime :created_at, :default => 'NOW()'
+  end
+end
+
+class ::Article < ActiveRecord::Base
+  include Elasticsearch::Model
+  include Elasticsearch::Model::Callbacks
+
+  settings index: {number_of_shards: 1, number_of_replicas: 0} do
+    mapping do
+      indexes :title, type: 'string', analyzer: 'snowball'
+      indexes :created_at, type: 'date'
+    end
+  end
+end
+
+Article.delete_all
+Article.__elasticsearch__.create_index! force: true
+
+::Article.create! title: 'Test'
+::Article.create! title: 'Testing Coding'
+::Article.create! title: 'Coding'
+
+Article.__elasticsearch__.refresh_index!

data/spec/setup/articles_with_comments.rb

@@ -1,3 +1,5 @@
+load 'setup/undefine.rb'
+
 require 'elasticsearch/model/extensions/all'
 
 ActiveRecord::Schema.define(:version => 1) do

data/spec/setup/articles_with_comments_and_delayed_jobs.rb

@@ -0,0 +1,90 @@
+load 'setup/undefine.rb'
+
+require 'elasticsearch/model/extensions/all'
+require 'elasticsearch/model/extensions/delayed_job'
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :articles do |t|
+    t.string :title
+    t.datetime :created_at, :default => 'NOW()'
+  end
+
+  create_table :comments do |t|
+    t.integer :article_id
+    t.string :body
+    t.datetime :created_at, :default => 'NOW()'
+  end
+
+  create_table :delayed_jobs, :force => true do |table|
+    table.integer  :priority, :default => 0
+    table.integer  :attempts, :default => 0
+    table.text     :handler
+    table.text     :last_error
+    table.datetime :run_at
+    table.datetime :locked_at
+    table.datetime :failed_at
+    table.string   :locked_by
+    table.string   :queue
+    table.timestamps
+  end
+end
+
+Delayed::Worker.delay_jobs = false
+
+class ::Article < ActiveRecord::Base
+  has_many :comments
+
+  accepts_nested_attributes_for :comments
+
+  include Elasticsearch::Model
+  include Elasticsearch::Model::Callbacks
+  include Elasticsearch::Model::Extensions::IndexOperations
+  include Elasticsearch::Model::Extensions::BatchUpdating
+  include Elasticsearch::Model::Extensions::PartialUpdating
+
+  DEPENDENT_CUSTOM_ATTRIBUTES = {
+    %w| comments | => %w| num_comments |
+  }
+
+  include Elasticsearch::Model::Extensions::DependencyTracking
+
+  settings index: {number_of_shards: 1, number_of_replicas: 0} do
+    mapping do
+      indexes :title, type: 'string', analyzer: 'snowball'
+      indexes :created_at, type: 'date'
+      indexes :comments, type: 'object' do
+        indexes :body, type: 'string', include_in_all: true
+      end
+      indexes :num_comments, type: 'long'
+    end
+  end
+
+  def num_comments
+    comments.count
+  end
+
+  # Required by Comment's `OuterDocumentUpdating`
+  include Elasticsearch::Model::Extensions::MappingReflection
+end
+
+class ::Comment < ActiveRecord::Base
+  include Elasticsearch::Model
+  include Elasticsearch::Model::Callbacks
+  include Elasticsearch::Model::Extensions::IndexOperations
+  include Elasticsearch::Model::Extensions::BatchUpdating
+  include Elasticsearch::Model::Extensions::PartialUpdating
+  include Elasticsearch::Model::Extensions::OuterDocumentUpdating
+
+  partially_updates_document_of ::Article, records_to_update_documents: -> comment { Article.find(comment.article_id) } do |t, changed_fields|
+    Elasticsearch::Model::Extensions::DelayedJob::PartiallyUpdateDocumentJob.new(record: t, changes: changed_fields).enqueue!
+  end
+end
+
+Article.delete_all
+Article.__elasticsearch__.create_index! force: true
+
+::Article.create! title: 'Test'
+::Article.create! title: 'Testing Coding'
+::Article.create! title: 'Coding', comments_attributes: [{ body: 'Comment1' }]
+
+Article.__elasticsearch__.refresh_index!

data/spec/setup/undefine.rb

@@ -0,0 +1,7 @@
+if defined? ::Article
+  Object.send(:remove_const, :Article)
+end
+
+if defined? ::Comment
+  Object.send(:remove_const, :Comment)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-model-extensions
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yusuke KUOKA
@@ -59,6 +59,11 @@ files:
 - lib/elasticsearch/model/extensions/batch_updating.rb
 - lib/elasticsearch/model/extensions/callback.rb
 - lib/elasticsearch/model/extensions/configuration.rb
+- lib/elasticsearch/model/extensions/delayed_job.rb
+- lib/elasticsearch/model/extensions/delayed_job/delete_document_job.rb
+- lib/elasticsearch/model/extensions/delayed_job/document_job.rb
+- lib/elasticsearch/model/extensions/delayed_job/index_document_job.rb
+- lib/elasticsearch/model/extensions/delayed_job/partially_update_document_job.rb
 - lib/elasticsearch/model/extensions/dependency_tracking.rb
 - lib/elasticsearch/model/extensions/destroy_callback.rb
 - lib/elasticsearch/model/extensions/index_operations.rb
@@ -73,11 +78,14 @@ files:
 - spec/integration_spec.rb
 - spec/outer_document_updating_spec.rb
 - spec/partial_updating_spec.rb
+- spec/setup/articles.rb
 - spec/setup/articles_with_comments.rb
+- spec/setup/articles_with_comments_and_delayed_jobs.rb
 - spec/setup/elasticsearch/model.rb
 - spec/setup/elasticsearch/start.rb
 - spec/setup/elasticsearch/stop.rb
 - spec/setup/sqlite.rb
+- spec/setup/undefine.rb
 - spec/spec_helper.rb
 homepage: https://github.com/crowdworks/elasticsearch-model-extensions
 licenses:
@@ -110,10 +118,12 @@ test_files:
 - spec/integration_spec.rb
 - spec/outer_document_updating_spec.rb
 - spec/partial_updating_spec.rb
+- spec/setup/articles.rb
 - spec/setup/articles_with_comments.rb
+- spec/setup/articles_with_comments_and_delayed_jobs.rb
 - spec/setup/elasticsearch/model.rb
 - spec/setup/elasticsearch/start.rb
 - spec/setup/elasticsearch/stop.rb
 - spec/setup/sqlite.rb
+- spec/setup/undefine.rb
 - spec/spec_helper.rb
-has_rdoc: