redi_search 2.0.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b7bc12a1d3a50de259ae10c27658e164d3ef84b65f0c4108c925138e53c1239
-  data.tar.gz: 899ac067a70ee3f5d43c833a59aa32546ca4e18a57beaba3bccabc496ffff96a
+  metadata.gz: 140fad214c11689ac648949c29c17409c96164ca68e9c6cc5cb694b291aa685c
+  data.tar.gz: 7ba282b0a28eb08c5a8064d3d26afd6c1b97935991f55bd5b69ff50c5a3b7eec
 SHA512:
-  metadata.gz: 131f1b1c9a4e2dad0740da6398a41a5ea01725e6e7dc02b9d604b252d3ad2612d3d23946fa1029e2d897c879b9b8c1c2951a73b1d7e4bca415d65998c0d8d0b8
-  data.tar.gz: c1a6d747b27f77054c797feee442359306a36609fe1d8d8483467df93916ea4b2e7af7a1db5c3bd442aba04e54dad0131ac673dc6aa10ddba89b63ef48dbad37
+  metadata.gz: df96fa21f24f4fec24c66c64b447775a01eb9de86fbf5b30fd028a101363f8036e612d2a2d9b49ed4f09c6dcc14bbcbe7f9a9893be5dcc4dcec7aa4a75db9c95
+  data.tar.gz: 63c12659be3dc7fdfd790c5f4bab980e970ae5943273c2bda750ba0b43c0ddab50390cb718193130ee7658dd6b6384eed96881619ce49699bb7914c5687643fc

data/.github/workflows/lint.yml

@@ -1,20 +1,22 @@
 name: lint
 
-on: [push]
+on:
+  pull_request:
+  push:
+    branches:
+      - master
 
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby 2.7
-      uses: actions/setup-ruby@v1
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 3.0
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.x
-    - name: Install dependencies
+        ruby-version: 3.0
+    - name: Install rubocop
       run: |
-        sudo apt-get install libsqlite3-dev
-        gem install bundler --no-document
-        bundle install
-    - name: Run tests
-      run: bundle exec rubocop --config=./.rubocop.yml --parallel
+        gem install rubocop rubocop-performance rubocop-minitest rubocop-rake
+    - name: Lint
+      run: rubocop --config=./.rubocop.yml --parallel

data/.github/workflows/tests.yml

@@ -1,20 +1,25 @@
 name: tests
 
-on: [push]
+on:
+  pull_request:
+  push:
+    branches:
+      - master
 
 jobs:
   unit:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.5.x', '2.6.x', '2.7.x' ]
-        gemfile: [ 'Gemfile', 'gemfiles/activerecord_51.gemfile', 'gemfiles/activerecord_52.gemfile' ]
+        ruby: [ '2.7', '3.0' ]
+        gemfile: [ 'Gemfile', 'gemfiles/activerecord_60.gemfile', 'gemfiles/activerecord_61.gemfile', 'gemfiles/activerecord_70.gemfile'  ]
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
     - name: Set up Ruby ${{ matrix.ruby }}
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+        bundler-cache: false
     - name: Install dependencies
       run: |
         sudo apt-get install libsqlite3-dev -y
@@ -24,21 +29,21 @@ jobs:
       run: BUNDLE_GEMFILE=${{ matrix.gemfile }} bundle exec rake test:unit
   integration:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        redi_search: [ '1.4.28', '1.6.13', 'edge' ]
+    services:
+      redisearch:
+        image: redislabs/redisearch:2.0.12
+        ports:
+          - 6379:6379
     steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby 2.7
-      uses: actions/setup-ruby@v1
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 3.0
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.x
+        ruby-version: 3.0
     - name: Install dependencies
       run: |
         sudo apt-get install libsqlite3-dev -y
-        gem install bundler --no-document
         bundle install
-        docker run -d -p 6379:6379 redislabs/redisearch:${{ matrix.redi_search }} --protected-mode no --loadmodule /usr/lib/redis/modules/redisearch.so
     - name: Run tests
       run: |
         bundle exec rake test:integration

data/.rubocop.yml

@@ -1,6 +1,9 @@
 require:
+  - rubocop-minitest
   - rubocop-performance
+  - rubocop-rake
 AllCops:
+  NewCops: enable
   Exclude:
     - vendor/**/*
     - Gemfile.lock
@@ -9,7 +12,8 @@ AllCops:
     - tmp/**/*
     - test/dummy/db/schema.rb
     - gemfiles/**/*
-  TargetRubyVersion: 2.5
+    - bin/**/*
+  TargetRubyVersion: 2.7
 
 # Department Bundler
 Bundler/DuplicatedGem:
@@ -611,7 +615,7 @@ Lint/UselessAssignment:
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars
   Enabled: true
 
-Lint/UselessComparison:
+Lint/BinaryOperatorWithIdenticalOperands:
   Description: Checks for comparison of something with itself.
   Enabled: true
 
@@ -1197,9 +1201,6 @@ Style/MethodDefParentheses:
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#method-parens
   Enabled: true
 
-Style/MethodMissingSuper:
-  Enabled: true
-
 Style/MissingRespondToMissing:
   Enabled: true
 
@@ -1630,5 +1631,70 @@ Style/RedundantRegexpCharacterClass:
   Enabled: true
 Style/RedundantRegexpEscape:
   Enabled: true
+Lint/MissingSuper:
+  Enabled: false
+
+
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/DuplicateRescueException:
+  Enabled: true
+Lint/EmptyConditionalBody:
+  Enabled: true
+Lint/FloatComparison:
+  Enabled: true
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+Lint/SelfAssignment:
+  Enabled: true
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+Lint/UnreachableLoop:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/ArrayCoercion:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/ExplicitBlockArgument:
+  Enabled: false
+Style/GlobalStdStream:
+  Enabled: true
+Style/HashAsLastArrayItem:
+  Enabled: false
+Style/HashLikeCase:
+  Enabled: true
+Style/OptionalBooleanParameter:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
 Style/RedundantFetchBlock:
   Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/SingleArgumentDig:
+  Enabled: true
+Style/StringConcatenation:
+  Enabled: true
+Performance/AncestorsInclude:
+  Enabled: true
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+Performance/RedundantSortBlock:
+  Enabled: true
+Performance/RedundantStringChars:
+  Enabled: true
+Performance/ReverseFirst:
+  Enabled: true
+Performance/SortReverse:
+  Enabled: true
+Performance/Squeeze:
+  Enabled: true
+Performance/StringInclude:
+  Enabled: true
+Minitest/AssertionInLifecycleHook:
+  Enabled: false

data/Appraisals

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
-appraise "activerecord-52" do
-  gem "activerecord", "< 6.0", ">= 5.2"
+appraise "activerecord-60" do
+  gem "activerecord", "< 6.1", ">= 6.0"
 end
 
-appraise "activerecord-51" do
-  gem "activerecord", "< 5.2", ">= 5.1"
+appraise "activerecord-61" do
+  gem "activerecord", "< 6.2", ">= 6.1"
+end
+
+appraise "activerecord-70" do
+  gem "activerecord", "~> 7.0.0.alpha1"
 end

data/Gemfile

@@ -9,10 +9,11 @@ gemspec
 gem "appraisal", "~> 2.2"
 gem "faker"
 gem "mocha"
-gem "pry"
 gem "rubocop"
+gem "rubocop-minitest"
 gem "rubocop-performance"
+gem "rubocop-rake"
 gem "simplecov"
 gem "sqlite3"
 
-gem "activerecord", "~> 6.0.0"
+gem "activerecord", "~> 6.1"

data/README.md

