algoliasearch-rails 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eb55772f506326a5847dbc0ebee0674f23c8a382b3eea7c3fddc01b9039150d
-  data.tar.gz: f41c8aa08a1d28ddf8f88643bb5e6231e4f447e49ff21714d0b803e6c0567394
+  metadata.gz: 04d14efb20e58715bff263a1eb160ccd0d192c7c44091b03aa2dc9f9ee9a3bac
+  data.tar.gz: 0eaa9daddcdde5d578fa8a9657a3233bcf7b30d24af61f9892056c70bf9dfe3e
 SHA512:
-  metadata.gz: 8c763ac336f5cb507a73dbaf5b1d2be086bef6260054c3887bf2d7fa568fb513e8611151a2adfedf1f9b52d738e3cf2cb626eb9e44439a9dea2715fea501ced0
-  data.tar.gz: 7df4726bca1c2d10aa9037d83da3a7d15684d39d429db8f5bda5b25b722edbe4c3d41538d58f96e1874a5acd5e33a3ccc6ba0437ca3b9373cdde35da63b8dd23
+  metadata.gz: 10af848ac5cea8769630f6bbeab00756f85ba5dd27e17eedaa9f5a026c20c5d027ae60523ec42fa7e7c4a9d737995ee4b828a17a447ebf23fe9dc807760cf740
+  data.tar.gz: 4427826729ef4ab92903e6161373b6eaee44b3601a236ce2278d1bda8d3f2351c06cffdd503d246ac965f5f75033dd058ef8622e5535d26ee7e75630c5ccccb8

data/ChangeLog

@@ -1,34 +1,56 @@
-CHANGELOG
+# CHANGELOG
 
-## [1.21.0](https://github.com/algolia/algoliasearch-rails/releases/tag/1.21.0) (2019-02-12)
+## [1.22.0](https://github.com/algolia/algoliasearch-rails/releases/tag/1.22.0) (2019-03-21)
+
+🚨 The documentation for our Rails integration was refreshed 🎉
+https://www.algolia.com/doc/framework-integration/rails/getting-started/setup/
 
 **Added**
 
