algoliasearch-rails 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d428c61f7c4dc2a09a1cf096ea4a3ff8f473a371
-  data.tar.gz: 6ff620725b76b9d753a6a01078c216168e33d0ab
+  metadata.gz: 0e29ac47364a507c6d864668517822cffce9c2d6
+  data.tar.gz: 66acdcd30134e3b656e03eab50400c3424853e52
 SHA512:
-  metadata.gz: bd7bf16ad2c6ca12e1850b5cc0e33c6990a03bae6aca68c6b97185fef5d1e842b6a6f56c5f7700b85936c8c26ca136542cf68b334fec1bde0eadd77601e24d79
-  data.tar.gz: 361a11ba7ba9c81f572b773f0bc97afc0e8fea5d324c552963c06fd248d22b93fe69f54c87503910361656c86a11bb9ba05c9de69c76373c90570e9f202fa2b6
+  metadata.gz: daa6bdbe2bd086b90c710942c87474684cad0a1af44406e2a2ffdc6033baf7ef4a4eac7d9a566bab4e6b4f4a34f0d3b4a1f4ac8ff1fe3527da14ec0178a5edf1
+  data.tar.gz: fd0ab69277ac18436e0fa3a789fd0844621360a3310d81721732234530b240d561b5c821864c55151491818244ce0fb14b80e95574456f8fdf5d7e4595698e90

data/ChangeLog

@@ -1,5 +1,11 @@
 CHANGELOG
 
+2013-11-07  1.3.3
+
+      * new :per_environment options suffixing index's name by the Rails environment
+      * index's settings are now initialized on first usage, not at include time
+      * plug attributesForFaceting setting
+
 2013-10-17  1.3.2
 
       * while detecting settings changes, fixed array comparison

data/Gemfile.lock

@@ -1,32 +1,32 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.9.4)
-    actionpack (4.0.0)
-      activesupport (= 4.0.0)
+    ZenTest (4.9.5)
+    actionpack (4.0.1)
+      activesupport (= 4.0.1)
       builder (~> 3.1.0)
       erubis (~> 2.7.0)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    activemodel (4.0.0)
-      activesupport (= 4.0.0)
+    activemodel (4.0.1)
+      activesupport (= 4.0.1)
       builder (~> 3.1.0)
-    activerecord (4.0.0)
-      activemodel (= 4.0.0)
+    activerecord (4.0.1)
+      activemodel (= 4.0.1)
       activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.0)
+      activesupport (= 4.0.1)
       arel (~> 4.0.0)
     activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.0)
+    activesupport (4.0.1)
       i18n (~> 0.6, >= 0.6.4)
       minitest (~> 4.2)
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
     addressable (2.3.5)
-    algoliasearch (1.1.4)
+    algoliasearch (1.1.5)
       curb
-    arel (4.0.0)
+    arel (4.0.1)
     atomic (1.1.14)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
@@ -46,7 +46,7 @@ GEM
       multipart-post (~> 1.2.0)
     faraday_middleware (0.9.0)
       faraday (>= 0.7.4, < 0.9)
-    ffi (1.9.0)
+    ffi (1.9.3)
     gh (0.13.0)
       addressable
       backports
@@ -63,7 +63,7 @@ GEM
       nokogiri (~> 1.5.2)
       oauth2
     hashie (2.0.5)
-    highline (1.6.19)
+    highline (1.6.20)
     httpauth (0.2.0)
     i18n (0.6.5)
     jeweler (1.8.8)
@@ -75,7 +75,7 @@ GEM
       nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.8.0)
+    json (1.8.1)
     jwt (0.1.8)
       multi_json (>= 1.5)
     kaminari (0.14.1)
@@ -104,8 +104,7 @@ GEM
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
-    pusher-client (0.3.1)
-      ruby-hmac (~> 0.4.0)
+    pusher-client (0.4.0)
       websocket (~> 1.0.0)
     rack (1.5.2)
     rack-test (0.6.2)
@@ -118,19 +117,18 @@ GEM
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
+    rspec-core (2.14.7)
     rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    ruby-hmac (0.4.0)
+    rspec-mocks (2.14.4)
     slop (3.4.6)
     sqlite3 (1.3.8)
     sys-uname (0.9.2)
       ffi (>= 1.0.0)
-    terminal-notifier (1.5.1)
     thread_safe (0.1.3)
       atomic
-    travis (1.5.5)
+    travis (1.5.8)
+      addressable (~> 2.3)
       backports
       faraday (~> 0.8.7)
       faraday_middleware (~> 0.9)
@@ -139,10 +137,9 @@ GEM
       launchy (~> 2.1)
       netrc (~> 0.7)
       pry (~> 0.9)
-      pusher-client (~> 0.3, >= 0.3.1)
-      terminal-notifier (>= 1.4.2)
+      pusher-client (~> 0.4)
       typhoeus (~> 0.6)
-    typhoeus (0.6.5)
+    typhoeus (0.6.6)
       ethon (~> 0.6.1)
     tzinfo (0.3.38)
     websocket (1.0.7)

data/README.md

@@ -56,7 +56,7 @@ AlgoliaSearch.configuration = { application_id: 'YourApplicationID', api_key: 'Y
 Quick Start
 -------------
 
-The following code will create a <code>contact</code> index and add search capabilities to your <code>Contact</code> model:
+The following code will create a <code>Contact</code> index and add search capabilities to your <code>Contact</code> model:
 
 ```ruby
 class Contact < ActiveRecord::Base
@@ -113,13 +113,25 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-You can force force the index name using the following option:
+You can force the index name using the following option:
 
 ```ruby
 class Contact < ActiveRecord::Base
   include AlgoliaSearch
 
-  algoliasearch index_name: "contacts_#{Rails.env}" do
+  algoliasearch index_name: "MyCustomName" do
+    attribute :first_name, :last_name, :email
+  end
+end
+```
+
+You can suffix the index name with the current Rails environment using the following option:
+
+```ruby
+class Contact < ActiveRecord::Base
+  include AlgoliaSearch
+
+  algoliasearch per_environment: true do # index name will be "Contact_#{Rails.env}"
     attribute :first_name, :last_name, :email
   end
 end
@@ -164,7 +176,7 @@ All [settings](https://github.com/algolia/algoliasearch-client-ruby#index-settin
 class Contact < ActiveRecord::Base
   include AlgoliaSearch
 
-  algoliasearch auto_index: false, auto_remove: false do
+  algoliasearch do
     attribute :first_name, :last_name, :email
     minWordSizeForApprox1 2
     minWordSizeForApprox2 5
@@ -180,7 +192,7 @@ p Contact.search("jon doe", hitsPerPage: 5, page: 2)
 Typeahead UI
 -------------
 
-Require ```algolia/algoliasearch.min``` (see [algoliasearch-client-js](https://github.com/algolia/algoliasearch-client-js)) and ```algolia/typeahead.js``` (a modified version of typeahead.js with custom transports, see the [pull request](https://github.com/twitter/typeahead.js/pull/473)) somewhere in your JavaScript manifest, for example in application.js if you are using Rails 3.1+:
+Require ```algolia/algoliasearch.min``` (see [algoliasearch-client-js](https://github.com/algolia/algoliasearch-client-js)) and ```algolia/typeahead.js``` (a modified version of typeahead.js with custom transports, see the [pull request](https://github.com/twitter/typeahead.js/pull/473)) somewhere in your JavaScript manifest, for example in ```application.js``` if you are using Rails 3.1+:
 
 ```javascript
 //= require algolia/algoliasearch.min
@@ -199,10 +211,10 @@ Turns any ```input[type="text"]``` element into a typeahead, for example:
 <input name="email" placeholder="test@example.org" id="user_email" />
 <script type="text/javascript">
   $(document).ready(function() {
-    var client = new AlgoliaSearch('YourApplicationID', 'ReadOnlyApplicationKey');
+    var client = new AlgoliaSearch('YourApplicationID', 'SearchOnlyApplicationKey');
     $('input#user_email').typeahead({
       name: 'emails',
-      remote: client.initIndex('YourIndex').getTypeaheadTransport(),
+      remote: client.initIndex('#{Contact.index_name}').getTypeaheadTransport(),
       engine: Hogan,
       template: '{{{_highlightResult.email.value}}} ({{{_highlightResult.first_name.value}}} {{{_highlightResult.last_name.value}}})',
       valueKey: 'email'

data/VERSION

@@ -1 +1 @@
-1.3.2
+1.3.3

data/algoliasearch-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-rails"
-  s.version = "1.3.2"
+  s.version = "1.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]
-  s.date = "2013-10-17"
+  s.date = "2013-11-07"
   s.description = "AlgoliaSearch integration to your favorite ORM"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [
@@ -46,7 +46,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/algolia/algoliasearch-rails"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.3"
+  s.rubygems_version = "2.0.12"
   s.summary = "AlgoliaSearch integration to your favorite ORM"
 
   if s.respond_to? :specification_version then

data/lib/algoliasearch-rails.rb

@@ -48,7 +48,7 @@ module AlgoliaSearch
     OPTIONS = [:attributesToIndex, :minWordSizefor1Typo,
       :minWordSizefor2Typos, :hitsPerPage, :attributesToRetrieve,
       :attributesToHighlight, :attributesToSnippet, :attributesToIndex,
-      :ranking, :customRanking, :queryType]
+      :ranking, :customRanking, :queryType, :attributesForFaceting]
     OPTIONS.each do |k|
       define_method k do |v|
         instance_variable_set("@#{k}", v)
@@ -89,11 +89,11 @@ module AlgoliaSearch
       attr_accessor :highlight_result
 
       if options[:synchronous] == true
-        before_save :mark_synchronous if respond_to?(:before_save)
+        after_validation :mark_synchronous if respond_to?(:before_validation)
       end
       unless options[:auto_index] == false
-        before_save :mark_for_auto_indexing if respond_to?(:before_save)
         after_validation :mark_must_reindex if respond_to?(:after_validation)
+        before_save :mark_for_auto_indexing if respond_to?(:before_save)
         after_save :perform_index_tasks if respond_to?(:after_save)
       end
       unless options[:auto_remove] == false
@@ -101,10 +101,10 @@ module AlgoliaSearch
       end
 
       @options = { type: model_name, per_page: @index_options.get(:hitsPerPage) || 10, page: 1 }.merge(options)
-      init
     end
 
     def reindex!(batch_size = 1000, synchronous = false)
+      ensure_init
       last_task = nil
       find_in_batches(batch_size: batch_size) do |group|
         objects = group.map { |o| attributes(o).merge 'objectID' => o.id.to_s }
@@ -114,6 +114,7 @@ module AlgoliaSearch
     end
 
     def index!(object, synchronous = false)
+      ensure_init
       if synchronous
         @index.add_object!(attributes(object), object.id.to_s)
       else
@@ -122,6 +123,7 @@ module AlgoliaSearch
     end
 
     def remove_from_index!(object, synchronous = false)
+      ensure_init
       if synchronous
         @index.delete_object!(object.id.to_s)
       else
@@ -130,9 +132,9 @@ module AlgoliaSearch
     end
 
     def clear_index!
-      @index.delete rescue "already deleted, not fatal"
+      ensure_init
+      @index.delete
       @index = nil
-      init
     end
 
     def search(q, settings = {})
@@ -145,11 +147,13 @@ module AlgoliaSearch
       AlgoliaSearch::Pagination.create(results, json['nbHits'].to_i, @options)
     end
 
-    def init
-      @index ||= Algolia::Index.new(@options[:index_name] || model_name)
-      settings = @index_options.to_settings
-      prev_settings = @index.get_settings rescue nil # if the index doesn't exist
-      @index.set_settings(settings) if index_settings_changed?(prev_settings, settings)
+    def ensure_init
+      new_settings = @index_options.to_settings
+      return if @index and !index_settings_changed?(@settings, new_settings)
+      @index = Algolia::Index.new(index_name)
+      current_settings = @index.get_settings rescue nil # if the index doesn't exist
+      @index.set_settings(new_settings) if index_settings_changed?(current_settings, new_settings)
+      @settings = new_settings
     end
 
     def must_reindex?(object)
@@ -161,6 +165,12 @@ module AlgoliaSearch
       return false
     end
 
+    def index_name
+      name = @options[:index_name] || model_name
+      name = "#{name}_#{Rails.env.to_s}" if @options[:per_environment]
+      name
+    end
+
     private
 
     def attributes(object)

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 require 'rubygems'
+require 'bundler'
+
 Bundler.setup :test
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -147,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.12
 signing_key: 
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM