textacular 5.1.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3bd98a4fec2d72714909b49059a7f8b50298d734
-  data.tar.gz: 9b3fc608d5192296392da8323048c65440146cbd
+SHA256:
+  metadata.gz: 974b8a8209d44a134f421db20f9ae6338c03057d8bcf26ce1e0c40778a29d6bf
+  data.tar.gz: 422c096f881919e53eaaab5f530e26e0e5aeffe33a4c8646bcb7f3b367dc9084
 SHA512:
-  metadata.gz: 7e1cd1fdce05d21df1e9803ca0bd1db66fc18ba371a4980175824ad5c46df5eb1e4cfd1aed857e5cea384887734f7f563ce498cc860c8c8827873f669a9ca584
-  data.tar.gz: 6237664f59c95a81b48283b3f761289a8c63199c908fba347e3931be9f93c59f5be897c971434266a7d1a203dfc3aa11af217736ca2e3313cea180c73c0d16c3
+  metadata.gz: ab93dff1128025cc4615d29c819d104a9300bdbb0a88d9cc588940a1f630922a201b9f11449d610ba5cadc5ae85c2e761c0ad3ff5b8cb7a85f1fd3dd15acf744
+  data.tar.gz: 2102ea9936a087f18ed4945ddb4213e93acb70dc4bc8d3281489664fda2968b635e024636f0f2112f0fa8fc7a13b5d2b7e728aa200ac7663b681ae287b7e6b5d

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## Unreleased
 
+## 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
+
 ## 5.1.0
 
 * ActiveRecord 5.2 compatibility by wrapping string queries with `Arel.sql()`

data/Gemfile

@@ -2,4 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'activerecord', '~> 5.2.x'
+git 'git://github.com/rails/rails.git', branch: 'main' do
+  gem 'activerecord'
+end
+
+gem "pg", "~> 1.1"

data/README.md

@@ -25,20 +25,18 @@ extending ActiveRecord with scopes making search easy and fun!
 
 ### Quick Start
 
-#### Rails 3, Rails 4
-
 In the project's Gemfile add
 
 ```ruby
-gem 'textacular', '~> 4.0'
+gem 'textacular', '~> 5.0'
 ```
 
-#### Rails 5.0 and Rails 5.1!
+#### 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 +73,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 +162,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/Rakefile

@@ -43,12 +43,18 @@ namespace :db do
 
     desc 'Run the test database migrations'
     task :up => :'db:connect' do
-      migrations = if ActiveRecord.version.version >= '5.2'
-        ActiveRecord::Migration.new.migration_context.migrations
+      if ActiveRecord.version >= Gem::Version.new('6.0.0')
+        context = ActiveRecord::Migration.new.migration_context
+        migrations = context.migrations
+        schema_migration = context.schema_migration
+      elsif ActiveRecord.version >= Gem::Version.new('5.2')
+        migrations = ActiveRecord::Migration.new.migration_context.migrations
+        schema_migration = nil
       else
-        ActiveRecord::Migrator.migrations('db/migrate')
+        migrations = ActiveRecord::Migrator.migrations('db/migrate')
+        schema_migration = nil
       end
-      ActiveRecord::Migrator.new(:up, migrations, nil).migrate
+      ActiveRecord::Migrator.new(:up, migrations, schema_migration).migrate
     end
 
     desc 'Reverse the test database migrations'

data/lib/textacular/version.rb

@@ -1,5 +1,5 @@
 module Textacular
-  VERSION = '5.1.0'
+  VERSION = '5.5.0'
 
   def self.version
     VERSION

data/lib/textacular.rb

@@ -12,29 +12,36 @@ module Textacular
     'english'
   end
 
-  def search(query = "", exclusive = true)
-    basic_search(query, exclusive)
+  def search(query = "", exclusive = true, rank_alias = nil)
+    basic_search(query, exclusive, rank_alias)
   end
 
-  def basic_search(query = "", exclusive = true)
+  def basic_search(query = "", exclusive = true, rank_alias = nil)
     exclusive, query = munge_exclusive_and_query(exclusive, query)
     parsed_query_hash = parse_query_hash(query)
     similarities, conditions = basic_similarities_and_conditions(parsed_query_hash)
-    assemble_query(similarities, conditions, exclusive)
+    assemble_query(similarities, conditions, exclusive, rank_alias)
   end
 
-  def advanced_search(query = "", exclusive = true)
+  def advanced_search(query = "", exclusive = true, rank_alias = nil)
     exclusive, query = munge_exclusive_and_query(exclusive, query)
     parsed_query_hash = parse_query_hash(query)
     similarities, conditions = advanced_similarities_and_conditions(parsed_query_hash)
