algoliasearch-rails 1.4.5 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 385a4a1b2e2ba4fdfe5fd4a548cb8cd999e337e9
-  data.tar.gz: 5ed6fa59120bfd28e4ba395e969645c422bc3cb6
+  metadata.gz: 3f261644d4f85253064f4683e6815c3fc4ef8a36
+  data.tar.gz: 47b1f0cfccd530d7fd5987fa82019abc4363e4da
 SHA512:
-  metadata.gz: 7d2ce611df1b22d8c81d2ab76896a6cd9236ce2f7c2b822d956a43bbc70e3cbaad6e219d7ad956a6ee6a276195b81101f05b52da8695a64bd1a40eedfa94665f
-  data.tar.gz: 3beeb4d604280581b6a22831b9fc29a37bfd1117f010f21f56af56fdcb360275294ba8036e7853f0e0c3f96fe300226f0c56f5dedf239d2a656451c70ba76272
+  metadata.gz: f596456245ab08f64f23f7fb908d839489fb1bedfcf2b36752a67d7c561f52ab974e87a40c3a57614334b0ae56345d8e24779b54f3b561e639f7f741d767ed5f
+  data.tar.gz: 77cd27fb4231f8e6c4fc7076993557d23f17f89edec86aa299c03fe2807c37fce722b4aac9317446079cfa597a535e6dc1d081bdfa984125172eff8c997f888b

data/ChangeLog

@@ -1,5 +1,9 @@
 CHANGELOG
 
+2013-12-03  1.5.1
+
+      * ability to specify which attribute is used as objectID
+
 2013-11-29  1.4.5
 
       * updated algoliasearch-client-js to 2.3.3

data/README.md

@@ -89,7 +89,7 @@ p Contact.search("jon doe")
 Options
 ----------
 
-Each time a record is saved; it will be - asynchronously - indexed. In the other hand, each time a record is destroyed, it will be - asynchronoulsy - removed from the index.
+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.
 
 You can disable auto-indexing and auto-removing setting the following options:
 
@@ -164,6 +164,17 @@ class Contact < ActiveRecord::Base
 end
 ```
 
+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).
+
+```ruby
+class UniqUser < ActiveRecord::Base
+  include AlgoliaSearch
+
+  algoliasearch id: :uniq_name do
+  end
+end
+```
+
 Indexing
 ---------
 

data/VERSION

@@ -1 +1 @@
-1.4.5
+1.5.1

data/algoliasearch-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-rails"
-  s.version = "1.4.5"
+  s.version = "1.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]
-  s.date = "2013-11-29"
+  s.date = "2013-12-03"
   s.description = "AlgoliaSearch integration to your favorite ORM"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [

data/lib/algoliasearch-rails.rb

@@ -124,7 +124,7 @@ module AlgoliaSearch
       ensure_init
       last_task = nil
       find_in_batches(batch_size: batch_size) do |group|
-        objects = group.map { |o| @index_settings.get_attributes(o).merge 'objectID' => o.id.to_s }
+        objects = group.map { |o| @index_settings.get_attributes(o).merge 'objectID' => object_id_of(o) }
         last_task = @index.save_objects(objects)
       end
       @index.wait_task(last_task["taskID"]) if last_task and synchronous == true
@@ -134,9 +134,9 @@ module AlgoliaSearch
       return if @without_auto_index_scope
       ensure_init
       if synchronous
-        @index.add_object!(@index_settings.get_attributes(object), object.id.to_s)
+        @index.add_object!(@index_settings.get_attributes(object), object_id_of(object))
       else
-        @index.add_object(@index_settings.get_attributes(object), object.id.to_s)
+        @index.add_object(@index_settings.get_attributes(object), object_id_of(object))
       end
     end
 
@@ -144,9 +144,9 @@ module AlgoliaSearch
       return if @without_auto_index_scope
       ensure_init
       if synchronous
-        @index.delete_object!(object.id.to_s)
+        @index.delete_object!(object_id_of(object))
       else
-        @index.delete_object(object.id.to_s)
+        @index.delete_object(object_id_of(object))
       end
     end
 
@@ -160,7 +160,7 @@ module AlgoliaSearch
       ensure_init
       json = @index.search(q, Hash[settings.map { |k,v| [k.to_s, v.to_s] }])
       results = json['hits'].map do |hit|
-        o = full_const_get(@options[:type].to_s).find(hit['objectID'])
+        o = full_const_get(@options[:type].to_s).where(object_id_method => hit['objectID']).first
         o.highlight_result = hit['_highlightResult']
         o
       end
@@ -175,7 +175,7 @@ module AlgoliaSearch
     end
 
     def must_reindex?(object)
-      return true if object.id_changed?
+      return true if object_id_changed?(object)
       @index_settings.get_attributes(object).each do |k, v|
         changed_method = "#{k}_changed?"
         return true if object.respond_to?(changed_method) && object.send(changed_method)
@@ -191,6 +191,19 @@ module AlgoliaSearch
 
     private
 
+    def object_id_method
+      @options[:id] || @options[:object_id] || :id
+    end
+
+    def object_id_of(o)
+      o.send(object_id_method).to_s
+    end
+
+    def object_id_changed?(o)
+      m = "#{object_id_method}_changed?"
+      o.respond_to?(m) ? o.send(m) : false
+    end
+
     def index_settings_changed?(prev, current)
       return true if prev.nil?
       current.each do |k, v|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.5.1
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json