elasticsearch-model-extensions 0.2.2 → 0.3.0

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

@@ -1,4 +1,3 @@
-require_relative 'mapping_node'
 require_relative 'update_callback'
 require_relative 'destroy_callback'
 
@@ -10,11 +9,6 @@ module Elasticsearch
           klass.extend ClassMethods
         end
 
-        def index_update_required?
-          (previous_changes.keys & self.class.nested_object_fields).size > 0 ||
-            (previous_changes.size > 0 && self.class.has_dependent_fields?)
-        end
-
         class Update
           def initialize(from:, to:)
             @parent_class = from
@@ -96,21 +90,6 @@ module Elasticsearch
         end
 
         module ClassMethods
-          def nested_object_fields
-            @nested_object_fields
-          end
-
-          def has_dependent_fields?
-            @has_dependent_fields
-          end
-
-          def path_from(from)
-            Elasticsearch::Model::Extensions::MappingNode.
-              from_class(from).
-              breadth_first_search { |e| e.destination.relates_to_class?(self) }.
-              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, 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,

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

@@ -1,141 +1,41 @@
+require_relative 'partial_updating/partial_updater'
+
 module Elasticsearch
   module Model
     module Extensions
       module PartialUpdating
         def self.included(klass)
           klass.extend ClassMethods
-        end
-
-        def self.build_as_json_options(klass:, props: )
-          indexed_attributes = props.keys
-          associations = klass.reflect_on_all_associations.select { |a| %i| has_one has_many belongs_to |.include? a.macro }
-          association_names = associations.map(&:name)
-          persisted_attributes = klass.attribute_names.map(&:intern)
 
-          nested_attributes = indexed_attributes & association_names
-          method_attributes = indexed_attributes - persisted_attributes - nested_attributes
-          only_attributes = indexed_attributes - nested_attributes
-
-          options = {
-            root: false
-          }
-
-          if only_attributes.size > 1
-            options[:only] = only_attributes
-          elsif only_attributes.size == 1
-            options[:only] = only_attributes.first
-          end
-
-          if method_attributes.size > 1
-            options[:methods] = method_attributes
-          elsif method_attributes.size == 1
-            options[:methods] = method_attributes.first
-          end
-
-          nested_attributes.each do |n|
-            a = associations.find { |a| a.name == n.intern }
-            nested_klass = a.class_name.constantize
-            nested_prop = props[n]
-            if nested_prop.present?
-              options[:include] ||= {}
-              options[:include][n] = build_as_json_options(
-                klass: nested_klass,
-                props: nested_prop[:properties]
-              )
-            end
-          end
-
-          options
+          klass.instance_variable_set :@__partial_updater__, PartialUpdater.new(klass)
         end
 
         def as_indexed_json(options={})
-          as_json(options.merge(self.class.as_json_options))
-        end
-
-        # @param [Array<Symbol>] changed_attributes
-        # @param [Proc<Symbol, Hash>] json_options
-        def build_partial_document_for_update(*changed_attributes, json_options: nil)
-          changes = {}
-
-          json_options ||= -> field { self.class.partial_as_json_options(field) || {} }
-
-          self.class.each_field_to_update_according_to_changed_fields(changed_attributes) do |field_to_update|
-            options = json_options.call field_to_update
-
-            json = __send__(:"#{field_to_update}").as_json(options)
-
-            changes[field_to_update] = json
-          end
-
-          changes
+          as_json(options.merge(self.class.__partial_updater__.as_json_options))
         end
 
         def partially_update_document(*changed_attributes)
           if changed_attributes.empty?
             __elasticsearch__.index_document
           else
-            begin
-              partial_document = build_partial_document_for_update(*changed_attributes)
-            rescue => e
-              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
+            partial_updater = self.class.__partial_updater__
 
-            update_document(partial_document)
-          end
-        end
-
-        # @param [Hash] partial_document
-        def update_document(partial_document)
-          klass = self.class
-
-          __elasticsearch__.client.update(
-            { index: klass.index_name,
-              type:  klass.document_type,
-              id:    self.id,
-              body:  { doc: partial_document } }
-          ) if partial_document.size > 0
-        end
-
-        module ClassMethods
-          def as_json_options
-            @as_json_options ||= Elasticsearch::Model::Extensions::PartialUpdating.build_as_json_options(
-              klass: self,
-              props: self.mappings.to_hash[self.document_type.intern][:properties]
+            partial_document = partial_updater.build_partial_document_for_update_with_error_logging(
+              record: self,
+              changed_attributes: changed_attributes
             )
-          end
-
-          def partial_as_json_options(field)
-            as_json_options[:include][field]
-          end
 
-          def each_field_to_update_according_to_changed_fields(changed_fields)
-            root_mapping_properties = mappings.to_hash[:"#{document_type}"][:properties]
-
-            changed_fields.each do |changed_field|
-              field_mapping = root_mapping_properties[:"#{changed_field}"]
-
-              next unless field_mapping
-
-              yield changed_field
-            end
-
-            each_dependent_attribute_for(changed_fields.map(&:to_s)) do |a|
-              a_sym = a.intern
-
-              yield a_sym
+            if partial_document
+              partial_updater.update_document(id: self.id, doc: partial_document)
             end
           end
 
-          def fields_to_update_according_to_changed_fields(changed_fields)
-            fields = []
-            each_field_to_update_according_to_changed_fields changed_fields do |field_to_update|
-              fields << field_to_update
-            end
-            fields
+          true
+        end
+
+        module ClassMethods
+          def __partial_updater__
+            @__partial_updater__
           end
         end
 

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

@@ -0,0 +1,149 @@
+module Elasticsearch
+  module Model
+    module Extensions
+      module PartialUpdating
+        class PartialUpdater
+          def initialize(base)
+            @base = base
+          end
+
+          def base
+            @base
+          end
+
+          def build_as_json_options(klass:, props: )
+            indexed_attributes = props.keys
+            associations = klass.reflect_on_all_associations.select { |a| %i| has_one has_many belongs_to |.include? a.macro }
+            association_names = associations.map(&:name)
+            persisted_attributes = klass.attribute_names.map(&:intern)
+
+            nested_attributes = indexed_attributes & association_names
+            method_attributes = indexed_attributes - persisted_attributes - nested_attributes
+            only_attributes = indexed_attributes - nested_attributes
+
+            options = {
+              root: false
+            }
+
+            nested_attributes.map!(&:to_s)
+            method_attributes.map!(&:to_s)
+            only_attributes.map!(&:to_s)
+
+            if only_attributes.size > 1
+              options[:only] = only_attributes
+            elsif only_attributes.size == 1
+              options[:only] = only_attributes.first
+            end
+
+            if method_attributes.size > 1
+              options[:methods] = method_attributes
+            elsif method_attributes.size == 1
+              options[:methods] = method_attributes.first
+            end
+
+            nested_attributes.each do |n|
+              n_as_sym = n.intern
+              a = associations.find { |a| a.name == n_as_sym }
+              nested_klass = a.class_name.constantize
+              nested_prop = props[n_as_sym]
+              if nested_prop.present?
+                options[:include] ||= {}
+                options[:include][n] = build_as_json_options(
+                  klass: nested_klass,
+                  props: nested_prop[:properties]
+                )
+              end
+            end
+
+            options
+          end
+
+          def as_json_options
+            @as_json_options ||= build_as_json_options(
+              klass: base,
+              props: base.mappings.to_hash[base.document_type.intern][:properties]
+            )
+          end
+
+          def partial_as_json_options(field)
+            as_json_options[:include][field.to_s]
+          end
+
+          def each_field_to_update_according_to_changed_fields(changed_fields)
+            root_mapping_properties = base.mappings.to_hash[:"#{base.document_type}"][:properties]
+
+            changed_fields.each do |changed_field|
+              field_mapping = root_mapping_properties[:"#{changed_field}"]
+
+              next unless field_mapping
+
+              yield changed_field
+            end
+
+            base.__dependency_tracker__.each_dependent_attribute_for(changed_fields.map(&:to_s)) do |a|
+              a_sym = a.intern
+
+              yield a_sym
+            end
+          end
+
+          def fields_to_update_according_to_changed_fields(changed_fields)
+            fields = []
+            each_field_to_update_according_to_changed_fields changed_fields do |field_to_update|
+              fields << field_to_update
+            end
+            fields
+          end
+
+          def build_partial_document_for_update_with_error_logging(record:, changed_attributes:, json_options: nil)
+            begin
+              build_partial_document_for_update(
+                record: record,
+                changed_attributes: changed_attributes,
+                json_options: json_options
+              )
+            rescue => e
+              if defined? ::Rails
+                ::Rails.logger.error "Error in #build_partial_document_for_update_with_error_logging: #{e.message}\n#{e.backtrace.join("\n")}"
+              else
+                warn "Error in #build_partial_document_for_update_with_error_logging: #{e.message}\n#{e.backtrace.join("\n")}"
+              end
+
+              nil
+            end
+          end
+
+          # @param [ActiveRecord::Base] record
+          # @param [Array<Symbol>] changed_attributes
+          # @param [Proc<Symbol, Hash>] json_options
+          def build_partial_document_for_update(record:, changed_attributes:, json_options: nil)
+            changes = {}
+
+            json_options ||= -> field { partial_as_json_options(field) || {} }
+
+            each_field_to_update_according_to_changed_fields(changed_attributes) do |field_to_update|
+              options = json_options.call field_to_update
+
+              json = record.__send__(:"#{field_to_update}").as_json(options)
+
+              changes[field_to_update] = json
+            end
+
+            changes
+          end
+
+          # @param [Hash] doc
+          def update_document(id:, doc:)
+            base.__elasticsearch__.client.update(
+              { index: base.index_name,
+                type:  base.document_type,
+                id:    id,
+                body:  { doc: doc } }
+            ) if doc.size > 0
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -9,9 +9,10 @@ module Elasticsearch
             records_to_update_documents = config.records_to_update_documents
             only_if = config.only_if
             callback = self
+            _config = config
 
             record.instance_eval do
-              return unless only_if.call(self) && index_update_required?
+              return unless only_if.call(self) && _config.index_update_required?(self)
 
               target = records_to_update_documents.call(self)
 
@@ -39,4 +40,4 @@ module Elasticsearch
       end
     end
   end
-end
+end

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

@@ -1,7 +1,7 @@
 module Elasticsearch
   module Model
     module Extensions
-      VERSION = "0.2.2"
+      VERSION = "0.3.0"
     end
   end
 end

data/spec/batch_updating/batch_updater_spec.rb

@@ -0,0 +1,50 @@
+require 'elasticsearch/model/extensions/all'
+
+RSpec.describe Elasticsearch::Model::Extensions::BatchUpdating::BatchUpdater 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(:batch_updater) {
+    Article.__batch_updater__
+  }
+
+  describe '#split_ids_into' do
+    subject {
+      batch_updater.split_ids_into(2, min: 0, max: 3)
+    }
+
+    specify {
+      expect(subject).to eq([0..1, 2..3])
+    }
+  end
+
+  context 'the index dropped' do
+    before(:each) do
+      Article.__elasticsearch__.create_index! force: true
+      Article.__elasticsearch__.refresh_index!
+    end
+
+    def number_of_articles_about_coding
+      Article.search('Coding').records.size
+    end
+
+    describe '.update_index_in_parallel' do
+      subject {
+        batch_updater.update_index_in_batch(Article.all.to_ary)
+        Article.__elasticsearch__.refresh_index!
+      }
+
+      specify {
+        expect { subject }.to change { number_of_articles_about_coding }.by(2)
+      }
+    end
+  end
+end

data/spec/batch_updating_spec.rb

@@ -0,0 +1,134 @@
+require 'elasticsearch/model/extensions/all'
+
+require 'parallel'
+
+RSpec.describe Elasticsearch::Model::Extensions::BatchUpdating 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 '.with_indexed_tables_included' do
+    subject {
+      Article.with_indexed_tables_included
+    }
+
+    context 'without a `with_indexed_tables_included` implementation' do
+      specify {
+        expect { subject }.to raise_error
+      }
+    end
+
+    context 'with a `with_indexed_tables_included` implementation' do
+      before(:each) do
+        Article.class_eval do
+          def self.with_indexed_tables_included
+            includes(:comments)
+          end
+        end
+      end
+
+      specify {
+        expect { subject }.to_not raise_error
+      }
+    end
+  end
+
+  describe '.elasticsearch_hosts' do
+    subject {
+      Article.elasticsearch_hosts
+    }
+
+    context 'without a `elasticsearch_hosts` implementation' do
+      specify {
+        expect { subject }.to raise_error
+      }
+
+      specify {
+        expect { Article.__batch_updater__.reconnect! }.to raise_error
+      }
+    end
+
+    context 'with a `elasticsearch_hosts` implementation' do
+      before(:each) do
+        Article.class_eval do
+          def self.elasticsearch_hosts
+            'http://localhost:9250'
+          end
+        end
+      end
+
+      specify {
+        expect { subject }.to_not raise_error
+      }
+    end
+  end
+
+  context 'the index dropped' do
+    before(:each) do
+      Article.__elasticsearch__.create_index! force: true
+      Article.__elasticsearch__.refresh_index!
+
+      Article.class_eval do
+        def self.elasticsearch_hosts
+          listened_port = (ENV['TEST_CLUSTER_PORT'] || 9250)
+          "http://localhost:#{listened_port}/"
+        end
+
+        def self.with_indexed_tables_included
+          includes(:comments)
+        end
+      end
+    end
+
+    shared_examples 'indexing all articles' do
+      def number_of_articles_about_coding
+        Article.search('Coding').records.size
+      end
+
+      specify {
+        expect { subject; Article.__elasticsearch__.refresh_index! }.to change { number_of_articles_about_coding }.by(2)
+      }
+    end
+
+    describe '.update_index_in_parallel' do
+      subject {
+        Article.update_index_in_parallel(parallelism: 2)
+      }
+
+      it_behaves_like 'indexing all articles'
+      end
+
+    describe '.update_index_in_batches' do
+      subject {
+        Article.update_index_in_batches
+      }
+
+      it_behaves_like 'indexing all articles'
+    end
+
+    describe 'Association/Extension' do
+      describe '.update_index_for_ids_in_range' do
+        subject {
+          Article.for_indexing.update_index_for_ids_in_range(Article.minimum(:id)..Article.maximum(:id))
+        }
+
+        it_behaves_like 'indexing all articles'
+      end
+
+      describe '.update_index_in_batches' do
+        subject {
+          Article.for_indexing.update_index_in_batches
+        }
+
+        it_behaves_like 'indexing all articles'
+      end
+    end
+  end
+end