algoliasearch-rails 1.20.4 → 1.20.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 51327702006b16333b88bce137fd854e8ffbba7f
-  data.tar.gz: 97c79f69aeb332096cf93ca367a109c216e3fe74
+SHA256:
+  metadata.gz: 38fe24b0c83678a9d4c08faf6faac62a894970be01fa7739b33ef8da116588ed
+  data.tar.gz: 8d01bb4274a36b989f9c021245e9aa2f6495ed07fd1bc05351aca9eb7f4953c1
 SHA512:
-  metadata.gz: 4623121eec3c0de995007f827971c897ebf35b73aaa911124e4d0cc62a3197bef0d70ca8e262606ac58985baffb7484fb7ea4b2c98a684b6cc4273ce2b74d146
-  data.tar.gz: a0559d93bd9aadd3fd24c368e6c8949e50d6ccd92d0a1287e9bf8b5f5e484c4e8031432242d09bcc03f87a5d80c5a1e86b0e8eeebb2ba2305a116a4826b6407b
+  metadata.gz: ac5bbe58eb801e574af5c7a7155bfed178928ffec9065a2845aa6d9189eaca677f103891c3e61a2be38cd7766e1685c32fba9050ea20f2b7fb103923e755ce1a
+  data.tar.gz: 2a235e08fc3d7d8620dac3048df6b6e9936b00ce27858f3020296dd98c44ff892f76ea255476be2c6cb835ef6458011d6d21d89fcc0d1ab89e37e214c32681bd

data/.travis.yml

@@ -10,22 +10,30 @@ matrix:
     env: RAILS_VERSION=3.2.0
   - rvm: 1.9.3
     env: RAILS_VERSION=4.2
-  - rvm: 2.2.5
+  - rvm: 2.2.9
     env: RAILS_VERSION=3.2.0
-  - rvm: 2.2.5
+  - rvm: 2.2.9
     env: RAILS_VERSION=4.2
-  - rvm: 2.2.5
+  - rvm: 2.2.9
     env: RAILS_VERSION=5.1
-  - rvm: 2.3.4
+  - rvm: 2.3.6
     env: RAILS_VERSION=3.2.0
-  - rvm: 2.3.4
+  - rvm: 2.3.6
     env: RAILS_VERSION=4.2
-  - rvm: 2.3.4
+  - rvm: 2.3.6
     env: RAILS_VERSION=5.1
-  - rvm: 2.4.1
+  - rvm: 2.4.3
     env: RAILS_VERSION=4.2
-  - rvm: 2.4.1
-    env: RAILS_VERSION=5.1
+  - rvm: 2.4.3
+    env: RAILS_VERSION=5.1 SEQUEL_VERSION=4.0
+  - rvm: 2.4.3
+    env: RAILS_VERSION=5.1 SEQUEL_VERSION=5.0
+  - rvm: 2.5.0
+    env: RAILS_VERSION=4.2
+  - rvm: 2.5.0
+    env: RAILS_VERSION=5.1 SEQUEL_VERSION=4.0
+  - rvm: 2.5.0
+    env: RAILS_VERSION=5.1 SEQUEL_VERSION=5.0
   # - rvm: jruby-9.1.2.0
   #   env: RAILS_VERSION=3.2.0
   # - rvm: jruby-9.1.2.0
@@ -45,11 +53,9 @@ matrix:
   allow_failures:
   - rvm: rbx-2
 before_install:
+  - wget http://api-key-dealer.herokuapp.com/clients/algolia-keys && chmod +x algolia-keys
   - gem install bundler
   - bundle --version
-install: rm -f Gemfile.lock && bundle install
+install: rm -f Gemfile.lock && bundle install --without development
 cache: bundler
-env:
-  global:
-  - secure: "o/Hi/6KnBugN5P/cpVtpwyKrK5fVzAc0efw+qZ9ZqwqZN0GmipZrHmRNuLVUxVf+CIcqfLpIT0U172XGOZ5zJ1gs3qZZrDsJ1ptXnPyvvCrw+VX5yGhMh67JnlO0WLWvci0WdltJTmrhCoLSSw39nCPswC7I6/hai4KyiOXoMk4="
-  - secure: "Jv9jOYRwJq5i17Int/p75330yxCJXKLYlstHuBjwkKa6anJHFSXQaAxWj8sZHCY4IAVDsBfdi0j6S3dtVu2LaVLA3hfPp36YRVolSZu9zLbGqyPKBWM7E3i7GkS3Jub0nMV3Yo3cMeiFzQ4BmpSQOYo0biCkL8bh4/5NRZ7Q6VI="
+script: eval $(./algolia-keys export) && bundle exec rake

data/ChangeLog

@@ -1,5 +1,10 @@
 CHANGELOG
 
+2018-12-07 1.20.6
+
+    * Better support for Rails 5.1 and deprecated `attribute_changed?`
+    * Better support for `after_commit` for Sequel 5.0
+
 2017-12-04 1.20.4
 
       * Remove Bundler and RubyGems requirements

data/Gemfile

@@ -39,7 +39,9 @@ group :test do
   gem 'activerecord-jdbc-adapter', :platform => :jruby
   gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
   gem 'redgreen'
-  gem 'sequel'
+
+  sequel_version = ENV['SEQUEL_VERSION'] ? "~> #{ENV['SEQUEL_VERSION']}" : '>= 4.0'
+  gem 'sequel', sequel_version
 end
 
 group :development do

data/Gemfile.lock

@@ -39,23 +39,23 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.4.0)
-    algoliasearch (1.17.0)
-      httpclient (~> 2.8.3)
+    algoliasearch (1.23.2)
+      httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     arel (7.1.4)
-    backports (3.6.8)
+    backports (3.11.1)
     builder (3.2.3)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     erubis (2.7.0)
-    ethon (0.10.1)
+    ethon (0.11.0)
       ffi (>= 1.3.0)
-    faraday (0.11.0)
+    faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.11.0.1)
+    faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.18)
-    gh (0.15.0)
+    ffi (1.9.25)
+    gh (0.15.1)
       addressable (~> 2.4.0)
       backports
       faraday (~> 0.8)
@@ -64,9 +64,10 @@ GEM
       net-http-pipeline
     globalid (0.3.7)
       activesupport (>= 4.1.0)
-    highline (1.7.8)
+    highline (1.7.10)
     httpclient (2.8.3)
-    i18n (0.8.1)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
     json (1.8.6)
     kaminari (1.0.1)
       activesupport (>= 4.1.0)
@@ -86,23 +87,23 @@ GEM
       nokogiri (>= 1.5.9)
     mail (2.6.4)
       mime-types (>= 1.16, < 4)
-    method_source (0.8.2)
+    method_source (0.9.0)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
-    mini_portile2 (2.1.0)
-    minitest (5.10.1)
-    multi_json (1.12.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
     multipart-post (2.0.0)
     net-http-persistent (2.9.4)
     net-http-pipeline (1.0.1)
     nio4r (2.0.0)
-    nokogiri (1.7.0.1)
-      mini_portile2 (~> 2.1.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
     pusher-client (0.6.2)
       json
       websocket (~> 1.0)
-    rack (2.0.1)
+    rack (2.0.3)
     rack-test (0.6.3)
       rack (>= 1.0)
     rails (5.0.2)
@@ -129,7 +130,7 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.1.1)
-    rdoc (5.1.0)
+    rdoc (6.0.4)
     redgreen (1.2.2)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
@@ -139,7 +140,7 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.4)
-    sequel (4.44.0)
+    sequel (4.49.0)
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -148,7 +149,7 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.3.13)
-    thor (0.19.4)
+    thor (0.20.0)
     thread_safe (0.3.6)
     travis (1.8.8)
       backports
@@ -161,9 +162,9 @@ GEM
       typhoeus (~> 0.6, >= 0.6.8)
     typhoeus (0.8.0)
       ethon (>= 0.8.0)
-    tzinfo (1.2.2)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    websocket (1.2.4)
+    websocket (1.2.5)
     websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)
@@ -184,10 +185,10 @@ DEPENDENCIES
   rdoc
   redgreen
   rspec (>= 2.5.0, < 3.0)
-  sequel
+  sequel (>= 4.0)
   sqlite3
   travis
   will_paginate (>= 2.3.15)
 
 BUNDLED WITH
-   1.16.0
+   1.16.6

data/LICENSE

@@ -1,7 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2013 Algolia
-http://www.algolia.com/
+Copyright (c) 2013-Present Algolia
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -10,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,6 +1,8 @@
+
 # Algolia Search API Client for Rails
 
-[Algolia Search](https://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
+[Algolia Search](https://www.algolia.com) is a hosted full-text, numerical,
+and faceted search engine capable of delivering realtime results from the first keystroke.
 
 [![Build Status](https://travis-ci.org/algolia/algoliasearch-rails.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-rails) [![Gem Version](https://badge.fury.io/rb/algoliasearch-rails.svg)](http://badge.fury.io/rb/algoliasearch-rails) [![Code Climate](https://codeclimate.com/github/algolia/algoliasearch-rails.svg)](https://codeclimate.com/github/algolia/algoliasearch-rails) ![ActiveRecord](https://img.shields.io/badge/ActiveRecord-yes-blue.svg?style=flat-square) ![Mongoid](https://img.shields.io/badge/Mongoid-yes-blue.svg?style=flat-square) ![Sequel](https://img.shields.io/badge/Sequel-yes-blue.svg?style=flat-square)
 
@@ -8,8 +10,7 @@
 This gem let you easily integrate the Algolia Search API to your favorite ORM. It's based on the [algoliasearch-client-ruby](https://github.com/algolia/algoliasearch-client-ruby) gem.
 Rails 3.x, 4.x and 5.x are all supported.
 
-You might be interested in the sample Ruby on Rails application providing a `autocomplete.js`-based auto-completion and `instantsearch.js`-based instant search results page: [algoliasearch-rails-example](https://github.com/algolia/algoliasearch-rails-example/).
-
+You might be interested in the sample Ruby on Rails application providing a `autocomplete.js`-based auto-completion and `InstantSearch.js`-based instant search results page: [algoliasearch-rails-example](https://github.com/algolia/algoliasearch-rails-example/).
 
 
 
@@ -18,19 +19,14 @@ You might be interested in the sample Ruby on Rails application providing a `aut
 You can find the full reference on [Algolia's website](https://www.algolia.com/doc/api-client/rails/).
 
 
-## Table of Contents
-
-
 
 1. **[Setup](#setup)**
-
     * [Install](#install)
     * [Configuration](#configuration)
     * [Timeouts](#timeouts)
     * [Notes](#notes)
 
 1. **[Usage](#usage)**
-
     * [Index Schema](#index-schema)
     * [Relevancy](#relevancy)
     * [Indexing](#indexing)
@@ -44,13 +40,12 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
     * [Geo-Search](#geo-search)
 
 1. **[Options](#options)**
-
     * [Auto-indexing & asynchronism](#auto-indexing--asynchronism)
     * [Custom index name](#custom-index-name)
     * [Per-environment indices](#per-environment-indices)
     * [Custom attribute definition](#custom-attribute-definition)
     * [Nested objects/relations](#nested-objectsrelations)
-    * [Custom `objectID`](#custom-objectid)
+    * [Custom <code>objectID</code>](#custom-codeobjectidcode)
     * [Restrict indexing to a subset of your data](#restrict-indexing-to-a-subset-of-your-data)
     * [Sanitizer](#sanitizer)
     * [UTF-8 Encoding](#utf-8-encoding)
@@ -58,7 +53,6 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
     * [Configuration example](#configuration-example)
 
 1. **[Indices](#indices)**
-
     * [Manual indexing](#manual-indexing)
     * [Manual removal](#manual-removal)
     * [Reindexing](#reindexing)
@@ -69,15 +63,12 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
     * [Target multiple indices](#target-multiple-indices)
 
 1. **[Testing](#testing)**
-
     * [Notes](#notes)
 
 
 
 
 
-
-
 # Setup
 
 
@@ -140,6 +131,7 @@ Contact.algolia_search("jon doe") # <=> Contact.search("jon doe")
 
 
 
+
 # Usage
 
 
@@ -448,13 +440,14 @@ At query time, specify <code>{ aroundLatLng: "37.33, -121.89", aroundRadius: 500
 
 
 
+
 # Options
 
 
 
 ## Auto-indexing & asynchronism
 
-Each time a record is saved; it will be - asynchronously - indexed. On the other hand, each time a record is destroyed, it will be - asynchronously - removed from the index. That means that a network call with the ADD/DELETE operation is sent **synchronously** to the Algolia API but then the engine will **asynchronously** process the operation (so if you do a search just after, the results may not reflect it yet).
+Each time a record is saved, it will be *asynchronously* indexed. On the other hand, each time a record is destroyed, it will be - asynchronously - removed from the index. That means that a network call with the ADD/DELETE operation is sent **synchronously** to the Algolia API but then the engine will **asynchronously** process the operation (so if you do a search just after, the results may not reflect it yet).
 
 You can disable auto-indexing and auto-removing setting the following options:
 
@@ -659,6 +652,8 @@ end
 
 ## Nested objects/relations
 
+### Defining the relationship
+
 You can easily embed nested objects defining an extra attribute returning any JSON-compliant object (an array or a hash or a combination of both).
 
 ```ruby
@@ -684,6 +679,82 @@ class Profile < ActiveRecord::Base
 end
 ```
 
+### Propagating the change from a nested child
+
+#### With ActiveRecord
+
+With ActiveRecord, we'll be using `touch` and `after_touch` to achieve this.
+
+```ruby
+# app/models/app.rb
+class App < ApplicationRecord
+  include AlgoliaSearch
+
+  belongs_to :author, class_name: :User
+  after_touch :index!
+
+  algoliasearch do
+    attribute :title
+    attribute :author do
+      author.as_json
+    end
+  end
+end
+
+# app/models/user.rb
+class User < ApplicationRecord
+  # If your association uses belongs_to
+  # - use `touch: true`
+  # - do not define an `after_save` hook
+  has_many :apps, foreign_key: :author_id
+
+  after_save { apps.each(&:touch) }
+end
+```
+
+#### With Sequel
+
+With Sequel, you can use the `touch` plugin to propagate the changes:
+
+```ruby
+# app/models/app.rb
+class App < Sequel::Model
+  include AlgoliaSearch
+
+  many_to_one :author, class: :User
+
+  plugin :timestamps
+  plugin :touch
+
+  algoliasearch do
+    attribute :title
+    attribute :author do
+      author.to_hash
+    end
+  end
+end
+
+# app/models/user.rb
+class User < Sequel::Model
+  one_to_many :apps, key: :author_id
+
+  plugin :timestamps
+  # Can't use the associations since it won't trigger the after_save
+  plugin :touch
+
+  # Define the associations that need to be touched here
+  # Less performant, but allows for the after_save hook to trigger
+  def touch_associations
+    apps.map(&:touch)
+  end
+
+  def touch
+    super
+    touch_associations
+  end
+end
+```
+
 ## Custom `objectID`
 
 By default, the `objectID` is based on your record's `id`. You can change this behavior specifying the `:id` option (be sure to use a uniq field).
@@ -864,6 +935,7 @@ end
 
 
 
+
 # Indices
 
 
@@ -1046,6 +1118,7 @@ Book.search 'foo bar', index: 'Book_by_editor'
 
 
 
+
 # Testing
 
 
@@ -1096,3 +1169,4 @@ end
 ```
 
 
+

data/algoliasearch-rails.gemspec

@@ -2,6 +2,8 @@
 
 require File.join(File.dirname(__FILE__), 'lib', 'algoliasearch', 'version')
 
+require 'date'
+
 Gem::Specification.new do |s|
   s.name = "algoliasearch-rails"
   s.version = AlgoliaSearch::VERSION

data/lib/algoliasearch-rails.rb

@@ -59,7 +59,7 @@ module AlgoliaSearch
       :unretrievableAttributes, :disableTypoToleranceOnWords, :disableTypoToleranceOnAttributes, :altCorrections,
       :ignorePlurals, :maxValuesPerFacet, :distinct, :numericAttributesToIndex, :numericAttributesForFiltering,
       :allowTyposOnNumericTokens, :allowCompressionOfIntegerArray,
-      :advancedSyntax, :disablePrefixOnAttributes, :disableTypoToleranceOnAttributes,
+      :advancedSyntax, :disablePrefixOnAttributes,
       :paginationLimitedTo]
     OPTIONS.each do |k|
       define_method k do |v|
@@ -402,7 +402,6 @@ module AlgoliaSearch
           class_eval do
             copy_after_validation = instance_method(:after_validation)
             copy_before_save = instance_method(:before_save)
-            copy_after_commit = instance_method(:after_commit)
 
             define_method(:after_validation) do |*args|
               super(*args)
@@ -416,10 +415,23 @@ module AlgoliaSearch
               super(*args)
             end
 
-            define_method(:after_commit) do |*args|
-              super(*args)
-              copy_after_commit.bind(self).call
-              algolia_perform_index_tasks
+            sequel_version = Gem::Version.new(Sequel.version)
+            if sequel_version >= Gem::Version.new('4.0.0') && sequel_version < Gem::Version.new('5.0.0')
+              copy_after_commit = instance_method(:after_commit)
+              define_method(:after_commit) do |*args|
+                super(*args)
+                copy_after_commit.bind(self).call
+                algolia_perform_index_tasks
+              end
+            else
+              copy_after_save = instance_method(:after_save)
+              define_method(:after_save) do |*args|
+                super(*args)
+                copy_after_save.bind(self).call
+                self.db.after_commit do
+                  algolia_perform_index_tasks
+                end
+              end
             end
           end
         else
@@ -703,14 +715,14 @@ module AlgoliaSearch
         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 = "#{k}_changed?"
+          changed_method = attribute_changed_method(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 = "#{condition}_changed?"
+            changed_method = attribute_changed_method(condition)
             return true if !object.respond_to?(changed_method) || object.send(changed_method)
           else
             # if the :if, :unless condition is a anything else,
@@ -785,7 +797,7 @@ module AlgoliaSearch
     end
 
     def algolia_object_id_changed?(o, options = nil)
-      m = "#{algolia_object_id_method(options)}_changed?"
+      m = attribute_changed_method(algolia_object_id_method(options))
       o.respond_to?(m) ? o.send(m) : false
     end
 
@@ -879,6 +891,15 @@ module AlgoliaSearch
         yield items unless items.empty?
       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?"
+      end
+    end
   end
 
   # these are the instance methods included

data/lib/algoliasearch/version.rb

@@ -1,3 +1,3 @@
 module AlgoliaSearch
-  VERSION = '1.20.4'
+  VERSION = '1.20.6'
 end

data/spec/spec_helper.rb

@@ -31,6 +31,6 @@ end
 # avoid concurrent access to the same index
 def safe_index_name(name)
   return name if ENV['TRAVIS'].to_s != "true"
-  id = ENV['TRAVIS_JOB_NUMBER'].split('.').last
-  "#{name}_travis-#{id}"
+  id = ENV['TRAVIS_JOB_NUMBER']
+  "TRAVIS_RAILS_#{name}_#{id}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.20.4
+  version: 1.20.6
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -189,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM