Allow configuration of searchable classes

README.md

@@ -23,8 +23,7 @@ quickstart guide, but these commands should be enough to get you started:
 ## Indexing
 
 SphinxSearch indexes your pages on title and content (parts.) Sphinx
-attributes are created for `status_id`, `updated_at`, `virtual`, and
-`class_name`.
+attributes are created for `status_id`, `updated_at`, and `virtual`.
 
 ## Building a Search Page
 

lib/sphinx_search.rb

@@ -1,3 +1,3 @@
 module SphinxSearch
-  mattr_accessor :param_name, :content_length
+  mattr_accessor :param_name, :content_length, :hidden_classes
 end

lib/sphinx_search/page_extensions.rb

@@ -8,10 +8,17 @@ def self.included(base)
        set_property :delta => true, :group_concat_max_len => SphinxSearch.content_length || 8.kilobytes
        set_property :field_weights => { 'title' => 100 }
        indexes title, parts.content
-       has updated_at, status_id, virtual, class_name
+       has updated_at, status_id, virtual
      end
 
+     base.extend ClassMethods
+   end
+
+   module ClassMethods
+     def searchable(search=true)
+       search ? SphinxSearch.hidden_classes.delete(self.name) : SphinxSearch.hidden_classes.push(self.name)
+     end
+   end
+
    end
-
-  end
 end

lib/sphinx_search/radius_tags.rb

@@ -158,7 +158,11 @@ def will_paginate_options(tag)
       end
 
       def thinking_sphinx_options(tag)
-        { :with => { :status_id => 100, :virtual => false }, :retry_stale => true }
+        {
+          :with => { :status_id => 100, :virtual => false },
+          :without => { :class_crc => SphinxSearch.hidden_classes.map(&:to_crc32) },
+          :retry_stale => true
+        }
       end
   end
 end

lib/templates/initializer.rb

@@ -3,4 +3,8 @@
 
 # Max length of content to index, per page. Bump this up if you have more than
 # 8k of text per page (as calculated by combining all page parts.)
-SphinxSearch.content_length = 8.kilobytes
+SphinxSearch.content_length = 8.kilobytes
+
+# Don't include these page subclasses in the search results. This can also be
+# accessed by declaring `self.searchable [true|false]` in your Page subclasses.
+SphinxSearch.hidden_classes = %w(SearchPage JavascriptPage StylesheetPage)

radiant-sphinx_search-extension.gemspec

@@ -34,8 +34,8 @@ Gem::Specification.new do |s|
      "lib/templates/sphinx.yml",
      "radiant-sphinx_search-extension.gemspec",
      "spec/datasets/search_pages_dataset.rb",
-     "spec/lib/radiant-sphinx_search-extension.rb",
      "spec/lib/search_radius_tags_spec.rb",
+     "spec/models/page_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "sphinx_search_extension.rb"
@@ -47,8 +47,8 @@ Gem::Specification.new do |s|
   s.summary = %q{Sphinx Search Extension for Radiant CMS}
   s.test_files = [
     "spec/datasets/search_pages_dataset.rb",
-     "spec/lib/radiant-sphinx_search-extension.rb",
      "spec/lib/search_radius_tags_spec.rb",
+     "spec/models/page_spec.rb",
      "spec/spec_helper.rb"
   ]
 

spec/models/page_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Page do
+  describe "Page.searchable" do
+    it "should add itself to the hidden classes array" do
+      SphinxSearch.hidden_classes = []
+      FileNotFoundPage.searchable false
+      SphinxSearch.hidden_classes.should include('FileNotFoundPage')
+    end
+
+    it "should remove itself from the hidden classes array" do
+      SphinxSearch.hidden_classes = %w(FileNotFoundPage)
+      FileNotFoundPage.searchable true
+      SphinxSearch.hidden_classes.should_not include("FileNotFoundPage")
+    end
+  end
+
+  describe "#thinking_sphinx_options" do
+    it "should description" do
+      SphinxSearch.hidden_classes = %w(FileNotFoundPage)
+      opts = SearchPage.new.send :thinking_sphinx_options, nil
+      opts[:without][:class_crc].should include('FileNotFoundPage'.to_crc32)
+    end
+  end
+end

spec/spec_helper.rb

@@ -18,6 +18,7 @@
 end
 
 Spec::Runner.configure do |config|
+  SphinxSearch.hidden_classes ||= %w(SearchPage JavascriptPage StylesheetPage)
   # config.use_transactional_fixtures = true
   # config.use_instantiated_fixtures  = false
   # config.fixture_path = RAILS_ROOT + '/spec/fixtures'