search_flip 2.0.0.beta3 → 2.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55f88fe9b429304c6f605a0175b3b711334cf47613facc78864511b012e2eb4e
-  data.tar.gz: 12c5e164eb18caaf72a361c7d1ba24f9b0324c412f2c7712f79f87e9248dbf1c
+  metadata.gz: c626b4c449c70b071fee204d164b226271d2f098ae48f4c54568e07b6ad8d9d8
+  data.tar.gz: f35599e1cd57a27fe3c008fa20538be08fa9f7251a5c421d25fd98113d2a6cc7
 SHA512:
-  metadata.gz: 26842b8df4ee2014ee77f1429ab6438350f45458e150fe1786f654bb2d925c53524007d2ec88bed42f80d0983887b8720c19b617ec1e00de8de8964c70a602dd
-  data.tar.gz: 6976b12cd544bbc19f88fb69e855c6107badd49c565578b6b5a75b07d63d85ad4d85762e0e18b02010b9376123f44c8bb73dc81676e3f28cdd5b9ab9d237659c
+  metadata.gz: 95df5e882633308f0dcbcac35d155901db7bfee39f0f37d1ee84c055fdde821a22b697fd0df5ea4ab82204896c3adb483769cae85b1489ec2eca28c4fc0e2de5
+  data.tar.gz: e97fceeacf0186b99829fb70d9a8eb396455c2f2cf3dec58e2f357dd5b8bd542025e7ee33201757af02c45b90752da70e6d28e6cbff2605fc36d0fd7ac9638d2

data/UPDATING.md