-    * Add `AlgoliaSearch::IndexSettings::DEFAULT_BATCH_SIZE` constant - PR [#319](https://github.com/algolia/algoliasearch-rails/pull/319)
+* Introduce `algolia_dirty?` on models to decide if a model should be reindex.
 
-    * Support ActiveModel Serializer 🎉 - PR [#266](https://github.com/algolia/algoliasearch-rails/pull/266)
+    This feature already exists via _changed? methods but might requires to implements many
+    methods if you have multiple dynamic attributes. Dynamic attributes are attributes not mapping
+    to a DB column. This feature allows you to group avoid all the _changed? method calls and
+    group all the logic inside one unique method.
+
+**Fixed**
 
-        ```ruby
-        class SerializedObject < ActiveRecord::Base
-            include AlgoliaSearch
+* Fix _changed? method call for Rails 5.2+ with dynamic attribute - PR [#338](https://github.com/algolia/algoliasearch-rails/pull/338)
 
-            algoliasearch do
+    Related issue: https://github.com/algolia/algoliasearch-rails/issues/140
+    Documentation: https://www.algolia.com/doc/framework-integration/rails/indexing/indexing/#automatic-updates
 
-                use_serializer SerializedObjectSerializer
 
-                tags do
-                    ['tag1', 'tag2']
-                end
+## [1.21.0](https://github.com/algolia/algoliasearch-rails/releases/tag/1.21.0) (2019-02-12)
+
+**Added**
 
+* Add `AlgoliaSearch::IndexSettings::DEFAULT_BATCH_SIZE` constant - PR [#319](https://github.com/algolia/algoliasearch-rails/pull/319)
+
+* Support ActiveModel Serializer 🎉 - PR [#266](https://github.com/algolia/algoliasearch-rails/pull/266)
+
+    ```ruby
+    class SerializedObject < ActiveRecord::Base
+        include AlgoliaSearch
+
+        algoliasearch do
+
+            use_serializer SerializedObjectSerializer
+
+            tags do
+                ['tag1', 'tag2']
             end
+
         end
-        ```
+    end
+    ```
 
 **Fixed**
 
-    * Add support for all new recent engine settings - PR [#327](https://github.com/algolia/algoliasearch-rails/pull/327)
+* Add support for all new recent engine settings - PR [#327](https://github.com/algolia/algoliasearch-rails/pull/327)
 
-        Algolia regularly introduce new settings, all of them are supported by this gem.
+    Algolia regularly introduce new settings, all of them are supported by this gem.
 
 2018-12-07 1.20.6
 

data/Gemfile.lock

@@ -203,7 +203,7 @@ DEPENDENCIES
   redgreen
   rspec (>= 2.5.0, < 3.0)
   sequel (>= 4.0)
-  sqlite3
+  sqlite3 (< 1.4.0)
   travis
   will_paginate (>= 2.3.15)
 

data/lib/algoliasearch-rails.rb

@@ -739,19 +739,21 @@ module AlgoliaSearch
     end
 
     def algolia_must_reindex?(object)
+      # use +algolia_dirty?+ method if implemented
+      return object.send(:algolia_dirty?) if (object.respond_to?(:algolia_dirty?))
+      # Loop over each index to see if a attribute used in records has changed
       algolia_configurations.each do |options, settings|
         next if options[:slave] || options[:replica]
         return true if algolia_object_id_changed?(object, options)
         settings.get_attribute_names(object).each do |k|
-          changed_method = attribute_changed_method(k)
-          return true if !object.respond_to?(changed_method) || object.send(changed_method)
+          return true if algolia_attribute_changed?(object, k)
+          # return true if !object.respond_to?(changed_method) || object.send(changed_method)
         end
         [options[:if], options[:unless]].each do |condition|
           case condition
           when nil
           when String, Symbol
-            changed_method = attribute_changed_method(condition)
-            return true if !object.respond_to?(changed_method) || object.send(changed_method)
+            return true if algolia_attribute_changed?(object, condition)
           else
             # if the :if, :unless condition is a anything else,
             # we have no idea whether we should reindex or not
@@ -760,6 +762,7 @@ module AlgoliaSearch
           end
         end
       end
+      # By default, we don't reindex
       return false
     end
 
@@ -825,8 +828,8 @@ module AlgoliaSearch
     end
 
     def algolia_object_id_changed?(o, options = nil)
-      m = attribute_changed_method(algolia_object_id_method(options))
-      o.respond_to?(m) ? o.send(m) : false
+      changed = algolia_attribute_changed?(o, algolia_object_id_method(options))
+      changed.nil? ? false : changed
     end
 
     def algoliasearch_settings_changed?(prev, current)
@@ -920,13 +923,48 @@ module AlgoliaSearch
       end
     end
 
-    def attribute_changed_method(attr)
-      if defined?(::ActiveRecord) && ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 1 ||
-          (defined?(::ActiveRecord) && ActiveRecord::VERSION::MAJOR > 5)
-        "will_save_change_to_#{attr}?"
-      else
-        "#{attr}_changed?"
+    def algolia_attribute_changed?(object, attr_name)
+      # if one of two method is implemented, we return its result
+      # true/false means whether it has changed or not
+      # +#{attr_name}_changed?+ always defined for automatic attributes but deprecated after Rails 5.2
+      # +will_save_change_to_#{attr_name}?+ should be use instead for Rails 5.2+, also defined for automatic attributes.
+      # If none of the method are defined, it's a dynamic attribute
+
+      method_name = "#{attr_name}_changed?"
+      if object.respond_to?(method_name)
+        # If +#{attr_name}_changed?+ respond we want to see if the method is user defined or if it's automatically
+        # defined by Rails.
+        # If it's user-defined, we call it.
+        # If it's automatic we check ActiveRecord version to see if this method is deprecated
+        # and try to call +will_save_change_to_#{attr_name}?+ instead.
+        # See: https://github.com/algolia/algoliasearch-rails/pull/338
+        # This feature is not compatible with Ruby 1.8
+        # In this case, we always call #{attr_name}_changed?
+        if Object.const_defined?(:RUBY_VERSION) && RUBY_VERSION.to_f < 1.9
+          return object.send(method_name)
+        end
+        unless automatic_changed_method?(object, method_name) && automatic_changed_method_deprecated?
+          return object.send(method_name)
+        end
       end
+
+      if object.respond_to?("will_save_change_to_#{attr_name}?")
+        return object.send("will_save_change_to_#{attr_name}?")
+      end
+
+      # Nil means we don't know if the attribute has changed
+      nil
+    end
+
+    def automatic_changed_method?(object, method_name)
+      raise ArgumentError.new("Method #{method_name} doesn't exist on #{object.class.name}") unless object.respond_to?(method_name)
+      file = object.method(method_name).source_location[0]
+      file.end_with?("active_model/attribute_methods.rb")
+    end
+
+    def automatic_changed_method_deprecated?
+      (defined?(::ActiveRecord) && ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 1) ||
+          (defined?(::ActiveRecord) && ActiveRecord::VERSION::MAJOR > 5)
     end
   end
 

data/lib/algoliasearch/version.rb

@@ -1,3 +1,3 @@
 module AlgoliaSearch
-  VERSION = '1.21.0'
+  VERSION = '1.22.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json