redi_search 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0666cc15e7fc7d132026337c916b5d233114d65378ff172d9a48ae81ed1a9eae
-  data.tar.gz: 575c1230885537ea9a31b753808894d187f00718fe8d0fca282cba426b75e0c8
+  metadata.gz: 28b67b5a88b3440ae45548484cc556a2cc0866328701f3a0ae8bac9aee8fe0c4
+  data.tar.gz: 494003de36b2acfd5b0338dc2421dd1add923d55ac0925f1ae2f798f0d56f535
 SHA512:
-  metadata.gz: 0f1486c6d2a7b1a726d6c956398e693317df4efffa0c73e45b180a3acb2ac36b69284e68e3230862e6948015b1ceee0a1ac518dab6182c86e4b2c710f587cd16
-  data.tar.gz: c9e179c20fc545612a00fd2f9b46e5a2eae9ce1292d4635625a80abf641d726d248ee753633dfa8e292b0dba1543af410e58cf5a10380d7854c66af2c06326a1
+  metadata.gz: cf672f8b0c8ac5b129c36596c24bfcbbb0eb522c7b8233d24b5b6f68ccf4465989e298c2fef25ed355a9ab476159ffd2682bf622bc10df8625b46a641005633c
+  data.tar.gz: 319e401ec3cf9ac165c62e84223c62e267bd80658bdf61abcbf673d87a51516a6de8f02c51441d3b355fdd03fddf479c5e6ae5aa86002e7503bc62f33e32422f

data/lib/redi_search/add.rb

@@ -35,15 +35,8 @@ module RediSearch
     attr_reader :index, :document, :score, :replace, :language, :no_save
 
     def command
-      [
-        "ADD",
-        index.name,
-        document.document_id,
-        score,
-        *extract_options,
-        "FIELDS",
-        document.redis_attributes
-      ].compact
+      ["ADD", index.name, document.document_id, score, *extract_options,
+       "FIELDS", document.redis_attributes].compact
     end
 
     def extract_options

data/lib/redi_search/alter.rb

@@ -10,12 +10,9 @@ module RediSearch
 
     def call!
       index.schema.alter(field_name, raw_schema)
+
       RediSearch.client.call!(
-        "ALTER",
-        index.name,
-        "SCHEMA",
-        "ADD",
-        *field_schema
+        "ALTER", index.name, "SCHEMA", "ADD", *field_schema
       ).ok?
     end
 

data/lib/redi_search/client/response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RediSearch
+  class Client
+    class Response < SimpleDelegator
+      def initialize(response)
+        @response = response
+
+        super(response)
+      end
+
+      def ok?
+        case response
+        when String then response == "OK"
+        when Integer then response == 1
+        when Array then array_ok?
+        else response
+        end
+      end
+
+      private
+
+      attr_reader :response
+
+      def array_ok?
+        response.all? do |pipeline_response|
+          Response.new(pipeline_response).ok?
+        end
+      end
+    end
+  end
+end

data/lib/redi_search/client.rb

@@ -1,31 +1,10 @@
 # frozen_string_literal: true
 
 require "redis"
+require "redi_search/client/response"
 
 module RediSearch
   class Client
-    class Response < SimpleDelegator
-      def initialize(response)
-        @response = response
-
-        super(response)
-      end
-
-      def ok?
-        if response.is_a? String
-          response == "OK"
-        elsif response.is_a? Array
-          response.all? { |pipeline_response| pipeline_response == "OK" }
-        else
-          response
-        end
-      end
-
-      private
-
-      attr_reader :response
-    end
-
     def initialize(redis_config)
       @redis = Redis.new(redis_config)
     end
@@ -52,16 +31,11 @@ module RediSearch
       Response.new(redis.call("FT.#{command}", *params))
     end
 
-    def instrument(action, payload)
-      block =
-        if block_given?
-          Proc.new
-        else
-          proc {}
-        end
-
+    def instrument(action, payload, &block)
       ActiveSupport::Notifications.instrument(
-        "#{action}.redi_search", { name: "RediSearch" }.merge(payload), &block
+        "#{action}.redi_search",
+        { name: "RediSearch" }.merge(payload),
+        &Proc.new(&(block || proc {}))
       )
     end
   end

data/lib/redi_search/create.rb

@@ -18,11 +18,7 @@ module RediSearch
 
     def call!
       RediSearch.client.call!(
-        "CREATE",
-        index.name,
-        *extract_options.compact,
-        "SCHEMA",
-        schema.to_a
+        "CREATE", index.name, *extract_options.compact, "SCHEMA", schema.to_a
       ).ok?
     end
 

data/lib/redi_search/document/display.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RediSearch
+  class Document
+    module Display
+      #:nocov:
+      def inspect
+        inspection = pretty_print_attributes.map do |field_name|
+          "#{field_name}: #{public_send(field_name)}"
+        end.compact.join(", ")
+
+        "#<#{self.class} #{inspection}>"
+      end
+
+      def pretty_print(printer) # rubocop:disable Metrics/MethodLength
+        printer.object_address_group(self) do
+          printer.seplist(
+            pretty_print_attributes , proc { printer.text "," }
+          ) do |field_name|
+            printer.breakable " "
+            printer.group(1) do
+              printer.text field_name
+              printer.text ":"
+              printer.breakable
+              printer.pp public_send(field_name)
+            end
+          end
+        end
+      end
+
+      def pretty_print_attributes
+        pp_attrs = attributes.keys.dup
+        pp_attrs.push("document_id")
+        pp_attrs.push("score") if score.present?
+
+        pp_attrs.compact
+      end
+      #:nocov:
+    end
+  end
+end

data/lib/redi_search/document/finder.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RediSearch
+  class Document
+    class Finder
+      def initialize(index, *document_ids)
+        @index = index
+        @document_ids = Array.wrap(document_ids)
+      end
+
+      def find
+        if multi?
+          parse_multi_documents
+        else
+          parse_document(document_ids.first, response)
+        end
+      end
+
+      private
+
+      attr_reader :index, :document_ids
+
+      def response
+        @response ||= call!(get_command, index.name, *prepended_document_ids)
+      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
+      end
+
+      def prepend_document_id(id)
+        if id.to_s.start_with? index.name
+          id
+        else
+          "#{index.name}#{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 if document_response.blank?
+
+        Document.new(index, document_id, Hash[*document_response])
+      end
+    end
+  end
+end

data/lib/redi_search/document.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
+require "redi_search/document/display"
+require "redi_search/document/finder"
+
 module RediSearch
   class Document
+    include Display
+
     class << self
       def for_object(index, record, serializer: nil, only: [])
         object_to_serialize = serializer&.new(record) || record
@@ -16,34 +21,11 @@ module RediSearch
       end
 
       def get(index, document_id)
-        response = RediSearch.client.call!(
-          "GET", index.name, prepend_document_id(index, document_id)
-        )
-
-        return if response.blank?
-
-        new(index, document_id, Hash[*response])
+        Finder.new(index, document_id).find
       end
 
       def mget(index, *document_ids)
-        unique_document_ids = document_ids.map do |id|
-          prepend_document_id(index, id)
-        end
-        document_ids.zip(
-          RediSearch.client.call!("MGET", index.name, *unique_document_ids)
-        ).map do |document|
-          next if document[1].blank?
-
-          new(index, document[0], Hash[*document[1]])
-        end.compact
-      end
-
-      def prepend_document_id(index, document_id)
-        if document_id.to_s.starts_with? index.name
-          document_id
-        else
-          "#{index.name}#{document_id}"
-        end
+        Finder.new(index, *document_ids).find
       end
     end
 
@@ -55,53 +37,12 @@ module RediSearch
       @attributes = fields
       @score = score
 
-      attributes.each do |field, value|
-        next unless schema_fields.include? field
-
-        instance_variable_set(:"@#{field}", value)
-        define_singleton_method(field) { value }
-      end
+      load_attributes
     end
 
     def del(delete_document: false)
-      client.call!(
-        "DEL", index.name, document_id, ("DD" if delete_document)
-      ) == 1
-    end
-
-    #:nocov:
-    def inspect
-      inspection = pretty_print_attributes.map do |field_name|
-        "#{field_name}: #{public_send(field_name)}"
-      end.compact.join(", ")
-
-      "#<#{self.class} #{inspection}>"
-    end
-
-    def pretty_print(printer) # rubocop:disable Metrics/MethodLength
-      printer.object_address_group(self) do
-        printer.seplist(
-          pretty_print_attributes , proc { printer.text "," }
-        ) do |field_name|
-          printer.breakable " "
-          printer.group(1) do
-            printer.text field_name
-            printer.text ":"
-            printer.breakable
-            printer.pp public_send(field_name)
-          end
-        end
-      end
-    end
-
-    def pretty_print_attributes
-      pp_attrs = attributes.keys.dup
-      pp_attrs.push("document_id")
-      pp_attrs.push("score") if score.present?
-
-      pp_attrs.compact
+      call!("DEL", index.name, document_id, ("DD" if delete_document)).ok?
     end
-    #:nocov:
 
     def schema_fields
       @schema_fields ||= index.schema.fields.map(&:to_s)
@@ -112,7 +53,11 @@ module RediSearch
     end
 
     def document_id
-      self.class.prepend_document_id(index, @document_id)
+      if @document_id.to_s.start_with? index.name
+        @document_id
+      else
+        "#{index.name}#{@document_id}"
+      end
     end
 
     def document_id_without_index
@@ -127,8 +72,17 @@ module RediSearch
 
     attr_reader :index
 
-    def client
-      RediSearch.client
+    def call!(*command)
+      RediSearch.client.call!(*command)
+    end
+
+    def load_attributes
+      attributes.each do |field, value|
+        next unless schema_fields.include? field
+
+        instance_variable_set(:"@#{field}", value)
+        define_singleton_method(field) { value }
+      end
     end
   end
 end

data/lib/redi_search/lazily_load.rb

@@ -19,24 +19,26 @@ module RediSearch
     def to_a
       execute unless loaded?
 
-      @documents
+      documents
     end
 
     alias load to_a
 
     #:nocov:
     def inspect
-      execute unless loaded?
+      execute_and_rescue_inspection do
+        return super unless valid?
 
-      to_a
+        documents
+      end
     end
 
     def pretty_print(printer)
-      execute unless loaded?
+      execute_and_rescue_inspection do
+        return super(inspect) unless valid?
 
-      printer.pp(documents)
-    rescue Redis::CommandError => e
-      printer.pp(e.message)
+        printer.pp(documents)
+      end
     end
     #:nocov:
 
@@ -51,15 +53,35 @@ module RediSearch
     end
 
     def execute
+      return unless valid?
+
       @loaded = true
 
-      RediSearch.client.call!(*command).yield_self do |response|
+      call!(*command).yield_self do |response|
         parse_response(response)
       end
     end
 
+    def call!(*command)
+      RediSearch.client.call!(*command)
+    end
+
     def parse_response(_response)
       raise NotImplementedError, "included class did not define #{__method__}"
     end
+
+    def valid?
+      true
+    end
+
+    #:nocov:
+    def execute_and_rescue_inspection
+      execute unless loaded?
+
+      yield
+    rescue Redis::CommandError => e
+      e.message
+    end
+    #:nocov:
   end
 end

data/lib/redi_search/log_subscriber.rb

@@ -68,17 +68,19 @@ module RediSearch
       self.class.runtime += event.duration
       return unless logger.debug?
 
-      payload = event.payload
-      name = "#{payload[:name]} (#{event.duration.round(1)}ms)"
-      command = command_string(payload)
+      command = command_string(event)
 
-      debug "  #{color(name, RED, true)}  #{color(command, debug_color, true)}"
+      debug "  #{log_name(event)}  #{color(command, debug_color, true)}"
     end
 
-    def command_string(payload)
-      payload[:query].flatten.map.with_index do |arg, i|
+    def log_name(event)
+      color("#{event.payload[:name]} (#{event.duration.round(1)}ms)", RED, true)
+    end
+
+    def command_string(event)
+      event.payload[:query].flatten.map.with_index do |arg, i|
         arg = "FT.#{arg}" if prepend_ft?(arg, i)
-        arg = arg.inspect if inspect_arg?(payload, arg)
+        arg = arg.inspect if inspect_arg?(event.payload, arg)
         arg
       end.join(" ")
     end

data/lib/redi_search/schema.rb

@@ -12,9 +12,7 @@ module RediSearch
       schema, options = options.to_a.flatten
 
       "RediSearch::Schema::#{schema.to_s.capitalize}Field".
-        constantize.
-        new(field_name, **options.to_h).
-        to_a
+        constantize.new(field_name, **options.to_h).to_a
     end
 
     def initialize(raw)

data/lib/redi_search/search/clauses/boolean.rb

@@ -9,16 +9,13 @@ module RediSearch
           @prior_clause = prior_clause
           @not = false
 
-          initialize_term(term, **term_options)
+          initialize_term(term, **term_options) if term.present?
         end
 
         def to_s
           raise ArgumentError, "missing query terms" if term.blank?
 
-          [
-            prior_clause.presence,
-            queryify_term.dup.prepend(not_operator)
-          ].compact.join(operand)
+          [prior_clause.presence, queryify_term].compact.join(operand)
         end
 
         delegate :inspect, to: :to_s
@@ -26,7 +23,7 @@ module RediSearch
         def not(term, **term_options)
           @not = true
 
-          initialize_term(term, **term_options)
+          initialize_term(term, **term_options) if term.present?
 
           search
         end
@@ -46,25 +43,31 @@ module RediSearch
         end
 
         def initialize_term(term, **term_options)
-          return if term.blank?
-
-          @term =
-            if term.is_a? RediSearch::Search
-              term
-            else
-              Term.new(term, term_options)
-            end
+          @term = if term.is_a? RediSearch::Search
+                    term
+                  else
+                    Term.new(term, term_options)
+                  end
         end
 
         def queryify_term
-          if term.is_a?(RediSearch::Search) &&
-             !term.term_clause.is_a?(RediSearch::Search::Clauses::Where)
-            "(#{term.term_clause})"
-          elsif term.is_a?(RediSearch::Search)
-            term.term_clause
+          if term_is_search?
+            queryify_search
           else
             term
-          end.to_s
+          end.to_s.dup.prepend(not_operator)
+        end
+
+        def term_is_search?
+          term.is_a? RediSearch::Search
+        end
+
+        def queryify_search
+          if !term.term_clause.is_a?(RediSearch::Search::Clauses::Where)
+            "(#{term.term_clause})"
+          else
+            term.term_clause
+          end
         end
       end
     end

data/lib/redi_search/search/clauses/where.rb

@@ -53,12 +53,15 @@ module RediSearch
           condition, *options = condition.to_a
 
           @field = condition[0]
-          @term =
-            if condition[1].is_a? RediSearch::Search
-              condition[1]
-            else
-              Term.new(condition[1], **options.to_h)
-            end
+          @term = make_term(condition, options)
+        end
+
+        def make_term(condition, options)
+          if condition[1].is_a? RediSearch::Search
+            condition[1]
+          else
+            Term.new(condition[1], **options.to_h)
+          end
         end
       end
     end

data/lib/redi_search/search/clauses.rb

@@ -66,13 +66,11 @@ module RediSearch
       end
 
       def count
-        if @loaded
-          to_a.size
-        else
-          RediSearch.client.call!(
-            "SEARCH", index.name, term_clause, *Limit.new(total: 0).clause
-          ).first
-        end
+        return to_a.size if loaded?
+
+        call!(
+          "SEARCH", index.name, term_clause, *Limit.new(total: 0).clause
+        ).first
       end
 
       def where(**condition)

data/lib/redi_search/search/result.rb

@@ -7,13 +7,7 @@ module RediSearch
         @count = count
         @used_clauses = used_clauses
 
-        super(documents.each_slice(response_slice).map do |slice|
-          document_id = slice[0]
-          fields = slice.last unless no_content?
-          score = slice[1].to_f if with_scores?
-
-          Document.new(index, document_id, Hash[*fields.to_a], score)
-        end)
+        super(parse_results(index, documents))
       end
 
       def count
