redi_search 2.0.0 → 4.1.0

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.rc2"
+gem "activerecord", "~> 6.1"

data/README.md

@@ -6,8 +6,7 @@
 
 # RediSearch
 
-[![Build Status](https://travis-ci.com/npezza93/redi_search.svg?branch=master)](https://travis-ci.com/npezza93/redi_search)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/c6437acac5684de2549d/test_coverage)](https://codeclimate.com/github/npezza93/redi_search/test_coverage)
+![Build Status](https://github.com/npezza93/redi_search/workflows/tests/badge.svg)
 [![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(only: [], **options)` 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`
+`User.reindex(recreate: false, only: [])` is also added and behaves
+similarly to `RediSearch::Index#reindex`. Some of the differences include:
+  - `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
@@ -561,6 +543,10 @@ class User < ApplicationRecord
 end
 ```
 
+When searching, by default a collection of `Document`s is returned. Calling
+`#results` on the search query will execute the search, and then look up all the
+found records in the database and return an ActiveRecord relation.
+
 The default `Index` name for model `Index`s is
 `#{model_name.plural}_#{RediSearch.env}`. The `redi_search` method takes an
 optional `index_prefix` argument which gets prepended to the index name:

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"
 
@@ -35,10 +35,7 @@ def seed_users(count = 10_000)
 end
 
 def reload!
-  Object.send :remove_const, :RediSearch
-  files = $LOADED_FEATURES.select { |feat| feat =~ /\/redi_search\// }
-  files.each { |file| load file }
-  true
+  exec($0)
 end
 
-Pry.start
+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/lib/redi_search.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "delegate"
+require "forwardable"
 require "redis"
 require "active_support/lazy_load_hooks"
 

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.rb

@@ -9,10 +9,12 @@ module RediSearch
   class Client
     def initialize(redis = Redis.new)
       @redis = redis
+      @pipeline = false
     end
 
-    def call!(command, *params)
+    def call!(command, *params, skip_ft: false)
       instrument(command.downcase, query: [command, params]) do
+        command = "FT.#{command}" unless skip_ft
         send_command(command, *params)
       end
     end
@@ -20,24 +22,32 @@ module RediSearch
     def multi
       Response.new(redis.multi do
         instrument("pipeline", query: ["begin pipeline"])
-        yield
+        capture_pipeline { yield }
         instrument("pipeline", query: ["finish pipeline"])
       end)
     end
 
     private
 
-    attr_reader :redis
+    attr_reader   :redis
+    attr_accessor :pipeline
+
+    def capture_pipeline
+      self.pipeline = true
+      yield
+      self.pipeline = false
+    end
 
     def send_command(command, *params)
-      Response.new(redis.call("FT.#{command}", *params))
+      Response.new(redis.call(command, *params))
     end
 
     def instrument(action, payload, &block)
       ActiveSupport::Notifications.instrument(
         "action.redi_search",
-        { name: "RediSearch", action: action }.merge(payload),
-        &Proc.new(&(block || proc {}))
+        { name: "RediSearch", action: action, inside_pipeline: pipeline }.
+          merge(payload),
+        &Proc.new(&(block || proc {})) # rubocop:disable Lint/EmptyBlock
       )
     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

data/lib/redi_search/create.rb

@@ -31,7 +31,8 @@ module RediSearch
     attr_reader :index, :schema, :options
 
     def command
-      ["CREATE", index.name, *extract_options.compact, "SCHEMA", schema.to_a]
+      ["CREATE", index.name, "ON", "HASH", "PREFIX", 1, index.name,
+       *extract_options.compact, "SCHEMA", schema.to_a]
     end
 
     def extract_options

data/lib/redi_search/document.rb

@@ -11,8 +11,8 @@ module RediSearch
       def for_object(index, record, serializer: nil, only: [])
         object_to_serialize = serializer&.new(record) || record
 
-        field_values = index.schema.fields.map do |field|
-          next unless only.empty? || only.include?(field.to_sym)
+        field_values = index.schema.fields.map(&:name).map do |field|
+          next unless only.empty? || only.include?(field)
 
           [field.to_s, object_to_serialize.public_send(field)]
         end.compact.to_h
@@ -23,10 +23,6 @@ module RediSearch
       def get(index, document_id)
         Finder.new(index, document_id).find
       end
-
-      def mget(index, *document_ids)
-        Finder.new(index, *document_ids).find
-      end
     end
 
     attr_reader :attributes, :score
@@ -40,17 +36,20 @@ module RediSearch
       load_attributes
     end
 
-    def del(delete_document: false)
-      command = ["DEL", index.name, document_id, ("DD" if delete_document)]
-      call!(*command.compact).ok?
+    def del
+      RediSearch.client.call!("DEL", document_id, skip_ft: true).ok?
     end
 
     def schema_fields
-      @schema_fields ||= index.schema.fields.map(&:to_s)
+      @schema_fields ||= index.schema.fields.map do |field|
+        field.name.to_s
+      end
     end
 
     def redis_attributes
-      attributes.to_a.flatten
+      attributes.flat_map do |field, value|
+        [field, index.schema[field.to_sym].serialize(value)]
+      end
     end
 
     def document_id
@@ -73,10 +72,6 @@ module RediSearch
 
     attr_reader :index
 
-    def call!(*command)
-      RediSearch.client.call!(*command)
-    end
-
     def load_attributes
       attributes.each do |field, value|
         next unless schema_fields.include? field.to_s

data/lib/redi_search/document/finder.rb

@@ -3,75 +3,37 @@
 module RediSearch
   class Document
     class Finder
-      def initialize(index, *document_ids)
+      def initialize(index, document_id)
         @index = index
-        @document_ids = [*document_ids]
+        @document_id = document_id
       end
 
       def find
-        if multi?
-          parse_multi_documents
-        else
-          parse_document(document_ids.first, response)
-        end
+        Document.new(index, document_id, Hash[*response]) if response?
       end
 
       private
 
-      attr_reader :index, :document_ids
+      attr_reader :index, :document_id
 
       def response
-        @response ||= call!(get_command, index.name, *prepended_document_ids)
+        @response ||= call!("HGETALL", prepended_document_id)
       end
 
       def call!(*command)
-        RediSearch.client.call!(*command)
-      end
-
-      def get_command
-        if multi?
-          "MGET"
-        else
-          "GET"
-        end
-      end
-
-      def multi?
-        document_ids.size > 1
-      end
-
-      def prepended_document_ids
-        document_ids.map do |document_id|
-          prepend_document_id(document_id)
-        end
+        RediSearch.client.call!(*command, skip_ft: true)
       end
 
-      def prepend_document_id(id)
-        if id.to_s.start_with? index.name
-          id
+      def prepended_document_id
+        if document_id.to_s.start_with? index.name
+          document_id
         else
-          "#{index.name}#{id}"
+          "#{index.name}#{document_id}"
         end
       end
 
-      def parse_multi_documents
-        document_ids.map.with_index do |document_id, index|
-          parse_document(document_id, response[index])
-        end.compact
-      end
-
-      def parse_document(document_id, document_response)
-        return unless document_response?(document_response)
-
-        Document.new(index, document_id, Hash[*document_response])
-      end
-
-      def document_response?(document_response)
-        if document_response.respond_to?(:empty?)
-          !document_response.empty?
-        else
-          !document_response.nil?
-        end
+      def response?
+        !response.to_a.empty?
       end
     end
   end

data/lib/redi_search/hset.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RediSearch
+  class Hset
+    def initialize(index, document)
+      @index = index
+      @document = document
+    end
+
+    def call!
+      RediSearch.client.call!(*command, skip_ft: true)
+    end
+
+    def call
+      call!
+    rescue Redis::CommandError
+      false
+    end
+
+    private
+
+    attr_reader :index, :document
+
+    def command
+      ["HSET", document.document_id, document.redis_attributes].compact
+    end
+  end
+end