textacular 5.2.0 → 5.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9a8ae35c8edfea5bfe856e76614e2689eed90d4c41beee8a3271d1c3749586e
-  data.tar.gz: 4e88e50d311cdbccf5aae2fc71f0c3ef2d0af22b284a5bb772c7687f311eb50b
+  metadata.gz: eddfcccc0eaadfc3ac88a01770041972e58ec6f15d040fc2edd0d86622b520ac
+  data.tar.gz: 7d726e410c01a0438f57424c051736d8b68df4371f6089794fd5da107fd661e6
 SHA512:
-  metadata.gz: 3c5f2531575beb68748b2c4458ea7e4e57af212f901270c45e08c359c7e535c81f18a785ea95c8679e8a0be688472f4d798bdec0329212cb89d52789fae785ff
-  data.tar.gz: '0811ce97f78f63a84d41f4576115a07b8b2f01896e8a2d3d9904ff293cf8b95235919a83c66ab02c3f81a9c48653f798bb59d1cd7facb03d0d1f7ba24a97ef1c'
+  metadata.gz: b0d0e8a14b67b814d84f1f897a7c4c93fe1c9f3f6be1e9ca4d9749ced7b521c13144e21b06753a4b60620a31c4434828e515e8581c9267aba2794039a8517c8b
+  data.tar.gz: 55591215dc23ed584e9d2117215e4090479c9fd9e0e5cbae20a8f580656b3256bb6fc636228b42682dca461d231a89edf469c067f408bbbaa9bb716842dc9e8b

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## Unreleased
 
+## 5.5.1
+
+* Revert breaking change to fuzzy_search introduced in 49f09b389d2f2b18cbe9de565b7ac5fcac14d7c6
+
+## 5.5.0
+
+* ActiveRecord 7.0 compatibility
+
+## 5.4.0
+
+* ActiveRecord 6.1 compatibility
+
+## 5.3.0
+
+* Add `#web_search` method to use Postgres' 11+ `websearch_to_tsquery`
+
 ## 5.2.0
 
 * Active Record 6.0 compatibility

data/Gemfile

@@ -2,6 +2,13 @@ source 'https://rubygems.org'
 
 gemspec
 
-git 'git://github.com/rails/rails.git', branch: 'master' do
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+github 'rails/rails', branch: 'main' do
   gem 'activerecord'
 end
+
+gem "pg", "~> 1.1"

data/README.md

@@ -1,10 +1,9 @@
 # textacular
 [![Gem Version](http://img.shields.io/gem/v/textacular.svg)][rubygems]
-[![Build Status](https://img.shields.io/travis/textacular/textacular/master.svg)][travis]
+[![Build Status](https://github.com/textacular/textacular/actions/workflows/main.yml/badge.svg)](https://github.com/textacular/textacular/actions/workflows/main.yml)
 [![Code Climate](https://img.shields.io/codeclimate/github/textacular/textacular.svg)][codeclimate]
 
 [rubygems]: http://rubygems.org/gems/textacular
-[travis]: https://travis-ci.org/textacular/textacular
 [codeclimate]: https://codeclimate.com/github/textacular/textacular
 
 Further documentation available at http://textacular.github.com/textacular.
@@ -19,26 +18,26 @@ extending ActiveRecord with scopes making search easy and fun!
 ## FEATURES/PROBLEMS:
 
 * Only works with PostgreSQL
+* Anything that mucks with the `SELECT` statement (notably `pluck`), is likely
+  to [cause problems](https://github.com/textacular/textacular/issues/28).
 
 
 ## SYNOPSIS:
 
 ### Quick Start
 
-#### Rails 3, Rails 4
-
 In the project's Gemfile add
 
 ```ruby
-gem 'textacular', '~> 4.0'
+gem 'textacular', '~> 5.0'
 ```
 
-#### Rails > 5.0
+#### Rails 3, Rails 4
 
 In the project's Gemfile add
 
 ```ruby
-gem 'textacular', '~> 5.0'
+gem 'textacular', '~> 4.0'
 ```
 
 #### ActiveRecord outside of Rails
@@ -75,6 +74,20 @@ Game.advanced_search(title: 'Street|Fantasy')
 Game.advanced_search(system: '!PS2')
 ```
 
+The `#web_search` method lets you use Postgres' 11+ `websearch_to_tsquery` function
+ supporting websearch like syntax:
+
+- unquoted text: text not inside quote marks will be converted to terms separated by & operators, as if processed by plainto_tsquery.
+- "quoted text": text inside quote marks will be converted to terms separated by <-> operators, as if processed by phraseto_tsquery.
+- OR: logical or will be converted to the | operator.
+- -: the logical not operator, converted to the the ! operator.
+
+```ruby
+Game.web_search(title: '"Street Fantasy"')
+Game.web_search(title: 'Street OR Fantasy')
+Game.web_search(system: '-PS2')
+```
+
 Finally, the `#fuzzy_search` method lets you use Postgres's trigram search
 functionality.
 
@@ -150,29 +163,20 @@ migration add code like the following:
 
 #### For basic_search
 ```ruby
-execute "
-    create index on email_logs using gin(to_tsvector('english', subject));
-    create index on email_logs using gin(to_tsvector('english', email_address));"
+add_index :email_logs, %{to_tsvector('english', subject)}, using: :gin
+add_index :email_logs, %{to_tsvector('english', email_address)}, using: :gin
 ```
 
 #### For fuzzy_search
 ```ruby
-execute "
-    CREATE INDEX trgm_subject_indx ON users USING gist (subject gist_trgm_ops);
-    CREATE INDEX trgm_email_address_indx ON users USING gist (email_address gist_trgm_ops);
+add_index :email_logs, :subject, using: :gist, opclass: :gist_trgm_ops
+add_index :email_logs, :email_address, using: :gist, opclass: :gist_trgm_ops
 ```
 
 In the above example, the table email_logs has two text columns that we search against, subject and email_address.
 You will need to add an index for every text/string column you query against, or else Postgresql will revert to a
 full table scan instead of using the indexes.
 
-If you create these indexes, you should also switch to sql for your schema_format in `config/application.rb`:
-
-```ruby
-config.active_record.schema_format = :sql
-```
-
-
 ## REQUIREMENTS:
 
 * ActiveRecord

data/lib/textacular/version.rb

@@ -1,5 +1,5 @@
 module Textacular
-  VERSION = '5.2.0'
+  VERSION = '5.5.1'
 
   def self.version
     VERSION

data/lib/textacular.rb

@@ -37,6 +37,13 @@ module Textacular
     assemble_query(similarities, conditions, exclusive, rank_alias)
   end
 
+  def web_search(query = '', exclusive = true, rank_alias = nil)
+    exclusive, query = munge_exclusive_and_query(exclusive, query)
+    parsed_query_hash = parse_query_hash(query)
+    similarities, conditions = web_similarities_and_conditions(parsed_query_hash)
+    assemble_query(similarities, conditions, exclusive, rank_alias)
+  end
+
   private
 
   def munge_exclusive_and_query(exclusive, query)
@@ -120,6 +127,24 @@ module Textacular
     "(#{table_name}.#{column}::text % #{search_term})"
   end
 
+
+  def web_similarities_and_conditions(parsed_query_hash)
+    parsed_query_hash.inject([[], []]) do |(similarities, conditions), query_args|
+      similarities << web_similarity_string(*query_args)
+      conditions << web_condition_string(*query_args)
+
+      [similarities, conditions]
+    end
+  end
+
+  def web_similarity_string(table_name, column, search_term)
+    "COALESCE(ts_rank(to_tsvector(#{quoted_language}, #{table_name}.#{column}::text), websearch_to_tsquery(#{quoted_language}, #{search_term}::text)), 0)"
+  end
+
+  def web_condition_string(table_name, column, search_term)
+    "to_tsvector(#{quoted_language}, #{table_name}.#{column}::text) @@ websearch_to_tsquery(#{quoted_language}, #{search_term}::text)"
+  end
+
   def assemble_query(similarities, conditions, exclusive, rank_alias)
     rank_alias ||= 'rank' + rand(100000000000000000).to_s
     rank = connection.quote_column_name(rank_alias)

data/spec/{config.travis.yml → config.github.yml}

@@ -3,6 +3,6 @@ timeout: 5000
 host: localhost
 adapter: postgresql
 username: postgres
-password:
+password: password
 database: textacular_test
-min_messages: ERROR
+min_messages: ERROR

data/spec/textacular/searchable_spec.rb

@@ -113,6 +113,14 @@ RSpec.describe "Searchable" do
         end
       end
 
+      describe "web search" do # Uses websearch_to_tsquery
+        ["hello \\", "tebow!" , "food &"].each do |search_term|
+          it "works with interesting term \"#{search_term}\"" do
+            expect(WebComicWithSearchableName.web_search(search_term)).to be_empty
+          end
+        end
+      end
+
       it "does fuzzy searching" do
         expect(
           WebComicWithSearchableName.fuzzy_search('Questio')
@@ -182,6 +190,14 @@ RSpec.describe "Searchable" do
         expect(
           WebComicWithSearchableNameAndAuthor.advanced_search("Tycho")
         ).to eq([penny_arcade])
+
+        expect(
+          WebComicWithSearchableNameAndAuthor.web_search("Penny")
+        ).to eq([penny_arcade])
+
+        expect(
+          WebComicWithSearchableNameAndAuthor.web_search("Tycho")
+        ).to eq([penny_arcade])
       end
 
       it "allows includes" do
@@ -218,6 +234,11 @@ RSpec.describe "Searchable" do
         search_result = WebComicWithSearchableNameAndAuthor.fuzzy_search('Questionable Content', true, 'my_rank')
         expect(search_result.first.attributes['my_rank']).to be_truthy
       end
+
+      it "is selected for web_search" do
+        search_result = WebComicWithSearchableNameAndAuthor.web_search('Questionable Content', true, 'my_rank')
+        expect(search_result.first.attributes['my_rank']).to be_truthy
+      end
     end
   end
 end

metadata

@@ -1,32 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: textacular
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.5.1
 platform: ruby
 authors:
 - Ben Hamill
 - ecin
 - Aaron Patterson
 - Greg Molnar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2022-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -120,7 +120,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -130,7 +130,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 description: |-
   Textacular exposes full text search capabilities from PostgreSQL, extending
       ActiveRecord with scopes making search easy and fun!
@@ -154,7 +154,7 @@ files:
 - lib/textacular/tasks.rb
 - lib/textacular/trigram_installer.rb
 - lib/textacular/version.rb
-- spec/config.travis.yml
+- spec/config.github.yml
 - spec/config.yml.example
 - spec/spec_helper.rb
 - spec/support/ar_stand_in.rb
@@ -179,7 +179,7 @@ homepage: http://textacular.github.com/textacular
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -194,14 +194,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Textacular exposes full text search capabilities from PostgreSQL
 test_files:
 - spec/config.yml.example
-- spec/config.travis.yml
+- spec/config.github.yml
 - spec/spec_helper.rb
 - spec/support/ar_stand_in.rb
 - spec/support/character.rb