textacular 4.0.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 496462806ce43763aaeefe0d72e47bf1ed300a4d
-  data.tar.gz: 1ce89e8864290e04eccbf312aac17b65dac96211
+SHA256:
+  metadata.gz: 39d5e5ef4609c4ad498b48ba0b2553b5e211cca399fd6df820db27b2925114d6
+  data.tar.gz: b0b76e8c23b19fa21f6e283c449099d5f6e8978d50e788f49a4cf80bc0664ea9
 SHA512:
-  metadata.gz: aec40e799a52f138444950693b6606446c50d011fb17fabb3d96218c2831693498ba89584f474c0539a2dd48b3eb45596f9c443362812696fd85419069889138
-  data.tar.gz: d3f7dffb02381e1364474c1df66c0a464d9927794c354569de0905e434d58e5e449d012c5bd656c3c74fc2e034a99e87ddb40f7a3e11f5d3ec24224bd668935f
+  metadata.gz: 10bf037b59c151203a7f2dd962f7a4acb9abb0638f09fea15eba6f887c34635a28cc4aaa931df5a052da712b858e65080449a04e320b97e88e3b3cf997728182
+  data.tar.gz: e807fa30b6bf512418a06e97833fd48577be25aadd34d26d289df1005f83b0b9f1980e296ad818e05ee7a72357ae0453c2f8cd5eb2aed73161c85fac77e7ec05

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 ## Unreleased
 
+## 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()`
+* Adds latest Ruby, Rails and Postgres-dependencies to Travis.
+* Rewrite development migration code to support Rails 5.0-5.2.
+
+## 5.0.0
+
+* ActiveRecord 5.1 compatibility
+* drop support for ActiveRecord older than 5.0 and Ruby version lower than 2.2.5
+
 ## 4.0.1
 
 * ActiveRecord 5 compatibility above 5.0.0

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+git 'git://github.com/rails/rails.git', branch: 'master' do
+  gem 'activerecord'
+end

data/README.md

@@ -25,12 +25,20 @@ extending ActiveRecord with scopes making search easy and fun!
 
 ### Quick Start
 
-#### Rails 3, Rails 4 and Rails 5!
+#### Rails 3, Rails 4
 
 In the project's Gemfile add
 
 ```ruby
-gem 'textacular', '~> 3.0'
+gem 'textacular', '~> 4.0'
+```
+
+#### Rails > 5.0
+
+In the project's Gemfile add
+
+```ruby
+gem 'textacular', '~> 5.0'
 ```
 
 #### ActiveRecord outside of Rails
@@ -67,6 +75,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.
 
@@ -140,12 +162,20 @@ end
 You can have Postgresql use an index for the full-text search.  To declare a full-text index, in a
 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));"
 ```
 
+#### 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);
+```
+
 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.

data/Rakefile

@@ -43,12 +43,28 @@ namespace :db do
 
     desc 'Run the test database migrations'
     task :up => :'db:connect' do
-      ActiveRecord::Migrator.up 'db/migrate'
+      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
+        migrations = ActiveRecord::Migrator.migrations('db/migrate')
+        schema_migration = nil
+      end
+      ActiveRecord::Migrator.new(:up, migrations, schema_migration).migrate
     end
 
     desc 'Reverse the test database migrations'
     task :down => :'db:connect' do
-      ActiveRecord::Migrator.down 'db/migrate'
+      migrations = if ActiveRecord.version.version >= '5.2'
+        ActiveRecord::Migration.new.migration_context.migrations
+      else
+        ActiveRecord::Migrator.migrations('db/migrate')
+      end
+      ActiveRecord::Migrator.new(:down, migrations, nil).migrate
     end
   end
   task :migrate => :'migrate:up'

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,19 +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})"
+    "(#{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 = 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("#{quoted_table_name + '.*,' if select_values.empty?} #{similarities.join(" + ")} AS #{rank}").
+    select(Arel.sql("#{quoted_table_name + '.*,' if select_values.empty?} #{similarities.join(" + ")} AS #{rank}")).
       where(conditions.join(exclusive ? " AND " : " OR ")).
-      order("#{rank} DESC")
+      order(Arel.sql("#{rank} DESC"))
   end
 
   def select_values
@@ -151,7 +177,7 @@ module Textacular
   module Helper
     class << self
       def normalize(query)
-        query.to_s.gsub(/\s(?![\&|\!|\|])/, '\\\\ ')
+        query.to_s.gsub(/\s(?![\&\!\|])/, '\\\\ ')
       end
     end
   end

data/lib/textacular/full_text_indexer.rb

@@ -16,7 +16,7 @@ class #{model_name}FullTextSearch < ActiveRecord::Migration
 end
 MIGRATION
     filename = "#{model_name.underscore}_full_text_search"
-    generator = Textacular::MigrationGenerator.new(content, filename)
+    generator = Textacular::MigrationGenerator.new(filename, content)
     generator.generate_migration
   end
 
@@ -52,7 +52,7 @@ MIGRATION
     <<-SQL
 CREATE index #{index_name_for(model, column)}
   ON #{model.table_name}
-  USING gin(to_tsvector("#{dictionary}", "#{model.table_name}"."#{column}"::text));
+  USING gin(to_tsvector('#{dictionary}', "#{model.table_name}"."#{column}"::text));
 SQL
   end
 

data/lib/textacular/migration_generator.rb

@@ -4,6 +4,7 @@ class Textacular::MigrationGenerator
   def initialize(filename, content)
     @filename = filename
     @content = content
+    @output_stream = nil
   end
 
   def generate_migration

data/lib/textacular/version.rb

@@ -1,5 +1,5 @@
 module Textacular
-  VERSION = '4.0.1'
+  VERSION = '5.3.0'
 
   def self.version
     VERSION

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/full_text_indexer_spec.rb

@@ -12,7 +12,7 @@ class WebComicWithSearchableNameFullTextSearch < ActiveRecord::Migration
       DROP index IF EXISTS web_comics_name_fts_idx;
       CREATE index web_comics_name_fts_idx
         ON web_comics
-        USING gin(to_tsvector("english", "web_comics"."name"::text));
+        USING gin(to_tsvector('english', "web_comics"."name"::text));
     SQL
   end
 
@@ -25,7 +25,7 @@ end
 MIGRATION
 
       generator = double(:migration_generator)
-      expect(Textacular::MigrationGenerator).to receive(:new).with(content, file_name).and_return(generator)
+      expect(Textacular::MigrationGenerator).to receive(:new).with(file_name, content).and_return(generator)
       expect(generator).to receive(:generate_migration)
 
       Textacular::FullTextIndexer.new.generate_migration('WebComicWithSearchableName')
@@ -42,11 +42,11 @@ class WebComicWithSearchableNameAndAuthorFullTextSearch < ActiveRecord::Migratio
       DROP index IF EXISTS web_comics_name_fts_idx;
       CREATE index web_comics_name_fts_idx
         ON web_comics
-        USING gin(to_tsvector("english", "web_comics"."name"::text));
+        USING gin(to_tsvector('english', "web_comics"."name"::text));
       DROP index IF EXISTS web_comics_author_fts_idx;
       CREATE index web_comics_author_fts_idx
         ON web_comics
-        USING gin(to_tsvector("english", "web_comics"."author"::text));
+        USING gin(to_tsvector('english', "web_comics"."author"::text));
     SQL
   end
 
@@ -60,7 +60,7 @@ end
 MIGRATION
 
       generator = double(:migration_generator)
-      expect(Textacular::MigrationGenerator).to receive(:new).with(content, file_name).and_return(generator)
+      expect(Textacular::MigrationGenerator).to receive(:new).with(file_name, content).and_return(generator)
       expect(generator).to receive(:generate_migration)
 
       Textacular::FullTextIndexer.new.generate_migration('WebComicWithSearchableNameAndAuthor')

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textacular
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.3.0
 platform: ruby
 authors:
 - Ben Hamill
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -97,26 +97,40 @@ 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
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
 description: |-
   Textacular exposes full text search capabilities from PostgreSQL, extending
       ActiveRecord with scopes making search easy and fun!
@@ -180,8 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Textacular exposes full text search capabilities from PostgreSQL
@@ -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: