searchkick_bharthur 0.0.1

data/test/sql_test.rb

@@ -0,0 +1,196 @@
+require_relative "test_helper"
+
+class SqlTest < Minitest::Test
+  def test_partial
+    store_names ["Honey"]
+    assert_search "fresh honey", []
+    assert_search "fresh honey", ["Honey"], partial: true
+  end
+
+  def test_operator
+    store_names ["Honey"]
+    assert_search "fresh honey", []
+    assert_search "fresh honey", ["Honey"], operator: "or"
+  end
+
+  def test_fields_operator
+    store [
+      {name: "red", color: "red"},
+      {name: "blue", color: "blue"},
+      {name: "cyan", color: "blue green"},
+      {name: "magenta", color: "red blue"},
+      {name: "green", color: "green"}
+    ]
+    assert_search "red blue", ["red", "blue", "cyan", "magenta"], operator: "or", fields: ["color"]
+  end
+
+  def test_fields
+    store [
+      {name: "red", color: "light blue"},
+      {name: "blue", color: "red fish"}
+    ]
+    assert_search "blue", ["red"], fields: ["color"]
+  end
+
+  def test_non_existent_field
+    store_names ["Milk"]
+    assert_search "milk", [], fields: ["not_here"]
+  end
+
+  def test_fields_both_match
+    store [
+      {name: "Blue A", color: "red"},
+      {name: "Blue B", color: "light blue"}
+    ]
+    assert_first "blue", "Blue B", fields: [:name, :color]
+  end
+
+  def test_big_decimal
+    store [
+      {name: "Product", latitude: 80.0}
+    ]
+    assert_search "product", ["Product"], where: {latitude: {gt: 79}}
+  end
+
+  # load
+
+  def test_load_default
+    store_names ["Product A"]
+    assert_kind_of Product, Product.search("product").first
+  end
+
+  def test_load_false
+    store_names ["Product A"]
+    assert_kind_of Hash, Product.search("product", load: false).first
+  end
+
+  def test_load_false_methods
+    store_names ["Product A"]
+    assert_equal "Product A", Product.search("product", load: false).first.name
+  end
+
+  def test_load_false_with_include
+    store_names ["Product A"]
+    assert_kind_of Hash, Product.search("product", load: false, include: [:store]).first
+  end
+
+  # select
+
+  def test_select
+    skip unless elasticsearch_below50?
+    store [{name: "Product A", store_id: 1}]
+    result = Product.search("product", load: false, select: [:name, :store_id]).first
+    assert_equal %w(id name store_id), result.keys.reject { |k| k.start_with?("_") }.sort
+    assert_equal ["Product A"], result.name # this is not great
+    assert_equal [1], result.store_id
+  end
+
+  def test_select_array
+    skip unless elasticsearch_below50?
+    store [{name: "Product A", user_ids: [1, 2]}]
+    result = Product.search("product", load: false, select: [:user_ids]).first
+    assert_equal [1, 2], result.user_ids
+  end
+
+  def test_select_single_field
+    skip unless elasticsearch_below50?
+    store [{name: "Product A", store_id: 1}]
+    result = Product.search("product", load: false, select: :name).first
+    assert_equal %w(id name), result.keys.reject { |k| k.start_with?("_") }.sort
+    assert_equal ["Product A"], result.name
+    assert_nil result.store_id
+  end
+
+  def test_select_all
+    skip unless elasticsearch_below50?
+    store [{name: "Product A", user_ids: [1, 2]}]
+    hit = Product.search("product", select: true).hits.first
+    assert_equal hit["_source"]["name"], "Product A"
+    assert_equal hit["_source"]["user_ids"], [1, 2]
+  end
+
+  def test_select_none
+    skip unless elasticsearch_below50?
+    store [{name: "Product A", user_ids: [1, 2]}]
+    hit = Product.search("product", select: []).hits.first
+    assert_nil hit["_source"]
+  end
+
+  # select_v2
+
+  def test_select_v2
+    store [{name: "Product A", store_id: 1}]
+    result = Product.search("product", load: false, select_v2: [:name, :store_id]).first
+    assert_equal %w(id name store_id), result.keys.reject { |k| k.start_with?("_") }.sort
+    assert_equal "Product A", result.name
+    assert_equal 1, result.store_id
+  end
+
+  def test_select_v2_array
+    store [{name: "Product A", user_ids: [1, 2]}]
+    result = Product.search("product", load: false, select_v2: [:user_ids]).first
+    assert_equal [1, 2], result.user_ids
+  end
+
+  def test_select_v2_single_field
+    store [{name: "Product A", store_id: 1}]
+    result = Product.search("product", load: false, select_v2: :name).first
+    assert_equal %w(id name), result.keys.reject { |k| k.start_with?("_") }.sort
+    assert_equal "Product A", result.name
+    assert_nil result.store_id
+  end
+
+  def test_select_v2_all
+    store [{name: "Product A", user_ids: [1, 2]}]
+    hit = Product.search("product", select_v2: true).hits.first
+    assert_equal hit["_source"]["name"], "Product A"
+    assert_equal hit["_source"]["user_ids"], [1, 2]
+  end
+
+  def test_select_v2_none
+    store [{name: "Product A", user_ids: [1, 2]}]
+    hit = Product.search("product", select_v2: []).hits.first
+    assert_nil hit["_source"]
+    hit = Product.search("product", select_v2: false).hits.first
+    assert_nil hit["_source"]
+  end
+
+  def test_select_v2_include
+    store [{name: "Product A", user_ids: [1, 2]}]
+    result = Product.search("product", load: false, select_v2: {include: [:name]}).first
+    assert_equal %w(id name), result.keys.reject { |k| k.start_with?("_") }.sort
+    assert_equal "Product A", result.name
+    assert_nil result.store_id
+  end
+
+  def test_select_v2_exclude
+    store [{name: "Product A", user_ids: [1, 2], store_id: 1}]
+    result = Product.search("product", load: false, select_v2: {exclude: [:name]}).first
+    assert_nil result.name
+    assert_equal [1, 2], result.user_ids
+    assert_equal 1, result.store_id
+  end
+
+  def test_select_v2_include_and_exclude
+    # let's take this to the next level
+    store [{name: "Product A", user_ids: [1, 2], store_id: 1}]
+    result = Product.search("product", load: false, select_v2: {include: [:store_id], exclude: [:name]}).first
+    assert_equal 1, result.store_id
+    assert_nil result.name
+    assert_nil result.user_ids
+  end
+
+  # other tests
+
+  def test_nested_object
+    aisle = {"id" => 1, "name" => "Frozen"}
+    store [{name: "Product A", aisle: aisle}]
+    assert_equal aisle, Product.search("product", load: false).first.aisle.to_hash
+  end
+
+  def test_include
+    skip unless defined?(ActiveRecord)
+    store_names ["Product A"]
+    assert Product.search("product", include: [:store]).first.association(:store).loaded?
+  end
+end

data/test/suggest_test.rb

@@ -0,0 +1,80 @@
+require_relative "test_helper"
+
+class SuggestTest < Minitest::Test
+  def test_basic
+    store_names ["Great White Shark", "Hammerhead Shark", "Tiger Shark"]
+    assert_suggest "How Big is a Tigre Shar", "how big is a tiger shark", fields: [:name]
+  end
+
+  def test_perfect
+    store_names ["Tiger Shark", "Great White Shark"]
+    assert_suggest "Tiger Shark", nil, fields: [:name] # no correction
+  end
+
+  def test_phrase
+    store_names ["Big Tiger Shark", "Tiger Sharp Teeth", "Tiger Sharp Mind"]
+    assert_suggest "How to catch a big tiger shar", "how to catch a big tiger shark", fields: [:name]
+  end
+
+  def test_without_option
+    store_names ["hi"] # needed to prevent ElasticsearchException - seed 668
+    assert_raises(RuntimeError) { Product.search("hi").suggestions }
+  end
+
+  def test_multiple_fields
+    store [
+      {name: "Shark", color: "Sharp"},
+      {name: "Shark", color: "Sharp"}
+    ]
+    assert_suggest_all "shar", ["shark", "sharp"]
+  end
+
+  def test_multiple_fields_highest_score_first
+    store [
+      {name: "Tiger Shark", color: "Sharp"}
+    ]
+    assert_suggest "tiger shar", "tiger shark"
+  end
+
+  def test_multiple_fields_same_value
+    store [
+      {name: "Shark", color: "Shark"}
+    ]
+    assert_suggest_all "shar", ["shark"]
+  end
+
+  def test_fields_option
+    store [
+      {name: "Shark", color: "Sharp"}
+    ]
+    assert_suggest_all "shar", ["shark"], fields: [:name]
+  end
+
+  def test_fields_option_multiple
+    store [
+      {name: "Shark"}
+    ]
+    assert_suggest "shar", "shark", fields: [:name, :unknown]
+  end
+
+  def test_fields_partial_match
+    store_names ["Great White Shark", "Hammerhead Shark", "Tiger Shark"]
+    assert_suggest "How Big is a Tigre Shar", "how big is a tiger shark", fields: [{name: :word_start}]
+  end
+
+  def test_fields_partial_match_boost
+    store_names ["Great White Shark", "Hammerhead Shark", "Tiger Shark"]
+    assert_suggest "How Big is a Tigre Shar", "how big is a tiger shark", fields: [{"name^2" => :word_start}]
+  end
+
+  protected
+
+  def assert_suggest(term, expected, options = {})
+    assert_equal expected, Product.search(term, options.merge(suggest: true)).suggestions.first
+  end
+
+  # any order
+  def assert_suggest_all(term, expected, options = {})
+    assert_equal expected.sort, Product.search(term, options.merge(suggest: true)).suggestions.sort
+  end
+end

data/test/synonyms_test.rb

@@ -0,0 +1,54 @@
+require_relative "test_helper"
+
+class SynonymsTest < Minitest::Test
+  def test_bleach
+    store_names ["Clorox Bleach", "Kroger Bleach"]
+    assert_search "clorox", ["Clorox Bleach", "Kroger Bleach"]
+  end
+
+  def test_saran_wrap
+    store_names ["Saran Wrap", "Kroger Plastic Wrap"]
+    assert_search "saran wrap", ["Saran Wrap", "Kroger Plastic Wrap"]
+  end
+
+  def test_burger_buns
+    store_names ["Hamburger Buns"]
+    assert_search "burger buns", ["Hamburger Buns"]
+  end
+
+  def test_bandaids
+    store_names ["Band-Aid", "Kroger 12-Pack Bandages"]
+    assert_search "bandaids", ["Band-Aid", "Kroger 12-Pack Bandages"]
+  end
+
+  def test_qtips
+    store_names ["Q Tips", "Kroger Cotton Swabs"]
+    assert_search "q tips", ["Q Tips", "Kroger Cotton Swabs"]
+  end
+
+  def test_reverse
+    store_names ["Scallions"]
+    assert_search "green onions", ["Scallions"]
+  end
+
+  def test_exact
+    store_names ["Green Onions", "Yellow Onions"]
+    assert_search "scallion", ["Green Onions"]
+  end
+
+  def test_stemmed
+    store_names ["Green Onions", "Yellow Onions"]
+    assert_search "scallions", ["Green Onions"]
+  end
+
+  def test_word_start
+    store_names ["Clorox Bleach", "Kroger Bleach"]
+    assert_search "clorox", ["Clorox Bleach", "Kroger Bleach"], fields: [{name: :word_start}]
+  end
+
+  def test_wordnet
+    skip unless ENV["TEST_WORDNET"]
+    store_names ["Creature", "Beast", "Dragon"], Animal
+    assert_search "animal", ["Creature", "Beast"], {}, Animal
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,361 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "minitest/autorun"
+require "minitest/pride"
+require "logger"
+require "active_support/core_ext" if defined?(NoBrainer)
+require "active_support/notifications"
+
+ENV["RACK_ENV"] = "test"
+
+Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)
+
+File.delete("elasticsearch.log") if File.exist?("elasticsearch.log")
+Searchkick.client.transport.logger = Logger.new("elasticsearch.log")
+Searchkick.search_timeout = 5
+
+puts "Running against Elasticsearch #{Searchkick.server_version}"
+
+I18n.config.enforce_available_locales = true
+
+ActiveJob::Base.logger = nil if defined?(ActiveJob)
+ActiveSupport::LogSubscriber.logger = Logger.new(STDOUT) if ENV["NOTIFICATIONS"]
+
+def elasticsearch_below50?
+  Searchkick.server_below?("5.0.0-alpha1")
+end
+
+def elasticsearch_below20?
+  Searchkick.server_below?("2.0.0")
+end
+
+def elasticsearch_below14?
+  Searchkick.server_below?("1.4.0")
+end
+
+def mongoid2?
+  defined?(Mongoid) && Mongoid::VERSION.starts_with?("2.")
+end
+
+def nobrainer?
+  defined?(NoBrainer)
+end
+
+def activerecord_below41?
+  defined?(ActiveRecord) && Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new("4.1.0")
+end
+
+if defined?(Mongoid)
+  Mongoid.logger.level = Logger::INFO
+  Mongo::Logger.logger.level = Logger::INFO if defined?(Mongo::Logger)
+
+  if mongoid2?
+    # enable comparison of BSON::ObjectIds
+    module BSON
+      class ObjectId
+        def <=>(other)
+          data <=> other.data
+        end
+      end
+    end
+  end
+
+  Mongoid.configure do |config|
+    if mongoid2?
+      config.master = Mongo::Connection.new.db("searchkick_test")
+    else
+      config.connect_to "searchkick_test"
+    end
+  end
+
+  class Product
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :name
+    field :store_id, type: Integer
+    field :in_stock, type: Boolean
+    field :backordered, type: Boolean
+    field :orders_count, type: Integer
+    field :found_rate, type: BigDecimal
+    field :price, type: Integer
+    field :color
+    field :latitude, type: BigDecimal
+    field :longitude, type: BigDecimal
+    field :description
+    field :alt_description
+  end
+
+  class Store
+    include Mongoid::Document
+    has_many :products
+
+    field :name
+  end
+
+  class Animal
+    include Mongoid::Document
+
+    field :name
+  end
+
+  class Dog < Animal
+  end
+
+  class Cat < Animal
+  end
+elsif defined?(NoBrainer)
+  NoBrainer.configure do |config|
+    config.app_name = :searchkick
+    config.environment = :test
+  end
+
+  class Product
+    include NoBrainer::Document
+    include NoBrainer::Document::Timestamps
+
+    field :id,           type: Object
+    field :name,         type: String
+    field :in_stock,     type: Boolean
+    field :backordered,  type: Boolean
+    field :orders_count, type: Integer
+    field :found_rate
+    field :price,        type: Integer
+    field :color,        type: String
+    field :latitude
+    field :longitude
+    field :description, type: String
+    field :alt_description, type: String
+
+    belongs_to :store, validates: false
+  end
+
+  class Store
+    include NoBrainer::Document
+
+    field :id,   type: Object
+    field :name, type: String
+  end
+
+  class Animal
+    include NoBrainer::Document
+
+    field :id,   type: Object
+    field :name, type: String
+  end
+
+  class Dog < Animal
+  end
+
+  class Cat < Animal
+  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: "sqlite3", database: ":memory:"
+
+  ActiveRecord::Base.raise_in_transactional_callbacks = true if ActiveRecord::Base.respond_to?(:raise_in_transactional_callbacks=)
+
+  if defined?(Apartment)
+    class Rails
+      def self.env
+        ENV["RACK_ENV"]
+      end
+    end
+
+    tenants = ["tenant1", "tenant2"]
+    Apartment.configure do |config|
+      config.tenant_names = tenants
+      config.database_schema_file = false
+      config.excluded_models = ["Product", "Store", "Animal", "Dog", "Cat"]
+    end
+
+    class Tenant < ActiveRecord::Base
+      searchkick index_prefix: -> { Apartment::Tenant.current }
+    end
+
+    tenants.each do |tenant|
+      begin
+        Apartment::Tenant.create(tenant)
+      rescue Apartment::TenantExists
+        # do nothing
+      end
+      Apartment::Tenant.switch!(tenant)
+
+      ActiveRecord::Migration.create_table :tenants, force: true do |t|
+        t.string :name
+        t.timestamps null: true
+      end
+
+      Tenant.reindex
+    end
+
+    Apartment::Tenant.reset
+  end
+
+  ActiveRecord::Migration.create_table :products do |t|
+    t.string :name
+    t.integer :store_id
+    t.boolean :in_stock
+    t.boolean :backordered
+    t.integer :orders_count
+    t.decimal :found_rate
+    t.integer :price
+    t.string :color
+    t.decimal :latitude, precision: 10, scale: 7
+    t.decimal :longitude, precision: 10, scale: 7
+    t.text :description
+    t.text :alt_description
+    t.timestamps null: true
+  end
+
+  ActiveRecord::Migration.create_table :stores do |t|
+    t.string :name
+  end
+
+  ActiveRecord::Migration.create_table :animals do |t|
+    t.string :name
+    t.string :type
+  end
+
+  class Product < ActiveRecord::Base
+  end
+
+  class Store < ActiveRecord::Base
+    has_many :products
+  end
+
+  class Animal < ActiveRecord::Base
+  end
+
+  class Dog < Animal
+  end
+
+  class Cat < Animal
+  end
+end
+
+class Product
+  belongs_to :store
+
+  searchkick \
+    synonyms: [
+      ["clorox", "bleach"],
+      ["scallion", "greenonion"],
+      ["saranwrap", "plasticwrap"],
+      ["qtip", "cottonswab"],
+      ["burger", "hamburger"],
+      ["bandaid", "bandag"]
+    ],
+    autocomplete: [:name],
+    suggest: [:name, :color],
+    conversions: "conversions",
+    personalize: "user_ids",
+    locations: ["location", "multiple_locations"],
+    text_start: [:name],
+    text_middle: [:name],
+    text_end: [:name],
+    word_start: [:name],
+    word_middle: [:name],
+    word_end: [:name],
+    highlight: [:name],
+    # unsearchable: [:description],
+    searchable: [:name, :color],
+    only_analyzed: [:alt_description],
+    match: ENV["MATCH"] ? ENV["MATCH"].to_sym : nil
+
+  attr_accessor :conversions, :user_ids, :aisle
+
+  def search_data
+    serializable_hash.except("id").merge(
+      conversions: conversions,
+      user_ids: user_ids,
+      location: {lat: latitude, lon: longitude},
+      multiple_locations: [{lat: latitude, lon: longitude}, {lat: 0, lon: 0}],
+      aisle: aisle
+    )
+  end
+
+  def should_index?
+    name != "DO NOT INDEX"
+  end
+end
+
+class Store
+  searchkick \
+    routing: true,
+    merge_mappings: true,
+    mappings: {
+      store: {
+        properties: {
+          name: elasticsearch_below50? ? {type: "string", analyzer: "keyword"} : {type: "keyword"}
+        }
+      }
+    }
+
+  def search_document_id
+    id
+  end
+
+  def search_routing
+    name
+  end
+end
+
+class Animal
+  searchkick \
+    autocomplete: [:name],
+    suggest: [:name],
+    index_name: -> { "#{name.tableize}-#{Date.today.year}" }
+    # wordnet: true
+end
+
+Product.searchkick_index.delete if Product.searchkick_index.exists?
+Product.reindex
+Product.reindex # run twice for both index paths
+Product.create!(name: "Set mapping")
+
+Store.reindex
+Animal.reindex
+
+class Minitest::Test
+  def setup
+    Product.destroy_all
+    Store.destroy_all
+    Animal.destroy_all
+  end
+
+  protected
+
+  def store(documents, klass = Product)
+    documents.shuffle.each do |document|
+      klass.create!(document)
+    end
+    klass.searchkick_index.refresh
+  end
+
+  def store_names(names, klass = Product)
+    store names.map { |name| {name: name} }, klass
+  end
+
+  # no order
+  def assert_search(term, expected, options = {}, klass = Product)
+    assert_equal expected.sort, klass.search(term, options).map(&:name).sort
+  end
+
+  def assert_order(term, expected, options = {}, klass = Product)
+    assert_equal expected, klass.search(term, options).map(&:name)
+  end
+
+  def assert_first(term, expected, options = {}, klass = Product)
+    assert_equal expected, klass.search(term, options).map(&:name).first
+  end
+end