-    assemble_query(similarities, conditions, exclusive)
+    assemble_query(similarities, conditions, exclusive, rank_alias)
   end
 
-  def fuzzy_search(query = '', exclusive = true)
+  def fuzzy_search(query = '', exclusive = true, rank_alias = nil)
     exclusive, query = munge_exclusive_and_query(exclusive, query)
     parsed_query_hash = parse_query_hash(query)
     similarities, conditions = fuzzy_similarities_and_conditions(parsed_query_hash)
-    assemble_query(similarities, conditions, exclusive)
+    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
@@ -113,15 +120,38 @@ module Textacular
   end
 
   def fuzzy_similarity_string(table_name, column, search_term)
-    "COALESCE(similarity(#{table_name}.#{column}, #{search_term}), 0)"
+    "COALESCE(similarity(#{table_name}.#{column}::text, #{search_term}), 0)"
   end
 
   def fuzzy_condition_string(table_name, column, search_term)
-    "(#{table_name}.#{column} % #{search_term})"
+    # At this point, search_term is already quoted and query ready. Insert % between the quotes and the actual string.
+    search_term = search_term.gsub(/^(['"])/, '\1%')
+    search_term = search_term.gsub(/(['"])$/, '%\1')
+
+    "(#{table_name}.#{column}::text ILIKE #{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 = connection.quote_column_name('rank' + rand(100000000000000000).to_s)
+  def assemble_query(similarities, conditions, exclusive, rank_alias)
+    rank_alias ||= 'rank' + rand(100000000000000000).to_s
+    rank = connection.quote_column_name(rank_alias)
 
     select(Arel.sql("#{quoted_table_name + '.*,' if select_values.empty?} #{similarities.join(" + ")} AS #{rank}")).
       where(conditions.join(exclusive ? " AND " : " OR ")).

data/spec/config.travis.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
@@ -190,5 +206,39 @@ RSpec.describe "Searchable" do
         ).to eq([penny_arcade])
       end
     end
+
+    context 'custom rank' do
+      let!(:questionable_content) do
+        WebComicWithSearchableName.create(
+          name: 'Questionable Content',
+          author: nil,
+        )
+      end
+
+      it "is selected for search" do
+        search_result = WebComicWithSearchableNameAndAuthor.search('Questionable Content', true, 'my_rank')
+        expect(search_result.first.attributes['my_rank']).to be_truthy
+      end
+
+      it "is selected for basic_search" do
+        search_result = WebComicWithSearchableNameAndAuthor.basic_search('Questionable Content', true, 'my_rank')
+        expect(search_result.first.attributes['my_rank']).to be_truthy
+      end
+
+      it "is selected for advanced_search" do
+        search_result = WebComicWithSearchableNameAndAuthor.advanced_search('Questionable Content', true, 'my_rank')
+        expect(search_result.first.attributes['my_rank']).to be_truthy
+      end
+
+      it "is selected for fuzzy_search" 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

data/spec/textacular_spec.rb

@@ -181,6 +181,13 @@ RSpec.describe Textacular do
         expect(GameExtendedWithTextacular).to respond_to(:search)
       end
 
+      describe "#fuzzy_search" do
+        it 'searches non-text columns' do
+          expect(GameExtendedWithTextacular.fuzzy_search(id: mario.id)
+          ).to eq([mario])
+        end
+      end
+
       describe "#advanced_search" do
         context "with a String argument" do
           it "searches across all :string columns (if not indexes have been specified)" do
@@ -282,6 +289,12 @@ RSpec.describe Textacular do
           end
         end
       end
+
+      describe "#fuzzy_search" do
+        it "works if column contains multiple space delimited strings" do
+          expect(GameExtendedWithTextacular.fuzzy_search(title: 'mar')).to eq([mario])
+        end
+      end
     end
   end
 end

metadata

@@ -1,32 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: textacular
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Ben Hamill
 - ecin
 - Aaron Patterson
 - Greg Molnar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-12 00:00:00.000000000 Z
+date: 2021-12-23 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
@@ -97,6 +97,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +120,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -116,7 +130,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
 description: |-
   Textacular exposes full text search capabilities from PostgreSQL, extending
       ActiveRecord with scopes making search easy and fun!
@@ -165,7 +179,7 @@ homepage: http://textacular.github.com/textacular
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,9 +194,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Textacular exposes full text search capabilities from PostgreSQL
 test_files:
@@ -207,4 +220,3 @@ test_files:
 - spec/textacular/migration_generator_spec.rb
 - spec/textacular/searchable_spec.rb
 - spec/textacular/trigram_installer_spec.rb
-has_rdoc: