redi_search 2.0.2 → 5.0.0

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,23 +22,31 @@ 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),
+        { name: "RediSearch", action: action, inside_pipeline: pipeline }.
+          merge(payload),
         &Proc.new(&(block || proc {}))
       )
     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/display.rb

@@ -4,9 +4,9 @@ module RediSearch
   class Document
     module Display
       def inspect
-        inspection = pretty_print_attributes.map do |field_name|
+        inspection = pretty_print_attributes.filter_map do |field_name|
           "#{field_name}: #{public_send(field_name)}"
-        end.compact.join(", ")
+        end.join(", ")
 
         "#<#{self.class} #{inspection}>"
       end
@@ -19,7 +19,7 @@ module RediSearch
         pp_attrs.compact
       end
 
-      #:nocov:
+      # :nocov:
       def pretty_print(printer) # rubocop:disable Metrics/MethodLength
         printer.object_address_group(self) do
           printer.seplist(
@@ -35,7 +35,7 @@ module RediSearch
           end
         end
       end
-      #:nocov:
+      # :nocov:
     end
   end
 end

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

@@ -11,11 +11,11 @@ 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).filter_map do |field|
+          next unless only.empty? || only.include?(field)
 
           [field.to_s, object_to_serialize.public_send(field)]
-        end.compact.to_h
+        end.to_h
 
         new(index, object_to_serialize.id, field_values)
       end
@@ -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/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

data/lib/redi_search/index.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "redi_search/add"
+require "redi_search/hset"
 require "redi_search/create"
 require "redi_search/schema"
 require "redi_search/search"
@@ -33,34 +33,36 @@ module RediSearch
       Create.new(self, schema, options).call!
     end
 
-    def drop
-      drop!
+    def drop(keep_docs: false)
+      drop!(keep_docs: keep_docs)
     rescue Redis::CommandError
       false
     end
 
-    def drop!
-      client.call!("DROP", name).ok?
+    def drop!(keep_docs: false)
+      command = ["DROPINDEX", name]
+      command << "DD" unless keep_docs
+      client.call!(*command.compact).ok?
     end
 
-    def add(document, **options)
-      Add.new(self, document, **options).call
+    def add(document)
+      Hset.new(self, document).call
     end
 
-    def add!(document, **options)
-      Add.new(self, document, **options).call!
+    def add!(document)
+      Hset.new(self, document).call!
     end
 
-    def add_multiple(documents, **options)
+    def add_multiple(documents)
       client.multi do
         documents.each do |document|
-          add(document, **options)
+          add(document)
         end
-      end.ok?
+      end.all? { |response| response >= 0 }
     end
 
-    def del(document, delete_document: false)
-      document.del(delete_document: delete_document)
+    def del(document)
+      document.del
     end
 
     def exist?
@@ -78,14 +80,14 @@ module RediSearch
     end
 
     def fields
-      schema.fields.map(&:to_s)
+      schema.fields.map { |field| field.name.to_s }
     end
 
-    def reindex(documents, recreate: false, **options)
+    def reindex(documents, recreate: false)
       drop if recreate
       create unless exist?
 
-      add_multiple documents, **options
+      add_multiple documents
     end
 
     def document_count

data/lib/redi_search/lazily_load.rb

@@ -30,7 +30,7 @@ module RediSearch
       end
     end
 
-    #:nocov:
+    # :nocov:
     def pretty_print(printer)
       execute_and_rescue_inspection do
         return super(inspect) unless valid?
@@ -38,7 +38,7 @@ module RediSearch
         printer.pp(documents)
       end
     end
-    #:nocov:
+    # :nocov:
 
     private
 

data/lib/redi_search/log_subscriber.rb

@@ -12,12 +12,12 @@ module RediSearch
       Thread.current[:redi_search_runtime] ||= 0
     end
 
-    #:nocov:
+    # :nocov:
     def self.reset_runtime
       rt, self.runtime = runtime, 0
       rt
     end
-    #:nocov:
+    # :nocov:
 
     def action(event)
       self.class.runtime += event.duration
@@ -39,9 +39,9 @@ module RediSearch
     def action_color(action)
       case action.to_sym
       when :search, :spellcheck then YELLOW
-      when :create, :add then GREEN
-      when :drop, :del then RED
-      when :get, :mget, :info then CYAN
+      when :create, :hset then GREEN
+      when :dropindex, :del then RED
+      when :hgetall, :info then CYAN
       when :pipeline then MAGENTA
       when :explaincli then BLUE
       end
@@ -52,6 +52,7 @@ module RediSearch
       event.payload[:query].flatten.map.with_index do |arg, i|
         arg = "FT.#{arg}" if prepend_ft?(arg, i)
         arg = arg.inspect if inspect_arg?(event.payload, arg)
+        arg = "  #{arg}"  if event.payload[:inside_pipeline]
         arg
       end.join(" ")
     end
@@ -61,7 +62,7 @@ module RediSearch
     end
 
     def prepend_ft?(arg, index)
-      index.zero? && !multiword?(arg)
+      index.zero? && !multiword?(arg) && %w(HSET HGETALL DEL).exclude?(arg.to_s)
     end
 
     def inspect_arg?(payload, arg)

data/lib/redi_search/model.rb

@@ -48,11 +48,11 @@ module RediSearch
         redi_search_index.spellcheck(term, distance: distance)
       end
 
-      def reindex(recreate: false, only: [], **options)
+      def reindex(recreate: false, only: [])
         search_import.find_in_batches.all? do |group|
           redi_search_index.reindex(
             group.map { |record| record.redi_search_document(only: only) },
-            recreate: recreate, **options.deep_merge(replace: { partial: true })
+            recreate: recreate
           )
         end
       end
@@ -67,17 +67,11 @@ module RediSearch
       end
 
       def redi_search_delete_document
-        return unless self.class.redi_search_index.exist?
-
-        self.class.redi_search_index.del(
-          redi_search_document, delete_document: true
-        )
+        self.class.redi_search_index.del(redi_search_document)
       end
 
       def redi_search_add_document
-        return unless self.class.redi_search_index.exist?
-
-        self.class.redi_search_index.add(redi_search_document, replace: true)
+        self.class.redi_search_index.add(redi_search_document)
       end
     end
   end

data/lib/redi_search/schema/field.rb

@@ -3,6 +3,14 @@
 module RediSearch
   class Schema
     class Field
+      def name
+        @name&.to_sym
+      end
+
+      def serialize(value)
+        value
+      end
+
       private
 
       FALSES = [
@@ -10,10 +18,10 @@ module RediSearch
       ].freeze
 
       def boolean_options_string
-        boolean_options.map do |option|
+        boolean_options.filter_map do |option|
           option.to_s.upcase.split("_").join unless
             FALSES.include?(send(option))
-        end.compact
+        end
       end
     end
   end