elasticsearch-model-extensions 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a5e049bad3147441c538c4b369b93d438dc431c
-  data.tar.gz: 93cee441524ba5c0dcfc77e1c4024fe53be31371
+  metadata.gz: bc9cef5c332c7100957fd86118f2bc7e3b441d1c
+  data.tar.gz: ca19391b4737aad8eeef5a31ce4f939bf41125a8
 SHA512:
-  metadata.gz: a34d4689f80a8676ca79f4bd522c45b8d9f044ecf13fe541632e5bcfb120d220bbca7a75c63648c46e2791d8843316a22799957360d512cd9172776bb386977c
-  data.tar.gz: 34b1d5ce206560036aad88adcc71833292f4bf7ae0d53a56a941939f09cb70323852ed7d58829b3a89ce884f900d10ff2d46e2f23f14e70d61a23b4bf6ea84dd
+  metadata.gz: 6f33927f78adcf088dcd924a1961a131cd0d236db9fafc6be1fbc68a3d18788cdb4b0edd68dbd76e6261aed5dd39b844e533e1684ccbac6854350ee079ce43aa
+  data.tar.gz: eb90efb604e5244469a3b769d93f34ac1791240382686bd50ca8ce8db2c67f985cc15e3fe79962acbe1ff51fe68f51057aaa4809b14cca6c7ff58830e61fbe83

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,15 @@
+bundler_args: --without development
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.1.3
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+before_script:
+  - 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

data/Gemfile

@@ -5,7 +5,13 @@ gemspec
 
 group :test do
   gem 'rspec', '~> 3.1.0'
+  gem 'database_cleaner'
+  gem 'coveralls', require: false
+end
+
+group :test, :development do
   gem 'activerecord', '~> 3.2'
   gem 'sqlite3'
   gem 'elasticsearch-model'
+  gem 'elasticsearch-extensions'
 end

data/README.md

@@ -1,5 +1,9 @@
 # Elasticsearch::Model::Extensions
 
+[![Build Status](https://travis-ci.org/crowdworks/elasticsearch-model-extensions.svg?branch=master)](https://travis-ci.org/crowdworks/elasticsearch-model-extensions)
+[![Coverage Status](https://coveralls.io/repos/crowdworks/elasticsearch-model-extensions/badge.png)](https://coveralls.io/r/crowdworks/elasticsearch-model-extensions)
+[![Code Climate](https://codeclimate.com/github/crowdworks/elasticsearch-model-extensions/badges/gpa.svg)](https://codeclimate.com/github/crowdworks/elasticsearch-model-extensions)
+
 TODO: Write a gem description
 
 ## Installation
@@ -22,6 +26,14 @@ Or install it yourself as:
 
 TODO: Write usage instructions here
 
+## Running examples
+
+With Elasticsearch installed, you can run examples configured with an ES instance started on the port 9250 and AR connected to sqlite:
+
+    $ bundle exec irb -I spec -r example/articles_with_comments
+    (A bunch of log output here)
+    irb(main):001:0> Article.search('Comment1')
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/elasticsearch-model-extensions/fork )

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

@@ -92,7 +92,11 @@ module Elasticsearch
               one_or_more_errors_occurred = response["errors"]
 
               if one_or_more_errors_occurred
-                Rails.logger.warn "One or more error(s) occurred while updating the index #{records} for the type #{type}\n#{JSON.pretty_generate(response)}"
+                if defined? ::Rails
+                  ::Rails.logger.warn "One or more error(s) occurred while updating the index #{records} for the type #{type}\n#{JSON.pretty_generate(response)}"
+                else
+                  warn "One or more error(s) occurred while updating the index #{records} for the type #{type}\n#{JSON.pretty_generate(response)}"
+                end
               end
             else
               records.each do |r|

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

@@ -4,7 +4,7 @@ module Elasticsearch
       class Configuration
         attr_reader :delayed
 
-        def initialize(active_record_class, parent_class: parent_class, delayed:, only_if: -> r { true }, records_to_update_documents: nil, field_to_update: nil)
+        def initialize(active_record_class, parent_class: parent_class, delayed:, only_if: -> r { true }, records_to_update_documents: nil, field_to_update: nil, block: nil)
           @delayed = @delayed
 
           @active_record_class = active_record_class
@@ -12,6 +12,7 @@ module Elasticsearch
           @if = binding.local_variable_get(:only_if)
           @records_to_update_documents = records_to_update_documents
           @field_to_update = field_to_update
+          @block = block
         end
 
         def to_hash
@@ -34,6 +35,10 @@ module Elasticsearch
           -> t { delayed ? t.delay : t }
         end
 
+        def block
+          to_hash[:block]
+        end
+
         private
 
         def build_hash
@@ -65,10 +70,18 @@ module Elasticsearch
 
           only_if, records_to_update_documents = update_strategy.apply
 
+          # The default block used to trigger partial updating on the parent document.
+          # Replace this by specifying `block` parameter to a configuration like `Configuration.new(block: BLOCK)`
+          # when more fine-grained controls over it like feature-toggling, graceful-degradation are required.
+          default_partial_updating_block = -> t, field_to_update {
+            t.partially_update_document(field_to_update)
+          }
+
           {
             field_to_update: field_to_update,
             records_to_update_documents: @records_to_update_documents || records_to_update_documents,
-            only_if: -> r { custom_if.call(r) && only_if.call(r) }
+            only_if: -> r { custom_if.call(r) && only_if.call(r) },
+            block: @block || default_partial_updating_block
           }
         end
       end

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

@@ -9,6 +9,7 @@ module Elasticsearch
           records_to_update_documents = config.records_to_update_documents
           optionally_delayed = config.optionally_delayed
           only_if = config.only_if
+          block = config.block
 
           record.instance_eval do
             return unless only_if.call(self)
@@ -17,7 +18,7 @@ module Elasticsearch
 
             if target.respond_to? :each
               target.map(&:reload).map(&optionally_delayed).each do |t|
-                t.partially_update_document(field_to_update)
+                block.call(t, [*field_to_update])
               end
             else
               optionally_delayed.call(target.reload).partially_update_document(field_to_update)

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

@@ -39,7 +39,14 @@ module Elasticsearch
               records_to_update_documents = begin
                 child_to_parent_path = Elasticsearch::Model::Extensions::OuterDocumentUpdating::ClassMethods::AssociationTraversal.shortest_path(from: child_class, to: parent_class)
 
-                -> updated_record { child_to_parent_path.inject(updated_record) { |d, parent_association| d.send parent_association } }
+                -> updated_record {
+                  if child_to_parent_path.nil?
+                    warn "Couldn't automatically determine the path from the class `#{child_class}` to `#{parent_class}." +
+                            "Use `partially_updates_document_of parent_class, records_to_update_documents: -> child { ... }` to specify it."
+                  end
+
+                  child_to_parent_path.inject(updated_record) { |d, parent_association| d.send parent_association }
+                }
               end
 
               [only_if, records_to_update_documents]
@@ -104,15 +111,17 @@ module Elasticsearch
               first
           end
 
-          def initialize_active_record!(active_record_class, parent_class: parent_class, delayed:, only_if: -> r { true }, records_to_update_documents: nil, field_to_update: nil)
+          def initialize_active_record!(active_record_class, parent_class: parent_class, delayed:, only_if: -> r { true }, records_to_update_documents: nil, field_to_update: nil, block: block)
             config = Elasticsearch::Model::Extensions::Configuration.new(active_record_class, parent_class: parent_class, delayed: delayed, only_if: binding.local_variable_get(:only_if), records_to_update_documents: records_to_update_documents,
-            field_to_update: field_to_update)
+              field_to_update: field_to_update,
+              block: block
+            )
 
             active_record_class.after_commit Elasticsearch::Model::Extensions::UpdateCallback.new(config)
             active_record_class.after_commit Elasticsearch::Model::Extensions::DestroyCallback.new(config), on: :destroy
           end
 
-          def partially_updates_document_of(parent_class, options)
+          def partially_updates_document_of(parent_class, options, &block)
             options ||= {}
             delayed = options[:delayed] || nil
             only_if = options[:if] || (-> r { true })
@@ -125,7 +134,8 @@ module Elasticsearch
               :delayed => delayed,
               :only_if => only_if,
               :field_to_update => field_to_update,
-              :records_to_update_documents => records_to_update_documents
+              :records_to_update_documents => records_to_update_documents,
+              :block => block
             )
           end
 

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

@@ -16,7 +16,9 @@ module Elasticsearch
           method_attributes = indexed_attributes - persisted_attributes - nested_attributes
           only_attributes = indexed_attributes - nested_attributes
 
-          options = {}
+          options = {
+            root: false
+          }
 
           if only_attributes.size > 1
             options[:only] = only_attributes
@@ -75,7 +77,11 @@ module Elasticsearch
             begin
               partial_document = build_partial_document_for_update(*changed_attributes)
             rescue => e
-              Rails.logger.error "Error in #partially_update_document: #{e.message}\n#{e.backtrace.join("\n")}"
+              if defined? ::Rails
+                ::Rails.logger.error "Error in #partially_update_document: #{e.message}\n#{e.backtrace.join("\n")}"
+              else
+                warn "Error in #partially_update_document: #{e.message}\n#{e.backtrace.join("\n")}"
+              end
             end
 
             update_document(partial_document)

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

@@ -9,6 +9,7 @@ module Elasticsearch
           records_to_update_documents = config.records_to_update_documents
           optionally_delayed = config.optionally_delayed
           only_if = config.only_if
+          block = config.block
 
           record.instance_eval do
             return unless only_if.call(self) && index_update_required?
@@ -30,7 +31,7 @@ module Elasticsearch
               # Here, `article_comment.article` may contain outdated `comments` because `article_comment.article`
               # won't be notified with changes in `article_comments` thus won't reload `comments` automatically.
               target.map(&:reload).map(&optionally_delayed).each do |t|
-                t.partially_update_document(field_to_update)
+                block.call(t, [*field_to_update])
               end
             else
               optionally_delayed.call(target.reload).partially_update_document(field_to_update)

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

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

data/spec/example/articles_with_comments.rb

@@ -0,0 +1,8 @@
+load 'setup/sqlite.rb'
+load 'setup/elasticsearch/model.rb'
+load 'setup/elasticsearch/start.rb'
+load 'setup/articles_with_comments.rb'
+
+at_exit do
+  load 'setup/elasticsearch/stop.rb'
+end

data/spec/integration_spec.rb

@@ -1,7 +1,7 @@
 require 'elasticsearch/model/extensions/all'
 
 RSpec.describe 'example' do
-  before :all do
+  before :each do
     ActiveRecord::Schema.define(:version => 1) do
       create_table :articles do |t|
         t.string :title
@@ -12,13 +12,6 @@ RSpec.describe 'example' do
     class ::Article < ActiveRecord::Base
       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 = {}
-
-      include Elasticsearch::Model::Extensions::DependencyTracking
 
       settings index: {number_of_shards: 1, number_of_replicas: 0} do
         mapping do
@@ -38,6 +31,12 @@ RSpec.describe 'example' do
     Article.__elasticsearch__.refresh_index!
   end
 
+  after :each do
+    ActiveRecord::Schema.define(:version => 2) do
+      drop_table :articles
+    end
+  end
+
   subject {
     ::Article.create(title: 'foo', created_at: Time.now)
   }

data/spec/outer_document_updating_spec.rb

@@ -0,0 +1,49 @@
+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
+
+  describe 'an article' do
+    def article
+      ::Article.search('Comment1').records.first
+    end
+
+    context 'with a comment added' do
+      before(:each) do
+        article.comments.create(body: 'Comment2')
+
+        Article.__elasticsearch__.refresh_index!
+      end
+
+      specify {
+        expect(Article.search('Comment1').records.first).not_to be_nil
+        expect(Article.search('Comment2').records.first).not_to be_nil
+      }
+    end
+
+    context 'when a comment destroyed' do
+      before(:each) do
+        article.comments.first.destroy
+
+        Article.__elasticsearch__.refresh_index!
+      end
+
+      specify 'the article is updated' do
+        expect(Article.search('Comment1').records).to be_empty
+      end
+
+      specify 'the comment becomes unsearchable' do
+        expect(Comment.search('Comment1').records).to be_empty
+      end
+    end
+  end
+end

data/spec/partial_updating_spec.rb

@@ -0,0 +1,30 @@
+require 'elasticsearch/model/extensions/all'
+
+RSpec.describe Elasticsearch::Model::Extensions::PartialUpdating 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
+
+  let(:as_json_options) {
+    described_class.build_as_json_options(klass: Article, props: Article.mappings.to_hash[Article.document_type.intern][:properties])
+  }
+
+  subject {
+    Article.last
+  }
+
+  specify {
+    expect(as_json_options).to include(methods: :num_comments)
+  }
+
+  specify {
+    expect(subject.build_partial_document_for_update(:comments)).to include(:comments, :num_comments)
+  }
+end

data/spec/setup/articles_with_comments.rb

@@ -0,0 +1,72 @@
+require 'elasticsearch/model/extensions/all'
+
+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
+end
+
+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|
+    t.partially_update_document(*changed_fields)
+  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/elasticsearch/model.rb

@@ -0,0 +1,11 @@
+require 'elasticsearch/model'
+
+tracer = ::Logger.new(STDERR)
+tracer.formatter = lambda { |s, d, p, m| "#{m.gsub(/^.*$/) { |n| '   ' + n }}\n" }
+
+listened_port = (ENV['TEST_CLUSTER_PORT'] || 9250)
+
+tracer.info "Connecting to the Elasticsearch listening for the port: #{listened_port}"
+
+Elasticsearch::Model.client = Elasticsearch::Client.new host: "localhost:#{listened_port}",
+                                                        tracer: (ENV['QUIET'] ? nil : tracer)

data/spec/setup/elasticsearch/start.rb

@@ -0,0 +1,5 @@
+require 'elasticsearch/extensions/test/cluster'
+
+port_to_listen = ENV['TEST_CLUSTER_PORT'] || '9250'
+
+Elasticsearch::Extensions::Test::Cluster.start(nodes:1, port: port_to_listen.to_i)

data/spec/setup/elasticsearch/stop.rb

@@ -0,0 +1,3 @@
+require 'elasticsearch/extensions/test/cluster'
+
+Elasticsearch::Extensions::Test::Cluster.stop(nodes:1)

data/spec/setup/sqlite.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+require 'logger'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ":memory:")
+logger = ::Logger.new(STDERR)
+logger.formatter = lambda { |s, d, p, m| "\e[2;36m#{m}\e[0m\n" }
+ActiveRecord::Base.logger = logger unless ENV['QUIET']
+
+ActiveRecord::LogSubscriber.colorize_logging = false
+ActiveRecord::Migration.verbose = false

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
@@ -13,23 +16,28 @@ RSpec.configure do |config|
 
   Kernel.srand config.seed
 
-  config.before(:all) do
-    require 'active_record'
-    require 'logger'
-    require 'elasticsearch/model'
+  config.before :all do
+    load 'setup/elasticsearch/start.rb'
+    load 'setup/elasticsearch/model.rb'
+  end
 
-    ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ":memory:")
-    logger = ::Logger.new(STDERR)
-    logger.formatter = lambda { |s, d, p, m| "\e[2;36m#{m}\e[0m\n" }
-    ActiveRecord::Base.logger = logger unless ENV['QUIET']
+  config.after :all do
+    load 'setup/elasticsearch/stop.rb'
+  end
 
-    ActiveRecord::LogSubscriber.colorize_logging = false
-    ActiveRecord::Migration.verbose = false
+  config.before :suite do
+    require 'setup/sqlite.rb'
 
-    tracer = ::Logger.new(STDERR)
-    tracer.formatter = lambda { |s, d, p, m| "#{m.gsub(/^.*$/) { |n| '   ' + n }}\n" }
+    require 'database_cleaner'
+
+    # https://github.com/DatabaseCleaner/database_cleaner#additional-activerecord-options-for-truncation
+    DatabaseCleaner.clean_with :deletion, cache_tables: false
+    DatabaseCleaner.strategy = :deletion
+  end
 
-    Elasticsearch::Model.client = Elasticsearch::Client.new host: "localhost:#{(ENV['TEST_CLUSTER_PORT'] || 9250)}",
-                                                            tracer: (ENV['QUIET'] ? nil : tracer)
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-model-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Yusuke KUOKA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,6 +47,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -67,7 +69,15 @@ files:
 - lib/elasticsearch/model/extensions/shortest_path.rb
 - lib/elasticsearch/model/extensions/update_callback.rb
 - lib/elasticsearch/model/extensions/version.rb
+- spec/example/articles_with_comments.rb
 - spec/integration_spec.rb
+- spec/outer_document_updating_spec.rb
+- spec/partial_updating_spec.rb
+- spec/setup/articles_with_comments.rb
+- spec/setup/elasticsearch/model.rb
+- spec/setup/elasticsearch/start.rb
+- spec/setup/elasticsearch/stop.rb
+- spec/setup/sqlite.rb
 - spec/spec_helper.rb
 homepage: https://github.com/crowdworks/elasticsearch-model-extensions
 licenses:
@@ -96,5 +106,14 @@ summary: A set of extensions for elasticsearch-model which aims to ease the burd
   of things like re-indexing, verbose/complex mapping that you may face once you started
   using elasticsearch seriously.
 test_files:
+- spec/example/articles_with_comments.rb
 - spec/integration_spec.rb
+- spec/outer_document_updating_spec.rb
+- spec/partial_updating_spec.rb
+- spec/setup/articles_with_comments.rb
+- spec/setup/elasticsearch/model.rb
+- spec/setup/elasticsearch/start.rb
+- spec/setup/elasticsearch/stop.rb
+- spec/setup/sqlite.rb
 - spec/spec_helper.rb
+has_rdoc: