search_flip 2.2.0 → 2.3.0

data/lib/search_flip/post_filterable.rb

@@ -29,7 +29,7 @@ module SearchFlip
 
     # Adds a post query string query to the criteria while using AND as the
     # default operator unless otherwise specified. Check out the
-    # ElasticSearch docs for further details.
+    # Elasticsearch docs for further details.
     #
     # @example
     #   CommentIndex.aggregate(:user_id).post_search("message:hello OR message:worl*")
@@ -201,7 +201,7 @@ module SearchFlip
     # Adds a post range filter to the criteria without being forced to specify
     # the left and right end of the range, such that you can eg simply specify
     # lt, lte, gt and gte. For fully specified ranges, you can easily use
-    # #post_where, etc. Check out the ElasticSearch docs for further details
+    # #post_where, etc. Check out the Elasticsearch docs for further details
     # regarding the range filter.
     #
     # @example

data/lib/search_flip/response.rb

@@ -11,14 +11,14 @@ module SearchFlip
     # @api private
     #
     # Initializes a new response object for the provided criteria and raw
-    # ElasticSearch response.
+    # Elasticsearch response.
 
     def initialize(criteria, response)
       self.criteria = criteria
       self.response = response
     end
 
-    # Returns the raw response, ie a hash derived from the ElasticSearch JSON
+    # Returns the raw response, ie a hash derived from the Elasticsearch JSON
     # response.
     #
     # @example
@@ -198,25 +198,25 @@ module SearchFlip
       end
     end
 
-    # Returns the hits returned by ElasticSearch.
+    # Returns the hits returned by Elasticsearch.
     #
     # @example
     #   CommentIndex.search("hello world").hits
     #   # => {"total"=>3, "max_score"=>2.34, "hits"=>[{...}, ...]}
     #
-    # @return [Hash] The hits returned by ElasticSearch
+    # @return [Hash] The hits returned by Elasticsearch
 
     def hits
       response["hits"]
     end
 
-    # Returns the scroll id returned by ElasticSearch, that can be used in the
+    # Returns the scroll id returned by Elasticsearch, that can be used in the
     # following request to fetch the next batch of records.
     #
     # @example
     #   CommentIndex.scroll(timeout: "1m").scroll_id #=> "cXVlcnlUaGVuRmV0Y2..."
     #
-    # @return [String] The scroll id returned by ElasticSearch
+    # @return [String] The scroll id returned by Elasticsearch
 
     def scroll_id
       response["_scroll_id"]
@@ -224,7 +224,7 @@ module SearchFlip
 
     # Returns the database records, usually ActiveRecord objects, depending on
     # the ORM you're using. The records are sorted using the order returned by
-    # ElasticSearch.
+    # Elasticsearch.
     #
     # @example
     #   CommentIndex.search("hello world").records # => [#<Comment ...>, ...]
@@ -240,7 +240,7 @@ module SearchFlip
     end
 
     # Builds and returns a scope for the array of ids in the current result set
-    # returned by ElasticSearch, including the eager load, preload and includes
+    # returned by Elasticsearch, including the eager load, preload and includes
     # associations, if specified. A scope is eg an ActiveRecord::Relation,
     # depending on the ORM you're using.
     #
@@ -259,7 +259,7 @@ module SearchFlip
       res
     end
 
-    # Returns the array of ids returned by ElasticSearch for the current result
+    # Returns the array of ids returned by Elasticsearch for the current result
     # set, ie the ids listed in the hits section of the response.
     #
     # @example
@@ -273,19 +273,19 @@ module SearchFlip
 
     def_delegators :ids, :size, :count, :length
 
-    # Returns the response time in milliseconds of ElasticSearch specified in
+    # Returns the response time in milliseconds of Elasticsearch specified in
     # the took info of the response.
     #
     # @example
     #   CommentIndex.match_all.took # => 6
     #
-    # @return [Fixnum] The ElasticSearch response time in milliseconds
+    # @return [Fixnum] The Elasticsearch response time in milliseconds
 
     def took
       response["took"]
     end
 
-    # Returns a single or all aggregations returned by ElasticSearch, depending
+    # Returns a single or all aggregations returned by Elasticsearch, depending
     # on whether or not a name is specified. If no name is specified, the raw
     # aggregation hash is simply returned. Contrary, if a name is specified,
     # only this aggregation is returned. Moreover, if a name is specified and
@@ -300,7 +300,7 @@ module SearchFlip
     #   CommentIndex.aggregate(:user_id).aggregations(:user_id)
     #   # => {4922=>1129, ...}
     #
