textacular 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9a8ae35c8edfea5bfe856e76614e2689eed90d4c41beee8a3271d1c3749586e
-  data.tar.gz: 4e88e50d311cdbccf5aae2fc71f0c3ef2d0af22b284a5bb772c7687f311eb50b
+  metadata.gz: 39d5e5ef4609c4ad498b48ba0b2553b5e211cca399fd6df820db27b2925114d6
+  data.tar.gz: b0b76e8c23b19fa21f6e283c449099d5f6e8978d50e788f49a4cf80bc0664ea9
 SHA512:
-  metadata.gz: 3c5f2531575beb68748b2c4458ea7e4e57af212f901270c45e08c359c7e535c81f18a785ea95c8679e8a0be688472f4d798bdec0329212cb89d52789fae785ff
-  data.tar.gz: '0811ce97f78f63a84d41f4576115a07b8b2f01896e8a2d3d9904ff293cf8b95235919a83c66ab02c3f81a9c48653f798bb59d1cd7facb03d0d1f7ba24a97ef1c'
+  metadata.gz: 10bf037b59c151203a7f2dd962f7a4acb9abb0638f09fea15eba6f887c34635a28cc4aaa931df5a052da712b858e65080449a04e320b97e88e3b3cf997728182
+  data.tar.gz: e807fa30b6bf512418a06e97833fd48577be25aadd34d26d289df1005f83b0b9f1980e296ad818e05ee7a72357ae0453c2f8cd5eb2aed73161c85fac77e7ec05

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 5.3.0
+
+* Add `#web_search` method to use Postgres' 11+ `websearch_to_tsquery`
+
 ## 5.2.0
 
 * Active Record 6.0 compatibility

data/README.md

@@ -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/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/lib/textacular/version.rb

@@ -1,5 +1,5 @@
 module Textacular
-  VERSION = '5.2.0'
+  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/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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textacular
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Ben Hamill
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -194,8 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Textacular exposes full text search capabilities from PostgreSQL