search_flip 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51aeb6ec190e4ee6ff8d291d46e038e55bec7eb2b09cfc5eb410b9f523b75f8a
-  data.tar.gz: 89882033f77adf5c29104ae35e5c0ee2fd4d4222111ba98ad76cfb508a92da8d
+  metadata.gz: 2a1c972daa52dd27bff5ba1d5393f261f63d822df616e1c9c5c1a362ebf7ba6b
+  data.tar.gz: 175036020a5b0e6b21aad2b1c6a8a3eb4f26ac65cc48b250455c8dd952c1d72e
 SHA512:
-  metadata.gz: 5fd5f110807947f0a1bc9906ced03be0c20a1c79a792321cd472d24b0c50a68e6ed88927f1db087ce64f45fd1544d85a5b434b25365f90f2ef83f9d06a8cb6db
-  data.tar.gz: cf8e8c77ec27b895249d39e8498207f4a4484776d9f3aefb79f163f5c9e262c80516e4ff99573e833f83ad1de96659a1b2707c1ae7d2786bd72d5d59631ba00b
+  metadata.gz: f12ca12f6fd01ab6bd5a6bc81d5a1d520c9fa1feb08157c6fd0abfece940f8307daa7c2eda5fd62bdae36e8be07b3e71b8fa3a515322eb68803721ff65021826
+  data.tar.gz: 472b96a7c30a61ad68d48faa01b785831103594e55095b78bf66ee6041b1551dbda239177b1ac41370d7c76e1a9286eb95b6c4c46a10705f4722c44e9af5ee16

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+on: push
+name: test
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        elasticsearch:
+        - plainpicture/elasticsearch:2.4.1_delete-by-query
+        - elasticsearch:5.4
+        - docker.elastic.co/elasticsearch/elasticsearch:6.7.0
+        - docker.elastic.co/elasticsearch/elasticsearch:7.0.0
+        - docker.elastic.co/elasticsearch/elasticsearch:7.9.0
+        ruby:
+        - 2.5
+        - 2.6
+        - 2.7
+    services:
+      elasticsearch:
+        image: ${{ matrix.elasticsearch }}
+        env:
+          discovery.type: single-node
+        ports:
+          - 9200:9200
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: bundle
+    - run: sleep 10
+    - run: bundle exec rspec
+    - run: bundle exec rubocop

data/.rubocop.yml

@@ -2,6 +2,9 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.4
 
+Layout/EmptyLineBetweenDefs:
+  EmptyLineBetweenClassDefs: false
+
 Gemspec/RequiredRubyVersion:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 
 # CHANGELOG
 
+## v3.2.0
+
+* Fix `index_scope` not being passed in `each_record` without block
+* Added `SearchFlip::Criteria#match_none`
+
 ## v3.1.2
 
 * Fix ignored false value for source when merging criterias

data/README.md

@@ -419,6 +419,14 @@ Simply matches all documents:
 CommentIndex.match_all
 ```
 
+* `match_none`
+
+Simply matches none documents at all:
+
+```ruby
+CommentIndex.match_none
+```
+
 * `all`
 
 Simply returns the criteria as is or an empty criteria when called on the index
@@ -926,6 +934,7 @@ require "search_flip/to_json"
 
 * for Elasticsearch 2.x, the delete-by-query plugin is required to delete
   records via queries
+* `#match_none` is only available with Elasticsearch >= 5
 * `#track_total_hits` is only available with Elasticsearch >= 7
 
 ## Keeping your Models and Indices in Sync

data/lib/search_flip/filterable.rb

@@ -235,6 +235,22 @@ module SearchFlip
       filter(match_all: options)
     end
 
+    # Adds a match none filter to the criteria, which simply matches none
+    # documents at all. Check out the Elasticsearch docs for further details.
+    #
+    # @example Basic usage
+    #   CommentIndex.match_none
+    #
+    # @example Filter chaining
+    #   query = CommentIndex.search("...")
+    #   query = query.match_none unless current_user.admin?
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def match_none
+      filter(match_none: {})
+    end
+
     # Adds an exists filter to the criteria, which selects all documents for
     # which the specified field has a non-null value.
     #

data/lib/search_flip/index.rb

@@ -153,7 +153,7 @@ module SearchFlip
       #   scope to be applied to the scope
 
       def each_record(scope, index_scope: false)
-        return enum_for(:each_record, scope) unless block_given?
+        return enum_for(:each_record, scope, index_scope: index_scope) unless block_given?
 
         if scope.respond_to?(:find_each)
           (index_scope ? self.index_scope(scope) : scope).find_each do |record|
@@ -247,8 +247,8 @@ module SearchFlip
         SearchFlip::Criteria.new(target: self)
       end
 
-      def_delegators :criteria, :all, :profile, :where, :where_not, :filter, :range, :match_all, :exists,
-        :exists_not, :post_where, :post_where_not, :post_range, :post_exists, :post_exists_not,
+      def_delegators :criteria, :all, :profile, :where, :where_not, :filter, :range, :match_all, :match_none,
+        :exists, :exists_not, :post_where, :post_where_not, :post_range, :post_exists, :post_exists_not,
         :post_filter, :post_must, :post_must_not, :post_should, :aggregate, :scroll, :source,
         :includes, :eager_load, :preload, :sort, :resort, :order, :reorder, :offset, :limit, :paginate,
         :page, :per, :search, :highlight, :suggest, :custom, :find_in_batches, :find_results_in_batches,

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.1.2"
+  VERSION = "3.2.0"
 end

data/spec/search_flip/criteria_spec.rb

@@ -416,6 +416,18 @@ RSpec.describe SearchFlip::Criteria do
     end
   end
 
+  describe "#match_none" do
+    it "does not match any documents" do
+      if ProductIndex.connection.version.to_i >= 5
+        ProductIndex.import create(:product)
+
+        query = ProductIndex.match_none
+
+        expect(query.records).to eq([])
+      end
+    end
+  end
+
   describe "#exists" do
     it "sets up the constraints correctly and is chainable" do
       product1 = create(:product, title: "title1", description: "description1")

data/spec/search_flip/index_spec.rb

@@ -5,8 +5,8 @@ RSpec.describe SearchFlip::Index do
     subject { ProductIndex }
 
     methods = [
-      :all, :profile, :where, :where_not, :filter, :range, :match_all, :exists,
-      :exists_not, :post_where, :post_where_not, :post_filter, :post_must,
+      :all, :profile, :where, :where_not, :filter, :range, :match_all, :match_none,
+      :exists, :exists_not, :post_where, :post_where_not, :post_filter, :post_must,
       :post_must_not, :post_should, :post_range, :post_exists, :post_exists_not,
       :aggregate, :scroll, :source, :includes, :eager_load, :preload, :sort, :resort,
       :order, :reorder, :offset, :limit, :paginate, :page, :per, :search,
@@ -211,12 +211,18 @@ RSpec.describe SearchFlip::Index do
         mapping = { properties: { id: { type: "long" } } }
 
         allow(TestIndex).to receive(:mapping).and_return(mapping)
-        allow(TestIndex.connection).to receive(:update_mapping).and_call_original
+        allow(TestIndex.connection).to receive(:update_mapping)
 
         TestIndex.update_mapping
 
         expect(TestIndex.connection).to have_received(:update_mapping).with("test", { "test" => mapping }, type_name: "test")
       end
+
+      it "updates the mapping" do
+        TestIndex.create_index
+
+        expect(TestIndex.update_mapping).to eq(true)
+      end
     end
   end
 
@@ -258,12 +264,19 @@ RSpec.describe SearchFlip::Index do
         TestIndex.create_index
         TestIndex.update_mapping
 
-        allow(TestIndex.connection).to receive(:get_mapping).and_call_original
+        allow(TestIndex.connection).to receive(:get_mapping)
 
         TestIndex.get_mapping
 
         expect(TestIndex.connection).to have_received(:get_mapping).with("test", type_name: "test")
       end
+
+      it "returns the mapping" do
+        TestIndex.create_index
+        TestIndex.update_mapping
+
+        expect(TestIndex.get_mapping).to be_present
+      end
     end
   end
 

data/spec/search_flip/null_instrumenter_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe SearchFlip::NullInstrumenter do
     it "calls start" do
       allow(subject).to receive(:start)
 
-      subject.instrument("name", { key: "value" }) {}
+      subject.instrument("name", { key: "value" }) { true }
 
       expect(subject).to have_received(:start)
     end
@@ -15,7 +15,7 @@ RSpec.describe SearchFlip::NullInstrumenter do
     it "calls finish" do
       allow(subject).to receive(:finish)
 
-      subject.instrument("name", { key: "value" }) {}
+      subject.instrument("name", { key: "value" }) { true }
 
       expect(subject).to have_received(:finish)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -213,9 +213,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -287,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Full-Featured Elasticsearch Ruby Client with a Chainable DSL

data/.travis.yml

@@ -1,20 +0,0 @@
-sudo: false
-language: ruby
-env:
-  - ES_IMAGE=plainpicture/elasticsearch:2.4.1_delete-by-query
-  - ES_IMAGE=elasticsearch:5.4
-  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:6.7.0
-  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:7.0.0
-  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:7.9.0
-rvm:
-  - ruby-2.5.3
-  - ruby-2.6.2
-  - ruby-2.7.1
-before_install:
-  - docker-compose up -d
-  - sleep 10
-install:
-  - travis_retry bundle install
-script:
- - bundle exec rspec
- - bundle exec rubocop