@@ -127,3 +127,48 @@ query = CommentIndex.highlight(:title).search("hello")
 query.results[0]._hit.highlight.title # => "<em>hello</em> world"
 ```
 
+* **[BREAKING]** `index_name` no longer defaults to `type_name`
+
+1.x:
+
+```ruby
+class CommentIndex
+  include SearchFlip::Index
+
+  def self.type_name
+    "comments"
+  end
+
+  # CommentIndex.index_name defaults to CommentIndex.type_name
+end
+```
+
+2.x:
+
+```ruby
+class CommentIndex
+  include SearchFlip::Index
+
+  def self.type_name
+    "comments"
+  end
+
+  def self.index_name
+    "comments"
+  end
+end
+```
+
+* **[BREAKING]** Multiple calls to `source` no longer concatenate
+
+1.x:
+
+```ruby
+CommentIndex.source([:id]).source([:description]) # => CommentIndex.source([:id, :description])
+```
+
+2.x:
+
+```ruby
+CommentIndex.source([:id]).source([:description]) # => CommentIndex.source([:description])
+```

data/lib/search_flip/aggregation.rb

@@ -49,6 +49,53 @@ module SearchFlip
       res
     end
 
+    # @api private
+    #
+    # Merges a criteria into the aggregation.
+    #
+    # @param other [SearchFlip::Criteria] The criteria to merge in
+    #
+    # @return [SearchFlip::Aggregation] A fresh aggregation including the merged criteria
+
+    def merge(other)
+      other = other.criteria
+
+      fresh.tap do |aggregation|
+        unsupported_methods = [
+          :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :offset_value, :limit_value,
+          :scroll_args, :highlight_values, :suggest_values, :custom_value, :source_value, :sort_values,
+          :includes_values, :preload_values, :eager_load_values, :post_search_values, :post_must_values,
+          :post_must_not_values, :post_should_values, :post_filter_values
+        ]
+
+        unsupported_methods.each do |unsupported_method|
+          unless other.send(unsupported_method).nil?
+            raise(SearchFlip::NotSupportedError, "Using #{unsupported_method} within aggregations is not supported")
+          end
+        end
+
+        aggregation.search_values = (aggregation.search_values || []) + other.search_values if other.search_values
+        aggregation.must_values = (aggregation.must_values || []) + other.must_values if other.must_values
+        aggregation.must_not_values = (aggregation.must_not_values || []) + other.must_not_values if other.must_not_values
+        aggregation.should_values = (aggregation.should_values || []) + other.should_values if other.should_values
+        aggregation.filter_values = (aggregation.filter_values || []) + other.filter_values if other.filter_values
+
+        aggregation.aggregation_values = (aggregation.aggregation_values || {}).merge(other.aggregation_values) if other.aggregation_values
+      end
+    end
+
+    def respond_to_missing?(name, *args)
+      target.respond_to?(name, *args)
+    end
+
+    def method_missing(name, *args, &block)
+      if target.respond_to?(name)
+        merge(target.send(name, *args, &block))
+      else
+        super
+      end
+    end
+
     # @api private
     #
     # Simply dups the object for api compatability.

data/lib/search_flip/connection.rb

@@ -137,12 +137,15 @@ module SearchFlip
         .parse
     end
 
+    alias_method :cat_indices, :get_indices
+
     # Creates the specified index within ElasticSearch and applies index
     # settings, if specified. Raises SearchFlip::ResponseError in case any
     # errors occur.
     #
     # @param index_name [String] The index name
     # @param index_settings [Hash] The index settings
+    #
     # @return [Boolean] Returns true or raises SearchFlip::ResponseError
 
     def create_index(index_name, index_settings = {})
@@ -157,6 +160,7 @@ module SearchFlip
     #
     # @param index_name [String] The index name to update the settings for
     # @param index_settings [Hash] The index settings
+    #
     # @return [Boolean] Returns true or raises SearchFlip::ResponseError
 
     def update_index_settings(index_name, index_settings)
@@ -170,6 +174,7 @@ module SearchFlip
     # SearchFlip::ResponseError in case any errors occur.
     #
     # @param index_name [String] The index name
+    #
     # @return [Hash] The index settings
 
     def get_index_settings(index_name)
@@ -195,6 +200,7 @@ module SearchFlip
     # @param index_name [String] The index name
     # @param type_name [String] The type name
     # @param mapping [Hash] The mapping
+    #
     # @return [Boolean] Returns true or raises SearchFlip::ResponseError
 
     def update_mapping(index_name, type_name, mapping)
@@ -208,6 +214,7 @@ module SearchFlip
     #
     # @param index_name [String] The index name
     # @param type_name [String] The type name
+    #
     # @return [Hash] The current type mapping
 
     def get_mapping(index_name, type_name)
@@ -218,6 +225,7 @@ module SearchFlip
     # SearchFlip::ResponseError in case any errors occur.
     #
     # @param index_name [String] The index name
+    #
     # @return [Boolean] Returns true or raises SearchFlip::ResponseError
 
     def delete_index(index_name)
@@ -229,6 +237,7 @@ module SearchFlip
     # Returns whether or not the specified index already exists.
     #
     # @param index_name [String] The index name
+    #
     # @return [Boolean] Whether or not the index exists
 
     def index_exists?(index_name)
@@ -246,6 +255,7 @@ module SearchFlip
     #
     # @param index_name [String] The index name
     # @param type_name [String] The type name
+    #
     # @return [String] The ElasticSearch type URL
 
     def type_url(index_name, type_name)
@@ -256,6 +266,7 @@ module SearchFlip
     # URL and index name with prefix.
     #
     # @param index_name [String] The index name
+    #
     # @return [String] The ElasticSearch index URL
 
     def index_url(index_name)

data/lib/search_flip/criteria.rb

@@ -45,8 +45,8 @@ module SearchFlip
         criteria.offset_value = other.offset_value if other.offset_value
         criteria.limit_value = other.limit_value if other.limit_value
         criteria.scroll_args = other.scroll_args if other.scroll_args
+        criteria.source_value = other.source_value if other.source_value
 
-        criteria.source_value = (criteria.source_value || []) + other.source_value if other.source_value
         criteria.sort_values = (criteria.sort_values || []) + other.sort_values if other.sort_values
         criteria.includes_values = (criteria.includes_values || []) + other.includes_values if other.includes_values
         criteria.preload_values = (criteria.preload_values || []) + other.preload_values if other.preload_values
@@ -122,7 +122,7 @@ module SearchFlip
 
       fresh.tap do |criteria|
         criteria.search_values = nil if scopes.include?(:search)
-        criteria.post_search_values = nil if scopes.include?(:search)
+        criteria.post_search_values = nil if scopes.include?(:post_search)
         criteria.sort_values = nil if scopes.include?(:sort)
         criteria.hightlight_values = nil if scopes.include?(:highlight)
         criteria.suggest_values = nil if scopes.include?(:suggest)
@@ -375,8 +375,10 @@ module SearchFlip
     #
     # @example
     #   CommentIndex.source([:id, :message]).search("hello world")
+    #   CommentIndex.source(exclude: "description")
+    #   CommentIndex.source(false)
     #
-    # @param value [Array] Array listing the field names of the source document
+    # @param value Pass any allowed value to restrict the returned source
     #
     # @return [SearchFlip::Criteria] A newly created extended criteria
 

data/lib/search_flip/index.rb

@@ -87,6 +87,7 @@ module SearchFlip
       #
       # @param index_name [String] A custom index_name
       # @param connection [SearchFlip::Connection] A custom connection
+      #
       # @return [Class] An anonymous class
 
       def with_settings(index_name: nil, connection: nil)
@@ -113,6 +114,7 @@ module SearchFlip
       #   end
       #
       # @param record The record that gets serialized
+      #
       # @return [Hash] The hash-representation of the record
 
       def serialize(record)
@@ -178,6 +180,7 @@ module SearchFlip
       #   end
       #
       # @param record The record to get the primary key for
+      #
       # @return [String, Fixnum] The record's primary key
 
       def record_id(record)
@@ -189,6 +192,7 @@ module SearchFlip
       # keys and/or ORMs.
       #
       # @param ids [Array] The array of ids to fetch the records for
+      #
       # @return The record set or an array of records
 
       def fetch_records(ids)
@@ -267,7 +271,7 @@ module SearchFlip
       # @return [String] The base name of the index, ie without prefix
 
       def index_name
-        type_name
+        raise SearchFlip::MethodNotImplemented, "You must implement #{name}::index_name"
       end
 
       # @api private
@@ -324,6 +328,7 @@ module SearchFlip
       # occur.
       #
       # @param include_mapping [Boolean] Whether or not to include the mapping
+      #
       # @return [Boolean] Returns true or false
 
       def create_index(include_mapping: false)
@@ -393,6 +398,7 @@ module SearchFlip
       #
       # @param id [String, Fixnum] The id to get
       # @param params [Hash] Optional params for the request
+      #
       # @return [Hash] The specified document
 
       def get(id, params = {})

data/lib/search_flip/version.rb

@@ -1,5 +1,5 @@
 
 module SearchFlip
-  VERSION = "2.0.0.beta3"
+  VERSION = "2.0.0.beta4"
 end
 

data/spec/search_flip/aggregation_spec.rb

@@ -262,4 +262,122 @@ RSpec.describe SearchFlip::Aggregation do
       expect(query.aggregations(:category)["category2"].title.buckets.detect { |bucket| bucket[:key] == "title2" }.price.value).to eq(60)
     end
   end
+
+  describe "#merge" do
+    it "merges a criteria into the aggregation" do
+      product1 = create(:product, price: 100, category: "category1")
+      product2 = create(:product, price: 150, category: "category1")
+      product3 = create(:product, price: 200, category: "category2")
+      product4 = create(:product, price: 300, category: "category1")
+
+      ProductIndex.import [product1, product2, product3, product4]
+
+      query = ProductIndex.aggregate(categories: {}) do |agg|
+        agg.merge(ProductIndex.where(price: 100..200)).aggregate(:category)
+      end
+
+      result = query.aggregations(:categories).category.buckets.each_with_object({}) do |bucket, hash|
+        hash[bucket["key"]] = bucket.doc_count
+      end
+
+      expect(result).to eq("category1" => 2, "category2" => 1)
+    end
+
+    describe "unsupported methods" do
+      unsupported_methods = [
+        :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :offset_value, :limit_value,
+        :scroll_args, :highlight_values, :suggest_values, :custom_value, :source_value, :sort_values,
+        :includes_values, :preload_values, :eager_load_values, :post_search_values, :post_must_values,
+        :post_must_not_values, :post_should_values, :post_filter_values
+      ]
+
+      unsupported_methods.each do |unsupported_method|
+        it "raises a NotSupportedError #{unsupported_method}" do
+          block = lambda do
+            TestIndex.aggregate(field: {}) do |agg|
+              criteria = SearchFlip::Criteria.new(target: TestIndex)
+              criteria.send("#{unsupported_method}=", "value")
+
+              agg.merge(criteria)
+            end
+          end
+
+          expect(&block).to raise_error(SearchFlip::NotSupportedError)
+        end
+      end
+    end
+
+    describe "array concatenations" do
+      methods = [:search_values, :must_values, :must_not_values, :should_values, :filter_values]
+
+      methods.each do |method|
+        it "concatenates the values for #{method}" do
+          aggregation = SearchFlip::Aggregation.new(target: TestIndex)
+          aggregation.send("#{method}=", ["value1"])
+
+          criteria = SearchFlip::Criteria.new(target: TestIndex)
+          criteria.send("#{method}=", ["value2"])
+
+          result = aggregation.merge(criteria)
+
+          expect(result.send(method)).to eq(["value1", "value2"])
+        end
+      end
+    end
+
+    describe "hash merges" do
+      methods = [:aggregation_values]
+
+      methods.each do |method|
+        it "merges the values for #{method}" do
+          aggregation = SearchFlip::Aggregation.new(target: TestIndex)
+          aggregation.send("#{method}=", key1: "value1")
+
+          criteria = SearchFlip::Criteria.new(target: TestIndex)
+          criteria.send("#{method}=", key2: "value2")
+
+          result = aggregation.merge(criteria)
+
+          expect(result.send(method)).to eq(key1: "value1", key2: "value2")
+        end
+      end
+    end
+  end
+
+  describe "#respond_to?" do
+    it "checks whether or not the index class responds to the method" do
+      temp_index = Class.new(ProductIndex)
+      aggregation = SearchFlip::Aggregation.new(target: temp_index)
+
+      expect(aggregation.respond_to?(:test_scope)).to eq(false)
+
+      temp_index.scope(:test_scope) { match_all }
+
+      expect(aggregation.respond_to?(:test_scope)).to eq(true)
+    end
+  end
+
+  describe "#method_missing" do
+    it "delegates to the index class" do
+      temp_index = Class.new(ProductIndex)
+      temp_index.scope(:with_price_range) { |range| where(price: range) }
+
+      product1 = create(:product, price: 100, category: "category1")
+      product2 = create(:product, price: 150, category: "category1")
+      product3 = create(:product, price: 200, category: "category2")
+      product4 = create(:product, price: 300, category: "category1")
+
+      temp_index.import [product1, product2, product3, product4]
+
+      query = temp_index.aggregate(categories: {}) do |agg|
+        agg.merge(temp_index.with_price_range(100..200)).aggregate(:category)
+      end
+
+      result = query.aggregations(:categories).category.buckets.each_with_object({}) do |bucket, hash|
+        hash[bucket["key"]] = bucket.doc_count
+      end
+
+      expect(result).to eq("category1" => 2, "category2" => 1)
+    end
+  end
 end

data/spec/search_flip/criteria_spec.rb

@@ -35,7 +35,7 @@ RSpec.describe SearchFlip::Criteria do
     describe "assignments" do
       methods = [
         :profile_value, :failsafe_value, :terminate_after_value, :timeout_value,
-        :offset_value, :limit_value, :scroll_args
+        :offset_value, :limit_value, :scroll_args, :source_value
       ]
 
       methods.each do |method|
@@ -53,10 +53,9 @@ RSpec.describe SearchFlip::Criteria do
 
     describe "array concatenations" do
       methods = [
-        :source_value, :sort_values, :includes_values, :preload_values, :eager_load_values,
-        :search_values, :must_values, :must_not_values, :should_values, :filter_values,
-        :post_search_values, :post_must_values, :post_must_not_values, :post_should_values,
-        :post_filter_values
+        :sort_values, :includes_values, :preload_values, :eager_load_values, :search_values,
+        :must_values, :must_not_values, :should_values, :filter_values, :post_search_values,
+        :post_must_values, :post_must_not_values, :post_should_values, :post_filter_values
       ]
 
       methods.each do |method|

data/spec/search_flip/index_spec.rb

@@ -42,6 +42,16 @@ RSpec.describe SearchFlip::Index do
     end
   end
 
+  describe ".type_name" do
+    it "raises a SearchFlip::MethodNotImplemented by default" do
+      klass = Class.new do
+        include SearchFlip::Index
+      end
+
+      expect { klass.index_name }.to raise_error(SearchFlip::MethodNotImplemented)
+    end
+  end
+
   describe ".create_index" do
     it "delegates to connection" do
       allow(TestIndex.connection).to receive(:create_index).and_call_original

data/spec/spec_helper.rb

@@ -88,6 +88,10 @@ class CommentIndex
     "comments"
   end
 
+  def self.index_name
+    "comments"
+  end
+
   def self.model
     Comment
   end
@@ -136,6 +140,10 @@ class ProductIndex
     "products"
   end
 
+  def self.index_name
+    "products"
+  end
+
   def self.model
     Product
   end
@@ -174,6 +182,10 @@ class TestIndex
   def self.type_name
     "test"
   end
+
+  def self.index_name
+    "test"
+  end
 end
 
 TestIndex.delete_index if TestIndex.index_exists?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta3
+  version: 2.0.0.beta4
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2019-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord