pg_search 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfa2efbbbc811da8b5c62690f0084c9ddd60615d
-  data.tar.gz: 90e7078224516ca17fdc503b418f309fd72560ae
+  metadata.gz: 33f93dcf75cdfe31418fe81f7f4eb4a1f6bef1c7
+  data.tar.gz: 7358d769fbba0629a3212550a2838e3478b748ec
 SHA512:
-  metadata.gz: 9c177eb231f004b44affdd5006ab5de2d75b13b4b4da0fbc0c4cb85b9d4394a1d96e26a27f28d23c4200638fc523e1dda1f414067a350c417f160ab0d2a96a2c
-  data.tar.gz: 7e98e612c9d089f5bab6c19365485c6190ad0b6338f662bfeb8864516592618f7883508c019bb031c7472ff3b5793b51f35ec27aaafcee748b9b85a5006fffe0
+  metadata.gz: a60014add058e2749d7f13b4286016e9d1d30c503714e3c054d0ffb46937e04f63b6a2ac7b18e3510fb8cd6dd9d08786d93d8e4b8db1ebaab3b128e36ebd8614
+  data.tar.gz: bb56ae42146f2c5b2c345f4e7ea07716292dddf7899c9c034bd1dec02c53ff2082111b9c87525d048eeddf3a872c0b18d5809edd5a0143d1a73528f62d8295bc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # pg_search changelog
 
+## 1.0.3
+
+*   Support STI models using a custom inheritance column. (Nick Doiron)
+
 ## 1.0.2
 
 *   Don’t use SQL to rebuild search documents when models are multisearchable against dynamic methods and not just columns. Iterate over each record with `find_each` instead.

data/README.md

@@ -5,7 +5,7 @@
 [![Gem Version](https://img.shields.io/gem/v/pg_search.svg?style=flat)](https://rubygems.org/gems/pg_search)
 [![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://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Casecommons/pg_search?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![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)
 
 ## DESCRIPTION
 

data/lib/pg_search/multisearch/rebuilder.rb

@@ -63,12 +63,12 @@ module PgSearch
 
       def sti_clause
         clause = ""
-        if model.column_names.include? 'type'
+        if model.column_names.include? model.inheritance_column
           clause = "WHERE"
           if model.base_class == model
-            clause = "#{clause} type IS NULL OR"
+            clause = "#{clause} #{model.inheritance_column} IS NULL OR"
           end
-          clause = "#{clause} type = #{model_name}"
+          clause = "#{clause} #{model.inheritance_column} = #{model_name}"
         end
         clause
       end

data/lib/pg_search/version.rb

@@ -1,3 +1,3 @@
 module PgSearch
-  VERSION = "1.0.2".freeze
+  VERSION = "1.0.3".freeze
 end

data/spec/integration/pg_search_spec.rb

@@ -1182,50 +1182,6 @@ describe "an Active Record model which includes PgSearch" do
       end
     end
 
-    context "on an STI subclass" do
-      with_model :SuperclassModel do
-        table do |t|
-          t.text 'content'
-          t.string 'type'
-        end
-
-        model do
-          include PgSearch
-        end
-      end
-
-      before do
-        SuperclassModel.pg_search_scope :search_content, :against => :content
-
-        class SearchableSubclassModel < SuperclassModel
-        end
-
-        class AnotherSearchableSubclassModel < SuperclassModel
-        end
-      end
-
-      it "returns only results for that subclass" do
-        included = [
-          SearchableSubclassModel.create!(:content => "foo bar")
-        ]
-        excluded = [
-          SearchableSubclassModel.create!(:content => "baz"),
-          SuperclassModel.create!(:content => "foo bar"),
-          SuperclassModel.create!(:content => "baz"),
-          AnotherSearchableSubclassModel.create!(:content => "foo bar"),
-          AnotherSearchableSubclassModel.create!(:content => "baz")
-        ]
-
-        expect(SuperclassModel.count).to eq(6)
-        expect(SearchableSubclassModel.count).to eq(2)
-
-        results = SearchableSubclassModel.search_content("foo bar")
-
-        expect(results).to include(*included)
-        expect(results).not_to include(*excluded)
-      end
-    end
-
     context "when there is a sort only feature" do
       it "excludes that feature from the conditions, but uses it in the sorting" do
         ModelWithPgSearch.pg_search_scope :search_content_ranked_by_dmetaphone,

data/spec/integration/single_table_inheritance_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+describe "a pg_search_scope on an STI subclass" do
+  context "with the standard type column" do
+    with_model :SuperclassModel do
+      table do |t|
+        t.text 'content'
+        t.string 'type'
+      end
+
+      model do
+        include PgSearch
+        pg_search_scope :search_content, :against => :content
+      end
+    end
+
+    before do
+      stub_const("SearchableSubclassModel", Class.new(SuperclassModel))
+      stub_const("AnotherSearchableSubclassModel", Class.new(SuperclassModel))
+    end
+
+    it "returns only results for that subclass" do
+      included = [
+        SearchableSubclassModel.create!(:content => "foo bar")
+      ]
+      excluded = [
+        SearchableSubclassModel.create!(:content => "baz"),
+        SuperclassModel.create!(:content => "foo bar"),
+        SuperclassModel.create!(:content => "baz"),
+        AnotherSearchableSubclassModel.create!(:content => "foo bar"),
+        AnotherSearchableSubclassModel.create!(:content => "baz")
+      ]
+
+      expect(SuperclassModel.count).to eq(6)
+      expect(SearchableSubclassModel.count).to eq(2)
+
+      results = SearchableSubclassModel.search_content("foo bar")
+
+      expect(results).to include(*included)
+      expect(results).not_to include(*excluded)
+    end
+  end
+
+  context "with a custom type column" do
+    with_model :SuperclassModel do
+      table do |t|
+        t.text 'content'
+        t.string 'custom_type'
+      end
+
+      model do
+        include PgSearch
+        self.inheritance_column = 'custom_type'
+        pg_search_scope :search_content, :against => :content
+      end
+    end
+
+    before do
+      stub_const("SearchableSubclassModel", Class.new(SuperclassModel))
+      stub_const("AnotherSearchableSubclassModel", Class.new(SuperclassModel))
+    end
+
+    it "returns only results for that subclass" do
+      included = [
+        SearchableSubclassModel.create!(:content => "foo bar")
+      ]
+      excluded = [
+        SearchableSubclassModel.create!(:content => "baz"),
+        SuperclassModel.create!(:content => "foo bar"),
+        SuperclassModel.create!(:content => "baz"),
+        AnotherSearchableSubclassModel.create!(:content => "foo bar"),
+        AnotherSearchableSubclassModel.create!(:content => "baz")
+      ]
+
+      expect(SuperclassModel.count).to eq(6)
+      expect(SearchableSubclassModel.count).to eq(2)
+
+      results = SearchableSubclassModel.search_content("foo bar")
+
+      expect(results).to include(*included)
+      expect(results).not_to include(*excluded)
+    end
+  end
+end
+

data/spec/lib/pg_search_spec.rb

@@ -75,91 +75,140 @@ describe PgSearch do
     end
 
     context "on an STI subclass" do
-      with_model :SuperclassModel do
-        table do |t|
-          t.text 'content'
-          t.string 'type'
+      context "with standard type column" do
+        with_model :SuperclassModel do
+          table do |t|
+            t.text 'content'
+            t.string 'type'
+          end
         end
-      end
 
-      before do
-        searchable_subclass_model = Class.new(SuperclassModel) do
-          include PgSearch
-          multisearchable :against => :content
+        before do
+          searchable_subclass_model = Class.new(SuperclassModel) do
+            include PgSearch
+            multisearchable :against => :content
+          end
+          stub_const("SearchableSubclassModel", searchable_subclass_model)
+          stub_const("AnotherSearchableSubclassModel", searchable_subclass_model)
+          stub_const("NonSearchableSubclassModel", Class.new(SuperclassModel))
         end
-        stub_const("SearchableSubclassModel", searchable_subclass_model)
-        stub_const("AnotherSearchableSubclassModel", searchable_subclass_model)
-        stub_const("NonSearchableSubclassModel", Class.new(SuperclassModel))
-      end
 
-      it "returns only results for that subclass" do
-        included = [
-          SearchableSubclassModel.create!(:content => "foo bar")
-        ]
-        excluded = [
-          SearchableSubclassModel.create!(:content => "baz"),
-          SuperclassModel.create!(:content => "foo bar"),
-          SuperclassModel.create!(:content => "baz"),
-          NonSearchableSubclassModel.create!(:content => "foo bar"),
+        it "returns only results for that subclass" do
+          included = [
+            SearchableSubclassModel.create!(:content => "foo bar")
+          ]
+          excluded = [
+            SearchableSubclassModel.create!(:content => "baz"),
+            SuperclassModel.create!(:content => "foo bar"),
+            SuperclassModel.create!(:content => "baz"),
+            NonSearchableSubclassModel.create!(:content => "foo bar"),
+            NonSearchableSubclassModel.create!(:content => "baz")
+          ]
+
+          expect(SuperclassModel.count).to be 6
+          expect(SearchableSubclassModel.count).to be 2
+
+          expect(PgSearch::Document.count).to be 2
+
+          results = PgSearch.multisearch("foo bar")
+
+          expect(results.length).to be 1
+          expect(results.first.searchable.class).to be SearchableSubclassModel
+          expect(results.first.searchable).to eq included.first
+        end
+
+        it "updates an existing STI model does not create a new pg_search document" do
+          model = SearchableSubclassModel.create!(:content => "foo bar")
+          expect(SearchableSubclassModel.count).to eq(1)
+          # We fetch the model from the database again otherwise
+          # the pg_search_document from the cache is used.
+          model = SearchableSubclassModel.find(model.id)
+          model.content = "foo"
+          model.save!
+          results = PgSearch.multisearch("foo")
+          expect(results.size).to eq(SearchableSubclassModel.count)
+        end
+
+        it "reindexing works" do
+          NonSearchableSubclassModel.create!(:content => "foo bar")
           NonSearchableSubclassModel.create!(:content => "baz")
-        ]
+          expected = SearchableSubclassModel.create!(:content => "baz")
+          SuperclassModel.create!(:content => "foo bar")
+          SuperclassModel.create!(:content => "baz")
+          SuperclassModel.create!(:content => "baz2")
 
-        expect(SuperclassModel.count).to be 6
-        expect(SearchableSubclassModel.count).to be 2
+          expect(SuperclassModel.count).to be 6
+          expect(NonSearchableSubclassModel.count).to be 2
+          expect(SearchableSubclassModel.count).to be 1
 
-        expect(PgSearch::Document.count).to be 2
+          expect(PgSearch::Document.count).to be 1
 
-        results = PgSearch.multisearch("foo bar")
+          PgSearch::Multisearch.rebuild(SearchableSubclassModel)
 
-        expect(results.length).to be 1
-        expect(results.first.searchable.class).to be SearchableSubclassModel
-        expect(results.first.searchable).to eq included.first
-      end
+          expect(PgSearch::Document.count).to be 1
+          expect(PgSearch::Document.first.searchable.class).to be SearchableSubclassModel
+          expect(PgSearch::Document.first.searchable).to eq expected
+        end
+
+        it "reindexing searchable STI doesn't clobber other related STI models" do
+          searchable_s = SearchableSubclassModel.create!(:content => "baz")
+          searchable_a = AnotherSearchableSubclassModel.create!(:content => "baz")
 
-      it "updates an existing STI model does not create a new pg_search document" do
-        model = SearchableSubclassModel.create!(:content => "foo bar")
-        expect(SearchableSubclassModel.count).to eq(1)
-        # We fetch the model from the database again otherwise
-        # the pg_search_document from the cache is used.
-        model = SearchableSubclassModel.find(model.id)
-        model.content = "foo"
-        model.save!
-        results = PgSearch.multisearch("foo")
-        expect(results.size).to eq(SearchableSubclassModel.count)
+          expect(PgSearch::Document.count).to be 2
+          PgSearch::Multisearch.rebuild(SearchableSubclassModel)
+          expect(PgSearch::Document.count).to be 2
+
+          classes = PgSearch::Document.all.collect {|d| d.searchable.class }
+          expect(classes).to include SearchableSubclassModel
+          expect(classes).to include AnotherSearchableSubclassModel
+        end
       end
 
-      it "reindexing works" do
-        NonSearchableSubclassModel.create!(:content => "foo bar")
-        NonSearchableSubclassModel.create!(:content => "baz")
-        expected = SearchableSubclassModel.create!(:content => "baz")
-        SuperclassModel.create!(:content => "foo bar")
-        SuperclassModel.create!(:content => "baz")
-        SuperclassModel.create!(:content => "baz2")
+      context "with custom type column" do
+        with_model :SuperclassModel do
+          table do |t|
+            t.text 'content'
+            t.string 'inherit'
+          end
 
-        expect(SuperclassModel.count).to be 6
-        expect(NonSearchableSubclassModel.count).to be 2
-        expect(SearchableSubclassModel.count).to be 1
+          model do
+            self.inheritance_column = 'inherit'
+          end
+        end
 
-        expect(PgSearch::Document.count).to be 1
+        before do
+          searchable_subclass_model = Class.new(SuperclassModel) do
+            include PgSearch
+            multisearchable :against => :content
+          end
+          stub_const("SearchableSubclassModel", searchable_subclass_model)
+          stub_const("AnotherSearchableSubclassModel", searchable_subclass_model)
+          stub_const("NonSearchableSubclassModel", Class.new(SuperclassModel))
+        end
 
-        PgSearch::Multisearch.rebuild(SearchableSubclassModel)
+        it "returns only results for that subclass" do
+          included = [
+            SearchableSubclassModel.create!(:content => "foo bar")
+          ]
+          excluded = [
+            SearchableSubclassModel.create!(:content => "baz"),
+            SuperclassModel.create!(:content => "foo bar"),
+            SuperclassModel.create!(:content => "baz"),
+            NonSearchableSubclassModel.create!(:content => "foo bar"),
+            NonSearchableSubclassModel.create!(:content => "baz")
+          ]
 
-        expect(PgSearch::Document.count).to be 1
-        expect(PgSearch::Document.first.searchable.class).to be SearchableSubclassModel
-        expect(PgSearch::Document.first.searchable).to eq expected
-      end
+          expect(SuperclassModel.count).to be 6
+          expect(SearchableSubclassModel.count).to be 2
 
-      it "reindexing searchable STI doesn't clobber other related STI models" do
-        searchable_s = SearchableSubclassModel.create!(:content => "baz")
-        searchable_a = AnotherSearchableSubclassModel.create!(:content => "baz")
+          expect(PgSearch::Document.count).to be 2
 
-        expect(PgSearch::Document.count).to be 2
-        PgSearch::Multisearch.rebuild(SearchableSubclassModel)
-        expect(PgSearch::Document.count).to be 2
+          results = PgSearch.multisearch("foo bar")
 
-        classes = PgSearch::Document.all.collect {|d| d.searchable.class }
-        expect(classes).to include SearchableSubclassModel
-        expect(classes).to include AnotherSearchableSubclassModel
+          expect(results.length).to be 1
+          expect(results.first.searchable.class).to be SearchableSubclassModel
+          expect(results.first.searchable).to eq included.first
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_search
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Grant Hutchins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -178,6 +178,7 @@ files:
 - spec/integration/associations_spec.rb
 - spec/integration/pagination_spec.rb
 - spec/integration/pg_search_spec.rb
+- spec/integration/single_table_inheritance_spec.rb
 - 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
@@ -228,6 +229,7 @@ test_files:
 - spec/integration/associations_spec.rb
 - spec/integration/pagination_spec.rb
 - spec/integration/pg_search_spec.rb
+- spec/integration/single_table_inheritance_spec.rb
 - 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