@@ -7,7 +7,6 @@
 # RediSearch
 
 ![Build Status](https://github.com/npezza93/redi_search/workflows/tests/badge.svg)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/c6437acac5684de2549d/test_coverage)](https://codeclimate.com/github/npezza93/redi_search/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c6437acac5684de2549d/maintainability)](https://codeclimate.com/github/npezza93/redi_search/maintainability)
 
 A simple, but powerful, Ruby wrapper around RediSearch, a search engine on top of
@@ -244,13 +243,11 @@ With no options: `{ place: :geo }`
 
 ## Document
 
-A `Document` is the Ruby representation of a RediSearch document.
+A `Document` is the Ruby representation of a Redis hash.
 
-You can fetch a `Document` using `.get` or `.mget` class methods.
+You can fetch a `Document` using `.get` class methods.
 - `get(index, document_id)` fetches a single `Document` in an `Index` for a
 given `document_id`.
-- `mget(index, *document_ids)` fetches a collection of `Document`s
-in an `Index` for the given `document_ids`.
 
 You can also make a `Document` instance using the
 `.for_object(index, record, serializer: nil, only: [])` class method. It takes
@@ -269,10 +266,7 @@ to override each other. There is also a `#document_id_without_index` method
 which removes the prepended index name.
 
 Finally there is a `#del` method that will remove the `Document` from the
-`Index`. It optionally accepts a `delete_document` named argument that signifies
-whether the `Document` should be completely removed from the Redis instance vs
-just the `Index`.
-
+`Index`.
 
 ## Index
 
@@ -314,42 +308,32 @@ RediSearch::Index.new(name_of_index, schema)
         - If set, we avoid saving the term frequencies in the index. This saves
           memory but does not allow sorting based on the frequencies of a given
           term within the document.
-- `drop`
+- `drop(keep_docs: false)`
   - Drops the `Index` from the Redis instance, returns a boolean. Has an
     accompanying bang method that will raise an exception upon failure. Will
-    return `false` if the `Index` has already been dropped.
+    return `false` if the `Index` has already been dropped. Takes an option
+    keyword arg, `keep_docs`, that will by default remove all the document
+    hashes in Redis.
 - `exist?`
   - Returns a boolean signifying `Index` existence.
 - `info`
   - Returns a struct object with all the information about the `Index`.
 - `fields`
   - Returns an array of the field names in the `Index`.
-- `add(document, score: 1.0, replace: {}, language: nil, no_save: false)`
-  - Takes a `Document` object and options. Has an
+- `add(document)`
+  - Takes a `Document` object. Has an
     accompanying bang method that will raise an exception upon failure.
-    - `score` -> The `Document`'s rank, a value between 0.0 and 1.0
-    - `language` -> Use a stemmer for the supplied language during indexing.
-    - `no_save` -> Don't save the actual `Document` in the database and only index it.
-    - `replace` -> Accepts a boolean or a hash. If a truthy value is passed, we
-      will do an UPSERT style insertion - and delete an older version of the
-      `Document` if it exists.
-    - `replace: { partial: true }` -> Allows you to not have to specify all
-      fields for reindexing. Fields not given to the command will be loaded from
-      the current version of the `Document`.
-- `add_multiple(documents, score: 1.0, replace: {}, language: nil, no_save: false)`
+- `add_multiple(documents)`
   - Takes an array of `Document` objects. This provides a more performant way to
     add multiple documents to the `Index`. Accepts the same options as `add`.
-- `del(document, delete_document: false)`
-  - Removes a `Document` from the `Index`. `delete_document` signifies whether the
-    `Document` should be completely removed from the Redis instance vs just the
-    `Index`.
+- `del(document)`
+  - Removes a `Document` from the `Index`.
 - `document_count`
   - Returns the number of `Document`s in the `Index`
 - `add_field(field_name, schema)`
   - Adds a new field to the `Index`. Ex: `index.add_field(:first_name, text: { phonetic: "dm:en" })`
-- `reindex(documents, recreate: false, **options)`
+- `reindex(documents, recreate: false)`
    - If `recreate` is `true` the `Index` will be dropped and recreated
-   - `options` accepts the same options as `add`
 
 
 ## Searching
@@ -521,11 +505,9 @@ end
 This will automatically add `User.search` and `User.spellcheck`
 methods which behave the same as if you called them on an `Index` instance.
 
-`User.reindex(recreate: false, only: [], **options)` is also added and behaves
+`User.reindex(recreate: false, only: [])` is also added and behaves
 similarly to `RediSearch::Index#reindex`. Some of the differences include:
-  - By default, does an upsert for all `Document`s added using the
-    option `replace: { partial: true }`.
-  - `Document`s do not to be passed as the first parameter. The `search_import`
+  - `Document`s do not need to be passed as the first parameter. The `search_import`
     scope is automatically called and all the records are converted
     to `Document`s.
   - Accepts an optional `only` parameter where you can specify a limited number

data/Rakefile

@@ -20,5 +20,6 @@ Rake::TestTask.new("test:integration") do |t|
   t.test_files = FileList["test/integration/**/*_test.rb"]
 end
 
+desc "run all tests"
 task test: [:default]
 task default: ["test:integration", "test:unit", :rubocop]

data/bin/console

@@ -5,7 +5,7 @@ require "bundler/setup"
 require "redi_search"
 
 require "faker"
-require "pry"
+require "irb"
 require "active_support/logger"
 require "active_record"
 
@@ -34,4 +34,8 @@ def seed_users(count = 10_000)
   User.reindex
 end
 
-Pry.start
+def reload!
+  exec($0)
+end
+
+IRB.start

data/gemfiles/{activerecord_51.gemfile → activerecord_60.gemfile}

@@ -2,12 +2,14 @@
 
 source "https://rubygems.org"
 
+gem "appraisal", "~> 2.2"
+gem "faker"
 gem "mocha"
-gem "pry"
 gem "rubocop"
+gem "rubocop-minitest"
 gem "rubocop-performance"
 gem "simplecov"
 gem "sqlite3"
-gem "activerecord", "< 5.2", ">= 5.1"
+gem "activerecord", "< 6.1", ">= 6.0"
 
 gemspec path: "../"

data/gemfiles/{activerecord_52.gemfile → activerecord_61.gemfile}

@@ -2,12 +2,14 @@
 
 source "https://rubygems.org"
 
+gem "appraisal", "~> 2.2"
+gem "faker"
 gem "mocha"
-gem "pry"
 gem "rubocop"
+gem "rubocop-minitest"
 gem "rubocop-performance"
 gem "simplecov"
 gem "sqlite3"
-gem "activerecord", "< 6.0", ">= 5.2"
+gem "activerecord", "< 6.2", ">= 6.1"
 
 gemspec path: "../"

data/gemfiles/activerecord_70.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.2"
+gem "faker"
+gem "mocha"
+gem "rubocop"
+gem "rubocop-minitest"
+gem "rubocop-performance"
+gem "simplecov"
+gem "sqlite3"
+gem "activerecord", "~> 7.0.0.alpha1"
+
+gemspec path: "../"

data/lib/redi_search/add_field.rb

@@ -29,7 +29,7 @@ module RediSearch
     end
 
     def field_schema
-      @field_schema ||= Schema.make_field(field_name, raw_schema)
+      @field_schema ||= Schema.make_field(field_name, raw_schema).to_a
     end
   end
 end

data/lib/redi_search/client/response.rb

@@ -6,7 +6,7 @@ module RediSearch
       def ok?
         case response
         when String then response == "OK"
-        when Integer then response == 1
+        when Integer then response >= 1
         when Array then array_ok?
         else response
         end