searchkick 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1da092cc431fe04831d998435718459f8bebf261
-  data.tar.gz: 21a86486b94f81e6b9b9061fb6cf051ac7672650
+  metadata.gz: ff1b17b6561440bad2ebe3c20d1606b13d579310
+  data.tar.gz: 50475abfd988e11bca0b04385a4ec264bac80467
 SHA512:
-  metadata.gz: 2b8bbdb5158b5c39994277ab80e46a14b222b5dd24a22204dcc3acb8d3b853b50b692e77a1b634774e5611ca930b1e495428200e9ddcd726254af7db3820a251
-  data.tar.gz: 3661b1fbb97fd864e524745b2f7435486aeb4cec005381e01a7c37ed6683b38e55b5a5921d60635d46d1700012d18b7662abb99545ee655c635882b9b5b322d4
+  metadata.gz: 19e25e2f81fb811f7bf1964cb59a5deccfc6386d10640279bfe6cfb7bb81a1611691ebd6ccb8879c7dcbec4f530d5ccf2fae089e19cc8f783409985092d2315b
+  data.tar.gz: be76d99160e570515a3120ecb517a6faef29f2b3b95eb4ebc6556cbe2839d3554faa7295ff72ccc14caf82fb817b65e2286a74377fd95137d68c6666383bc26f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.2
+
+- Added support for single table inheritance
+- Removed Tire::Model::Search
+
 ## 0.3.1
 
 - Added index_prefix option

data/README.md

@@ -360,7 +360,7 @@ class City < ActiveRecord::Base
   searchkick locations: ["location"]
 
   def search_data
-    to_hash.merge location: [latitude.to_f, longitude.to_f]
+    to_hash.merge location: [latitude, longitude]
   end
 end
 ```
@@ -419,6 +419,29 @@ Then deploy and reindex:
 rake searchkick:reindex CLASS=Product
 ```
 
+## Inheritance
+
+Searchkick supports single table inheritance.
+
+```ruby
+class Dog < Animal
+end
+```
+
+The parent and child model can both reindex.
+
+```ruby
+Animal.reindex
+Dog.reindex # equivalent
+```
+
+And to search, use:
+
+```ruby
+Animal.search "*" # all animals
+Dog.search "*"    # just dogs
+```
+
 ## Reference
 
 Searchkick requires Elasticsearch `0.90.0` or higher.

data/lib/searchkick/model.rb

@@ -2,26 +2,39 @@ module Searchkick
   module Model
 
     def searchkick(options = {})
-      @searchkick_options = options.dup
-      @searchkick_env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
-      searchkick_env = @searchkick_env # for class_eval
-
       class_eval do
+        cattr_reader :searchkick_options, :searchkick_env, :searchkick_klass, :searchkick_index
+
+        class_variable_set :@@searchkick_options, options.dup
+        class_variable_set :@@searchkick_env, ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
+        class_variable_set :@@searchkick_klass, self
+
+        # set index name
+        # TODO support proc
+        index_name = options[:index_name] || [options[:index_prefix], model_name.plural, searchkick_env].compact.join("_")
+        class_variable_set :@@searchkick_index, Tire::Index.new(index_name)
+
         extend Searchkick::Search
         extend Searchkick::Reindex
         include Searchkick::Similar
-        include Tire::Model::Search
-        include Tire::Model::Callbacks unless options[:callbacks] == false
-        tire do
-          index_name options[:index_name] || [options[:index_prefix], klass.model_name.plural, searchkick_env].compact.join("_")
-        end
 
         def reindex
-          tire.update_index
+          index = self.class.searchkick_index
+          if destroyed?
+            index.remove self
+          else
+            index.store self
+          end
+        end
+
+        unless options[:callbacks] == false
+          # TODO ability to temporarily disable
+          after_save :reindex
+          after_destroy :reindex
         end
 
         def search_data
-          to_hash.reject{|k, v| k == "id" }
+          respond_to?(:to_hash) ? to_hash : serializable_hash
         end
 
         def to_indexed_json
@@ -30,7 +43,7 @@ module Searchkick
           # stringify fields
           source = source.inject({}){|memo,(k,v)| memo[k.to_s] = v; memo}
 
-          options = self.class.instance_variable_get("@searchkick_options")
+          options = self.class.searchkick_options
 
           # conversions
           conversions_field = options[:conversions]
@@ -45,11 +58,22 @@ module Searchkick
 
           # locations
           (options[:locations] || []).map(&:to_s).each do |field|
-            source[field] = source[field].reverse if source[field]
+            source[field] = source[field].map(&:to_f).reverse if source[field]
           end
 
           source.to_json
         end
+
+        # TODO remove
+
+        def self.document_type
+          model_name.to_s.underscore
+        end
+
+        def document_type
+          self.class.document_type
+        end
+
       end
     end
 

data/lib/searchkick/reindex.rb

@@ -3,7 +3,7 @@ module Searchkick
 
     # https://gist.github.com/jarosan/3124884
     def reindex
-      alias_name = tire.index.name
+      alias_name = searchkick_index.name
       new_index = alias_name + "_" + Time.now.strftime("%Y%m%d%H%M%S%L")
       index = Tire::Index.new(new_index)
 
@@ -28,7 +28,7 @@ module Searchkick
           raise response.to_s
         end
       else
-        tire.index.delete if tire.index.exists?
+        searchkick_index.delete if searchkick_index.exists?
         response = Tire::Alias.create(name: alias_name, indices: [new_index])
         raise response.to_s if !response.success?
 
@@ -41,7 +41,7 @@ module Searchkick
     # remove old indices that start w/ index_name
     def clean_indices
       all_indices = JSON.parse(Tire::Configuration.client.get("#{Tire::Configuration.url}/_aliases").body)
-      indices = all_indices.select{|k, v| v["aliases"].empty? && k =~ /\A#{Regexp.escape(tire.index.name)}_\d{14,17}\z/ }.keys
+      indices = all_indices.select{|k, v| v["aliases"].empty? && k =~ /\A#{Regexp.escape(searchkick_index.name)}_\d{14,17}\z/ }.keys
       indices.each do |index|
         Tire::Index.new(index).delete
       end
@@ -56,7 +56,8 @@ module Searchkick
 
     def searchkick_import(index)
       # use scope for import
-      scope = respond_to?(:search_import) ? search_import : self
+      scope = searchkick_klass
+      scope = scope.search_import if scope.respond_to?(:search_import)
       if scope.respond_to?(:find_in_batches)
         scope.find_in_batches do |batch|
           index.import batch
@@ -77,7 +78,7 @@ module Searchkick
     end
 
     def searchkick_index_options
-      options = @searchkick_options
+      options = searchkick_options
 
       settings = {
         analysis: {
@@ -148,7 +149,7 @@ module Searchkick
         }
       }
 
-      if @searchkick_env == "test"
+      if searchkick_env == "test"
         settings.merge!(number_of_shards: 1, number_of_replicas: 0)
       end
 
@@ -220,7 +221,7 @@ module Searchkick
       end
 
       mappings = {
-        document_type.to_sym => {
+        searchkick_klass.document_type.to_sym => {
           properties: mapping,
           # https://gist.github.com/kimchy/2898285
           dynamic_templates: [

data/lib/searchkick/search.rb

@@ -12,7 +12,7 @@ module Searchkick
           end
         else
           if options[:autocomplete]
-            (@searchkick_options[:autocomplete] || []).map{|f| "#{f}.autocomplete" }
+            (searchkick_options[:autocomplete] || []).map{|f| "#{f}.autocomplete" }
           else
             ["_all"]
           end
@@ -28,10 +28,10 @@ module Searchkick
       page = [options[:page].to_i, 1].max
       per_page = (options[:limit] || options[:per_page] || 100000).to_i
       offset = options[:offset] || (page - 1) * per_page
-      index_name = options[:index_name] || tire.index.name
+      index_name = options[:index_name] || searchkick_index.name
 
-      conversions_field = @searchkick_options[:conversions]
-      personalize_field = @searchkick_options[:personalize]
+      conversions_field = searchkick_options[:conversions]
+      personalize_field = searchkick_options[:personalize]
 
       all = term == "*"
 
@@ -176,7 +176,7 @@ module Searchkick
                 if value[:near]
                   filters << {
                     geo_distance: {
-                      field => value.delete(:near).reverse,
+                      field => value.delete(:near).map(&:to_f).reverse,
                       distance: value.delete(:within) || "50mi"
                     }
                   }
@@ -186,8 +186,8 @@ module Searchkick
                   filters << {
                     geo_bounding_box: {
                       field => {
-                        top_left: value.delete(:top_left).reverse,
-                        bottom_right: value.delete(:bottom_right).reverse
+                        top_left: value.delete(:top_left).map(&:to_f).reverse,
+                        bottom_right: value.delete(:bottom_right).map(&:to_f).reverse
                       }
                     }
                   }
@@ -269,7 +269,7 @@ module Searchkick
 
       # suggestions
       if options[:suggest]
-        suggest_fields = (@searchkick_options[:suggest] || []).map(&:to_s)
+        suggest_fields = (searchkick_options[:suggest] || []).map(&:to_s)
         # intersection
         suggest_fields = suggest_fields & options[:fields].map(&:to_s) if options[:fields]
         if suggest_fields.any?
@@ -288,7 +288,9 @@ module Searchkick
       # http://www.elasticsearch.org/guide/reference/api/search/fields/
       payload[:fields] = [] if load
 
-      search = Tire::Search::Search.new(index_name, load: load, payload: payload, size: per_page, from: offset)
+      tire_options = {load: load, payload: payload, size: per_page, from: offset}
+      tire_options[:type] = document_type if self != searchkick_klass
+      search = Tire::Search::Search.new(index_name, tire_options)
       response = search.json
 
       # apply facet limit in client due to

data/lib/searchkick/similar.rb

@@ -2,7 +2,7 @@ module Searchkick
   module Similar
 
     def similar(options = {})
-      like_text = index.retrieve(document_type, id).to_hash
+      like_text = self.class.searchkick_index.retrieve(document_type, id).to_hash
         .keep_if{|k,v| k[0] != "_" and (!options[:fields] or options[:fields].map(&:to_sym).include?(k)) }
         .values.compact.join(" ")
 

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/test/index_test.rb

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

data/test/inheritance_test.rb

@@ -0,0 +1,33 @@
+require_relative "test_helper"
+
+class TestInheritance < Minitest::Unit::TestCase
+
+  def setup
+    super
+    Animal.destroy_all
+  end
+
+  def test_child_reindex
+    store_names ["Max"], Cat
+    assert Dog.reindex
+    Animal.searchkick_index.refresh
+    assert_equal 1, Animal.search("*").size
+  end
+
+  def test_child_index_name
+    assert_equal "animals_test", Dog.searchkick_index.name
+  end
+
+  def test_child_search
+    store_names ["Bear"], Dog
+    store_names ["Bear"], Cat
+    assert_equal 1, Dog.search("bear").size
+  end
+
+  def test_parent_search
+    store_names ["Bear"], Dog
+    store_names ["Bear"], Cat
+    assert_equal 2, Animal.search("bear").size
+  end
+
+end

data/test/test_helper.rb

@@ -24,6 +24,16 @@ if ENV["MONGOID"]
   class Store
     include Mongoid::Document
   end
+
+  class Animal
+    include Mongoid::Document
+  end
+
+  class Dog < Animal
+  end
+
+  class Cat < Animal
+  end
 else
   require "active_record"
 
@@ -49,7 +59,12 @@ else
     t.timestamps
   end
 
-  ActiveRecord::Migration.create_table :store, :force => true do |t|
+  ActiveRecord::Migration.create_table :stores, :force => true do |t|
+  end
+
+  ActiveRecord::Migration.create_table :animals, :force => true do |t|
+    t.string :name
+    t.string :type
   end
 
   class Product < ActiveRecord::Base
@@ -57,6 +72,15 @@ else
 
   class Store < ActiveRecord::Base
   end
+
+  class Animal < ActiveRecord::Base
+  end
+
+  class Dog < Animal
+  end
+
+  class Cat < Animal
+  end
 end
 
 class Product
@@ -80,14 +104,20 @@ class Product
   attr_accessor :conversions, :user_ids
 
   def search_data
-    to_hash.merge conversions: conversions, user_ids: user_ids, location: [latitude.to_f, longitude.to_f]
+    attributes.merge conversions: conversions, user_ids: user_ids, location: [latitude, longitude]
   end
 end
 
-Product.tire.index.delete if Product.tire.index.exists?
+class Animal
+  searchkick
+end
+
+Product.searchkick_index.delete if Product.searchkick_index.exists?
 Product.reindex
 Product.reindex # run twice for both index paths
 
+Animal.reindex
+
 class MiniTest::Unit::TestCase
 
   def setup
@@ -96,15 +126,15 @@ class MiniTest::Unit::TestCase
 
   protected
 
-  def store(documents)
+  def store(documents, klass = Product)
     documents.shuffle.each do |document|
-      Product.create!(document)
+      klass.create!(document)
     end
-    Product.tire.index.refresh
+    klass.searchkick_index.refresh
   end
 
-  def store_names(names)
-    store names.map{|name| {name: name} }
+  def store_names(names, klass = Product)
+    store names.map{|name| {name: name} }, klass
   end
 
   # no order

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-02 00:00:00.000000000 Z
+date: 2013-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tire
@@ -136,6 +136,7 @@ files:
 - test/boost_test.rb
 - test/facets_test.rb
 - test/index_test.rb
+- test/inheritance_test.rb
 - test/match_test.rb
 - test/similar_test.rb
 - test/sql_test.rb
@@ -171,6 +172,7 @@ test_files:
 - test/boost_test.rb
 - test/facets_test.rb
 - test/index_test.rb
+- test/inheritance_test.rb
 - test/match_test.rb
 - test/similar_test.rb
 - test/sql_test.rb