-    # @return [Hash] Specific or all aggregations returned by ElasticSearch
+    # @return [Hash] Specific or all aggregations returned by Elasticsearch
 
     def aggregations(name = nil)
       return response["aggregations"] || {} unless name

data/lib/search_flip/version.rb

@@ -1,5 +1,5 @@
 
 module SearchFlip
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end
 

data/search_flip.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.version       = SearchFlip::VERSION
   spec.authors       = ["Benjamin Vetter"]
   spec.email         = ["vetter@flakks.com"]
-  spec.description   = %q{Compositional EasticSearch client library}
-  spec.summary       = %q{Powerful ElasticSearch client library to easily build complex queries}
+  spec.description   = %q{Full-Featured Elasticsearch Ruby Client with a Chainable DSL}
+  spec.summary       = %q{Full-Featured Elasticsearch Ruby Client with a Chainable DSL}
   spec.homepage      = "https://github.com/mrkamel/search_flip"
   spec.license       = "MIT"
 
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "sqlite3", "~> 1.3.6"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "timecop"
   spec.add_development_dependency "webmock"
 

data/spec/search_flip/criteria_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe SearchFlip::Criteria do
       methods = [
         :profile_value, :failsafe_value, :terminate_after_value, :timeout_value,
         :offset_value, :limit_value, :scroll_args, :source_value, :preference_value,
-        :search_type_value, :routing_value, :track_total_hits_value
+        :search_type_value, :routing_value, :track_total_hits_value, :explain_value
       ]
 
       methods.each do |method|
@@ -259,6 +259,54 @@ RSpec.describe SearchFlip::Criteria do
     end
   end
 
+  describe "#must" do
+    it "sets up the constraints correctly and is chainable" do
+      product1 = create(:product, price: 100, category: "category1")
+      product2 = create(:product, price: 200, category: "category2")
+      product3 = create(:product, price: 300, category: "category1")
+
+      ProductIndex.import [product1, product2, product3]
+
+      query1 = ProductIndex.must(range: { price: { gte: 100, lte: 200 } })
+      query2 = query1.must(term: { category: "category1" })
+
+      expect(query1.records.to_set).to eq([product1, product2].to_set)
+      expect(query2.records).to eq([product1])
+    end
+  end
+
+  describe "#must_not" do
+    it "sets up the constraints correctly and is chainable" do
+      product1 = create(:product, price: 100, category: "category1")
+      product2 = create(:product, price: 200, category: "category2")
+      product3 = create(:product, price: 300, category: "category1")
+
+      ProductIndex.import [product1, product2, product3]
+
+      query1 = ProductIndex.must_not(range: { price: { gt: 200, lte: 300 } })
+      query2 = query1.must_not(term: { category: "category2" })
+
+      expect(query1.records.to_set).to eq([product1, product2].to_set)
+      expect(query2.records).to eq([product1])
+    end
+  end
+
+  describe "#should" do
+    it "sets up the constraints correctly and is chainable" do
+      product1 = create(:product, price: 100, category: "category1")
+      product2 = create(:product, price: 200, category: "category2")
+      product3 = create(:product, price: 300, category: "category1")
+
+      ProductIndex.import [product1, product2, product3]
+
+      query1 = ProductIndex.should(range: { price: { gte: 100, lt: 200 } })
+      query2 = query1.should(term: { category: "category2" })
+
+      expect(query1.records.to_set).to eq([product1].to_set)
+      expect(query2.records.to_set).to eq([product1, product2].to_set)
+    end
+  end
+
   describe "#range" do
     it "sets up the constraints correctly and is chainable" do
       product1 = create(:product, price: 100)
@@ -1035,6 +1083,15 @@ RSpec.describe SearchFlip::Criteria do
     end
   end
 
+  describe "#explain" do
+    it "returns the explaination" do
+      ProductIndex.import create(:product)
+
+      query = ProductIndex.match_all.explain(true)
+      expect(query.results.first._hit.key?(:_explanation)).to eq(true)
+    end
+  end
+
   describe "#custom" do
     it "adds a custom entry to the request" do
       request = ProductIndex.custom(custom_key: "custom_value").request

data/spec/search_flip/index_spec.rb

@@ -15,7 +15,7 @@ RSpec.describe SearchFlip::Index do
       :total_entries, :total_count, :terminate_after, :timeout, :records, :results,
       :should, :should_not, :must, :must_not, :find_each_result,
       :find_results_in_batches, :preference, :search_type, :routing,
-      :track_total_hits
+      :track_total_hits, :explain
     ]
 
     methods.each do |method|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -84,16 +84,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Compositional EasticSearch client library
+description: Full-Featured Elasticsearch Ruby Client with a Chainable DSL
 email:
 - vetter@flakks.com
 executables: []
@@ -199,7 +199,6 @@ files:
 - lib/search_flip/result.rb
 - lib/search_flip/to_json.rb
 - lib/search_flip/version.rb
-- logo.svg
 - search_flip.gemspec
 - spec/delegate_matcher.rb
 - spec/search_flip/aggregation_spec.rb
@@ -234,11 +233,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Powerful ElasticSearch client library to easily build complex queries
+summary: Full-Featured Elasticsearch Ruby Client with a Chainable DSL
 test_files:
 - spec/delegate_matcher.rb
 - spec/search_flip/aggregation_spec.rb

data/logo.svg

@@ -1,96 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Generated by IcoMoon.io -->
-
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
-   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
-   version="1.1"
-   width="300"
-   height="50"
-   viewBox="0 0 299.99998 50"
-   id="svg4869"
-   sodipodi:docname="logo.svg"
-   inkscape:export-filename="/home/hkf/projects/search_flip/logo.png"
-   inkscape:export-xdpi="299.34824"
-   inkscape:export-ydpi="299.34824"
-   inkscape:version="0.92.1 r15371">
-  <metadata
-     id="metadata4875">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title>arrow-long-up</dc:title>
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
-  <defs
-     id="defs4873" />
-  <sodipodi:namedview
-     pagecolor="#ffffff"
-     bordercolor="#666666"
-     borderopacity="1"
-     objecttolerance="10"
-     gridtolerance="10"
-     guidetolerance="10"
-     inkscape:pageopacity="0"
-     inkscape:pageshadow="2"
-     inkscape:window-width="1920"
-     inkscape:window-height="971"
-     id="namedview4871"
-     showgrid="false"
-     fit-margin-top="0"
-     fit-margin-left="0"
-     fit-margin-right="0"
-     fit-margin-bottom="0"
-     inkscape:zoom="2.085965"
-     inkscape:cx="91.987216"
-     inkscape:cy="-41.606043"
-     inkscape:window-x="0"
-     inkscape:window-y="31"
-     inkscape:window-maximized="1"
-     inkscape:current-layer="svg4869" />
-  <title
-     id="title4865">arrow-long-up</title>
-  <path
-     d="M 39.922489,4.151999 36.230955,18.361869 32.37339,14.504302 10.209748,36.667943 7.4576271,33.915823 29.621268,11.75218 25.712619,7.843531 Z"
-     id="path4867"
-     inkscape:connector-curvature="0"
-     style="stroke-width:1.80568123"
-     inkscape:export-xdpi="325.4834"
-     inkscape:export-ydpi="325.4834"
-     sodipodi:nodetypes="cccccccc"
-     inkscape:export-filename="/home/hkf/projects/search_flip/text4908.png" />
-  <path
-     d="M 17.625202,45.376517 31.473864,41.323778 27.948317,37.696072 50.111962,15.532428 47.418207,12.940838 25.254566,35.10448 21.677941,31.527854 Z"
-     id="path4867-7"
-     inkscape:connector-curvature="0"
-     style="stroke-width:1.74257004"
-     inkscape:export-xdpi="325.4834"
-     inkscape:export-ydpi="325.4834"
-     sodipodi:nodetypes="cccccccc"
-     inkscape:export-filename="/home/hkf/projects/search_flip/text4908.png" />
-  <text
-     xml:space="preserve"
-     style="font-style:normal;font-weight:normal;font-size:96.44345093px;line-height:1.25;font-family:sans-serif;letter-spacing:-0.65099335px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:2.41108632"
-     x="59.037937"
-     y="37.501484"
-     id="text4908"
-     inkscape:export-filename="/home/hkf/projects/search_flip/text4908.png"
-     inkscape:export-xdpi="325.4834"
-     inkscape:export-ydpi="325.4834"
-     inkscape:transform-center-x="-2.0432889"
-     inkscape:transform-center-y="-9.8078108"><tspan
-       sodipodi:role="line"
-       id="tspan4906"
-       x="59.037937"
-       y="37.501484"
-       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:51.43650818px;line-height:6;font-family:'times new roman';-inkscape-font-specification:'times new roman, ';letter-spacing:0px;word-spacing:-19.48158455px;stroke-width:2.41108632">search_flip</tspan></text>
-</svg>