algoliasearch-rails 1.11.18 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b90eda1033e39094342631bc26f4356b2fb77723
-  data.tar.gz: b2b8a9acdc2814b526f69c30c7bb85de3998f039
+  metadata.gz: 0d74f56ff72c3c4e345e66f172b6be8d29378bee
+  data.tar.gz: 0363a42c7a6c17e842c561807b151095ef7e23f7
 SHA512:
-  metadata.gz: fae998c2943cbaa65c7fd588a96aaee86fe7b5c8937dda84c3708e5c09fe6c94367361230a3e264023f4d6d585cc3b7641ac41b11b14a7e4b4cc689e23cfc7c3
-  data.tar.gz: d079747d3a7fcc582b4dce2ec76a225abf6c9c46dd8f340d893448e67e7d87d73a231ab2bb89b3c5631993f5dc9dc6964191fc9473f9cdac74b8382ba2104ef9
+  metadata.gz: 4196b33784fc23a9b8dbd3d66318a3c32c9bca6dfb3c132c0b6679c0182a6e6857261e6db9164c86d2133b3899b048bbedc1dde8a9fc6e99126a54e77a0fbe48
+  data.tar.gz: 92be73f9302e3081eff020bee02410491d35523488554f6f511cf00d5c9a99f6c7712006de9a2bb287655a616b22f9d5a7d3f378d08ced3b746f78b1b58eb6ea

data/ChangeLog

@@ -1,5 +1,9 @@
 CHANGELOG
 
+2015-04-29 1.12.0
+
+      * Add Sequel support.
+
 2015-03-31 1.11.18
 
       * Embed AlgoliaSearch JS API client v3 as well. Default is still the v2 to keep the backward compatibility.

data/Gemfile

@@ -15,6 +15,7 @@ group :test do
   gem 'autotest-fsevent', '~> 0.2.10'
   gem 'redgreen'
   gem 'autotest-growl'
+  gem 'sequel'
 end
 
 group :development do

data/Gemfile.lock

@@ -339,6 +339,7 @@ GEM
     rubysl-xmlrpc (2.0.0)
     rubysl-yaml (2.0.4)
     rubysl-zlib (2.0.1)
+    sequel (4.21.0)
     slop (3.6.0)
     spoon (0.0.4)
       ffi
@@ -392,6 +393,7 @@ DEPENDENCIES
   redgreen
   rspec (>= 2.5.0, < 3.0)
   rubysl (~> 2.0)
+  sequel
   sqlite3
   travis
   will_paginate (>= 2.3.15)

data/README.md

@@ -5,7 +5,7 @@ This gem let you easily integrate the Algolia Search API to your favorite ORM. I
 
 You might be interested in the sample Ruby on Rails application providing a ```typeahead.js```-based auto-completion and ```Google```-like instant search: [algoliasearch-rails-example](https://github.com/algolia/algoliasearch-rails-example/).
 
-[![Build Status](https://travis-ci.org/algolia/algoliasearch-rails.png?branch=master)](https://travis-ci.org/algolia/algoliasearch-rails) [![Gem Version](https://badge.fury.io/rb/algoliasearch-rails.png)](http://badge.fury.io/rb/algoliasearch-rails) [![Code Climate](https://codeclimate.com/github/algolia/algoliasearch-rails.png)](https://codeclimate.com/github/algolia/algoliasearch-rails)
+[![Build Status](https://travis-ci.org/algolia/algoliasearch-rails.png?branch=master)](https://travis-ci.org/algolia/algoliasearch-rails) [![Gem Version](https://badge.fury.io/rb/algoliasearch-rails.png)](http://badge.fury.io/rb/algoliasearch-rails) [![Code Climate](https://codeclimate.com/github/algolia/algoliasearch-rails.png)](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)
 
 Table of Content
 -------------
@@ -56,6 +56,8 @@ Create a new file <code>config/initializers/algoliasearch.rb</code> to setup you
 AlgoliaSearch.configuration = { application_id: 'YourApplicationID', api_key: 'YourAPIKey' }
 ```
 
+The gem is compatible with [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord), [Mongoid](https://github.com/mongoid/mongoid) and [Sequel](https://github.com/jeremyevans/sequel).
+
 We support both [will_paginate](https://github.com/mislav/will_paginate) and [kaminari](https://github.com/amatsuda/kaminari) as pagination backend. For example to use <code>:will_paginate</code>, specify the <code>:pagination_backend</code> as follow:
 
 ```ruby
@@ -158,16 +160,16 @@ index.search('something', function(success, hits) {
 
 #### Backend Search
 
-A search returns ORM-compliant objects reloading them from your database.
+If you want to search from your backend you can use the `raw_search` method. It retrieves the raw JSON answer from the API:
 
 ```ruby
-p Contact.search("jon doe")
+p Contact.raw_search("jon doe")
 ```
 
-If you want to retrieve the raw JSON answer from the API, without re-loading the objects from the database, you can use:
+You could also use `search` but it's not recommended. This method will fetch the matching `objectIDs` from the API and perform a database query to retrieve an array of matching models:
 
 ```ruby
-p Contact.raw_search("jon doe")
+p Contact.search("jon doe") # we recommend to use `raw_search` to avoid the database lookup
 ```
 
 #### Notes
@@ -691,7 +693,7 @@ end
 
 ```ruby
 # dynamical search parameters
-p Contact.search("jon doe", { :hitsPerPage => 5, :page => 2 })
+p Contact.raw_search("jon doe", { :hitsPerPage => 5, :page => 2 })
 ```
 
 Faceting

data/VERSION

@@ -1 +1 @@
-1.11.18
+1.12.0

data/lib/algoliasearch-rails.rb

@@ -71,7 +71,7 @@ module AlgoliaSearch
       raise ArgumentError.new('Cannot pass multiple attribute names if block given') if block_given? and names.length > 1
       raise ArgumentError.new('Cannot specify additional attributes on a slave index') if @options[:slave]
       @attributes ||= {}
-      names.each do |name|
+      names.flatten.each do |name|
         @attributes[name.to_s] = block_given? ? Proc.new { |o| o.instance_eval(&block) } : Proc.new { |o| o.send(name) }
       end
     end
@@ -95,6 +95,11 @@ module AlgoliaSearch
           Hash[@attributes.map { |name, value| [name.to_s, value.call(object) ] }]
         @additional_attributes.each { |name, value| res[name.to_s] = value.call(object) } if @additional_attributes
         res
+      elsif defined?(::Sequel) && clazz < ::Sequel::Model
+        res = @attributes.nil? || @attributes.length == 0 ? object.to_hash :
+          Hash[@attributes.map { |name, value| [name.to_s, value.call(object) ] }]
+        @additional_attributes.each { |name, value| res[name.to_s] = value.call(object) } if @additional_attributes
+        res
       else
         object.class.unscoped do
           res = @attributes.nil? || @attributes.length == 0 ? object.attributes :
@@ -229,12 +234,49 @@ module AlgoliaSearch
       attr_accessor :highlight_result, :snippet_result
 
       if options[:synchronous] == true
-        after_validation :algolia_mark_synchronous if respond_to?(:after_validation)
+        if defined?(::Sequel) && self < Sequel::Model
+          class_eval do
+            copy_after_validation = instance_method(:after_validation)
+            define_method(:after_validation) do |*args|
+              super(*args)
+              copy_after_validation.bind(self).call
+              algolia_mark_synchronous
+            end
+          end
+        else
+          after_validation :algolia_mark_synchronous if respond_to?(:after_validation)
+        end
       end
       unless options[:auto_index] == false
-        after_validation :algolia_mark_must_reindex if respond_to?(:after_validation)
-        before_save :algolia_mark_for_auto_indexing if respond_to?(:before_save)
-        after_save :algolia_perform_index_tasks if respond_to?(:after_save)
+        if defined?(::Sequel) && self < Sequel::Model
+          class_eval do
+            copy_after_validation = instance_method(:after_validation)
+            copy_before_save = instance_method(:before_save)
+            copy_after_save = instance_method(:after_save)
+
+            define_method(:after_validation) do |*args|
+              super(*args)
+              copy_after_validation.bind(self).call
+              algolia_mark_must_reindex
+            end
+
+            define_method(:before_save) do |*args|
+              copy_before_save.bind(self).call
+              algolia_mark_for_auto_indexing
+              super(*args)
+            end
+
+            define_method(:after_save) do |*args|
+              super(*args)
+              copy_after_save.bind(self).call
+              algolia_perform_index_tasks
+            end
+          end
+        else
+          after_validation :algolia_mark_must_reindex if respond_to?(:after_validation)
+          before_save :algolia_mark_for_auto_indexing if respond_to?(:before_save)
+          after_save :algolia_perform_index_tasks if respond_to?(:after_save)
+        end
       end
       unless options[:auto_remove] == false
         after_destroy { |searchable| searchable.remove_from_index! } if respond_to?(:after_destroy)
@@ -263,13 +305,18 @@ module AlgoliaSearch
             # delete non-indexable objects
             objects = group.select { |o| !algolia_indexable?(o, options) }.map { |o| algolia_object_id_of(o, options) }
             index.delete_objects(objects)
-            # select only indexable objects  
+            # select only indexable objects
             group = group.select { |o| algolia_indexable?(o, options) }
           end
-          objects = group.map { |o| settings.get_attributes(o).merge 'objectID' => algolia_object_id_of(o, options) }
+          objects = group.map do |o|
+            attributes = settings.get_attributes(o)
+            unless attributes.class == Hash
+              attributes = attributes.to_hash
+            end
+            attributes.merge 'objectID' => algolia_object_id_of(o, options)
+          end
           last_task = index.save_objects(objects)
         end
-
         index.wait_task(last_task["taskID"]) if last_task and synchronous == true
       end
       nil
@@ -590,6 +637,8 @@ module AlgoliaSearch
     def algolia_find_in_batches(batch_size, &block)
       if (defined?(::ActiveRecord) && ancestors.include?(::ActiveRecord::Base)) || respond_to?(:find_in_batches)
         find_in_batches(:batch_size => batch_size, &block)
+      elsif defined?(::Sequel) && self < Sequel::Model
+        each_page(batch_size, &block)
       else
         # don't worry, mongoid has its own underlying cursor/streaming mechanism
         items = []
@@ -638,7 +687,12 @@ module AlgoliaSearch
     end
 
     def algolia_mark_must_reindex
-      @algolia_must_reindex = new_record? || self.class.algolia_must_reindex?(self)
+      @algolia_must_reindex =
+       if defined?(::Sequel) && is_a?(Sequel::Model)
+         new? || self.class.algolia_must_reindex?(self)
+       else
+         new_record? || self.class.algolia_must_reindex?(self)
+       end
       true
     end
 

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.11.18
+  version: 1.12.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: algoliasearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.14
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.15
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: AlgoliaSearch integration to your favorite ORM
@@ -117,9 +117,9 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- .document
-- .rspec
-- .travis.yml
+- ".document"
+- ".rspec"
+- ".travis.yml"
 - ChangeLog
 - Gemfile
 - Gemfile.lock
@@ -172,17 +172,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM