pg_fulltext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49c8f3b3250945a7e3e600a100951abffe80a0537e14fcf392d96778d9648777
+  data.tar.gz: efef8f9be9540e961015472dc3f498203c62a37856ef4f7c66f00fad30e7e5a2
+SHA512:
+  metadata.gz: 2c324ce42e53dd725bec4ee7e11a8763927fe8080059a504ba31e5546b8d528ee76c040ae4a93c6b272a744d413f695583d413d991d1db6afb846f2e8750162e
+  data.tar.gz: 90e7cd23c65e9ee883c4c65c8fb5c21d08078eedf134f9d42cf989faf8928e2edc05a40ab008c07b367191326873773704de5bc458588aa5c0bcff7edce2ae11

data/lib/pg_fulltext/active_record.rb

@@ -0,0 +1,76 @@
+require 'securerandom'
+
+module PgFulltext
+  module ActiveRecord
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      # Class method to add a scope to the class, searching against `tsv` column by default
+      def add_search_scope(name = :search, **options)
+        self.scope name, -> (query) {
+          apply_search_to_relation(self, query, **options)
+        }
+      end
+
+      def apply_search_to_relation(
+        relation,
+        query,
+        tsvector_column: :tsv,
+        search_type: :simple,
+        order: true,
+        reorder: false,
+        any_word: false,
+        ignore_accents: false
+      )
+        serial = SecureRandom.hex(4)
+        table_quoted = connection.quote_table_name(table_name)
+        pk_quoted = "#{table_quoted}.#{connection.quote_column_name(primary_key)}"
+        fulltext_join_name = "pg_fulltext_#{serial}"
+
+        # Build the search relation to join on
+        search_relation = get_search_relation(
+          relation,
+          query,
+          tsvector_column: tsvector_column,
+          search_type: search_type,
+          any_word: any_word,
+          ignore_accents: ignore_accents,
+        )
+
+        # Join the search relation
+        relation = relation.joins("INNER JOIN (#{search_relation.to_sql}) AS #{fulltext_join_name} ON #{fulltext_join_name}.id = #{pk_quoted}")
+
+        # Order/reorder against the search rank
+        if order || reorder
+          relation = relation.send(reorder ? :reorder : :order, "#{fulltext_join_name}.rank DESC")
+        end
+
+        # Return the model relation
+        relation
+      end
+
+      def get_search_relation(
+        relation,
+        query,
+        tsvector_column: :tsv,
+        search_type: nil,
+        any_word: false,
+        ignore_accents: false
+      )
+        tsquery_string_quoted = connection.quote(PgFulltext::Query.to_tsquery_string(query, operator: any_word ? '|' : '&'))
+        tsquery_string_quoted = "unaccent(#{tsquery_string_quoted})" if ignore_accents
+        table_quoted = connection.quote_table_name(table_name)
+        column_quoted = connection.quote_column_name(tsvector_column)
+        fqc_quoted = "#{table_quoted}.#{column_quoted}"
+        tsquery = "to_tsquery(#{"#{connection.quote search_type}, " if search_type.present?}#{tsquery_string_quoted})"
+
+        relation
+          .select(:id, "ts_rank_cd(#{fqc_quoted}, #{tsquery}) AS rank")
+          .where("#{fqc_quoted} @@ #{tsquery}")
+      end
+    end
+  end
+end

data/lib/pg_fulltext/query.rb

@@ -0,0 +1,66 @@
+module PgFulltext
+  module Query
+    def self.to_tsquery_string(query, prefix: true, operator: '&')
+
+      # Parse out all [unicode] non-word and non-quote characters
+      query.gsub!(/[^\s\p{L}"!]/, '')
+      query.gsub!(/"+/, '"')
+      query.gsub!(/\s+/, ' ')
+
+      # Collect terms
+      terms = []
+
+      # Phrase mode
+      if query.count('"') > 0 && query.count('"') % 2 == 0
+        phrase_terms = []
+        negate_phrase = false
+
+        query_parts = query.split(' ')
+        query_parts.each do |term|
+
+          # Skip if completely comprised of non-unicode word characters
+          next if term.gsub(/[^\s\p{L}]/, '') == ''
+
+          if term.start_with?('!"') && !term.end_with?('"')
+            phrase_terms << format_term(term[2..-1], prefix: true)
+            negate_phrase = true
+          elsif term.start_with?('"') && !term.end_with?('"')
+            phrase_terms << format_term(term[1..-1], prefix: true)
+          elsif phrase_terms.length > 0
+            if term.end_with?('"')
+              phrase_terms << format_term(term[0..-2], prefix: prefix)
+              terms << "#{'!' if negate_phrase}(#{reject_falsy(phrase_terms, prefix: prefix).join(' <-> ')})"
+              phrase_terms = []
+              negate_phrase = false
+            else
+              phrase_terms << format_term(term, prefix: prefix)
+            end
+          else
+            terms << format_term(term, prefix: prefix)
+          end
+        end
+      else
+        query.gsub! /["]/, ''
+        terms = reject_falsy(query.split(' ').map { |v| format_term(v, prefix: prefix) }, prefix: prefix)
+      end
+
+      # Join terms with operator
+      terms.join(" #{operator} ")
+    end
+
+    private
+
+    def self.format_term(term, prefix: true)
+      # Remove any ! that's not at the beginning of the term, as it will break the query
+      term.gsub!(/(?<!^)!/, '')
+
+      # Add the prefix if prefix is set
+      "#{term}#{':*' if prefix}"
+    end
+
+    def self.reject_falsy(terms, prefix: true)
+      false_values = [nil, '', '"', '!', ':*', '":*', '!:*']
+      terms.reject { |v| false_values.include?(v) }
+    end
+  end
+end

data/lib/pg_fulltext.rb

@@ -0,0 +1,4 @@
+module PgFulltext; end
+
+require 'pg_fulltext/active_record'
+require 'pg_fulltext/query'

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: pg_fulltext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Robertson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-11 00:00:00.000000000 Z
+dependencies: []
+description: Allows simple searching with a variety of options
+email: adam@arcreative.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pg_fulltext.rb
+- lib/pg_fulltext/active_record.rb
+- lib/pg_fulltext/query.rb
+homepage: https://github.com/arcreative/pg_fulltext
+licenses:
+- MIT
+metadata: {}
+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.1.4
+signing_key:
+specification_version: 4
+summary: PostgreSQL fulltext search
+test_files: []