pg_search 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60b69d6e0600c725eba8d5f820eb05439982824a
-  data.tar.gz: d1f90c57f0d2db953516b2edf99127b0326be044
+  metadata.gz: 56abc4100a0dcd75ed558ec0ec631d53088ab5bf
+  data.tar.gz: 33edaaa054f61e59efa18c8e96f0ecd9cc12630c
 SHA512:
-  metadata.gz: 6157156f723baccc67229b771852de1adf1d21ffa5bc41e4a593908453c7af7125e1ae79ba46a0fa91de593e01c3b3117858e284c2e70b0cb9c7b4dd48184a27
-  data.tar.gz: 60a6c495d334f7af8dc4f98f9c20637de6058c218b1e35d98e1d298d923fa4bf6199ec456b8c6a5c1ab357d6c44e4b40348e16a99b92a03063dd8931fc4fa4d4
+  metadata.gz: d4e3fb0b2571d4fec4f447f1f6df9108b70e6219c7381e9d79e95d559bb063389a4ded5f50db1c320a1564647a83a9050ba6dfb32f3b87adae9866028c7633b8
+  data.tar.gz: f618f99de2af02e89346f6cde00036e6c56b88292511b434140276d470b6033da2717ebc132b5364e4ba9bdf32afc29ed6811098c532916db6973154b0db0d9e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # pg_search changelog
 
+## 0.7.5
+
+*   Add option to make feature available only for sorting. (Brent Wheeldon)
+
 ## 0.7.4
 
 *   Fix which STI class name is used for searchable_type for PgSearch::Document. (Ewan McDougall)

data/README.md

@@ -1,17 +1,10 @@
-# pg_search
+# [pg_search](http://github.com/Casecommons/pg_search/)
 
-http://github.com/Casecommons/pg_search/
-
-[<img src="https://secure.travis-ci.org/Casecommons/pg_search.png?branch=master"
-alt="Build Status" />](http://travis-ci.org/Casecommons/pg_search)
-[<img src="https://gemnasium.com/Casecommons/pg_search.png" alt="Dependency Status"
-/>](https://gemnasium.com/Casecommons/pg_search)
-[<img src="https://codeclimate.com/github/Casecommons/pg_search.png"
-/>](https://codeclimate.com/github/Casecommons/pg_search) 
-[<img src="https://coveralls.io/repos/Casecommons/pg_search/badge.png?branch=master"
-alt="Coverage Status" />](https://coveralls.io/r/Casecommons/pg_search) 
-[<img src="https://badge.fury.io/rb/pg_search.png" alt="Gem Version"
-/>](http://badge.fury.io/rb/pg_search)
+[![Build Status](https://secure.travis-ci.org/Casecommons/pg_search.svg?branch=master)](https://travis-ci.org/Casecommons/pg_search)
+[![Code Climate](https://img.shields.io/codeclimate/github/Casecommons/pg_search.svg)](https://codeclimate.com/github/Casecommons/pg_search)
+[![Coverage Status](https://img.shields.io/coveralls/Casecommons/pg_search/master.svg)](https://coveralls.io/r/Casecommons/pg_search)
+[![Gem Version](https://badge.fury.io/rb/pg_search.svg)](https://rubygems.org/gems/pg_search)
+[![Dependency Status](https://gemnasium.com/Casecommons/pg_search.svg)](https://gemnasium.com/Casecommons/pg_search)
 
 ## DESCRIPTION
 
@@ -670,6 +663,30 @@ Number.search_any_word('one two three') # => [one, two, three]
 Number.search_all_words('one two three') # => []
 ```
 
+##### :sort_only
+
+Setting this attribute to true will make this feature available for sorting,
+but will not include it in the query's WHERE condition.
+
+```ruby
+class Person < ActiveRecord::Base
+  include PgSearch
+  pg_search_scope :search,
+                  :against => :name,
+                  :using => {
+                    :tsearch => {:any_word => true}
+                    :dmetaphone => {:any_word => true, :sort_only => true}
+                  }
+end
+
+exact = Person.create!(:name => 'ash hines')
+one_exact_one_close = Person.create!(:name => 'ash heinz')
+one_exact = Person.create!(:name => 'ash smith')
+one_close = Person.create!(:name => 'leigh heinz')
+
+Person.search('ash hines') # => [exact, one_exact_one_close, one_exact]
+```
+
 #### :dmetaphone (Double Metaphone soundalike search)
 
 [Double Metaphone](http://en.wikipedia.org/wiki/Double_Metaphone) is an

data/lib/pg_search/document.rb

@@ -1,12 +1,14 @@
-require "logger"
+require 'logger'
 
 module PgSearch
   class Document < ActiveRecord::Base
     include PgSearch
+
     self.table_name = 'pg_search_documents'
     belongs_to :searchable, :polymorphic => true
 
-    before_validation :update_content
+    before_validation :update_content,
+                      :unless => Proc.new { |doc| doc.searchable.nil? }
 
     # The logger might not have loaded yet.
     # https://github.com/Casecommons/pg_search/issues/26

data/lib/pg_search/features/tsearch.rb

@@ -54,25 +54,8 @@ module PgSearch
       end
 
       def tsdocument
-        tsdocument_terms = []
-
-        columns_to_use = options[:tsvector_column] ?
-                           columns.select { |c| c.is_a?(PgSearch::Configuration::ForeignColumn) } :
-                           columns
-
-        if columns_to_use.present?
-          tsdocument_terms << columns_to_use.map do |search_column|
-            tsvector = Arel::Nodes::NamedFunction.new(
-              "to_tsvector",
-              [dictionary, Arel.sql(normalize(search_column.to_sql))]
-            ).to_sql
-
-            if search_column.weight.nil?
-              tsvector
-            else
-              "setweight(#{tsvector}, #{connection.quote(search_column.weight)})"
-            end
-          end.join(" || ")
+        tsdocument_terms = (columns_to_use || []).map do |search_column|
+          column_to_tsvector(search_column)
         end
 
         if options[:tsvector_column]
@@ -107,6 +90,27 @@ module PgSearch
       def arel_wrap(sql_string)
         Arel::Nodes::Grouping.new(Arel.sql(sql_string))
       end
+
+      def columns_to_use
+        if options[:tsvector_column]
+          columns.select { |c| c.is_a?(PgSearch::Configuration::ForeignColumn) }
+        else
+          columns
+        end
+      end
+
+      def column_to_tsvector(search_column)
+        tsvector = Arel::Nodes::NamedFunction.new(
+          "to_tsvector",
+          [dictionary, Arel.sql(normalize(search_column.to_sql))]
+        ).to_sql
+
+        if search_column.weight.nil?
+          tsvector
+        else
+          "setweight(#{tsvector}, #{connection.quote(search_column.weight)})"
+        end
+      end
     end
   end
 end

data/lib/pg_search/migration/associated_against_generator.rb

@@ -1,22 +1,10 @@
-require "rails/generators/base"
+require 'pg_search/migration/generator'
 
 module PgSearch
   module Migration
-    class AssociatedAgainstGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
-
-      def create_migration
-        now = Time.now.utc
-        filename = "#{now.strftime('%Y%m%d%H%M%S')}_add_pg_search_associated_against_support_functions.rb"
-        template "add_pg_search_associated_against_support_functions.rb.erb", "db/migrate/#{filename}"
-      end
-
-      private
-
-      def read_sql_file(filename)
-        sql_directory = File.expand_path("../../../../sql", __FILE__)
-        source_path = File.join(sql_directory, "#{filename}.sql")
-        File.read(source_path)
+    class AssociatedAgainstGenerator < Generator
+      def migration_name
+        'add_pg_search_associated_against_support_functions'.freeze
       end
     end
   end

data/lib/pg_search/migration/dmetaphone_generator.rb

@@ -1,22 +1,10 @@
-require "rails/generators/base"
+require 'pg_search/migration/generator'
 
 module PgSearch
   module Migration
-    class DmetaphoneGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
-
-      def create_migration
-        now = Time.now.utc
-        filename = "#{now.strftime('%Y%m%d%H%M%S')}_add_pg_search_dmetaphone_support_functions.rb"
-        template "add_pg_search_dmetaphone_support_functions.rb.erb", "db/migrate/#{filename}"
-      end
-
-      private
-
-      def read_sql_file(filename)
-        sql_directory = File.expand_path("../../../../sql", __FILE__)
-        source_path = File.join(sql_directory, "#{filename}.sql")
-        File.read(source_path)
+    class DmetaphoneGenerator < Generator
+      def migration_name
+        'add_pg_search_dmetaphone_support_functions'.freeze
       end
     end
   end

data/lib/pg_search/migration/generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/base'
+
+module PgSearch
+  module Migration
+    class Generator < Rails::Generators::Base
+      hide!
+
+      def self.inherited(subclass)
+        super
+        subclass.source_root File.expand_path('../templates', __FILE__)
+      end
+
+      def create_migration
+        now = Time.now.utc
+        filename = "#{now.strftime('%Y%m%d%H%M%S')}_#{migration_name}.rb"
+        template "#{migration_name}.rb.erb", "db/migrate/#{filename}"
+      end
+
+      private
+
+      def read_sql_file(filename)
+        sql_directory = File.expand_path('../../../../sql', __FILE__)
+        source_path = File.join(sql_directory, "#{filename}.sql")
+        File.read(source_path).strip
+      end
+    end
+  end
+end

data/lib/pg_search/migration/multisearch_generator.rb

@@ -1,14 +1,10 @@
-require "rails/generators/base"
+require 'pg_search/migration/generator'
 
 module PgSearch
   module Migration
-    class MultisearchGenerator < Rails::Generators::Base
-      source_root Pathname.new(File.dirname(__FILE__)).join("templates")
-
-      def create_migration
-        now = Time.now.utc
-        filename = "#{now.strftime('%Y%m%d%H%M%S')}_create_pg_search_documents.rb"
-        copy_file "create_pg_search_documents.rb", "db/migrate/#{filename}"
+    class MultisearchGenerator < Generator
+      def migration_name
+        'create_pg_search_documents'
       end
     end
   end

data/lib/pg_search/migration/templates/add_pg_search_associated_against_support_functions.rb.erb

@@ -3,7 +3,7 @@ class AddPgSearchAssociatedAgainstSupportFunctions < ActiveRecord::Migration
     say_with_time("Adding support functions for pg_search :associated_against") do
       if ActiveRecord::Base.connection.send(:postgresql_version) < 80400
         execute <<-'SQL'
-          <%= read_sql_file "array_agg" %>
+<%= read_sql_file "array_agg" %>
         SQL
       end
     end
@@ -13,7 +13,7 @@ class AddPgSearchAssociatedAgainstSupportFunctions < ActiveRecord::Migration
     say_with_time("Dropping support functions for pg_search :associated_against") do
       if ActiveRecord::Base.connection.send(:postgresql_version) < 80400
         execute <<-'SQL'
-          <%= read_sql_file "uninstall_array_agg" %>
+<%= read_sql_file "uninstall_array_agg" %>
         SQL
       end
     end

data/lib/pg_search/scope_options.rb

@@ -33,7 +33,9 @@ module PgSearch
     delegate :connection, :quoted_table_name, :to => :@model
 
     def conditions
-      config.features.map do |feature_name, feature_options|
+      config.features.reject do |feature_name, feature_options|
+        feature_options && feature_options[:sort_only]
+      end.map do |feature_name, feature_options|
         feature_for(feature_name).conditions
       end.inject do |accumulator, expression|
         Arel::Nodes::Or.new(accumulator, expression)

data/lib/pg_search/version.rb

@@ -1,3 +1,3 @@
 module PgSearch
-  VERSION = "0.7.4".freeze
+  VERSION = "0.7.5".freeze
 end

data/pg_search.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'pry'
-  s.add_development_dependency 'rspec', '>= 2.14'
+  s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'with_model'
 
   s.required_ruby_version = ">= 1.9.2"

data/spec/integration/associations_spec.rb

@@ -34,8 +34,8 @@ describe PgSearch do
         ]
 
         results = ModelWithoutAgainst.with_another('abcdef')
-        results.map(&:title).should =~ included.map(&:title)
-        results.should_not include(excluded)
+        expect(results.map(&:title)).to match_array(included.map(&:title))
+        expect(results).not_to include(excluded)
       end
     end
 
@@ -70,8 +70,8 @@ describe PgSearch do
                                                  :another_model => AssociatedModel.create!(:title => 'stuvwx'))
 
         results = ModelWithBelongsTo.with_associated('abcdef')
-        results.map(&:title).should =~ included.map(&:title)
-        results.should_not include(excluded)
+        expect(results.map(&:title)).to match_array(included.map(&:title))
+        expect(results).not_to include(excluded)
       end
     end
 
@@ -113,8 +113,8 @@ describe PgSearch do
         ])
 
         results = ModelWithHasMany.with_associated('foo bar')
-        results.map(&:title).should =~ included.map(&:title)
-        results.should_not include(excluded)
+        expect(results.map(&:title)).to match_array(included.map(&:title))
+        expect(results).not_to include(excluded)
       end
 
       it "uses an unscoped relation of the assocated model" do
@@ -129,8 +129,8 @@ describe PgSearch do
         ]
 
         results = ModelWithHasMany.limit(1).order("id ASC").with_associated('foo bar')
-        results.map(&:title).should =~ included.map(&:title)
-        results.should_not include(excluded)
+        expect(results.map(&:title)).to match_array(included.map(&:title))
+        expect(results).not_to include(excluded)
       end
 
     end
@@ -192,8 +192,8 @@ describe PgSearch do
           ]
 
           results = ModelWithManyAssociations.with_associated('foo bar')
-          results.map(&:title).should =~ included.map(&:title)
-          excluded.each { |object| results.should_not include(object) }
+          expect(results.map(&:title)).to match_array(included.map(&:title))
+          excluded.each { |object| expect(results).not_to include(object) }
         end
       end
 
@@ -247,8 +247,8 @@ describe PgSearch do
           ]
 
           results = ModelWithDoubleAssociation.with_associated('foo bar')
-          results.map(&:title).should =~ included.map(&:title)
-          excluded.each { |object| results.should_not include(object) }
+          expect(results.map(&:title)).to match_array(included.map(&:title))
+          excluded.each { |object| expect(results).not_to include(object) }
         end
       end
     end
@@ -300,9 +300,9 @@ describe PgSearch do
 
         results = ModelWithAssociation.with_associated('foo bar')
 
-        results.to_sql.scan("INNER JOIN").length.should == 1
-        included.each { |object| results.should include(object) }
-        excluded.each { |object| results.should_not include(object) }
+        expect(results.to_sql.scan("INNER JOIN").length).to eq(1)
+        included.each { |object| expect(results).to include(object) }
+        excluded.each { |object| expect(results).not_to include(object) }
       end
 
     end
@@ -339,8 +339,8 @@ describe PgSearch do
         ]
 
         results = Model.with_associated('123')
-        results.map(&:number).should =~ included.map(&:number)
-        results.should_not include(excluded)
+        expect(results.map(&:number)).to match_array(included.map(&:number))
+        expect(results).not_to include(excluded)
       end
     end
 
@@ -375,8 +375,8 @@ describe PgSearch do
         results = Parent.search_name('bar.foo').includes(:children)
         results.to_a
 
-        results.should include(included)
-        results.should_not include(excluded)
+        expect(results).to include(included)
+        expect(results).not_to include(excluded)
       end
     end
   end
@@ -422,8 +422,8 @@ describe PgSearch do
 
       results = ModelWithAssociation.joins(:associated_models).merge(relation)
 
-      results.should include(*included)
-      results.should_not include(*excluded)
+      expect(results).to include(*included)
+      expect(results).not_to include(*excluded)
     end
   end
 
@@ -463,8 +463,8 @@ describe PgSearch do
 
       results = company.positions.search('teller 1')
 
-      results.should include(*included)
-      results.should_not include(*excluded)
+      expect(results).to include(*included)
+      expect(results).not_to include(*excluded)
     end
   end
 
@@ -505,8 +505,8 @@ describe PgSearch do
 
       results = company.positions.search('teller 1')
 
-      results.should include(*included)
-      results.should_not include(*excluded)
+      expect(results).to include(*included)
+      expect(results).not_to include(*excluded)
     end
   end
 end

data/spec/integration/pagination_spec.rb

@@ -23,8 +23,8 @@ describe "pagination" do
       best = PaginatedModel.create!(:name => "foo foo foo")
       good = PaginatedModel.create!(:name => "foo bar bar")
 
-      PaginatedModel.page(1).search_name("foo").should == [best, better]
-      PaginatedModel.page(2).search_name("foo").should == [good]
+      expect(PaginatedModel.page(1).search_name("foo")).to eq([best, better])
+      expect(PaginatedModel.page(2).search_name("foo")).to eq([good])
     end
 
     it "is chainable after a search scope" do
@@ -32,8 +32,8 @@ describe "pagination" do
       best = PaginatedModel.create!(:name => "foo foo foo")
       good = PaginatedModel.create!(:name => "foo bar bar")
 
-      PaginatedModel.search_name("foo").page(1).should == [best, better]
-      PaginatedModel.search_name("foo").page(2).should == [good]
+      expect(PaginatedModel.search_name("foo").page(1)).to eq([best, better])
+      expect(PaginatedModel.search_name("foo").page(2)).to eq([good])
     end
   end
 end