pg_search 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 292701a98892eef31e95d8b5d723e94ce71fd47e4956e8bed595b8f87797f49c
-  data.tar.gz: cc08372ce5c032e288c28b2f6409c218d361b271fc271de08acbe8e5430c8dcb
+  metadata.gz: c8e6c02c032d2a7a39ebe47e50584410cebe923e868dc6be720af23cd3748e55
+  data.tar.gz: 24d70a673be8c9993c007b812af1d9af89cc565dfbbae9ed37c205d90ca893da
 SHA512:
-  metadata.gz: e95e7240968269703ae6d010639f2b4380e7616962c7a07f4932ad5e21c77affae6ea3c90e9a8171641a506988fa076ecdb30224f2b081d1468fb13618713d2e
-  data.tar.gz: 4910a636f53e444c3995e0ca728bd21475d11347d8a4d8223a1e881f3360bf8dc7e4f5689bd05cc559dad106a08b077abda1b3f50c6108221e4dbf75c4d73ffa
+  metadata.gz: 06e43bdc63bd98ea57943068cde6723780000ca3765a016d9baecdac3eea7006a1deae35885654b88b4752e3ad6f136190ac8602ffad62b3aac356425fad66d0
+  data.tar.gz: 500d85f688710b48bf235eb1765c66e569dd7db98d95f03eaa81242f12c746d2ce8a57176185700c8d1b6ca903039d2c9b42fd5b71c84a8e4f8c46d7ef3464f7

data/.editorconfig

@@ -0,0 +1,10 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # pg_search changelog
 
+## 2.3.0
+
+* Extract `PgSearch::Model` module
+* Deprecate `include PgSearch`. Use `include PgSearch::Model` instead.
+
 ## 2.2.0
 
 * Add word_similarity option to trigram search (Severin Räz)

data/README.md

@@ -49,7 +49,7 @@ To add PgSearch to an Active Record model, simply include the PgSearch module.
 
 ```ruby
 class Shape < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
 end
 ```    
 
@@ -87,12 +87,12 @@ multisearchable in its class definition.
 
 ```ruby
 class EpicPoem < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   multisearchable against: [:title, :author]
 end
 
 class Flower < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   multisearchable against: :color
 end
 ```
@@ -112,13 +112,13 @@ particular record should be included.
 
 ```ruby
 class Convertible < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   multisearchable against: [:make, :model],
                   if: :available_in_red?
 end
 
 class Jalopy < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   multisearchable against: [:make, :model],
                   if: lambda { |record| record.model_year > 1970 }
 end
@@ -132,7 +132,7 @@ timestamp.
 
 ```ruby
 class AntipatternExample
-  include PgSearch
+  include PgSearch::Model
   multisearchable against: [:contents],
                   if: :published?
 
@@ -374,7 +374,7 @@ To search against a column, pass a symbol as the :against option.
 
 ```ruby
 class BlogPost < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_by_title, against: :title
 end
 ```
@@ -394,7 +394,7 @@ Just pass an Array if you'd like to search more than one column.
 
 ```ruby
 class Person < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_by_full_name, against: [:first_name, :last_name]
 end
 ```
@@ -421,7 +421,7 @@ value if you wanted.
 
 ```ruby
 class Person < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_by_name, lambda { |name_part, query|
     raise ArgumentError unless [:first, :last].include?(name_part)
     {
@@ -459,7 +459,7 @@ class Cheese < ActiveRecord::Base
 end
 
 class Salami < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
 
   belongs_to :cracker
   has_many :cheeses, through: :cracker
@@ -494,7 +494,7 @@ search techniques.
 
 ```ruby
 class Beer < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_name, against: :name, using: [:tsearch, :trigram, :dmetaphone]
 end
 ```
@@ -520,7 +520,7 @@ subtitle, and finally the content.
 
 ```ruby
 class NewsArticle < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_full_text, against: {
     title: 'A',
     subtitle: 'B',
@@ -535,7 +535,7 @@ weight. If you omit the weight, a default will be used.
 
 ```ruby
 class NewsArticle < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_full_text, against: [
     [:title, 'A'],
     [:subtitle, 'B'],
@@ -544,7 +544,7 @@ class NewsArticle < ActiveRecord::Base
 end
 
 class NewsArticle < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_full_text, against: [
     [:title, 'A'],
     {subtitle: 'B'},
@@ -562,7 +562,7 @@ shown in the following example.
 
 ```ruby
 class Superhero < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :whose_name_starts_with,
                   against: :name,
                   using: {
@@ -591,7 +591,7 @@ term that you were trying to exclude.
 
 ```ruby
 class Animal < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :with_name_matching,
                   against: :name,
                   using: {
@@ -620,7 +620,7 @@ dictionary will be used.
 
 ```ruby
 class BoringTweet < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :kinda_matching,
                   against: :text,
                   using: {
@@ -664,7 +664,7 @@ their numbers together.
 
 ```ruby
 class BigLongDocument < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :regular_search,
                   against: :text
 
@@ -688,7 +688,7 @@ models containing any word in the search terms.
 
 ```ruby
 class Number < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_any_word,
                   against: :text,
                   using: {
@@ -714,7 +714,7 @@ but will not include it in the query's WHERE condition.
 
 ```ruby
 class Person < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search,
                   against: :name,
                   using: {
@@ -739,7 +739,7 @@ Adding .with_pg_search_highlight after the pg_search_scope you can access to
 
 ```ruby
 class Person < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search,
                   against: :bio,
                   using: {
@@ -793,7 +793,7 @@ The following example shows how to use :dmetaphone.
 
 ```ruby
 class Word < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :that_sounds_like,
                   against: :spelling,
                   using: :dmetaphone
@@ -824,7 +824,7 @@ feature can be used.
 
 ```ruby
 class Website < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :kinda_spelled_like,
                   against: :name,
                   using: :trigram
@@ -849,7 +849,7 @@ threshold will force a table scan as the derived query uses the
 
 ```ruby
 class Vegetable < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
 
   pg_search_scope :strictly_spelled_like,
                   against: :name,
@@ -887,7 +887,7 @@ and the word with greatest similarity.
 
 ```ruby
 class Sentence < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
 
   pg_search_scope :similarity_like,
                   against: :words,
@@ -918,7 +918,7 @@ which fields using the 'only' option:
 
 ```ruby
 class Image < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
 
   pg_search_scope :combined_search,
                   against: [:file_name, :short_description, :long_description]
@@ -953,7 +953,7 @@ must be installed before this feature can be used.
 
 ```ruby
 class SpanishQuestion < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :gringo_search,
                   against: :word,
                   ignoring: :accents

data/lib/pg_search.rb

@@ -7,6 +7,7 @@ require "active_support/core_ext/string/strip"
 
 require "pg_search/configuration"
 require "pg_search/features"
+require "pg_search/model"
 require "pg_search/multisearch"
 require "pg_search/multisearchable"
 require "pg_search/normalizer"
@@ -14,7 +15,15 @@ require "pg_search/scope_options"
 require "pg_search/version"
 
 module PgSearch
-  extend ActiveSupport::Concern
+  def self.included(base)
+    ActiveSupport::Deprecation.warn <<-MESSAGE.strip_heredoc
+      Directly including `PgSearch` into an Active Record model is deprecated and will be removed in pg_search 3.0.
+
+      Please replace `include PgSearch` with `include PgSearch::Model`.
+    MESSAGE
+
+    base.include PgSearch::Model
+  end
 
   mattr_accessor :multisearch_options
   self.multisearch_options = {}
@@ -22,30 +31,6 @@ module PgSearch
   mattr_accessor :unaccent_function
   self.unaccent_function = "unaccent"
 
-  module ClassMethods
-    def pg_search_scope(name, options)
-      options_proc = if options.respond_to?(:call)
-                       options
-                     elsif options.respond_to?(:merge)
-                       ->(query) { { query: query }.merge(options) }
-                     else
-                       raise ArgumentError, 'pg_search_scope expects a Hash or Proc'
-                     end
-
-      define_singleton_method(name) do |*args|
-        config = Configuration.new(options_proc.call(*args), self)
-        scope_options = ScopeOptions.new(config)
-        scope_options.apply(self)
-      end
-    end
-
-    def multisearchable(options = {})
-      include PgSearch::Multisearchable
-      class_attribute :pg_search_multisearchable_options
-      self.pg_search_multisearchable_options = options
-    end
-  end
-
   class << self
     def multisearch(*args)
       PgSearch::Document.search(*args)
@@ -67,32 +52,6 @@ module PgSearch
     end
   end
 
-  def method_missing(symbol, *args)
-    case symbol
-    when :pg_search_rank
-      raise PgSearchRankNotSelected unless respond_to?(:pg_search_rank)
-
-      read_attribute(:pg_search_rank).to_f
-    when :pg_search_highlight
-      raise PgSearchHighlightNotSelected unless respond_to?(:pg_search_highlight)
-
-      read_attribute(:pg_search_highlight)
-    else
-      super
-    end
-  end
-
-  def respond_to_missing?(symbol, *args)
-    case symbol
-    when :pg_search_rank
-      attributes.key?(:pg_search_rank)
-    when :pg_search_highlight
-      attributes.key?(:pg_search_highlight)
-    else
-      super
-    end
-  end
-
   class PgSearchRankNotSelected < StandardError
     def message
       "You must chain .with_pg_search_rank after the pg_search_scope " \

data/lib/pg_search/document.rb

@@ -4,7 +4,7 @@ require 'logger'
 
 module PgSearch
   class Document < ActiveRecord::Base
-    include PgSearch
+    include PgSearch::Model
 
     self.table_name = 'pg_search_documents'
     belongs_to :searchable, polymorphic: true

data/lib/pg_search/model.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module PgSearch
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def pg_search_scope(name, options)
+        options_proc = if options.respond_to?(:call)
+                         options
+                       elsif options.respond_to?(:merge)
+                         ->(query) { { query: query }.merge(options) }
+                       else
+                         raise ArgumentError, 'pg_search_scope expects a Hash or Proc'
+                       end
+
+        define_singleton_method(name) do |*args|
+          config = Configuration.new(options_proc.call(*args), self)
+          scope_options = ScopeOptions.new(config)
+          scope_options.apply(self)
+        end
+      end
+
+      def multisearchable(options = {})
+        include PgSearch::Multisearchable
+        class_attribute :pg_search_multisearchable_options
+        self.pg_search_multisearchable_options = options
+      end
+    end
+
+    def method_missing(symbol, *args)
+      case symbol
+      when :pg_search_rank
+        raise PgSearchRankNotSelected unless respond_to?(:pg_search_rank)
+
+        read_attribute(:pg_search_rank).to_f
+      when :pg_search_highlight
+        raise PgSearchHighlightNotSelected unless respond_to?(:pg_search_highlight)
+
+        read_attribute(:pg_search_highlight)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(symbol, *args)
+      case symbol
+      when :pg_search_rank
+        attributes.key?(:pg_search_rank)
+      when :pg_search_highlight
+        attributes.key?(:pg_search_highlight)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/pg_search/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgSearch
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/spec/integration/associations_spec.rb

@@ -18,7 +18,7 @@ describe PgSearch do
         end
 
         model do
-          include PgSearch
+          include PgSearch::Model
           belongs_to :another_model, class_name: 'AssociatedModel'
 
           pg_search_scope :with_another, associated_against: { another_model: :title }
@@ -55,7 +55,7 @@ describe PgSearch do
         end
 
         model do
-          include PgSearch
+          include PgSearch::Model
           belongs_to :another_model, class_name: 'AssociatedModel'
 
           pg_search_scope :with_associated, against: :title, associated_against: { another_model: :title }
@@ -91,7 +91,7 @@ describe PgSearch do
         end
 
         model do
-          include PgSearch
+          include PgSearch::Model
           has_many :other_models, class_name: 'AssociatedModelWithHasMany', foreign_key: 'ModelWithHasMany_id'
 
           pg_search_scope :with_associated, against: [:title], associated_against: { other_models: :title }
@@ -163,7 +163,7 @@ describe PgSearch do
           end
 
           model do
-            include PgSearch
+            include PgSearch::Model
 
             has_many :models_of_first_type,
                      class_name: 'FirstAssociatedModel',
@@ -222,7 +222,7 @@ describe PgSearch do
           end
 
           model do
-            include PgSearch
+            include PgSearch::Model
 
             has_many :things,
                      class_name: 'DoublyAssociatedModel',
@@ -282,7 +282,7 @@ describe PgSearch do
         end
 
         model do
-          include PgSearch
+          include PgSearch::Model
           belongs_to :another_model, class_name: 'AssociatedModel'
 
           pg_search_scope :with_associated, associated_against: { another_model: %i[title author] }
@@ -335,7 +335,7 @@ describe PgSearch do
         end
 
         model do
-          include PgSearch
+          include PgSearch::Model
           belongs_to :another_model, class_name: 'AssociatedModel'
 
           pg_search_scope :with_associated, associated_against: { another_model: :number }
@@ -366,7 +366,7 @@ describe PgSearch do
 
         model do
           has_many :children
-          include PgSearch
+          include PgSearch::Model
           pg_search_scope :search_name, against: :name
         end
       end
@@ -409,7 +409,7 @@ describe PgSearch do
       end
 
       model do
-        include PgSearch
+        include PgSearch::Model
         belongs_to :model_with_association
 
         pg_search_scope :search_content, against: :content
@@ -455,7 +455,7 @@ describe PgSearch do
       end
 
       model do
-        include PgSearch
+        include PgSearch::Model
         pg_search_scope :search, against: :title, using: %i[tsearch trigram]
       end
     end
@@ -496,7 +496,7 @@ describe PgSearch do
       end
 
       model do
-        include PgSearch
+        include PgSearch::Model
         pg_search_scope :search, against: :title, using: %i[tsearch trigram]
       end
     end

data/spec/integration/deprecation_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Including the deprecated PgSearch module" do
+  with_model :SomeModel do
+    model do
+      ActiveSupport::Deprecation.silence do
+        include PgSearch
+      end
+    end
+  end
+
+  with_model :AnotherModel
+
+  it "includes PgSearch::Model" do
+    expect(SomeModel.ancestors).to include PgSearch::Model
+  end
+
+  it "prints a deprecation message" do
+    allow(ActiveSupport::Deprecation).to receive(:warn)
+
+    AnotherModel.include(PgSearch)
+
+    expect(ActiveSupport::Deprecation).to have_received(:warn).with(
+      <<-MESSAGE.strip_heredoc
+        Directly including `PgSearch` into an Active Record model is deprecated and will be removed in pg_search 3.0.
+
+        Please replace `include PgSearch` with `include PgSearch::Model`.
+      MESSAGE
+    )
+  end
+end

data/spec/integration/pagination_spec.rb

@@ -10,7 +10,7 @@ describe "pagination" do
       end
 
       model do
-        include PgSearch
+        include PgSearch::Model
         pg_search_scope :search_name, against: :name
 
         def self.page(page_number)

data/spec/integration/pg_search_spec.rb

@@ -12,7 +12,7 @@ describe "an Active Record model which includes PgSearch" do
     end
 
     model do
-      include PgSearch
+      include PgSearch::Model
       belongs_to :parent_model
     end
   end
@@ -22,7 +22,7 @@ describe "an Active Record model which includes PgSearch" do
     end
 
     model do
-      include PgSearch
+      include PgSearch::Model
       has_many :models_with_pg_search
       scope :active, -> { where(active: true) }
     end
@@ -208,7 +208,7 @@ describe "an Active Record model which includes PgSearch" do
           end
 
           model do
-            include PgSearch
+            include PgSearch::Model
             belongs_to :person
             pg_search_scope :search_city, against: [:city]
           end
@@ -220,7 +220,7 @@ describe "an Active Record model which includes PgSearch" do
           end
 
           model do
-            include PgSearch
+            include PgSearch::Model
             has_many :houses
             pg_search_scope :named, against: [:name]
             scope :with_house_in_city, lambda { |city|
@@ -462,7 +462,7 @@ describe "an Active Record model which includes PgSearch" do
           end
 
           model do
-            include PgSearch
+            include PgSearch::Model
 
             # WARNING: searching timestamps is not something PostgreSQL
             # full-text search is good at. Use at your own risk.
@@ -995,7 +995,7 @@ describe "an Active Record model which includes PgSearch" do
         end
 
         model do
-          include PgSearch
+          include PgSearch::Model
           has_many :comments
         end
       end
@@ -1038,7 +1038,7 @@ describe "an Active Record model which includes PgSearch" do
     context 'using multiple tsvector columns' do
       with_model :ModelWithTsvector do
         model do
-          include PgSearch
+          include PgSearch::Model
 
           pg_search_scope :search_by_multiple_tsvector_columns,
                           against: ['content', 'message'],
@@ -1066,7 +1066,7 @@ describe "an Active Record model which includes PgSearch" do
           t.tsvector 'content_tsvector'
         end
 
-        model { include PgSearch }
+        model { include PgSearch::Model }
       end
 
       let!(:expected) { ModelWithTsvector.create!(content: 'tiling is grouty') }

data/spec/integration/single_table_inheritance_spec.rb

@@ -11,7 +11,7 @@ describe "a pg_search_scope on an STI subclass" do
       end
 
       model do
-        include PgSearch
+        include PgSearch::Model
         pg_search_scope :search_content, against: :content
       end
     end
@@ -51,7 +51,7 @@ describe "a pg_search_scope on an STI subclass" do
       end
 
       model do
-        include PgSearch
+        include PgSearch::Model
         self.inheritance_column = 'custom_type'
         pg_search_scope :search_content, against: :content
       end

data/spec/lib/pg_search/configuration/association_spec.rb

@@ -17,7 +17,7 @@ describe PgSearch::Configuration::Association do
     end
 
     model do
-      include PgSearch
+      include PgSearch::Model
       has_one :avatar, class_name: "Avatar"
       belongs_to :site
 
@@ -32,7 +32,7 @@ describe PgSearch::Configuration::Association do
     end
 
     model do
-      include PgSearch
+      include PgSearch::Model
       has_many :users, class_name: "User"
 
       pg_search_scope :with_users, associated_against: { users: :name }

data/spec/lib/pg_search/configuration/foreign_column_spec.rb

@@ -17,7 +17,7 @@ describe PgSearch::Configuration::ForeignColumn do
       end
 
       model do
-        include PgSearch
+        include PgSearch::Model
         belongs_to :another_model, class_name: 'AssociatedModel'
 
         pg_search_scope :with_another, associated_against: { another_model: :title }

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

@@ -28,7 +28,7 @@ describe PgSearch::Multisearch::Rebuilder do
       context "and multisearchable is not conditional" do
         with_model :Model do
           model do
-            include PgSearch
+            include PgSearch::Model
             multisearchable
 
             def rebuild_pg_search_documents
@@ -52,7 +52,7 @@ describe PgSearch::Multisearch::Rebuilder do
               end
 
               model do
-                include PgSearch
+                include PgSearch::Model
                 multisearchable conditional_key => :active?
 
                 def rebuild_pg_search_documents
@@ -79,7 +79,7 @@ describe PgSearch::Multisearch::Rebuilder do
             end
 
             model do
-              include PgSearch
+              include PgSearch::Model
               multisearchable against: :name
             end
           end
@@ -141,7 +141,7 @@ describe PgSearch::Multisearch::Rebuilder do
               end
 
               model do
-                include PgSearch
+                include PgSearch::Model
                 multisearchable against: :name
               end
             end
@@ -160,7 +160,7 @@ describe PgSearch::Multisearch::Rebuilder do
               end
 
               model do
-                include PgSearch
+                include PgSearch::Model
                 multisearchable against: :name
               end
             end
@@ -206,7 +206,7 @@ describe PgSearch::Multisearch::Rebuilder do
             end
 
             model do
-              include PgSearch
+              include PgSearch::Model
               multisearchable against: [:foo]
 
               def foo
@@ -246,7 +246,7 @@ describe PgSearch::Multisearch::Rebuilder do
             end
 
             model do
-              include PgSearch
+              include PgSearch::Model
               multisearchable if: :active?
             end
           end
@@ -282,7 +282,7 @@ describe PgSearch::Multisearch::Rebuilder do
             end
 
             model do
-              include PgSearch
+              include PgSearch::Model
               multisearchable unless: :inactive?
             end
           end

data/spec/lib/pg_search/multisearch_spec.rb

@@ -12,7 +12,7 @@ describe PgSearch::Multisearch do
       t.timestamps null: false
     end
     model do
-      include PgSearch
+      include PgSearch::Model
     end
   end
 

data/spec/lib/pg_search/multisearchable_spec.rb

@@ -8,7 +8,7 @@ describe PgSearch::Multisearchable do
   describe "a model that is multisearchable" do
     with_model :ModelThatIsMultisearchable do
       model do
-        include PgSearch
+        include PgSearch::Model
         multisearchable
       end
     end
@@ -19,7 +19,7 @@ describe PgSearch::Multisearchable do
       end
 
       model do
-        include PgSearch
+        include PgSearch::Model
         multisearchable
 
         has_many :multisearchable_children, dependent: :destroy
@@ -287,7 +287,7 @@ describe PgSearch::Multisearchable do
         end
 
         model do
-          include PgSearch
+          include PgSearch::Model
           multisearchable if: ->(record) { record.multisearchable? }
         end
       end
@@ -415,7 +415,7 @@ describe PgSearch::Multisearchable do
         end
 
         model do
-          include PgSearch
+          include PgSearch::Model
           multisearchable unless: ->(record) { record.not_multisearchable? }
         end
       end
@@ -544,7 +544,7 @@ describe PgSearch::Multisearchable do
         end
 
         model do
-          include PgSearch
+          include PgSearch::Model
           multisearchable if: :multisearchable?
         end
       end
@@ -676,7 +676,7 @@ describe PgSearch::Multisearchable do
         end
 
         model do
-          include PgSearch
+          include PgSearch::Model
           multisearchable unless: :not_multisearchable?
         end
       end

data/spec/lib/pg_search_spec.rb

@@ -43,7 +43,7 @@ describe PgSearch do
           t.string :title
         end
         model do
-          include PgSearch
+          include PgSearch::Model
           multisearchable against: :title
         end
       end
@@ -76,7 +76,7 @@ describe PgSearch do
           t.string :title
         end
         model do
-          include PgSearch
+          include PgSearch::Model
           multisearchable against: :title
         end
       end
@@ -106,7 +106,7 @@ describe PgSearch do
 
         before do
           searchable_subclass_model = Class.new(SuperclassModel) do
-            include PgSearch
+            include PgSearch::Model
             multisearchable against: :content
           end
           stub_const("SearchableSubclassModel", searchable_subclass_model)
@@ -196,7 +196,7 @@ describe PgSearch do
 
         before do
           searchable_subclass_model = Class.new(SuperclassModel) do
-            include PgSearch
+            include PgSearch::Model
             multisearchable against: :content
           end
           stub_const("SearchableSubclassModel", searchable_subclass_model)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_search
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Grant Hutchins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-26 00:00:00.000000000 Z
+date: 2019-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -149,6 +149,7 @@ files:
 - ".autotest"
 - ".bundle/config"
 - ".codeclimate.yml"
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -175,6 +176,7 @@ files:
 - lib/pg_search/migration/multisearch_generator.rb
 - lib/pg_search/migration/templates/add_pg_search_dmetaphone_support_functions.rb.erb
 - lib/pg_search/migration/templates/create_pg_search_documents.rb.erb
+- lib/pg_search/model.rb
 - lib/pg_search/multisearch.rb
 - lib/pg_search/multisearch/rebuilder.rb
 - lib/pg_search/multisearchable.rb
@@ -186,6 +188,7 @@ files:
 - pg_search.gemspec
 - spec/.rubocop.yml
 - spec/integration/associations_spec.rb
+- spec/integration/deprecation_spec.rb
 - spec/integration/pagination_spec.rb
 - spec/integration/pg_search_spec.rb
 - spec/integration/single_table_inheritance_spec.rb
@@ -231,6 +234,7 @@ summary: PgSearch builds Active Record named scopes that take advantage of Postg
   full text search
 test_files:
 - spec/integration/associations_spec.rb
+- spec/integration/deprecation_spec.rb
 - spec/integration/pagination_spec.rb
 - spec/integration/pg_search_spec.rb
 - spec/integration/single_table_inheritance_spec.rb