searchkick 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 777b21bb34049337d1ee1c20fcf51eeaf94ab604
-  data.tar.gz: 9219dfb5026333d38ce0486f5dbee7d2b3d54838
+  metadata.gz: 915b713c1d61ef9709e1c95f7c588b49013b4cdd
+  data.tar.gz: cdbefb8ecb273fc877de64cc25356bcd13bf02a8
 SHA512:
-  metadata.gz: 9461e485b83ecf1169e9bb305c5296e9484d8bfc6b141b204b9870698cd8efe3f79a43687758c87ed390ba9bf15bcec227111a3ed3075d1aceb71bca38093b0d
-  data.tar.gz: 85c318dae06729ff723e27dcbcf19906f09418d7b90d7a00bfd7ad50f20a3e6f860faedbeb4d486809b47bf8ac687afb7c8e87b7917d5bddc0686f04fef756f5
+  metadata.gz: 961fed20bdf8f9227f735b58fa5fd0f29566ca57396f45eaf7c9779749a2f637510b65187064e0b607d64847572a447729d9c56df08df2317a1e1814d787c3f8
+  data.tar.gz: d1b7c56bc92cc95e8308dd35bdd365d457217bf0e272f2cedd3d6cf625b8f1c715e0687859be8e005c1f828f3df00f6a150dc7d5f37a271cf508741f19e473cd

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.5.0
+
+- Added support for geo shape indexing and queries
+- Added `_and`, `_or`, `_not` to `where` option
+
 ## 1.4.2
 
 - Added support for directional synonyms

data/README.md

@@ -94,9 +94,7 @@ where: {
   aisle_id: {not: [25, 30]},  # not in
   user_ids: {all: [1, 3]},    # all elements in array
   category: /frozen .+/,      # regexp
-  or: [
-    [{in_stock: true}, {backordered: true}]
-  ]
+  _or: [{in_stock: true}, {backordered: true}]
 }
 ```
 
@@ -907,6 +905,69 @@ Also supports [additional options](https://www.elastic.co/guide/en/elasticsearch
 City.search "san", boost_by_distance: {field: :location, origin: {lat: 37, lon: -122}, function: :linear, scale: "30mi", decay: 0.5}
 ```
 
+### Geo Shapes
+
+You can also index and search geo shapes.
+
+```ruby
+class City < ActiveRecord::Base
+  searchkick geo_shape: {
+    bounds: {tree: "geohash", precision: "1km"}
+  }
+
+  def search_data
+    attributes.merge(
+      bounds: {
+        type: "envelope",
+        coordinates: [{lat: 4, lon: 1}, {lat: 2, lon: 3}]
+      }
+    )
+  end
+end
+```
+
+The `geo_shape` hash is passed through to Elasticsearch without modification. Please see the [geo shape documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html) for options.
+
+Any geospatial data type can be held in the index or give as a search query. It is up to you to ensure that it is a valid GeoJSON representation. Possible shapes are:
+
+* **point**: single lat/lon pair
+* **multipoint**: array of points
+* **linestring**: array of at least two lat/lon pairs
+* **multilinestring**: array of lines
+* **polygon**: an array of paths, each being an array of at least four lat/lon pairs whose first and last points are the same. Paths after the first represent exclusions. Elasticsearch will return an error if a polygon contains two consecutive identical points, intersects itself or is not closed.
+* **multipolygon**: array of polygons
+* **envelope**: a bounding box defined by top left and bottom right points
+* **circle**: a bounding circle defined by center point and radius
+* **geometrycollection**: an array of separate GeoJSON objects possibly of various types
+
+See the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html) for details. GeoJSON coordinates are usually given as an array of `[lon, lat]` points but searchkick can also take objects with `lon` and `lat` keys.
+
+Once a geo shape index is established, you can include a geo shape filter in any search. This also takes a GeoJSON shape and will return a list of items based on their overlap with that shape.
+
+Find shapes (of any kind) intersecting with the query shape
+
+```ruby
+City.search "san", where: {bounds: {geo_shape: {type: "polygon", coordinates: [[{lat: 38, lon: -123}, ...]]}}}
+```
+
+Falling entirely within the query shape
+
+```ruby
+City.search "san", where: {bounds: {geo_shape: {type: "circle", relation: "within", coordinates: [{lat: 38, lon: -123}], radius: "1km"}}}
+```
+
+Not touching the query shape
+
+```ruby
+City.search "san", where: {bounds: {geo_shape: {type: "envelope", relation: "disjoint", coordinates: [{lat: 38, lon: -123}, {lat: 37, lon: -122}]}}}
+```
+
+Containing the query shape (Elasticsearch 2.2+)
+
+```ruby
+City.search "san", where: {bounds: {geo_shape: {type: "envelope", relation: "contains", coordinates: [{lat: 38, lon: -123}, {lat: 37, lon: -122}]}}}
+```
+
 ### Routing
 
 Searchkick supports [Elasticsearch’s routing feature](https://www.elastic.co/blog/customizing-your-document-routing).

data/lib/searchkick/index_options.rb

@@ -281,6 +281,11 @@ module Searchkick
           }
         end
 
+        options[:geo_shape] = options[:geo_shape].product([{}]).to_h if options[:geo_shape].is_a?(Array)
+        (options[:geo_shape] || {}).each do |field, shape_options|
+          mapping[field] = shape_options.merge(type: "geo_shape")
+        end
+
         (options[:unsearchable] || []).map(&:to_s).each do |field|
           mapping[field] = {
             type: default_type,

data/lib/searchkick/query.rb

@@ -784,6 +784,24 @@ module Searchkick
               filters << {bool: {should: or_clause.map { |or_statement| {bool: {filter: where_filters(or_statement)}} }}}
             end
           end
+        elsif field == :_or
+          if below20?
+            filters << {or: value.map { |or_statement| {and: where_filters(or_statement)} }}
+          else
+            filters << {bool: {should: value.map { |or_statement| {bool: {filter: where_filters(or_statement)}} }}}
+          end
+        elsif field == :_not
+          if below20?
+            filters << {not: {and: where_filters(value)}}
+          else
+            filters << {bool: {must_not: where_filters(value)}}
+          end
+        elsif field == :_and
+          if below20?
+            filters << {and: value.map { |or_statement| {and: where_filters(or_statement)} }}
+          else
+            filters << {bool: {must: value.map { |or_statement| {bool: {filter: where_filters(or_statement)}} }}}
+          end
         else
           # expand ranges
           if value.is_a?(Range)
@@ -810,6 +828,17 @@ module Searchkick
                     field => op_value
                   }
                 }
