pg_search 0.3.4 → 0.4

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = PgSearch
 
+== 0.4
+
+* Add ability to search again tsvector columns. (Kris Hicks)
+
 == 0.3.4
 
 * Fix issue with {:using => {:tsearch => {:prefix => true}}} and hyphens.

data/README.rdoc

@@ -452,11 +452,37 @@ Ignoring accents uses the {unaccent contrib package}[http://www.postgresql.org/d
   SpanishQuestion.gringo_search("Que") # => [what]
   SpanishQuestion.gringo_search("Cüåñtô") # => [how_many]
 
+=== Using tsvector columns
+
+PostgreSQL allows you the ability to search against a column with type tsvector instead of using an expression; this speeds up searching dramatically as it offloads creation of the tsvector that the tsquery is evaluated against.
+
+To use this functionality you'll need to do a few things:
+
+* Create a column of type tsvector that you'd like to search against. If you want to search using multiple search methods, for example tsearch and dmetaphone, you'll need a column for each.
+* Create a trigger function that will update the column(s) using the expression appropriate for that type of search. See: http://www.postgresql.org/docs/current/static/textsearch-features.html#TEXTSEARCH-UPDATE-TRIGGERS
+* Should you have any pre-existing data in the table, update the newly-created tsvector columns with the expression that your trigger function uses.
+* Add the option to pg_search_scope, e.g:
+
+    pg_search_scope :fast_content_search,
+                    :against => :content,
+                    :using => {
+                      dmetaphone: {
+                        tsvector_column: 'tsvector_content_dmetaphone'
+                      },
+                      tsearch: {
+                        dictionary: 'english',
+                        tsvector_column: 'tsvector_content_tsearch'
+                      }
+                      trigram: {} # trigram does not use tsvectors
+                    }
+
+Please note that the :against column is only used when the tsvector_column is not present for the search type.
+
 == REQUIREMENTS
 
-* ActiveRecord 2 or 3
-* Postgresql
-* Postgresql contrib modules for certain features
+* ActiveRecord 3
+* PostgreSQL
+* PostgreSQL contrib packages for certain features
 
 == ATTRIBUTIONS
 

data/lib/pg_search/features/tsearch.rb

@@ -62,10 +62,14 @@ module PgSearch
       end
 
       def tsdocument
-        @columns.map do |search_column|
-          tsvector = "to_tsvector(:dictionary, #{@normalizer.add_normalization(search_column.to_sql)})"
-          search_column.weight.nil? ? tsvector : "setweight(#{tsvector}, #{connection.quote(search_column.weight)})"
-        end.join(" || ")
+        if @options[:tsvector_column]
+          @options[:tsvector_column].to_s
+        else
+          @columns.map do |search_column|
+            tsvector = "to_tsvector(:dictionary, #{@normalizer.add_normalization(search_column.to_sql)})"
+            search_column.weight.nil? ? tsvector : "setweight(#{tsvector}, #{connection.quote(search_column.weight)})"
+          end.join(" || ")
+        end
       end
 
       # From http://www.postgresql.org/docs/8.3/static/textsearch-controls.html

data/lib/pg_search/version.rb

@@ -1,3 +1,3 @@
 module PgSearch
-  VERSION = "0.3.4"
+  VERSION = "0.4"
 end

data/spec/pg_search_spec.rb

@@ -597,6 +597,46 @@ describe "an ActiveRecord model which includes PgSearch" do
       end
     end
 
+    context "using a tsvector column" do
+      with_model :ModelWithPgSearchUsingTsVectorColumn do
+        table do |t|
+          t.text 'content'
+          t.tsvector 'content_tsvector'
+        end
+
+        model { include PgSearch }
+      end
+
+      let!(:expected) { ModelWithPgSearchUsingTsVectorColumn.create!(:content => 'tiling is grouty') }
+      let!(:unexpected) { ModelWithPgSearchUsingTsVectorColumn.create!(:content => 'longcat is looooooooong') }
+
+      before do
+        ActiveRecord::Base.connection.execute <<-SQL
+          UPDATE #{ModelWithPgSearchUsingTsVectorColumn.table_name}
+          SET content_tsvector = to_tsvector('english'::regconfig, "#{ModelWithPgSearchUsingTsVectorColumn.table_name}"."content")
+        SQL
+
+        ModelWithPgSearchUsingTsVectorColumn.class_eval do
+          pg_search_scope :search_by_content_with_tsvector,
+            :against => :content,
+            :using => {
+              :tsearch => {
+                :tsvector_column => 'content_tsvector',
+                :dictionary => 'english'
+              }
+            }
+        end
+      end
+
+      it "should not use to_tsvector in the query" do
+        ModelWithPgSearchUsingTsVectorColumn.search_by_content_with_tsvector("tiles").to_sql.should_not =~ /to_tsvector/
+      end
+
+      it "should find the expected result" do
+        ModelWithPgSearchUsingTsVectorColumn.search_by_content_with_tsvector("tiles").map(&:id).should == [expected.id]
+      end
+    end
+
     context "ignoring accents" do
       before do
         ModelWithPgSearch.class_eval do

data/spec/spec_helper.rb

@@ -19,6 +19,11 @@ rescue PGError => e
   raise e
 end
 
+if ENV["LOGGER"]
+  require "logger"
+  ActiveRecord::Base.logger = Logger.new(STDOUT)
+end
+
 def install_extension_if_missing(name, query, expected_result)
   connection = ActiveRecord::Base.connection
   result = connection.select_value(query)

metadata

@@ -1,60 +1,46 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pg_search
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: '0.4'
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 4
-  version: 0.3.4
 platform: ruby
-authors: 
+authors:
 - Case Commons, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-25 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70335492023760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        version: "3"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70335492023760
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70335492023220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        version: "3"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
-  version_requirements: *id002
-description: PgSearch builds ActiveRecord named scopes that take advantage of PostgreSQL's full text search
-email: 
+  prerelease: false
+  version_requirements: *70335492023220
+description: PgSearch builds ActiveRecord named scopes that take advantage of PostgreSQL's
+  full text search
+email:
 - casecommons-dev@googlegroups.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .autotest
 - .gitignore
 - .rspec
@@ -97,38 +83,30 @@ files:
 - sql/unnest.sql
 homepage: https://github.com/Casecommons/pg_search
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: PgSearch builds ActiveRecord named scopes that take advantage of PostgreSQL's full text search
-test_files: 
+summary: PgSearch builds ActiveRecord named scopes that take advantage of PostgreSQL's
+  full text search
+test_files:
 - spec/associations_spec.rb
 - spec/pg_search/document_spec.rb
 - spec/pg_search/multisearch_spec.rb