redi_search 0.1.0

data/lib/redi_search/search/term.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module RediSearch
+  class Search
+    class Term
+      def initialize(term, **options)
+        @term = term
+        @options = options
+
+        validate_options
+      end
+
+      def to_s
+        if @term.is_a? Range
+          stringify_range
+        else
+          stringify_query
+        end
+      end
+
+      private
+
+      attr_accessor :term, :options
+
+      def fuzziness
+        @fuzziness ||= options[:fuzziness].to_i
+      end
+
+      def optional_operator
+        return unless options[:optional]
+
+        "~"
+      end
+
+      def prefix_operator
+        return unless options[:prefix]
+
+        "*"
+      end
+
+      def stringify_query
+        @term.to_s.
+          tr("`", "\`").
+          then { |str| "#{'%' * fuzziness}#{str}#{'%' * fuzziness}" }.
+          then { |str| "#{optional_operator}#{str}" }.
+          then { |str| "#{str}#{prefix_operator}" }.
+          then { |str| "`#{str}`" }
+      end
+
+      def stringify_range
+        first, last = @term.first, @term.last
+        first = "-inf" if first == -Float::INFINITY
+        last = "+inf" if last == Float::INFINITY
+
+        "[#{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
+      end
+    end
+  end
+end

data/lib/redi_search/search/where_clause.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RediSearch
+  class Search
+    class WhereClause
+      def initialize(search, condition, prior_clause = nil)
+        @search = search
+        @prior_clause = prior_clause
+        @not = false
+
+        initialize_term(condition)
+      end
+
+      def to_s
+        [
+          prior_clause.presence,
+          "(#{not_operator}@#{field}:#{queryify_term})"
+        ].compact.join(" ")
+      end
+
+      def inspect
+        to_s.inspect
+      end
+
+      def not(condition)
+        @not = true
+
+        initialize_term(condition)
+
+        search
+      end
+
+      private
+
+      attr_reader :prior_clause, :term, :field, :search
+
+      def queryify_term
+        if term.is_a? RediSearch::Search
+          "(#{term.term_clause})"
+        else
+          term.to_s
+        end
+      end
+
+      def not_operator
+        return "" unless @not
+
+        "-"
+      end
+
+      def initialize_term(condition)
+        return if condition.blank?
+
+        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
+      end
+    end
+  end
+end

data/lib/redi_search/search.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "redi_search/search/clauses"
+require "redi_search/search/term"
+require "redi_search/search/highlight_clause"
+require "redi_search/result/collection"
+
+module RediSearch
+  class Search
+    include Enumerable
+    include Clauses
+
+    def initialize(index, term = nil, model = nil, **term_options)
+      @index = index
+      @model = model
+      @loaded = false
+      @no_content = false
+      @clauses = []
+
+      @term_clause = term.presence &&
+        AndClause.new(self, term, nil, **term_options)
+    end
+
+    #:nocov:
+    def pretty_print(printer)
+      execute unless loaded?
+
+      printer.pp(records)
+    rescue Redis::CommandError => e
+      printer.pp(e.message)
+    end
+    #:nocov:
+
+    def loaded?
+      @loaded
+    end
+
+    def to_a
+      execute unless loaded?
+
+      @records
+    end
+
+    def results
+      model.where(id: to_a.map(&:document_id))
+    end
+
+    delegate :count, :each, to: :to_a
+
+    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
+      end.join(" ")
+    end
+
+    def dup
+      self.class.new(index)
+    end
+
+    attr_reader :term_clause
+
+    private
+
+    attr_reader :records
+    attr_accessor :index, :model, :clauses
+
+    def command
+      ["SEARCH", index.name, term_clause, *clauses]
+    end
+
+    def execute
+      @loaded = true
+
+      RediSearch.client.call!(*command).then do |results|
+        @records = Result::Collection.new(
+          index, results[0], results[1..-1].then do |docs|
+            next docs unless @no_content
+
+            docs.zip([[]] * results[0]).flatten(1)
+          end
+        )
+      end
+    end
+  end
+end

data/lib/redi_search/spellcheck.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RediSearch
+  class Spellcheck
+    include Enumerable
+
+    def initialize(index, query, distance: 1)
+      @index = index
+      @query = query
+      @distance = distance
+      @loaded = false
+    end
+
+    #:nocov:
+    def pretty_print(printer)
+      execute unless loaded?
+
+      printer.pp(records)
+    rescue Redis::CommandError => e
+      printer.pp(e.message)
+    end
+    #:nocov:
+
+    def loaded?
+      @loaded
+    end
+
+    def to_a
+      execute unless loaded?
+
+      @records
+    end
+
+    delegate :count, :each, to: :to_a
+
+    private
+
+    attr_reader :records
+    attr_accessor :index, :query, :distance
+
+    def command
+      ["SPELLCHECK", index.name, query, "DISTANCE", distance]
+    end
+
+    def execute
+      @loaded = true
+
+      RediSearch.client.call!(*command).then do |results|
+        @records = results
+      end
+    end
+  end
+end

data/lib/redi_search/version.rb

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

data/lib/redi_search.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "redis"
+require "active_support"
+require "active_support/core_ext/object"
+require "active_support/core_ext/module/delegation"
+
+require "redi_search/configuration"
+
+require "redi_search/model"
+require "redi_search/index"
+require "redi_search/log_subscriber"
+require "redi_search/document"
+
+module RediSearch
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def client
+      configuration.client
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include RediSearch::Model
+end
+RediSearch::LogSubscriber.attach_to :redi_search

data/redi_search.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redi_search/version"
+
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  spec.name          = "redi_search"
+  spec.version       = RediSearch::VERSION
+  spec.authors       = ["Nick Pezza"]
+  spec.email         = ["npezza93@gmail.com"]
+
+  spec.summary       = %q(RediSearch ruby wrapper that can integrate with Rails)
+  spec.homepage      = "https://github.com/npezza93/redi_search"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to
+  # any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] =
+      "https://github.com/npezza93/redi_search/blob/master/changelog.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "redis"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 12.0"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: redi_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Pezza
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: 
+email:
+- npezza93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/publish
+- bin/setup
+- bin/test
+- lib/redi_search.rb
+- lib/redi_search/client.rb
+- lib/redi_search/configuration.rb
+- lib/redi_search/document.rb
+- lib/redi_search/document/converter.rb
+- lib/redi_search/error.rb
+- lib/redi_search/index.rb
+- lib/redi_search/log_subscriber.rb
+- lib/redi_search/model.rb
+- lib/redi_search/result/collection.rb
+- lib/redi_search/schema.rb
+- lib/redi_search/schema/field.rb
+- lib/redi_search/schema/geo_field.rb
+- lib/redi_search/schema/numeric_field.rb
+- lib/redi_search/schema/tag_field.rb
+- lib/redi_search/schema/text_field.rb
+- lib/redi_search/search.rb
+- lib/redi_search/search/and_clause.rb
+- lib/redi_search/search/boolean_clause.rb
+- lib/redi_search/search/clauses.rb
+- lib/redi_search/search/highlight_clause.rb
+- lib/redi_search/search/or_clause.rb
+- lib/redi_search/search/term.rb
+- lib/redi_search/search/where_clause.rb
+- lib/redi_search/spellcheck.rb
+- lib/redi_search/version.rb
+- redi_search.gemspec
+homepage: https://github.com/npezza93/redi_search
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/npezza93/redi_search
+  source_code_uri: https://github.com/npezza93/redi_search
+  changelog_uri: https://github.com/npezza93/redi_search/blob/master/changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: RediSearch ruby wrapper that can integrate with Rails
+test_files: []