textacular 5.0.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d18e4abd3e1261c47932907d778c6733c930cdff
-  data.tar.gz: bf77d7e537625947e8b610dfd5177079418fff5c
+SHA256:
+  metadata.gz: d2f44e73cb226a66719aca4bdfb54732d7fc4bb2fe7af548b49aad5c81d97cfe
+  data.tar.gz: 7d43ad7e191607aef9c521d5218afd98df5bc5cfa98d84cb8189db9026cc44de
 SHA512:
-  metadata.gz: 43dc9f5012e6c8bb1da0811e55e48d0795a7fa8eff3a0127ec29c08b02c8fafca339f2e9ecb397abfd77baed9267893ed6efd53809a217903752c3fec1368fd8
-  data.tar.gz: 28b8cdc8eb8f7c00f12d5827c47aad0204f5e509abab74699618a9feff177a9e8d6b7c6dad053bddde0d6e8c6c03c3ef9fa223824cbd543ddd2746cab2a3a95f
+  metadata.gz: 0f8ba724deeb6e82160fea018b012592fd0a407231b81467ba6c52e6f921e9792aeb6653a8adbcf5c6618a5559e434ffd717e13174e21dd04eca8c2fece472fb
+  data.tar.gz: b84dfe00f5fd93a8735e3ce37847056fb82fa1ec583b59fa03cfbb411993fc33430e05ffe57986cded34c165261615edc3c524203da2a326d20fd0e3c9dcbc0a

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Unreleased
 
+## 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()`
+* 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

data/Gemfile

@@ -1,3 +1,9 @@
 source 'https://rubygems.org'
 
 gemspec
+
+git 'git://github.com/rails/rails.git', branch: 'master' do
+  gem 'activerecord'
+end
+
+gem "pg", "~> 1.1"

data/README.md

@@ -33,7 +33,7 @@ In the project's Gemfile add
 gem 'textacular', '~> 4.0'
 ```
 
-#### Rails 5.0 and Rails 5.1!
+#### Rails > 5.0
 
 In the project's Gemfile add
 
@@ -75,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.
 

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/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 = '5.0.0'
+  VERSION = '5.4.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/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,32 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: textacular
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Ben Hamill
 - ecin
 - Aaron Patterson
 - Greg Molnar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '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.2'
   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.2'
 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.4.5
-signing_key: 
+rubygems_version: 3.0.3
+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: