pg-searchable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eaf2e17acef704a8fd936d20b9716dace4e9f4319a26f8d72e4f4a79fa515bde
+  data.tar.gz: 8153451549b6fd494227f9c01377b0021241026188509778b2c3c430b087fa23
+SHA512:
+  metadata.gz: 70964f08dad60214f6d87f7f5f2497ce7118ad92d3ced7df0d79bcf31435bb45d9d269ff096e700d27c840df4b67383435b1ef96978e6d95429756d9d5ab6e99
+  data.tar.gz: 4904c0b55c7c847f15a1f2b2097a684a577c3ae28d1380bd9fed5f290db3fc899e5b2e8fde7f26212e5a13921a1fb05228213e272683589ccf15e05718d157a3

data/.editorconfig

@@ -0,0 +1,5 @@
+root = true
+
+[**.{rb,md}]
+indent_size = 2
+indent_style = space

data/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Test
+
+on: [push]
+
+jobs:
+  rspec-test:
+    name: RSpec
+    runs-on: ubuntu-18.04
+    services:
+      postgres:
+        image: postgres:12
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: postgres_test
+        ports:
+          - 5432:5432
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+      - name: Install postgres client
+        run: sudo apt-get install libpq-dev
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundler install
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1 @@
+spec/log

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'rake'
+  gem 'rspec'
+  gem 'rails'
+  gem 'rspec-rails'
+  gem 'pg'
+  gem 'combustion', '~> 1.1'
+end

data/Gemfile.lock

@@ -0,0 +1,167 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2.2)
+      actionview (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.2)
+      activesupport (= 6.0.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.2)
+      activesupport (= 6.0.2.2)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activestorage (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    builder (3.2.4)
+    combustion (1.1.2)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    pg (1.2.3)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2.2)
+      actioncable (= 6.0.2.2)
+      actionmailbox (= 6.0.2.2)
+      actionmailer (= 6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actiontext (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      bundler (>= 1.3.0)
+      railties (= 6.0.2.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  combustion (~> 1.1)
+  pg
+  rails
+  rake
+  rspec
+  rspec-rails
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -0,0 +1,56 @@
+## pg-searchable
+
+pg-searchable is a quick way to make Postgres columns full-text searchable in Rails models, with support for composing complex OR/AND queries.
+
+If all you need is a straightforward search with trigram/multi-column support, [pg_search](https://github.com/Casecommons/pg_search) is probably a better fit.
+
+### Install
+
+`gem "pg-searchable"`
+
+### Setup
+
+```ruby
+class Product < ActiveRecord::Base
+  include PgSearchable::Model
+  searchable_column :name
+end
+```
+
+### Usage
+
+```ruby
+# Add test data
+sour_bread = Product.create!(name: "Sour bread")
+italian_pasta = Product.create!(name: "Italian pasta")
+rye_bread = Product.create!(name: "Rye bread")
+sushi = Product.create!(name: "Sour Sushi Itamae")
+
+# Basic options
+bread_condition = Product.search_name("bread")
+expect(Product.where(bread_condition)).to match_array [sour_bread, rye_bread]
+
+ita_condition = Product.search_name("ita", prefix: true)
+expect(Product.where(ita_condition)).to match_array [italian_pasta, sushi]
+
+nonsour_condition = Product.search_name("!sour")
+expect(Product.where(nonsour_condition)).to match_array [italian_pasta, rye_bread]
+
+# Composing searches
+non_sour_breads = Product.where(bread_condition.and(nonsour_condition))
+expect(non_sour_breads).to match_array [rye_bread]
+
+nonsour_or_ita = Product.where(nonsour_condition.or(ita_condition))
+expect(nonsour_or_ita).to match_array [rye_bread, italian_pasta, sushi]
+```
+
+### Development
+
+**Testing locally:**
+
+1. Start local Postgres: `bin/local-docker-testing`
+2. Run tests: `bundle exec rspec`
+
+### Credits
+
+pg_search provided much of the inspiration and basis

data/bin/local-docker-testing

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+docker-compose -f docker-compose.test.yml up postgres

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/docker-compose.test.yml

@@ -0,0 +1,10 @@
+version: "3"
+services:
+  postgres:
+    image: postgres:12.1
+    ports:
+      - 5432:5432
+    environment:
+      POSTGRES_USERNAME: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: postgres_test

data/lib/pg-searchable/model.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module PgSearchable
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def searchable_column(column_name)
+        name = "search_#{column_name.to_s}"
+        define_singleton_method(name) do |*args|
+          Searcher.new(self).exec(column_name, *args)
+        end
+      end
+    end
+
+    class Searcher
+      def initialize(model)
+        @model = model
+      end
+  
+      def dictionary
+        Arel::Nodes.build_quoted(:simple)
+      end
+  
+      def exec(column_name, query, raw:false, prefix:false)
+        column_ref = "#{@model.quoted_table_name}.#{column_name}"
+  
+        vector = Arel::Nodes::NamedFunction.new(
+          "to_tsvector",
+          [dictionary, Arel.sql(column_ref)]
+        )
+  
+        query = Builder.tsquery(query, prefix: prefix, raw: raw)
+  
+        condition = Arel::Nodes::Grouping.new(
+          Arel::Nodes::InfixOperation.new("@@", vector, query)
+        )
+  
+        condition
+      end
+    end
+  
+    module Builder
+  
+      DISALLOWED_TSQUERY_CHARACTERS = /['?\\:‘’]/.freeze
+  
+      def self.dictionary
+        Arel::Nodes.build_quoted(:simple)
+      end
+  
+      def self.normalize(x)
+        x # TODO
+      end
+  
+      def self.tsquery_for_terms(terms, prefix:)
+        terms = terms.map { |term| tsquery_term(term, prefix: prefix) }
+        terms.inject do |memo, term|
+          term_anded = Arel::Nodes::InfixOperation.new("||", Arel::Nodes.build_quoted(" & "), term)
+          Arel::Nodes::InfixOperation.new("||", memo, term_anded)
+        end
+      end
+  
+      def self.tsquery_term(unsanitized_term, prefix:)
+        negated = false
+  
+        if unsanitized_term.start_with?("!")
+          unsanitized_term[0] = ''
+          negated = true
+        end
+  
+        sanitized_term = unsanitized_term.gsub(DISALLOWED_TSQUERY_CHARACTERS, " ")
+        tsquery_expression(sanitized_term, negated: negated, prefix: prefix)
+      end
+  
+      # After this, the SQL expression evaluates to a string containing the term surrounded by single-quotes.
+      # If :prefix is true, then the term will have :* appended to the end.
+      # If :negated is true, then the term will have ! prepended to the front.
+      def self.tsquery_expression(term, negated:, prefix:)
+        terms = [
+          (Arel::Nodes.build_quoted('!') if negated),
+          Arel::Nodes.build_quoted("' "),
+          Arel::Nodes.build_quoted(term),
+          Arel::Nodes.build_quoted(" '"),
+          (Arel::Nodes.build_quoted(":*") if prefix)
+        ].compact
+  
+        terms.inject do |memo, term|
+          Arel::Nodes::InfixOperation.new("||", memo, Arel::Nodes.build_quoted(term))
+        end
+      end
+  
+      def self.tsquery(query, prefix:, raw:)
+        query_terms = query.split(" ").compact
+        tsq =
+          if query.blank?
+            Arel::Nodes.build_quoted("")
+          elsif raw
+            Arel::Nodes.build_quoted(query)
+          else
+            tsquery_for_terms(query_terms, prefix: prefix)
+          end
+  
+        Arel::Nodes::NamedFunction.new("to_tsquery", [dictionary, tsq])
+      end
+    end
+  end
+end

data/lib/pg-searchable/version.rb

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

data/lib/pg-searchable.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "pg-searchable/model"
+require "pg-searchable/version"

data/pg-searchable.gemspec

@@ -0,0 +1,11 @@
+require_relative "lib/pg-searchable/version"
+
+Gem::Specification.new do |gem|
+  gem.authors = ["wyozi"]
+  gem.name = "pg-searchable"
+  gem.summary = "Simple full-text searching for Rails"
+
+  gem.files = `git ls-files | grep -Ev '^(spec)'`.split("\n")
+  gem.version = PgSearchable::VERSION
+  gem.required_ruby_version = ">= 2.5.0"
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: pg-searchable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wyozi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-21 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/local-docker-testing
+- config.ru
+- docker-compose.test.yml
+- lib/pg-searchable.rb
+- lib/pg-searchable/model.rb
+- lib/pg-searchable/version.rb
+- pg-searchable.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Simple full-text searching for Rails
+test_files: []