@@ -41,6 +35,16 @@ module RediSearch
       def no_content?
         @used_clauses.include? "no_content"
       end
+
+      def parse_results(index, documents)
+        documents.each_slice(response_slice).map do |slice|
+          document_id = slice[0]
+          fields = slice.last unless no_content?
+          score = slice[1].to_f if with_scores?
+
+          Document.new(index, document_id, Hash[*fields.to_a], score)
+        end
+      end
     end
   end
 end

data/lib/redi_search/search/term.rb

@@ -3,11 +3,19 @@
 module RediSearch
   class Search
     class Term
+      include ActiveModel::Validations
+
+      validates :fuzziness, numericality: {
+        only_integer: true, less_than: 4, greater_than: 0, allow_blank: true
+      }
+      validates :option, inclusion: { in: %i(fuzziness optional prefix) },
+                         allow_nil: true
+
       def initialize(term, **options)
         @term = term
         @options = options
 
-        validate_options
+        validate!
       end
 
       def to_s
@@ -23,7 +31,7 @@ module RediSearch
       attr_accessor :term, :options
 
       def fuzziness
-        @fuzziness ||= options[:fuzziness].to_i
+        @fuzziness ||= options[:fuzziness]
       end
 
       def optional_operator
@@ -38,10 +46,14 @@ module RediSearch
         "*"
       end
 
+      def fuzzy_operator
+        "%" * fuzziness.to_i
+      end
+
       def stringify_query
         @term.to_s.
           tr("`", "\`").
-          yield_self { |str| "#{'%' * fuzziness}#{str}#{'%' * fuzziness}" }.
+          yield_self { |str| "#{fuzzy_operator}#{str}#{fuzzy_operator}" }.
           yield_self { |str| "#{optional_operator}#{str}" }.
           yield_self { |str| "#{str}#{prefix_operator}" }.
           yield_self { |str| "`#{str}`" }
@@ -55,17 +67,8 @@ module RediSearch
         "[#{first} #{last}]"
       end
 
-      def validate_options
-        unsupported_options =
-          (options.keys.map(&:to_s) - %w(fuzziness optional prefix)).join(", ")
-
-        if unsupported_options.present?
-          raise(ArgumentError,
-                "#{unsupported_options} are unsupported term options")
-        end
-
-        raise(ArgumentError, "fuzziness can only be between 0 and 3") if
-          fuzziness.negative? || fuzziness > 3
+      def option
+        options.keys.first&.to_sym
       end
     end
   end

data/lib/redi_search/search.rb

@@ -37,11 +37,7 @@ module RediSearch
 
     def to_redis
       command.map do |arg|
-        if !arg.to_s.starts_with?(/\(-?@/) && arg.to_s.split(/\s|\|/).size > 1
-          arg.inspect
-        else
-          arg
-        end
+        inspect_command_arg(arg)
       end.join(" ")
     end
 
@@ -63,5 +59,17 @@ module RediSearch
     def parse_response(response)
       @documents = Result.new(index, used_clauses, response[0], response[1..-1])
     end
+
+    def inspect_command_arg(arg)
+      if !arg.to_s.starts_with?(/\(-?@/) && arg.to_s.split(/\s|\|/).size > 1
+        arg.inspect
+      else
+        arg
+      end
+    end
+
+    def valid?
+      term_clause.present?
+    end
   end
 end

data/lib/redi_search/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RediSearch
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redi_search
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nick Pezza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2019-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -145,9 +145,12 @@ files:
 - lib/redi_search/add.rb
 - lib/redi_search/alter.rb
 - lib/redi_search/client.rb
+- lib/redi_search/client/response.rb
 - lib/redi_search/configuration.rb
 - lib/redi_search/create.rb
 - lib/redi_search/document.rb
+- lib/redi_search/document/display.rb
+- lib/redi_search/document/finder.rb
 - lib/redi_search/index.rb
 - lib/redi_search/lazily_load.rb
 - lib/redi_search/log_subscriber.rb