pg_search 0.3.2 → 0.3.3

data/CHANGELOG.rdoc

@@ -0,0 +1,66 @@
+= PgSearch
+
+== 0.3.3
+
+* Backport array_agg() aggregate function to PostgreSQL 8.3 and earlier.
+  This fixes :associated_against searches.
+
+* Backport unnest() function to PostgreSQL 8.3 and earlier.
+  This fixes {:using => :dmetaphone} searches.
+
+* Disable {:using => {:tsearch => {:prefix => true}}} in PostgreSQL 8.3 and earlier.
+
+== 0.3.2
+
+* Fix :prefix search in PostgreSQL 8.x
+
+* Disable {:ignoring => :accents} in PostgreSQL 8.x
+
+== 0.3.1
+
+* Fix syntax error in generated dmetaphone migration. (Max De Marzi)
+
+== 0.3
+
+* Drop Active Record 2.0 support.
+
+* Add PgSearch.multisearch for cross-model searching.
+
+* Fix PostgreSQL warnings about truncated identifiers
+
+* Support specifying a method of rank normalisation when using tsearch. (Arthur Gunn)
+
+* Add :any_word option to :tsearch which uses OR between query terms instead of AND. (Fernando Espinosa)
+
+== 0.2
+
+* Set dictionary to :simple by default for :tsearch. Before it was unset,
+  which would fall back to PostgreSQL's default dictionary, usually
+  "english".
+
+* Fix a bug with search strings containing a colon ":"
+
+* Improve performance of :associated_against by only doing one INNER JOIN per
+  association
+
+== 0.1.1
+
+* Fix a bug with dmetaphone searches containing " w " (which dmetaphone maps
+  to an empty string)
+
+== 0.1
+
+* Change API to {:ignoring => :accents} from {:normalizing => :diacritics}
+
+* Improve documentation
+
+* Fix bug where :associated_against would not work without an :against
+  present
+
+== 0.0.2
+
+* Fix gem ownership.
+
+== 0.0.1
+
+* Initial release.

data/README.rdoc

@@ -181,7 +181,15 @@ Important: The returned hash must include a :query key. Its value does not neces
 
 ==== Searching through associations
 
-You can pass a Hash into the :associated_against option to search columns on other models. The keys are the names of the associations and the value works just like an :against option for the other model.
+It is possible to search columns on associated models. Note that if you do this, it will be impossible to speed up searches with database indexes. However, it is supported as a quick way to try out cross-model searching.
+
+In PostgreSQL 8.3 and earlier, you must install a utility function into your database. To generate a migration for this, run:
+
+  $ rake pg_search:migration:associated_against
+
+This migration is safe to run against newer versions of PostgreSQL as well. It will essentially do nothing.
+
+You can pass a Hash into the :associated_against option to set up searching through associations. The keys are the names of the associations and the value works just like an :against option for the other model. Right now, searching deeper than one association away is not supported. You can work around this by setting up a series of :through associations to point all the way through.
 
   class Cracker < ActiveRecord::Base
     has_many :cheeses
@@ -267,7 +275,7 @@ You can also pass the weights in as an array of arrays, or any other structure t
    ]
  end
 
-===== :prefix
+===== :prefix (PostgreSQL 8.4 and newer only)
 
 PostgreSQL's full text search matches on whole words by default. If you want to search for partial words, however, you can set :prefix to true. Since this is a :tsearch-specific option, you should pass it to :tsearch directly, as shown in the following example.
 
