pg_search 0.3.3 → 0.3.4

data/CHANGELOG.rdoc

@@ -1,5 +1,11 @@
 = PgSearch
 
+== 0.3.4
+
+* Fix issue with {:using => {:tsearch => {:prefix => true}}} and hyphens.
+
+* Get tests running against PostgreSQL 9.1 by using CREATE EXTENSION
+
 == 0.3.3
 
 * Backport array_agg() aggregate function to PostgreSQL 8.3 and earlier.

data/README.rdoc

@@ -75,7 +75,7 @@ Two associations are built automatically. On the original record, there is a has
 
 ==== Searching in the global search index
 
-To fetch the PgSearch::Document entries for all of the records that match a given query, use  PgSearch.multisearch.
+To fetch the PgSearch::Document entries for all of the records that match a given query, use PgSearch.multisearch.
 
  odyssey = EpicPoem.create!(:title => "Odyssey", :author => "Homer")
  rose = Flower.create!(:color => "Red")
@@ -93,6 +93,15 @@ PgSearch.multisearch returns an ActiveRecord::Relation, just like scopes do, so
    puts document.searchable.updated_at
  end
 
+==== Configuring multi-search
+
+PgSearch.multisearch can be configured using the same options as `pg_search_scope` (explained in more detail below). Just set the PgSearch.multisearchable_options in an initializer:
+
+ PgSearch.multisearchable_options = {
+   :using => [:tsearch, :trigram],
+   :ignoring => :accents
+ }
+
 ==== Rebuilding search documents for a given class
 
 If you change the :against option on a class, add multisearchable to a class that already has records in the database, or remove multisearchable from a class in order to remove it from the index, you will find that the pg_search_documents table could become out-of-sync with the actual records in your other tables.

data/lib/pg_search.rb

@@ -1,9 +1,13 @@
 require "active_record"
 require "active_support/concern"
+require "active_support/core_ext/module/attribute_accessors"
 
 module PgSearch
   extend ActiveSupport::Concern
 
+  mattr_accessor :multisearch_options
+  self.multisearch_options = {}
+
   module ClassMethods
     def pg_search_scope(name, options)
       self.scope(
@@ -26,8 +30,8 @@ module PgSearch
   end
 
   class << self
-    def multisearch(query)
-      PgSearch::Document.search(query)
+    def multisearch(*args)
+      PgSearch::Document.search(*args)
     end
 
     def disable_multisearch

data/lib/pg_search/document.rb

@@ -8,7 +8,14 @@ module PgSearch
 
     before_validation :update_content
 
-    pg_search_scope :search, :against => :content
+    pg_search_scope :search, lambda { |*args|
+      if PgSearch.multisearch_options.respond_to?(:call)
+        options = PgSearch.multisearch_options.call(*args)
+      else
+        options = PgSearch.multisearch_options.reverse_merge(:query => args.first)
+      end
+      options.reverse_merge(:against => :content)
+    }
 
     private
 

data/lib/pg_search/features/tsearch.rb

@@ -37,7 +37,7 @@ module PgSearch
         @columns.map { |column| column.to_sql }.join(" || ' ' || ")
       end
 
-      DISALLOWED_TSQUERY_CHARACTERS = /['?\-\\:]/
+      DISALLOWED_TSQUERY_CHARACTERS = /['?\\:]/
 
       def tsquery_for_term(term)
         sanitized_term = term.gsub(DISALLOWED_TSQUERY_CHARACTERS, " ")

data/lib/pg_search/version.rb

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

data/spec/pg_search_spec.rb

@@ -344,14 +344,11 @@ describe "an ActiveRecord model which includes PgSearch" do
           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')
+            included = ModelWithPgSearch.create!(:title => 'foo-bar')
+            excluded = ModelWithPgSearch.create!(:title => 'foo bar')
 
             results = ModelWithPgSearch.search_title_with_prefixes("foo-bar")
-            results.should =~ included
+            results.should include(included)
             results.should_not include(excluded)
           end
         end
@@ -703,14 +700,77 @@ describe "an ActiveRecord model which includes PgSearch" do
   end
 
   describe ".multisearch" do
-    subject { PgSearch.multisearch(query) }
-    let(:query) { double(:query) }
-    let(:relation) { double(:relation) }
-    before do
-      PgSearch::Document.should_receive(:search).with(query).and_return(relation)
+    with_table "pg_search_documents", {}, &DOCUMENTS_SCHEMA
+
+    describe "delegation to PgSearch::Document.search" do
+      subject { PgSearch.multisearch(query) }
+
+      let(:query) { double(:query) }
+      let(:relation) { double(:relation) }
+      before do
+        PgSearch::Document.should_receive(:search).with(query).and_return(relation)
+      end
+
+      it { should == relation }
+    end
+
+    context "with PgSearch.multisearch_options set to a Hash" do
+      before { PgSearch.stub(:multisearch_options).and_return({:using => :dmetaphone}) }
+      subject { PgSearch.multisearch(query).map(&:searchable) }
+
+      with_model :MultisearchableModel do
+        table do |t|
+          t.string :title
+        end
+        model do
+          include PgSearch
+          multisearchable :against => :title
+        end
+      end
+
+      let!(:soundalike_record) { MultisearchableModel.create!(:title => 'foning') }
+      let(:query) { "Phoning" }
+      it { should include(soundalike_record) }
     end
 
-    it { should == relation }
+    context "with PgSearch.multisearch_options set to a Proc" do
+      subject { PgSearch.multisearch(query, soundalike).map(&:searchable) }
+
+      before do
+        PgSearch.stub(:multisearch_options).and_return do
+          lambda do |query, soundalike|
+            if soundalike
+              {:using => :dmetaphone, :query => query}
+            else
+              {:query => query}
+            end
+          end
+        end
+      end
+
+      with_model :MultisearchableModel do
+        table do |t|
+          t.string :title
+        end
+        model do
+          include PgSearch
+          multisearchable :against => :title
+        end
+      end
+
+      let!(:soundalike_record) { MultisearchableModel.create!(:title => 'foning') }
+      let(:query) { "Phoning" }
+
+      context "with soundalike true" do
+        let(:soundalike) { true }
+        it { should include(soundalike_record) }
+      end
+
+      context "with soundalike false" do
+        let(:soundalike) { false }
+        it { should_not include(soundalike_record) }
+      end
+    end
   end
 
   describe ".disable_multisearch" do

data/spec/spec_helper.rb

@@ -7,7 +7,9 @@ begin
                                           :username => ('postgres' if ENV["TRAVIS"]),
                                           :min_messages => 'warning')
   connection = ActiveRecord::Base.connection
+  postgresql_version = connection.send(:postgresql_version)
   connection.execute("SELECT 1")
+  puts "postgresql_version = #{postgresql_version}"
 rescue PGError => e
   puts "-" * 80
   puts "Unable to connect to database.  Please run:"
@@ -17,40 +19,40 @@ rescue PGError => e
   raise e
 end
 
-def install_contrib_module_if_missing(name, query, expected_result)
+def install_extension_if_missing(name, query, expected_result)
   connection = ActiveRecord::Base.connection
   result = connection.select_value(query)
   raise "Unexpected output for #{query}: #{result.inspect}" unless result.downcase == expected_result.downcase
 rescue => e
   begin
-    share_path = `pg_config --sharedir`.strip
-    ActiveRecord::Base.connection.execute File.read(File.join(share_path, 'contrib', "#{name}.sql"))
-    puts $!.message
-  rescue
+    if postgresql_version >= 90100
+      ActiveRecord::Base.connection.execute "CREATE EXTENSION #{name};"
+    else
+      share_path = `pg_config --sharedir`.strip
+      ActiveRecord::Base.connection.execute File.read(File.join(share_path, 'contrib', "#{name}.sql"))
+      puts $!.message
+    end
+  rescue => e2
     puts "-" * 80
     puts "Please install the #{name} contrib module"
     puts "-" * 80
-    raise e
+    raise e2
   end
 end
 
-install_contrib_module_if_missing("pg_trgm", "SELECT 'abcdef' % 'cdef'", "t")
-unless connection.send(:postgresql_version) < 90000
-  install_contrib_module_if_missing("unaccent", "SELECT unaccent('foo')", "foo")
+install_extension_if_missing("pg_trgm", "SELECT 'abcdef' % 'cdef'", "t")
+unless postgresql_version < 90000
+  install_extension_if_missing("unaccent", "SELECT unaccent('foo')", "foo")
 end
-install_contrib_module_if_missing("fuzzystrmatch", "SELECT dmetaphone('foo')", "f")
+install_extension_if_missing("fuzzystrmatch", "SELECT dmetaphone('foo')", "f")
 
-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')))
+if 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', 'dmetaphone.sql')))
+  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')))
 
 require "with_model"
 

metadata

@@ -1,46 +1,60 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: pg_search
-version: !ruby/object:Gem::Version
-  version: 0.3.3
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 4
+  version: 0.3.4
 platform: ruby
-authors:
+authors: 
 - Case Commons, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-22 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-11-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: activerecord
-  requirement: &70192130541140 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
   type: :runtime
-  prerelease: false
-  version_requirements: *70192130541140
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: activesupport
-  requirement: &70192130540020 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
   type: :runtime
-  prerelease: false
-  version_requirements: *70192130540020
-description: PgSearch builds ActiveRecord named scopes that take advantage of PostgreSQL's
-  full text search
-email:
+  version_requirements: *id002
+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
@@ -69,7 +83,6 @@ files:
 - lib/pg_search/tasks.rb
 - lib/pg_search/version.rb
 - pg_search.gemspec
-- script/setup-contrib
 - spec/associations_spec.rb
 - spec/pg_search/document_spec.rb
 - spec/pg_search/multisearch_spec.rb
@@ -84,30 +97,38 @@ 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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      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

data/script/setup-contrib

@@ -1,12 +0,0 @@
-#!/bin/sh
-POSTGRESQL_VERSION=`pg_config --version | awk '{print $2}'`
-
-cd /tmp
-test -e /tmp/postgresql-$POSTGRESQL_VERSION.tar.bz2 || wget http://ftp9.us.postgresql.org/pub/mirrors/postgresql/source/v$POSTGRESQL_VERSION/postgresql-$POSTGRESQL_VERSION.tar.bz2
-test -d /tmp/postgresql-$POSTGRESQL_VERSION || tar zxvf postgresql-$POSTGRESQL_VERSION.tar.bz2
-cd postgresql-$POSTGRESQL_VERSION && eval ./configure `pg_config --configure` && make
-cd contrib/unaccent && make && make install
-cd ..
-cd contrib/pg_trgm && make && make install
-cd ..
-cd contrib/fuzzystrmatch && make && make install