+              when :geo_shape
+                shape = op_value.except(:relation)
+                shape[:coordinates] = coordinate_array(shape[:coordinates]) if shape[:coordinates]
+                filters << {
+                  geo_shape: {
+                    field => {
+                      relation: op_value[:relation] || "intersects",
+                      shape: shape
+                    }
+                  }
+                }
               when :top_left
                 filters << {
                   geo_bounding_box: {
@@ -925,6 +954,19 @@ module Searchkick
       end
     end
 
+    # Recursively descend through nesting of arrays until we reach either a lat/lon object or an array of numbers,
+    # eventually returning the same structure with all values transformed to [lon, lat].
+    #
+    def coordinate_array(value)
+      if value.is_a?(Hash)
+        [value[:lon], value[:lat]]
+      elsif value.is_a?(Array) and !value[0].is_a?(Numeric)
+        value.map {|a| coordinate_array(a) }
+      else
+        value
+      end
+    end
+
     def location_value(value)
       if value.is_a?(Array)
         value.map(&:to_f).reverse

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "1.4.2"
+  VERSION = "1.5.0"
 end

data/test/geo_shape_test.rb

@@ -0,0 +1,172 @@
+require_relative "test_helper"
+
+class GeoShapeTest < Minitest::Test
+  def setup
+    Region.destroy_all
+    store [
+      {
+        name: "Region A",
+        text: "The witch had a cat",
+        territory: {
+          type: "polygon",
+          coordinates: [[[30, 40], [35, 45], [40, 40], [40, 30], [30, 30], [30, 40]]]
+        }
+      },
+      {
+        name: "Region B",
+        text: "and a very tall hat",
+        territory: {
+          type: "polygon",
+          coordinates: [[[50, 60], [55, 65], [60, 60], [60, 50], [50, 50], [50, 60]]]
+        }
+      },
+      {
+        name: "Region C",
+        text: "and long ginger hair which she wore in a plait",
+        territory: {
+          type: "polygon",
+          coordinates: [[[10, 20], [15, 25], [20, 20], [20, 10], [10, 10], [10, 20]]]
+        }
+      }
+    ], Region
+  end
+
+  def test_circle
+    assert_search "*", ["Region A"], {
+      where: {
+        territory: {
+          geo_shape: {
+            type: "circle",
+            coordinates: {lat: 28.0, lon: 38.0},
+            radius: "444000m"
+          }
+        }
+      }
+    }, Region
+  end
+
+  def test_envelope
+    assert_search "*", ["Region A"], {
+      where: {
+        territory: {
+          geo_shape: {
+            type: "envelope",
+            coordinates: [[28, 42], [32, 38]]
+          }
+        }
+      }
+    }, Region
+  end
+
+  def test_polygon
+    assert_search "*", ["Region A"], {
+      where: {
+        territory: {
+          geo_shape: {
+            type: "polygon",
+            coordinates: [[[38, 42], [42, 42], [42, 38], [38, 38], [38, 42]]]
+          }
+        }
+      }
+    }, Region
+  end
+
+  def test_multipolygon
+    assert_search "*", ["Region A", "Region B"], {
+      where: {
+        territory: {
+          geo_shape: {
+            type: "multipolygon",
+            coordinates: [
+              [[[38, 42], [42, 42], [42, 38], [38, 38], [38, 42]]],
+              [[[58, 62], [62, 62], [62, 58], [58, 58], [58, 62]]]
+            ]
+          }
+        }
+      }
+    }, Region
+  end
+
+  def test_disjoint
+    assert_search "*", ["Region B", "Region C"], {
+      where: {
+        territory: {
+          geo_shape: {
+            type: "envelope",
+            relation: "disjoint",
+            coordinates: [[28, 42], [32, 38]]
+          }
+        }
+      }
+    }, Region
+  end
+
+  def test_within
+    assert_search "*", ["Region A"], {
+      where: {
+        territory: {
+          geo_shape: {
+            type: "envelope",
+            relation: "within",
+            coordinates: [[20,50], [50,20]]
+          }
+        }
+      }
+    }, Region
+  end
+
+  def test_search_math
+    assert_search "witch", ["Region A"], {
+      where: {
+        territory: {
+          geo_shape: {
+            type: "envelope",
+            coordinates: [[28, 42], [32, 38]]
+          }
+        }
+      }
+    }, Region
+  end
+
+  def test_search_no_match
+    assert_search "ginger hair", [], {
+      where: {
+        territory: {
+          geo_shape: {
+            type: "envelope",
+            coordinates: [[28, 42], [32, 38]]
+          }
+        }
+      }
+    }, Region
+  end
+
+  def test_contains
+    skip if elasticsearch_below22?
+    assert_search "*", ["Region C"], {
+      where: {
+        territory: {
+          geo_shape: {
+            type: "envelope",
+            relation: "contains",
+            coordinates: [[12, 13], [13, 12]]
+          }
+        }
+      }
+    }, Region
+  end
+
+  def test_latlon
+    assert_search "*", ["Region A"], {
+      where: {
+        territory: {
+          geo_shape: {
+            type: "envelope",
+            coordinates: [{lat: 42, lon: 28}, {lat: 38, lon: 32}]
+          }
+        }
+      }
+    }, Region
+  end
+
+end

data/test/highlight_test.rb

@@ -22,7 +22,7 @@ class HighlightTest < Minitest::Test
     store [{name: "Two Door Cinema Club", color: "Cinema Orange"}]
     highlight = Product.search("cinema", fields: [:name, :color], highlight: {fields: [:name]}).with_details.first[1][:highlight]
     assert_equal "Two Door <em>Cinema</em> Club", highlight[:name]
-    assert_equal nil, highlight[:color]
+    assert_nil highlight[:color]
   end
 
   def test_field_options

data/test/index_test.rb

@@ -28,6 +28,11 @@ class IndexTest < Minitest::Test
     assert !old_index.exists?
   end
 
+  def test_total_docs
+    store_names ["Product A"]
+    assert_equal 1, Product.searchkick_index.total_docs
+  end
+
   def test_mapping
     store_names ["Dollar Tree"], Store
     assert_equal [], Store.search(query: {match: {name: "dollar"}}).map(&:name)

data/test/model_test.rb

@@ -36,7 +36,7 @@ class ModelTest < Minitest::Test
 
   def test_multiple_models
     store_names ["Product A"]
-    store_names ["Product B"], Store
-    assert_equal Product.all + Store.all, Searchkick.search("product", index_name: [Product, Store], order: "name").to_a
+    store_names ["Product B"], Speaker
+    assert_equal Product.all + Speaker.all, Searchkick.search("product", index_name: [Product, Speaker], fields: [:name], order: "name").to_a
   end
 end

data/test/suggest_test.rb

@@ -70,7 +70,12 @@ class SuggestTest < Minitest::Test
   protected
 
   def assert_suggest(term, expected, options = {})
-    assert_equal expected, Product.search(term, options.merge(suggest: true)).suggestions.first
+    result = Product.search(term, options.merge(suggest: true)).suggestions.first
+    if expected.nil?
+      assert_nil result
+    else
+      assert_equal expected, result
+    end
   end
 
   # any order

data/test/test_helper.rb

@@ -25,6 +25,10 @@ def elasticsearch_below50?
   Searchkick.server_below?("5.0.0-alpha1")
 end
 
+def elasticsearch_below22?
+  Searchkick.server_below?("2.2.0")
+end
+
 def elasticsearch_below20?
   Searchkick.server_below?("2.0.0")
 end
@@ -93,6 +97,13 @@ if defined?(Mongoid)
     field :name
   end
 
+  class Region
+    include Mongoid::Document
+
+    field :name
+    field :text
+  end
+
   class Speaker
     include Mongoid::Document
 
@@ -143,6 +154,14 @@ elsif defined?(NoBrainer)
     field :name, type: String
   end
 
+  class Region
+    include NoBrainer::Document
+
+    field :id,   type: Object
+    field :name, type: String
+    field :text, type: Text
+  end
+
   class Speaker
     include NoBrainer::Document
 
@@ -234,6 +253,11 @@ else
     t.string :name
   end
 
+  ActiveRecord::Migration.create_table :regions do |t|
+    t.string :name
+    t.text :text
+  end
+
   ActiveRecord::Migration.create_table :speakers do |t|
     t.string :name
   end
@@ -250,6 +274,9 @@ else
     has_many :products
   end
 
+  class Region < ActiveRecord::Base
+  end
+
   class Speaker < ActiveRecord::Base
   end
 
@@ -340,6 +367,23 @@ class Store
   end
 end
 
+class Region
+  searchkick \
+    geo_shape: {
+      territory: {tree: "quadtree", precision: "10km"}
+    }
+
+  attr_accessor :territory
+
+  def search_data
+    {
+      name: name,
+      text: text,
+      territory: territory
+    }
+  end
+end
+
 class Speaker
   searchkick \
     conversions: ["conversions_a", "conversions_b"]
@@ -370,6 +414,7 @@ Product.create!(name: "Set mapping")
 Store.reindex
 Animal.reindex
 Speaker.reindex
+Region.reindex
 
 class Minitest::Test
   def setup

data/test/where_test.rb

@@ -31,6 +31,14 @@ class WhereTest < Minitest::Test
     assert_search "product", ["Product A", "Product B", "Product C"], where: {or: [[{in_stock: true}, {store_id: 3}]]}
     assert_search "product", ["Product A", "Product B", "Product C"], where: {or: [[{orders_count: [2, 4]}, {store_id: [1, 2]}]]}
     assert_search "product", ["Product A", "Product D"], where: {or: [[{orders_count: 1}, {created_at: {gte: now - 1}, backordered: true}]]}
+    # _or
+    assert_search "product", ["Product A", "Product B", "Product C"], where: {_or: [{in_stock: true}, {store_id: 3}]}
+    assert_search "product", ["Product A", "Product B", "Product C"], where: {_or: [{orders_count: [2, 4]}, {store_id: [1, 2]}]}
+    assert_search "product", ["Product A", "Product D"], where: {_or: [{orders_count: 1}, {created_at: {gte: now - 1}, backordered: true}]}
+    # _and
+    assert_search "product", ["Product A"], where: {_and: [{in_stock: true}, {backordered: true}]}
+    # _not
+    assert_search "product", ["Product B", "Product C"], where: {_not: {_or: [{orders_count: 1}, {created_at: {gte: now - 1}, backordered: true}]}}
     # all
     assert_search "product", ["Product A", "Product C"], where: {user_ids: {all: [1, 3]}}
     assert_search "product", [], where: {user_ids: {all: [1, 2, 3, 4]}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2016-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -140,6 +140,7 @@ files:
 - test/gemfiles/mongoid4.gemfile
 - test/gemfiles/mongoid5.gemfile
 - test/gemfiles/nobrainer.gemfile
+- test/geo_shape_test.rb
 - test/highlight_test.rb
 - test/index_test.rb
 - test/inheritance_test.rb
@@ -209,6 +210,7 @@ test_files:
 - test/gemfiles/mongoid4.gemfile
 - test/gemfiles/mongoid5.gemfile
 - test/gemfiles/nobrainer.gemfile
+- test/geo_shape_test.rb
 - test/highlight_test.rb
 - test/index_test.rb
 - test/inheritance_test.rb