@@ -414,7 +422,7 @@ Trigram support is currently available as part of the {pg_trgm contrib package}[
 
   Website.kinda_spelled_like("Yahoo!") # => [yahooo, yohoo]
 
-=== Ignoring accent marks (PostgreSQL 9.0 and above only)
+=== Ignoring accent marks (PostgreSQL 9.0 and newer only)
 
 Most of the time you will want to ignore accent marks when searching. This makes it possible to find words like "piñata" when searching with the query "pinata". If you set a pg_search_scope to ignore accents, it will ignore accents in both the searchable text and the query terms.
 

data/lib/pg_search/features/tsearch.rb

@@ -11,6 +11,12 @@ module PgSearch
         @model = model
         @columns = columns
         @normalizer = normalizer
+
+        if @options[:prefix] && @model.connection.send(:postgresql_version) < 80400
+          raise PgSearch::NotSupportedForPostgresqlVersion.new(<<-MESSAGE.gsub /^\s*/, '')
+            Sorry, {:using => {:tsearch => {:prefix => true}}} only works in PostgreSQL 8.4 and above.")
+          MESSAGE
+        end
       end
 
       def conditions

data/lib/pg_search/normalizer.rb

@@ -8,7 +8,7 @@ module PgSearch
       normalized_sql = original_sql
       if @config.ignore.include?(:accents)
         if @config.postgresql_version < 90000
-          raise PgSearch::NotSupportedForPostgresqlVersion.new(<<-MESSAGE)
+          raise PgSearch::NotSupportedForPostgresqlVersion.new(<<-MESSAGE.gsub /^\s*/, '')
           Sorry, {:ignoring => :accents} only works in PostgreSQL 9.0 and above.
           #{@config.inspect}
           MESSAGE

data/lib/pg_search/tasks.rb

@@ -48,11 +48,19 @@ end
       dmetaphone_sql = File.read(File.join(File.dirname(__FILE__), '..', '..', 'sql', 'dmetaphone.sql')).chomp
       uninstall_dmetaphone_sql = File.read(File.join(File.dirname(__FILE__), '..', '..', 'sql', 'uninstall_dmetaphone.sql')).chomp
 
+      unnest_sql = File.read(File.join(File.dirname(__FILE__), '..', '..', 'sql', 'unnest.sql')).chomp
+      uninstall_unnest_sql = File.read(File.join(File.dirname(__FILE__), '..', '..', 'sql', 'uninstall_unnest.sql')).chomp
+
       File.open(Rails.root + 'db' + 'migrate' + filename, 'wb') do |migration_file|
         migration_file.puts <<-RUBY
 class AddPgSearchDmetaphoneSupportFunctions < ActiveRecord::Migration
   def self.up
     say_with_time("Adding support functions for pg_search :dmetaphone") do
+      if ActiveRecord::Base.connection.send(:postgresql_version) < 80400
+        ActiveRecord::Base.connection.execute(<<-SQL)
+          #{unnest_sql}
+        SQL
+      end
       ActiveRecord::Base.connection.execute(<<-SQL)
         #{dmetaphone_sql}
       SQL
@@ -64,6 +72,46 @@ class AddPgSearchDmetaphoneSupportFunctions < ActiveRecord::Migration
       ActiveRecord::Base.connection.execute(<<-SQL)
         #{uninstall_dmetaphone_sql}
       SQL
+      if ActiveRecord::Base.connection.send(:postgresql_version) < 80400
+        ActiveRecord::Base.connection.execute(<<-SQL)
+          #{uninstall_unnest_sql}
+        end
+      end
+    end
+  end
+end
+        RUBY
+      end
+    end
+
+    desc "Generate migration to add support functions for :associated_against in PostgreSQL 8.3 and earlier"
+    task :associated_against do
+      now = Time.now.utc
+      filename = "#{now.strftime('%Y%m%d%H%M%S')}_add_pg_search_associated_against_support_functions.rb"
+
+      array_agg_sql = File.read(File.join(File.dirname(__FILE__), '..', '..', 'sql', 'array_agg.sql')).chomp
+      uninstall_array_agg_sql = File.read(File.join(File.dirname(__FILE__), '..', '..', 'sql', 'uninstall_array_agg.sql')).chomp
+
+      File.open(Rails.root + 'db' + 'migrate' + filename, 'wb') do |migration_file|
+        migration_file.puts <<-RUBY
+class AddPgSearchAssociatedAgainstSupportFunctions < ActiveRecord::Migration
+  def self.up
+    say_with_time("Adding support functions for pg_search :associated_against") do
+      if ActiveRecord::Base.connection.send(:postgresql_version) < 80400
+        ActiveRecord::Base.connection.execute(<<-SQL)
+          #{array_agg_sql}
+        SQL
+      end
+    end
+  end
+
+  def self.down
+    say_with_time("Dropping support functions for pg_search :associated_against") do
+      if ActiveRecord::Base.connection.send(:postgresql_version) < 80400
+        ActiveRecord::Base.connection.execute(<<-SQL)
+          #{uninstall_array_agg_sql}
+        SQL
+      end
     end
   end
 end

data/lib/pg_search/version.rb

@@ -1,3 +1,3 @@
 module PgSearch
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/spec/pg_search_spec.rb

@@ -316,36 +316,44 @@ describe "an ActiveRecord model which includes PgSearch" do
     end
 
     context "using tsearch" do
-      context "with :prefix => true" do
-        before do
-          ModelWithPgSearch.class_eval do
-            pg_search_scope :search_title_with_prefixes,
-                            :against => :title,
-                            :using => {
-                              :tsearch => {:prefix => true}
-                            }
-          end
+      before do
+        ModelWithPgSearch.class_eval do
+          pg_search_scope :search_title_with_prefixes,
+                          :against => :title,
+                          :using => {
+                            :tsearch => {:prefix => true}
+                          }
         end
+      end
 
-        it "returns rows that match the query and that are prefixed by the query" do
-          included = ModelWithPgSearch.create!(:title => 'prefix')
-          excluded = ModelWithPgSearch.create!(:title => 'postfix')
-
-          results = ModelWithPgSearch.search_title_with_prefixes("pre")
-          results.should == [included]
-          results.should_not include(excluded)
+      if ActiveRecord::Base.connection.send(:postgresql_version) < 80400
+        it "is unsupported in PostgreSQL 8.3 and earlier" do
+          lambda do
+            ModelWithPgSearch.search_title_with_prefixes("abcd\303\251f")
+          end.should raise_exception(PgSearch::NotSupportedForPostgresqlVersion)
         end
+      else
+        context "with :prefix => true" do
+          it "returns rows that match the query and that are prefixed by the query" do
+            included = ModelWithPgSearch.create!(:title => 'prefix')
+            excluded = ModelWithPgSearch.create!(:title => 'postfix')
+
+            results = ModelWithPgSearch.search_title_with_prefixes("pre")
+            results.should == [included]
+            results.should_not include(excluded)
+          end
 
-        it "returns rows that match the query when the query has a hyphen" do
-          included = [
-            ModelWithPgSearch.create!(:title => 'foo bar'),
-            ModelWithPgSearch.create!(:title => 'foo-bar')
-          ]
-          excluded = ModelWithPgSearch.create!(:title => 'baz quux')
+          it "returns rows that match the query when the query has a hyphen" do
+            included = [
+              ModelWithPgSearch.create!(:title => 'foo bar'),
+              ModelWithPgSearch.create!(:title => 'foo-bar')
+            ]
+            excluded = ModelWithPgSearch.create!(:title => 'baz quux')
 
-          results = ModelWithPgSearch.search_title_with_prefixes("foo-bar")
-          results.should =~ included
-          results.should_not include(excluded)
+            results = ModelWithPgSearch.search_title_with_prefixes("foo-bar")
+            results.should =~ included
+            results.should_not include(excluded)
+          end
         end
       end
 
@@ -536,7 +544,7 @@ describe "an ActiveRecord model which includes PgSearch" do
           pg_search_scope :with_tsearch,
                           :against => :title,
                           :using => [
-                            [:tsearch, {:prefix => true}]
+                            [:tsearch, {:dictionary => 'english'}]
                           ]
 
           pg_search_scope :with_trigram, :against => :title, :using => :trigram
@@ -544,7 +552,7 @@ describe "an ActiveRecord model which includes PgSearch" do
           pg_search_scope :with_tsearch_and_trigram_using_array,
                           :against => :title,
                           :using => [
-                            [:tsearch, {:prefix => true}],
+                            [:tsearch, {:dictionary => 'english'}],
                             :trigram
                           ]
 
@@ -561,7 +569,7 @@ describe "an ActiveRecord model which includes PgSearch" do
         ModelWithPgSearch.with_tsearch_and_trigram_using_array(trigram_query).should == [record]
 
         # matches tsearch only
-        tsearch_query = "til"
+        tsearch_query = "tiles"
         ModelWithPgSearch.with_tsearch(tsearch_query).should include(record)
         ModelWithPgSearch.with_trigram(tsearch_query).should_not include(record)
         ModelWithPgSearch.with_tsearch_and_trigram_using_array(tsearch_query).should == [record]

data/spec/spec_helper.rb

@@ -40,7 +40,17 @@ unless connection.send(:postgresql_version) < 90000
 end
 install_contrib_module_if_missing("fuzzystrmatch", "SELECT dmetaphone('foo')", "f")
 
-ActiveRecord::Base.connection.execute(File.read(File.join(File.dirname(__FILE__), '..', 'sql', 'dmetaphone.sql')))
+ActiveRecord::Base.connection.tap do |connection|
+  if connection.send(:postgresql_version) < 80400
+    unless connection.select_value("SELECT 1 FROM pg_catalog.pg_aggregate WHERE aggfnoid = 'array_agg'::REGPROC") == "1"
+      connection.execute(File.read(File.join(File.dirname(__FILE__), '..', 'sql', 'array_agg.sql')))
+    end
+    connection.execute(File.read(File.join(File.dirname(__FILE__), '..', 'sql', 'unnest.sql')))
+  end
+  connection.execute(File.read(File.join(File.dirname(__FILE__), '..', 'sql', 'dmetaphone.sql')))
+end
+
+
 
 require "with_model"
 

data/sql/array_agg.sql

@@ -0,0 +1,5 @@
+CREATE AGGREGATE array_agg(anyelement) (
+  SFUNC=array_append,
+  STYPE=anyarray,
+  INITCOND='{}'
+)

data/sql/uninstall_array_agg.sql

@@ -0,0 +1 @@
+DROP AGGREGATE array_agg(anyelement);

data/sql/uninstall_unnest.sql

@@ -0,0 +1 @@
+DROP FUNCTION unnest(anyarray);

data/sql/unnest.sql

@@ -0,0 +1,8 @@
+CREATE OR REPLACE FUNCTION unnest(anyarray)
+  RETURNS SETOF anyelement AS
+$BODY$
+SELECT $1[i] FROM
+    generate_series(array_lower($1,1),
+                    array_upper($1,1)) i;
+$BODY$
+  LANGUAGE 'sql' IMMUTABLE

metadata

@@ -1,66 +1,52 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pg_search
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.3.3
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 2
-  version: 0.3.2
 platform: ruby
-authors: 
+authors:
 - Case Commons, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70192130541140 !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: *70192130541140
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70192130540020 !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: *70192130540020
+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
 - .rvmrc
 - .travis.yml
-- CHANGELOG
+- CHANGELOG.rdoc
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -90,42 +76,38 @@ files:
 - spec/pg_search/multisearchable_spec.rb
 - spec/pg_search_spec.rb
 - spec/spec_helper.rb
+- sql/array_agg.sql
 - sql/dmetaphone.sql
+- sql/uninstall_array_agg.sql
 - sql/uninstall_dmetaphone.sql
+- sql/uninstall_unnest.sql
+- 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.4
+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

data/CHANGELOG

@@ -1,54 +0,0 @@
-### 0.3.2
-
- * Fix :prefix search in PostgreSQL 8.x
-
- * Disable {:ignoring => :accents} in PostgreSQL 8.x
-
-### 0.3.1
-
- * Fix syntax error in generated dmetaphone migration. (Max De Marzi)
-
-### 0.3
-
- * Drop Active Record 2.0 support.
-
- * Add PgSearch.multisearch for cross-model searching.
-
- * Fix PostgreSQL warnings about truncated identifiers
-
- * Support specifying a method of rank normalisation when using tsearch. (Arthur Gunn)
-
- * Add :any_word option to :tsearch which uses OR between query terms instead of AND. (Fernando Espinosa)
-
-### 0.2
-
- * Set dictionary to :simple by default for :tsearch. Before it was unset,
-   which would fall back to PostgreSQL's default dictionary, usually
-   "english".
-
- * Fix a bug with search strings containing a colon ":"
-
- * Improve performance of :associated_against by only doing one INNER JOIN per
-   association
-
-### 0.1.1
-
- * Fix a bug with dmetaphone searches containing " w " (which dmetaphone maps
-   to an empty string)
-
-### 0.1
-
- * Change API to {:ignoring => :accents} from {:normalizing => :diacritics}
-
- * Improve documentation
-
- * Fix bug where :associated_against would not work without an :against
-   present
-
-### 0.0.2
-
- * Fix gem ownership.
-
-### 0.0.1
-
- * Initial release.