pg_search 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d495a89c4bddfe4c4d367fb1cc8e4c5b1bea048
-  data.tar.gz: 611249f3cddce656579b5f4618a4d8a26ed77f8d
+  metadata.gz: 55ed2cdc0eaecdb0dcb05ee5fcf7e7460556669d
+  data.tar.gz: 8ff17add1a0a7c7a16dd6501b6335e5d364b07b4
 SHA512:
-  metadata.gz: b6bfca34ff32c71bc153173f6cd5ea293ab35bea8aa55cdabd53388b687e56b273402b2b822789994d378fed58e3591a1a91c724cfc91f1085edba9d988773f6
-  data.tar.gz: d03fc9fe66c02fb33744ec86ab12ec97d662c3eaff075da0c1b0f6f994e3c3f4c8da47045d4ce227bb6552e8890d95729d1cc679e80115378aabd9f7fd4b2324
+  metadata.gz: 1acf5bc208de87a781c1c2ddaa3b44b33609afb8927cd8bbbb256a9a9caf099f3c2507232a0d9f2a9ad45acaf997e3590bbcbac6d3cb4936515e6874c3cb4ea1
+  data.tar.gz: d569da3e3f8aa7b205596fbce5d1bd72e0db4dab9576ac9331b810b4dbcefd80f77918a8ce51cfb3e944f63520f4166e86bd5db883b01c0e2b8f97e3bff7018d

data/.rubocop_todo.yml

@@ -1,37 +1,84 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-12-12 15:10:11 -0600 using RuboCop version 0.28.0.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-01-25 14:11:25 -0600 using RuboCop version 0.36.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/UnneededDisable:
+  Exclude:
+    - 'lib/pg_search/features/tsearch.rb'
+    - 'lib/pg_search/scope_options.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/Casecmp:
+  Exclude:
+    - 'spec/support/database.rb'
+
 # Offense count: 27
 Style/Documentation:
   Enabled: false
 
-# Offense count: 16
+# Offense count: 3
 # Cop supports --auto-correct.
-Style/NumericLiterals:
-  MinDigits: 6
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: when_needed, always
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'lib/pg_search/migration/associated_against_generator.rb'
+    - 'lib/pg_search/migration/dmetaphone_generator.rb'
+    - 'lib/pg_search/version.rb'
 
-# Offense count: 2
+# Offense count: 1
+Style/IfInsideElse:
+  Exclude:
+    - 'lib/pg_search/multisearchable.rb'
+
+# Offense count: 26
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/PercentQLiterals:
+# Configuration parameters: SupportedStyles, IndentationWidth.
+# SupportedStyles: special_inside_parentheses, consistent, align_brackets
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
+# SupportedStyles: aligned, indented
+Style/MultilineMethodCallIndentation:
   Enabled: false
 
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/pg_search/configuration.rb'
+    - 'lib/pg_search/scope_options.rb'
+
+# Offense count: 16
+# Cop supports --auto-correct.
+Style/NumericLiterals:
+  MinDigits: 6
+
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/PerlBackrefs:
-  Enabled: false
+  Exclude:
+    - 'lib/pg_search/scope_options.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/Proc:
-  Enabled: false
+  Exclude:
+    - 'lib/pg_search/document.rb'
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: compact, exploded
 Style/RaiseArgs:
   Enabled: false
 
@@ -39,78 +86,114 @@ Style/RaiseArgs:
 # Cop supports --auto-correct.
 # Configuration parameters: AllowMultipleReturnValues.
 Style/RedundantReturn:
-  Enabled: false
+  Exclude:
+    - 'lib/pg_search/scope_options.rb'
 
-# Offense count: 10
+# Offense count: 11
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: only_raise, only_fail, semantic
 Style/SignalException:
-  Enabled: false
+  Exclude:
+    - 'lib/pg_search.rb'
+    - 'lib/pg_search/configuration.rb'
+    - 'lib/pg_search/features/tsearch.rb'
+    - 'lib/pg_search/multisearch/rebuilder.rb'
+    - 'lib/pg_search/normalizer.rb'
+    - 'lib/pg_search/scope_options.rb'
+    - 'lib/pg_search/tasks.rb'
+    - 'spec/lib/pg_search_spec.rb'
+    - 'spec/support/database.rb'
 
 # Offense count: 2
 # Cop supports --auto-correct.
 Style/SpaceAfterComma:
-  Enabled: false
+  Exclude:
+    - 'lib/pg_search/configuration.rb'
+    - 'lib/pg_search/tasks.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: space, no_space
 Style/SpaceAroundEqualsInParameterDefault:
   Enabled: false
 
-# Offense count: 1
+# Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: space, no_space
 Style/SpaceBeforeBlockBraces:
   Enabled: false
 
-# Offense count: 2
+# Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
 Style/SpaceInsideBlockBraces:
   Enabled: false
 
 # Offense count: 76
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+# SupportedStyles: space, no_space
 Style/SpaceInsideHashLiteralBraces:
   Enabled: false
 
 # Offense count: 2
 # Cop supports --auto-correct.
 Style/SpaceInsideParens:
-  Enabled: false
+  Exclude:
+    - 'spec/lib/pg_search/multisearch/rebuilder_spec.rb'
 
 # Offense count: 3
 # Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: use_perl_names, use_english_names
 Style/SpecialGlobalVars:
-  Enabled: false
+  EnforcedStyle: use_english_names
 
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: IgnoredMethods.
+# IgnoredMethods: respond_to
 Style/SymbolProc:
-  Enabled: false
+  Exclude:
+    - 'lib/pg_search/features/feature.rb'
+    - 'lib/pg_search/multisearch/rebuilder.rb'
 
-# Offense count: 4
+# Offense count: 5
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: final_newline, final_blank_line
 Style/TrailingBlankLines:
-  Enabled: false
+  Exclude:
+    - 'Guardfile'
+    - 'lib/pg_search/extensions/arel.rb'
+    - 'lib/pg_search/migration/multisearch_generator.rb'
+    - 'lib/pg_search/multisearch.rb'
+    - 'spec/integration/single_table_inheritance_spec.rb'
 
 # Offense count: 9
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
-Style/TrailingComma:
-  Enabled: false
+# SupportedStyles: comma, consistent_comma, no_comma
+Style/TrailingCommaInLiteral:
+  Exclude:
+    - 'spec/integration/pg_search_spec.rb'
+    - 'spec/lib/pg_search/features/dmetaphone_spec.rb'
+    - 'spec/lib/pg_search/features/tsearch_spec.rb'
 
-# Offense count: 6
+# Offense count: 2
 # Cop supports --auto-correct.
 Style/UnneededPercentQ:
-  Enabled: false
+  Exclude:
+    - 'pg_search.gemspec'
 
 # Offense count: 3
 # Cop supports --auto-correct.
-# Configuration parameters: WordRegex.
+# Configuration parameters: SupportedStyles, WordRegex.
+# SupportedStyles: percent, brackets
 Style/WordArray:
-  MinSize: 2
+  EnforcedStyle: percent
+  MinSize: 3

data/.travis.yml

@@ -2,10 +2,11 @@ language: ruby
 sudo: false
 
 rvm:
-  - "1.9"
-  - "2.0"
-  - "2.1"
+  - "2.3.1"
   - "2.2"
+  - "2.1"
+  - "2.0"
+  - "1.9"
   - jruby-19mode
   - jruby-9.0.0.0
 

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 # pg_search changelog
 
+## 1.0.6
+*   Add support for highlighting the matching portion of a search result. (Jose Galisteo)
+*   Add `:update_if` option to control when PgSearch::Document gets updated. (Adam Becker)
+*   Add `:additional_attributes` option for adding additional attributes to PgSearch::Document
+
 ## 1.0.5
 
-*   Clean up rank table aliasing (Adam Milligan)
-*   Fix issue when using `#with_pg_search_rank` across a join (Reid Lynch)
+*   Clean up rank table aliasing. (Adam Milligan)
+*   Fix issue when using `#with_pg_search_rank` across a join. (Reid Lynch)
 
 ## 1.0.4
 

data/Gemfile

@@ -12,13 +12,6 @@ end
 
 gem 'activerecord', ENV['ACTIVE_RECORD_VERSION'] if ENV['ACTIVE_RECORD_VERSION']
 
-group :development do
-  gem 'guard-rspec', :require => false
-  gem 'rb-inotify', :require => false
-  gem 'rb-fsevent', :require => false
-  gem 'rb-fchange', :require => false
-end
-
 group :test do
   gem "codeclimate-test-reporter", require: nil
 end

data/README.md

@@ -7,6 +7,7 @@
 [![Dependency Status](https://img.shields.io/gemnasium/Casecommons/pg_search.svg?style=flat)](https://gemnasium.com/Casecommons/pg_search)
 [![Inline docs](http://inch-ci.org/github/Casecommons/pg_search.svg?branch=master&style=flat)](http://inch-ci.org/github/Casecommons/pg_search)
 [![Join the chat at https://gitter.im/Casecommons/pg_search](https://img.shields.io/badge/gitter-join%20chat-blue.svg)](https://gitter.im/Casecommons/pg_search?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Stories in Ready](https://badge.waffle.io/Casecommons/pg_search.svg?label=ready&title=Ready)](https://waffle.io/Casecommons/pg_search)
 
 ## DESCRIPTION
 
@@ -239,10 +240,12 @@ receive SQL requests when necessary.
 ```ruby
 PgSearch.multisearch("Bertha").limit(10)
 PgSearch.multisearch("Juggler").where(:searchable_type => "Occupation")
-PgSearch.multisearch("Alamo").page(3).per_page(30)
+PgSearch.multisearch("Alamo").page(3).per(30)
 PgSearch.multisearch("Diagonal").find_each do |document|
   puts document.searchable.updated_at
 end
+PgSearch.multisearch("Moro").reorder("").group(:searchable_type).count(:all)
+PgSearch.multisearch("Square").includes(:searchable)
 ```
 
 #### Configuring multi-search
@@ -733,6 +736,34 @@ one_close = Person.create!(:name => 'leigh heinz')
 Person.search('ash hines') # => [exact, one_exact_one_close, one_exact]
 ```
 
+##### :highlight (PostgreSQL 9.0 and newer only)
+
+Adding .with_pg_search_highlight after the pg_search_scope you can access to
+`pg_highlight` attribute for each object.
+
+
+```ruby
+class Person < ActiveRecord::Base
+  include PgSearch
+  pg_search_scope :search,
+                  :against => :bio,
+                  :using => {
+                    :tsearch => {
+                      :start_sel => '<b>',
+                      :stop_sel => '</b>'
+                    }
+                  }
+end
+
+Person.create!(:bio => "Born in rural Alberta, where the buffalo roam.")
+
+first_match = Person.search("Alberta").with_pg_search_highlight.first
+first_match.pg_search_highlight # => "Born in rural <b>Alberta</b>, where the buffalo roam."
+```
+
+By default, it will add the delimiters `<b>` and `</b>` around the matched text. You can customize these delimiters and the number of fragments returned with the `:start_sel`, `stop_sel`, and `max_fragments` options.
+
+
 #### :dmetaphone (Double Metaphone soundalike search)
 
 [Double Metaphone](http://en.wikipedia.org/wiki/Double_Metaphone) is an
@@ -804,7 +835,9 @@ Website.kinda_spelled_like("Yahoo!") # => [yahooo, yohoo]
 By default, trigram searches find records which have a similarity of at least 0.3
 using pg_trgm's calculations. You may specify a custom threshold if you prefer.
 Higher numbers match more strictly, and thus return fewer results. Lower numbers
-match more permissively, letting in more results.
+match more permissively, letting in more results. Please note that setting a trigram
+threshold will force a table scan as the derived query uses the
+`similarity()` function instead of the `%` operator.
 
 ```ruby
 class Vegetable < ActiveRecord::Base
@@ -1068,7 +1101,7 @@ queried table.
 ```ruby
 shirt_brands = ShirtBrand.search_by_name("Penguin")
   .joins(:shirt_sizes)
-  .group_by('shirt_brands.id, #{PgSearch::Configuration.alias('shirt_brands')}.rank')
+  .group("shirt_brands.id, #{PgSearch::Configuration.alias('shirt_brands')}.rank")
 ```
 
 ## ATTRIBUTIONS

data/lib/pg_search.rb

@@ -73,6 +73,9 @@ module PgSearch
     when :pg_search_rank
       raise PgSearchRankNotSelected.new unless respond_to?(:pg_search_rank)
       read_attribute(:pg_search_rank).to_f
+    when :pg_search_highlight
+      raise PgSearchHighlightNotSelected.new unless respond_to?(:pg_search_highlight)
+      read_attribute(:pg_search_highlight)
     else
       super
     end
@@ -82,6 +85,8 @@ module PgSearch
     case symbol
     when :pg_search_rank
       attributes.key?(:pg_search_rank)
+    when :pg_search_highlight
+      attributes.key?(:pg_search_highlight)
     else
       super
     end
@@ -90,9 +95,15 @@ module PgSearch
   class NotSupportedForPostgresqlVersion < StandardError; end
 
   class PgSearchRankNotSelected < StandardError
+    def message
+      "You must chain .with_pg_search_rank after the pg_search_scope to access the pg_search_rank attribute on returned records" # rubocop:disable Metrics/LineLength
+    end
+  end
+
+  class PgSearchHighlightNotSelected < StandardError
     # rubocop:disable Metrics/LineLength
     def message
-      "You must chain .with_pg_search_rank after the pg_search_scope to access the pg_search_rank attribute on returned records"
+      "You must chain .with_pg_search_highlight after the pg_search_scope to access the pg_search_highlight attribute on returned records"
     end
   end
 end

data/lib/pg_search/document.rb

@@ -7,9 +7,6 @@ module PgSearch
     self.table_name = 'pg_search_documents'
     belongs_to :searchable, :polymorphic => true
 
-    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
     def self.logger
@@ -25,13 +22,5 @@ module PgSearch
 
       {:against => :content}.merge(options)
     }
-
-    private
-
-    def update_content
-      methods = Array(searchable.pg_search_multisearchable_options[:against])
-      searchable_text = methods.map { |symbol| searchable.send(symbol) }.join(" ")
-      self.content = searchable_text
-    end
   end
 end

data/lib/pg_search/features/tsearch.rb

@@ -3,19 +3,15 @@ require "active_support/core_ext/module/delegation"
 
 module PgSearch
   module Features
-    class TSearch < Feature
+    class TSearch < Feature # rubocop:disable Metrics/ClassLength
       def self.valid_options
-        super + [:dictionary, :prefix, :negation, :any_word, :normalization, :tsvector_column]
+        super + [:dictionary, :prefix, :negation, :any_word, :normalization, :tsvector_column, :highlight]
       end
 
       def initialize(*args)
         super
-
-        if options[:prefix] && model.connection.send(:postgresql_version) < 80400 # rubocop:disable Style/GuardClause
-          raise PgSearch::NotSupportedForPostgresqlVersion.new(<<-MESSAGE.strip_heredoc)
-            Sorry, {:using => {:tsearch => {:prefix => true}}} only works in PostgreSQL 8.4 and above.")
-          MESSAGE
-        end
+        checks_for_highlight
+        checks_for_prefix
       end
 
       def conditions
@@ -28,8 +24,47 @@ module PgSearch
         arel_wrap(tsearch_rank)
       end
 
+      def highlight
+        arel_wrap(ts_headline)
+      end
+
       private
 
+      def checks_for_prefix
+        if options[:prefix] && model.connection.send(:postgresql_version) < 80400
+          raise PgSearch::NotSupportedForPostgresqlVersion.new(<<-MESSAGE.strip_heredoc)
+            Sorry, {:using => {:tsearch => {:prefix => true}}} only works in PostgreSQL 8.4 and above.")
+          MESSAGE
+        end
+      end
+
+      def checks_for_highlight
+        if options[:highlight] && model.connection.send(:postgresql_version) < 90000
+          raise PgSearch::NotSupportedForPostgresqlVersion.new(<<-MESSAGE.strip_heredoc)
+            Sorry, {:using => {:tsearch => {:highlight => true}}} only works in PostgreSQL 9.0 and above.")
+          MESSAGE
+        end
+      end
+
+      def ts_headline
+        "ts_headline((#{document}), (#{tsquery}), '#{ts_headline_options}')"
+      end
+
+      def ts_headline_options
+        return nil unless options[:highlight].is_a?(Hash)
+
+        headline_options = map_headline_options
+        headline_options.map{|key, value| "#{key} = #{value}" if value }.compact.join(", ")
+      end
+
+      def map_headline_options
+        {
+          "StartSel" => options[:highlight][:start_sel],
+          "StopSel" => options[:highlight][:stop_sel],
+          "MaxFragments" => options[:highlight][:max_fragments]
+        }
+      end
+
       DISALLOWED_TSQUERY_CHARACTERS = /['?\\:]/
 
       def tsquery_for_term(unsanitized_term) # rubocop:disable Metrics/AbcSize

data/lib/pg_search/multisearchable.rb

@@ -14,6 +14,27 @@ module PgSearch
       end
     end
 
+    def searchable_text
+      Array(pg_search_multisearchable_options[:against])
+        .map { |symbol| send(symbol) }
+        .join(" ")
+    end
+
+    def pg_search_document_attrs
+      {
+        content: searchable_text
+      }.tap do |h|
+        if (attrs = pg_search_multisearchable_options[:additional_attributes])
+          h.merge! attrs.to_proc.call(self)
+        end
+      end
+    end
+
+    def should_update_pg_search_document?
+      conditions = Array(pg_search_multisearchable_options[:update_if])
+      conditions.all? { |condition| condition.to_proc.call(self) }
+    end
+
     def update_pg_search_document # rubocop:disable Metrics/AbcSize
       if_conditions = Array(pg_search_multisearchable_options[:if])
       unless_conditions = Array(pg_search_multisearchable_options[:unless])
@@ -23,10 +44,18 @@ module PgSearch
         unless_conditions.all? { |condition| !condition.to_proc.call(self) }
 
       if should_have_document
-        pg_search_document ? pg_search_document.save : create_pg_search_document
+        create_or_update_pg_search_document
       else
         pg_search_document.destroy if pg_search_document
       end
     end
+
+    def create_or_update_pg_search_document
+      if !pg_search_document
+        create_pg_search_document(pg_search_document_attrs)
+      elsif should_update_pg_search_document?
+        pg_search_document.update_attributes(pg_search_document_attrs)
+      end
+    end
   end
 end

data/lib/pg_search/scope_options.rb

@@ -21,6 +21,7 @@ module PgSearch
         .order("#{rank_table_alias}.rank DESC, #{order_within_rank}")
         .extend(DisableEagerLoading)
         .extend(WithPgSearchRank)
+        .extend(WithPgSearchHighlight[feature_for(:tsearch)])
     end
 
     # workaround for https://github.com/Casecommons/pg_search/issues/14
@@ -30,6 +31,32 @@ module PgSearch
       end
     end
 
+    module WithPgSearchHighlight
+      def self.[](tsearch)
+        Module.new do
+          include WithPgSearchHighlight
+          define_method(:tsearch) { tsearch }
+        end
+      end
+
+      def tsearch
+        raise TypeError.new("You need to instantiate this module with []")
+      end
+
+      def with_pg_search_highlight
+        scope = self
+        scope.select(pg_search_highlight_field)
+      end
+
+      def pg_search_highlight_field
+        "(#{highlight}) AS pg_search_highlight, #{table_name}.*"
+      end
+
+      def highlight
+        tsearch.highlight.to_sql
+      end
+    end
+
     module WithPgSearchRank
       def with_pg_search_rank
         scope = self
@@ -103,7 +130,7 @@ module PgSearch
     end
 
     def subquery_join
-      if config.associations.any? # rubocop:disable Style/GuardClause
+      if config.associations.any?
         config.associations.map do |association|
           association.join(primary_key)
         end.join(' ')

data/lib/pg_search/version.rb

@@ -1,3 +1,3 @@
 module PgSearch
-  VERSION = "1.0.5".freeze
+  VERSION = "1.0.6".freeze
 end

data/pg_search.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require "pg_search/version"
 
 Gem::Specification.new do |s|
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rspec', '>= 3.3'
   s.add_development_dependency 'with_model', '>= 1.2'
-  s.add_development_dependency 'rubocop', '>= 0.30.0'
+  s.add_development_dependency 'rubocop', '>= 0.36'
 
   s.required_ruby_version = ">= 1.9.2"
 end

data/spec/integration/pg_search_spec.rb

@@ -618,6 +618,33 @@ describe "an Active Record model which includes PgSearch" do
         end
       end
 
+      describe "highlighting" do
+        before do
+          ["Strip Down", "Down", "Down and Out", "Won't Let You Down"].each do |name|
+            ModelWithPgSearch.create! :content => name
+          end
+        end
+
+        context "with highlight turned on" do
+          before do
+            ModelWithPgSearch.pg_search_scope :search_content,
+              :against => :content
+          end
+
+          it "adds a #pg_search_highlight method to each returned model record" do
+            result = ModelWithPgSearch.search_content("Strip Down").with_pg_search_highlight.first
+
+            expect(result.pg_search_highlight).to be_a(String)
+          end
+
+          it "returns excerpts of text where search match occurred" do
+            result = ModelWithPgSearch.search_content("Let").with_pg_search_highlight.first
+
+            expect(result.pg_search_highlight).to eq("Won't <b>Let</b> You Down")
+          end
+        end
+      end
+
       describe "ranking" do
         before do
           ["Strip Down", "Down", "Down and Out", "Won't Let You Down"].each do |name|

data/spec/lib/pg_search/multisearch/rebuilder_spec.rb

@@ -3,6 +3,19 @@ require "spec_helper"
 describe PgSearch::Multisearch::Rebuilder do
   with_table "pg_search_documents", {}, &DOCUMENTS_SCHEMA
 
+  describe 'when intialized with a model that is not multisearchable' do
+    with_model :not_multisearchable
+
+    it 'raises an exception' do
+      expect {
+        PgSearch::Multisearch::Rebuilder.new(NotMultisearchable)
+      }.to raise_exception(
+        PgSearch::Multisearch::ModelNotMultisearchable,
+        "NotMultisearchable is not multisearchable. See PgSearch::ClassMethods#multisearchable"
+      )
+    end
+  end
+
   describe "#rebuild" do
     context "when the model defines .rebuild_pg_search_documents" do
       context "and multisearchable is not conditional" do

data/spec/lib/pg_search/multisearchable_spec.rb

@@ -94,6 +94,148 @@ describe PgSearch::Multisearchable do
         end
       end
     end
+
+    describe "populating the searchable text" do
+      let(:record) { ModelThatIsMultisearchable.new }
+      subject { record }
+
+      before do
+        ModelThatIsMultisearchable.multisearchable(multisearchable_options)
+      end
+
+      context "when searching against a single column" do
+        let(:multisearchable_options) { {:against => :some_content} }
+        let(:text) { "foo bar" }
+        before do
+          allow(record).to receive(:some_content) { text }
+          record.save
+        end
+
+        describe '#content' do
+          subject { super().pg_search_document.content }
+          it { is_expected.to eq(text) }
+        end
+      end
+
+      context "when searching against multiple columns" do
+        let(:multisearchable_options) { {:against => [:attr1, :attr2]} }
+        before do
+          allow(record).to receive(:attr1) { '1' }
+          allow(record).to receive(:attr2) { '2' }
+          record.save
+        end
+
+        describe '#content' do
+          subject { super().pg_search_document.content }
+          it { is_expected.to eq("1 2") }
+        end
+      end
+    end
+
+    describe "populating the searchable attributes" do
+      let(:record) { ModelThatIsMultisearchable.new }
+      subject { record }
+
+      before do
+        ModelThatIsMultisearchable.multisearchable(multisearchable_options)
+      end
+
+      context "when searching against a single column" do
+        let(:multisearchable_options) { {:against => :some_content} }
+        let(:text) { "foo bar" }
+        before do
+          allow(record).to receive(:some_content) { text }
+          record.save
+        end
+
+        describe '#content' do
+          subject { super().pg_search_document.content }
+          it { is_expected.to eq(text) }
+        end
+      end
+
+      context "when searching against multiple columns" do
+        let(:multisearchable_options) { {:against => [:attr1, :attr2]} }
+        before do
+          allow(record).to receive(:attr1) { '1' }
+          allow(record).to receive(:attr2) { '2' }
+          record.save
+        end
+
+        describe '#content' do
+          subject { super().pg_search_document.content }
+          it { is_expected.to eq("1 2") }
+        end
+      end
+
+      context "with additional_attributes" do
+        let(:multisearchable_options) do
+          {
+            :additional_attributes => lambda do |record|
+              { foo: record.bar }
+            end
+          }
+        end
+        let(:text) { "foo bar" }
+
+        it "sets the attributes" do
+          allow(record).to receive(:bar).and_return(text)
+          expect(record)
+            .to receive(:create_pg_search_document)
+            .with(content: '', foo: text)
+          record.save
+        end
+      end
+
+      context "when selectively updating" do
+        let(:multisearchable_options) do
+          {
+            :update_if => lambda do |record|
+              record.bar?
+            end
+          }
+        end
+        let(:text) { "foo bar" }
+
+        it "creates the document" do
+          allow(record).to receive(:bar?).and_return(false)
+          expect(record)
+            .to receive(:create_pg_search_document)
+            .with(content: '')
+          record.save
+        end
+
+        context "the document is created" do
+          before { record.save }
+
+          context "update_if returns false" do
+            before do
+              allow(record).to receive(:bar?).and_return(false)
+            end
+
+            it "does not update the document" do
+              expect_any_instance_of(PgSearch::Document)
+                .to_not receive(:update_attributes)
+
+              record.save
+            end
+          end
+
+          context "update_if returns true" do
+            before do
+              allow(record).to receive(:bar?).and_return(true)
+            end
+
+            it "updates the document" do
+              expect_any_instance_of(PgSearch::Document)
+                .to receive(:update_attributes)
+
+              record.save
+            end
+          end
+        end
+      end
+    end
   end
 
   describe "a model which is conditionally multisearchable using a Proc" do

data/spec/support/database.rb

@@ -30,7 +30,7 @@ rescue *error_classes
     puts "    createdb pg_search_test"
     puts "-" * 80
   end
-  raise $!
+  raise $ERROR_INFO
 end
 
 if ENV["LOGGER"]
@@ -50,7 +50,7 @@ rescue
     else
       share_path = `pg_config --sharedir`.strip
       ActiveRecord::Base.connection.execute File.read(File.join(share_path, 'contrib', "#{name}.sql"))
-      puts $!.message
+      puts $ERROR_INFO.message
     end
   rescue => exception
     at_exit do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_search
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Grant Hutchins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-30 00:00:00.000000000 Z
+date: 2016-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: '0.36'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: '0.36'
 description: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's
   full text search
 email:
@@ -184,7 +184,6 @@ files:
 - spec/lib/pg_search/configuration/association_spec.rb
 - spec/lib/pg_search/configuration/column_spec.rb
 - spec/lib/pg_search/configuration/foreign_column_spec.rb
-- spec/lib/pg_search/document_spec.rb
 - spec/lib/pg_search/features/dmetaphone_spec.rb
 - spec/lib/pg_search/features/trigram_spec.rb
 - spec/lib/pg_search/features/tsearch_spec.rb
@@ -222,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's
@@ -235,7 +234,6 @@ test_files:
 - spec/lib/pg_search/configuration/association_spec.rb
 - spec/lib/pg_search/configuration/column_spec.rb
 - spec/lib/pg_search/configuration/foreign_column_spec.rb
-- spec/lib/pg_search/document_spec.rb
 - spec/lib/pg_search/features/dmetaphone_spec.rb
 - spec/lib/pg_search/features/trigram_spec.rb
 - spec/lib/pg_search/features/tsearch_spec.rb

data/spec/lib/pg_search/document_spec.rb

@@ -1,56 +0,0 @@
-require "spec_helper"
-
-describe PgSearch::Document do
-  with_table "pg_search_documents", {}, &DOCUMENTS_SCHEMA
-
-  with_model :Searchable do
-    table
-    model do
-      include PgSearch
-      multisearchable
-    end
-  end
-
-  it { is_expected.to be_an(ActiveRecord::Base) }
-
-  describe "callbacks" do
-    describe "before_validation" do
-      subject { document }
-      let(:document) { PgSearch::Document.new(:searchable => searchable) }
-      let(:searchable) { Searchable.new }
-
-      before do
-        # Redefine the options for multisearchable
-        Searchable.multisearchable(multisearchable_options)
-      end
-
-      context "when searching against a single column" do
-        let(:multisearchable_options) { {:against => :some_content} }
-        let(:text) { "foo bar" }
-        before do
-          allow(searchable).to receive(:some_content) { text }
-          document.valid?
-        end
-
-        describe '#content' do
-          subject { super().content }
-          it { is_expected.to eq(text) }
-        end
-      end
-
-      context "when searching against multiple columns" do
-        let(:multisearchable_options) { {:against => [:attr1, :attr2]} }
-        before do
-          allow(searchable).to receive(:attr1) { '1' }
-          allow(searchable).to receive(:attr2) { '2' }
-          document.valid?
-        end
-
-        describe '#content' do
-          subject { super().content }
-          it { is_expected.to eq("1 2") }
-        end
-      end
-    end
-  end
-end