searchkick 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 275937983ec78c77a0d7f25fa26a9fbe067a5154
-  data.tar.gz: 31783a30cf0b0d6170d94a99daf2c0022d20008d
+  metadata.gz: f7e8d412864f6c87ba170611a9b2cdfb6d6f6cc8
+  data.tar.gz: 98d9385aa9ad6c967ccdae9924f15d8bf0c1ee69
 SHA512:
-  metadata.gz: 636392d9b685813dbdcfd6d8b9f9aa715be73515e089f32a1c95a870c3c0ff17a3a336c3605318b9f8ea6ca406927493752fa6d603762f70a77777de41306144
-  data.tar.gz: 954203fe3c5a0e48d404322c7a270cde965bbd5f69e32e285da9e1582546cd5257bd87b616315c3e997db9402838f4966920fd5c0e10c195502b0b54214a64ff
+  metadata.gz: 00cfd0a2da2ce78127466636d5176c89356ef90311335b26f0050d58375cd3eb082113255a7eb3c71a5e0860e5c2b45a0a463363d1665e8e765ce14bb0d4d371
+  data.tar.gz: a90e126bfe9c460538ef89570e1da4512b93c804b45d43b01384c0bd5cb29d128db88668c3fa2fd009dcdc5abd4870f9216b6b6b3f4f580833703c42709e5d35

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.4
+
+- Use `to_hash` instead of `as_json` for default `search_data` method
+- Works for Mongoid 1.3
+- Use one shard in test environment for consistent scores
+
 ## 0.2.3
 
 - Setup Travis

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in searchkick.gemspec
 gemspec
+
+# gem "mongoid", github: "mongoid/mongoid"
+# gem "mongoid", "~> 3.1.0"
+# gem "activerecord", "~> 3.2.0"
+# gem "activerecord", "~> 3.1.0"

data/README.md

@@ -19,6 +19,7 @@ Plus:
 - easily personalize results for each user
 - autocomplete
 - “Did you mean” suggestions
+- works with ActiveRecord and Mongoid
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com)
 
@@ -134,24 +135,6 @@ To change this, use:
 Product.search "fresh honey", partial: true # fresh OR honey
 ```
 
-### Autocomplete
-
-![Autocomplete](http://ankane.github.io/searchkick/autocomplete.png)
-
-You must specify which fields use this feature since this can increase the index size significantly.  Don’t worry - this gives you blazing faster queries.
-
-```ruby
-class Website < ActiveRecord::Base
-  searchkick autocomplete: ["title"]
-end
-```
-
-Reindex and search with:
-
-```ruby
-Website.search "where", autocomplete: true
-```
-
 ### Synonyms
 
 ```ruby
@@ -187,6 +170,19 @@ class Product < ActiveRecord::Base
 end
 ```
 
+### To Reindex, or Not to Reindex
+
+#### Reindex
+
+- when you install or upgrade searchkick
+- change the `search_data` method
+- change the `searchkick` method
+
+#### No need to reindex
+
+- App starts
+- Records are inserted, updated or deleted (syncs automatically)
+
 ### Keep Getting Better
 
 Searchkick uses conversion data to learn what users are looking for.  If a user searches for “ice cream” and adds Ben & Jerry’s Chunky Monkey to the cart (our conversion metric at Instacart), that item gets a little more weight for similar searches.
@@ -250,6 +246,58 @@ Reindex and search with:
 Product.search "milk", user_id: 8
 ```
 
+### Autocomplete
+
+Autocomplete predicts what a user will type, making the search experience faster and easier.
+
+![Autocomplete](http://ankane.github.io/searchkick/autocomplete.png)
+
+First, specify which fields use this feature.  This is necessary since autocomplete can increase the index size significantly, but don’t worry - this gives you blazing faster queries.
+
+```ruby
+class City < ActiveRecord::Base
+  searchkick autocomplete: ["name"]
+end
+```
+
+Reindex and search with:
+
+```ruby
+City.search "san fr", autocomplete: true
+```
+
+Typically, you want to use a Javascript library like [typeahead.js](http://twitter.github.io/typeahead.js/) or [jQuery UI](http://jqueryui.com/autocomplete/).
+
+#### Here’s how to make it work with Rails
+
+First, add a controller action.
+
+```ruby
+# app/controllers/cities_controller.rb
+class CitiesController < ApplicationController
+
+  def autocomplete
+    render json: City.search(params[:q], autocomplete: true, limit: 10).map(&:name)
+  end
+
+end
+```
+
+Then add the search box and Javascript code to a view.
+
+```html
+<input type="text" id="q" name="q" />
+
+<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.0.3/jquery.min.js"></script>
+<script src="//cdnjs.cloudflare.com/ajax/libs/typeahead.js/0.9.3/typeahead.min.js"></script>
+<script>
+  $("#q").typeahead({
+    name: "city",
+    remote: "/cities/autocomplete?q=%QUERY"
+  });
+</script>
+```
+
 ### Suggestions
 
 ![Suggest](http://ankane.github.io/searchkick/recursion.png)

data/lib/searchkick.rb

@@ -9,5 +9,5 @@ require "searchkick/tasks"
 require "searchkick/logger" if defined?(Rails)
 
 # TODO find better ActiveModel hook
-ActiveModel::AttributeMethods::ClassMethods.send(:include, Searchkick::Model)
+ActiveModel::Callbacks.send(:include, Searchkick::Model)
 ActiveRecord::Base.send(:extend, Searchkick::Model) if defined?(ActiveRecord)

data/lib/searchkick/model.rb

@@ -19,7 +19,7 @@ module Searchkick
         end
 
         def search_data
-          as_json
+          to_hash.reject{|k, v| k == "id" }
         end
 
         def to_indexed_json

data/lib/searchkick/reindex.rb

@@ -14,8 +14,22 @@ module Searchkick
 
       # use scope for import
       scope = respond_to?(:search_import) ? search_import : self
-      scope.find_in_batches do |batch|
-        index.import batch
+      if scope.respond_to?(:find_in_batches)
+        scope.find_in_batches do |batch|
+          index.import batch
+        end
+      else
+        # https://github.com/karmi/tire/blob/master/lib/tire/model/import.rb
+        # use cursor for Mongoid
+        items = []
+        scope.all.each do |item|
+          items << item
+          if items.length % 1000 == 0
+            index.import items
+            items = []
+          end
+        end
+        index.import items
       end
 
       if a = Tire::Alias.find(alias_name)
@@ -121,7 +135,13 @@ module Searchkick
             }
           }
         }
-      }.merge(options[:settings] || {})
+      }
+
+      if ENV["RACK_ENV"] == "test"
+        settings.merge!(number_of_shards: 1, number_of_replicas: 0)
+      end
+
+      settings.merge!(options[:settings] || {})
 
       # synonyms
       synonyms = options[:synonyms] || []

data/lib/searchkick/search.rb

@@ -28,7 +28,7 @@ module Searchkick
       page = [options[:page].to_i, 1].max
       per_page = options[:limit] || options[:per_page] || 100000
       offset = options[:offset] || (page - 1) * per_page
-      index_name = options[:index_name] || index.name
+      index_name = options[:index_name] || tire.index.name
 
       conversions_field = @searchkick_options[:conversions]
       personalize_field = @searchkick_options[:personalize]

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/test/index_test.rb

@@ -12,7 +12,7 @@ class TestIndex < Minitest::Unit::TestCase
 
     Product.clean_indices
 
-    assert Product.index.exists?
+    assert Product.tire.index.exists?
     assert different_index.exists?
     assert !old_index.exists?
   end

data/test/similar_test.rb

@@ -4,7 +4,7 @@ class TestSimilar < Minitest::Unit::TestCase
 
   def test_fields
     store_names ["1% Organic Milk", "2% Organic Milk", "Popcorn"]
-    assert_equal ["2% Organic Milk"], Product.find_by(name: "1% Organic Milk").similar(fields: ["name"]).map(&:name)
+    assert_equal ["2% Organic Milk"], Product.where(name: "1% Organic Milk").first.similar(fields: ["name"]).map(&:name)
   end
 
 end

data/test/test_helper.rb

@@ -2,47 +2,65 @@ require "bundler/setup"
 Bundler.require(:default)
 require "minitest/autorun"
 require "minitest/pride"
-require "active_record"
 
 ENV["RACK_ENV"] = "test"
 
-# for debugging
-# ActiveRecord::Base.logger = Logger.new(STDOUT)
+File.delete("elasticsearch.log") if File.exists?("elasticsearch.log")
+Tire.configure do
+  logger "elasticsearch.log", :level => "debug"
+  pretty true
+end
 
-# rails does this in activerecord/lib/active_record/railtie.rb
-ActiveRecord::Base.default_timezone = :utc
-ActiveRecord::Base.time_zone_aware_attributes = true
+if ENV["MONGOID"]
+  Mongoid.configure do |config|
+    config.connect_to "searchkick_test"
+  end
 
-# migrations
-ActiveRecord::Base.establish_connection :adapter => "postgresql", :database => "searchkick_test"
+  class Product
+    include Mongoid::Document
+    # include Mongoid::Attributes::Dynamic
+  end
 
-ActiveRecord::Migration.create_table :products, :force => true do |t|
-  t.string :name
-  t.integer :store_id
-  t.boolean :in_stock
-  t.boolean :backordered
-  t.integer :orders_count
-  t.string :color
-  t.timestamps
-end
+  class Store
+    include Mongoid::Document
+  end
+else
+  require "active_record"
+
+  # for debugging
+  # ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+  # rails does this in activerecord/lib/active_record/railtie.rb
+  ActiveRecord::Base.default_timezone = :utc
+  ActiveRecord::Base.time_zone_aware_attributes = true
+
+  # migrations
+  ActiveRecord::Base.establish_connection :adapter => "postgresql", :database => "searchkick_test"
+
+  ActiveRecord::Migration.create_table :products, :force => true do |t|
+    t.string :name
+    t.integer :store_id
+    t.boolean :in_stock
+    t.boolean :backordered
+    t.integer :orders_count
+    t.string :color
+    t.timestamps
+  end
 
-ActiveRecord::Migration.create_table :store, :force => true do |t|
-end
+  ActiveRecord::Migration.create_table :store, :force => true do |t|
+  end
 
-File.delete("elasticsearch.log") if File.exists?("elasticsearch.log")
-Tire.configure do
-  logger "elasticsearch.log", :level => "debug"
-  pretty true
+  class Product < ActiveRecord::Base
+  end
+
+  class Store < ActiveRecord::Base
+  end
 end
 
-class Product < ActiveRecord::Base
+class Product
   belongs_to :store
 
   searchkick \
-    settings: {
-      number_of_shards: 1,
-      number_of_replicas: 0
-    },
     synonyms: [
       ["clorox", "bleach"],
       ["scallion", "greenonion"],
@@ -59,14 +77,11 @@ class Product < ActiveRecord::Base
   attr_accessor :conversions, :user_ids
 
   def search_data
-    as_json.merge conversions: conversions, user_ids: user_ids
+    to_hash.merge conversions: conversions, user_ids: user_ids
   end
 end
 
-class Store < ActiveRecord::Base
-end
-
-Product.index.delete if Product.index.exists?
+Product.tire.index.delete if Product.tire.index.exists?
 Product.reindex
 Product.reindex # run twice for both index paths
 
@@ -82,7 +97,7 @@ class MiniTest::Unit::TestCase
     documents.shuffle.each do |document|
       Product.create!(document)
     end
-    Product.index.refresh
+    Product.tire.index.refresh
   end
 
   def store_names(names)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tire