refinerycms-pgsearch 0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store	
+Gemfile.lock
+spec/dummy

data/Gemfile

@@ -0,0 +1,65 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'refinerycms', '~> 2.0.0'
+
+group :development, :test do
+  gem 'refinerycms-testing', '~> 2.0.0'
+  gem 'guard-rspec', '~> 0.6.0'
+
+  platforms :jruby do
+    gem 'activerecord-jdbcpostgresql-adapter'
+    gem 'jruby-openssl'
+  end
+
+  unless defined?(JRUBY_VERSION)
+    gem 'pg'
+  end
+
+  platforms :mswin, :mingw do
+    gem 'win32console'
+    gem 'rb-fchange', '~> 0.0.5'
+    gem 'rb-notifu', '~> 0.0.4'
+  end
+
+  platforms :ruby do
+    gem 'spork', '~> 0.9.0.rc'
+    gem 'guard-spork'
+
+    unless ENV['TRAVIS']
+      require 'rbconfig'
+      if RbConfig::CONFIG['target_os'] =~ /darwin/i
+        gem 'rb-fsevent', '>= 0.3.9'
+        gem 'ruby_gntp'
+      end
+      if RbConfig::CONFIG['target_os'] =~ /linux/i
+        gem 'rb-inotify', '>= 0.5.1'
+        gem 'libnotify',  '~> 0.1.3'
+        gem 'therubyracer', '~> 0.9.9'
+      end
+    end
+  end
+
+  platforms :jruby do
+    unless ENV['TRAVIS']
+      require 'rbconfig'
+      if RbConfig::CONFIG['target_os'] =~ /darwin/i
+        gem 'ruby_gntp'
+      end
+      if RbConfig::CONFIG['target_os'] =~ /linux/i
+        gem 'rb-inotify', '>= 0.5.1'
+        gem 'libnotify',  '~> 0.1.3'
+      end
+    end
+  end
+end
+
+# Refinery/rails should pull in the proper versions of these
+group :assets do
+  gem 'sass-rails'
+  gem 'coffee-rails'
+  gem 'uglifier'
+end
+
+gem 'jquery-rails'

data/Guardfile

@@ -0,0 +1,20 @@
+guard 'rspec', :version => 2, :cli => "--color" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/controllers/#{m[1]}_#{m[2]}_spec.rb", "spec/requests/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+
+guard 'spork', :wait => 60, :cucumber => false, :rspec_env => { 'RAILS_ENV' => 'test' } do
+  watch('config/application.rb')
+  watch('config/environment.rb')
+  watch(%r{^config/environments/.+\.rb$})
+  watch(%r{^config/initializers/.+\.rb$})
+  watch('spec/spec_helper.rb')
+end

data/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+ENGINE_PATH = File.dirname(__FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+if File.exists?(APP_RAKEFILE)
+  load 'rails/tasks/engine.rake'
+end
+
+require "refinerycms-testing"
+Refinery::Testing::Railtie.load_tasks
+Refinery::Testing::Railtie.load_dummy_tasks(ENGINE_PATH)
+
+load File.expand_path('../tasks/rspec.rake', __FILE__)

data/app/controllers/refinery/search_controller.rb

@@ -0,0 +1,12 @@
+module Refinery
+  class SearchController < ::ApplicationController
+
+  	# Display search results given the query supplied
+    def show
+      @results = Refinery::SearchEngine.search(params[:query], params[:page])
+
+      present(@page = Refinery::Page.find_by_link_url("/search"))
+    end
+
+  end
+end

data/app/helpers/refinery/search_helper.rb

@@ -0,0 +1,23 @@
+module Refinery
+  module SearchHelper
+
+    def result_title(result)
+      result.title.gsub /(#{Regexp.escape(params[:query])})/i, '<mark>\1</mark>'
+    end
+
+    def result_type(result)
+      result.class.to_s.titleize.gsub('Refinery/', '').gsub '/', '::'
+    end
+
+    # this is where you register your result URLs based on the
+    # type of result we're dealing with
+    def result_url(result)
+      if result.respond_to? :url
+        refinery.url_for result.url
+      else
+        refinery.url_for send(Refinery.route_for_model(result.class, :admin => false), result)
+      end
+    end
+
+  end
+end

data/app/models/refinery/search_engine.rb

@@ -0,0 +1,13 @@
+module Refinery
+  class SearchEngine
+
+    # How many results should we show per page
+    RESULTS_LIMIT = 10
+
+    # Perform search over the specified models
+    def self.search(query, page = 1)
+      PgSearch.multisearch(query).paginate(:page => page, :per_page => RESULTS_LIMIT)
+    end
+
+  end
+end

data/app/views/refinery/search/show.html.erb

@@ -0,0 +1,19 @@
+<% content_for :body_content_title do %>
+  <%= t('.search_results_for', :what => params[:query]) %>
+<% end %>
+
+<% content_for :body_content_left do %>
+  <ul id="search_results">
+    <% @results.each do |result| %>
+      <li>
+        <span class='result_type'>
+          <%= result_type result.searchable %>
+        </span>
+        <%= link_to result_title(result.searchable).html_safe, result_url(result.searchable) %>
+      </li>
+    <% end %>
+  </ul>
+
+<% end %>
+
+<%= render :partial => "/refinery/content_page" %>

data/app/views/refinery/shared/_search.html.erb

@@ -0,0 +1,6 @@
+<%= form_tag refinery.search_path do -%>
+  <%= text_field_tag :query, {}, {:type => "search",
+                     :placeholder => "Search site for...", 
+                     :value => (params[:query] if params[:query])} %>
+  <%= submit_tag 'Go' %>
+<% end %>

data/config/locales/bg.yml

@@ -0,0 +1,6 @@
+bg:
+  refinery:
+    plugins:
+      refinerycms_search:
+        title: Търсене
+        description: Допълнителна функционалност при търсене за Refinery CMS

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  refinery:
+    plugins:
+      refinerycms_search:
+        title: Search
+        description: Extra search handling for Refinery CMS
+    search:
+      show:
+        search_results_for: Search Results for '%{what}'

data/config/routes.rb

@@ -0,0 +1,3 @@
+Refinery::Core::Engine.routes.draw do
+  match "/search", :to => 'search#show', :as => 'search'
+end

data/db/seeds.rb

@@ -0,0 +1,23 @@
+if defined?(Refinery::User)
+  Refinery::User.all.each do |user|
+    if user.plugins.where(:name => 'refinerycms_search').blank?
+      user.plugins.create(:name => 'refinerycms_search')
+    end
+  end
+end
+
+if defined?(Refinery::Page)
+  unless Refinery::Page.where(:menu_match => "^/search.*$").any?
+    page = Refinery::Page.create(
+      :title => "Search Results",
+      :show_in_menu => false,
+      :link_url => "/search",
+      :deletable => false,
+      :menu_match => "^/search.*$"
+    )
+
+    Refinery::Pages.default_parts.each do |default_page_part|
+      page.parts.create(:title => default_page_part, :body => nil)
+    end
+  end
+end

data/lib/generators/refinery/search/search_generator.rb

@@ -0,0 +1,45 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Refinery
+  class SearchGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Creates the installation files for RefineryCMS Search"
+    
+    source_root File.expand_path("../templates", __FILE__)
+
+    def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+    end
+
+    def create_migration_file
+      migration_template '01_create_search_page.rb', 'db/migrate/create_search_page.rb'
+      sleep 1
+    end
+
+    def pg_search_migration
+      migration_template '02_create_pg_search_table.rb', 'db/migrate/create_pg_search_table.rb'
+    end
+
+    def copy_initializer
+        copy_file "03_initializer.rb", "config/initializers/refinery/search.rb"
+    end
+
+    def append_load_seed_data
+      create_file 'db/seeds.rb' unless File.exists?(File.join(destination_root, 'db', 'seeds.rb'))
+      append_file 'db/seeds.rb', :verbose => true do
+        <<-EOH
+
+# Added by Refinery CMS Search engine
+Refinery::Search::Engine.load_seed
+        EOH
+      end
+    end
+
+  end
+end

data/lib/generators/refinery/search/templates/01_create_search_page.rb

@@ -0,0 +1,16 @@
+class CreateSearchPage < ActiveRecord::Migration
+
+  def up
+  end
+
+  def down
+    if defined?(Refinery::UserPlugin)
+      Refinery::UserPlugin.destroy_all({:name => "refinerycms_search"})
+    end
+
+    if defined?(Refinery::Page)
+      Refinery::Page.delete_all({:link_url => "/search"})
+    end
+  end
+
+end

data/lib/generators/refinery/search/templates/02_create_pg_search_table.rb

@@ -0,0 +1,21 @@
+class CreatePgSearchTable < ActiveRecord::Migration
+  def self.up
+    say_with_time("Creating table for pg_search multisearch") do
+      create_table :pg_search_documents do |t|
+        t.text :content
+        t.belongs_to :searchable, :polymorphic => true
+        t.timestamps
+      end
+      execute "CREATE EXTENSION IF NOT EXISTS unaccent;"
+      execute "ALTER TABLE pg_search_documents ADD COLUMN tsv tsvector;"
+      execute "CREATE INDEX index_pg_search_documents_tsv ON pg_search_documents USING gin(tsv);"
+      execute "CREATE TRIGGER tsvectorupdate BEFORE INSERT OR UPDATE ON pg_search_documents FOR EACH ROW EXECUTE PROCEDURE tsvector_update_trigger(tsv, 'pg_catalog.english', content)"
+    end
+  end
+
+  def self.down
+    say_with_time("Dropping table for pg_search multisearch") do
+      drop_table :pg_search_documents
+    end
+  end
+end

data/lib/generators/refinery/search/templates/03_initializer.rb

@@ -0,0 +1,23 @@
+Refinery::Search.configure do |config|
+    config.searchable_models = {
+        # Add a Hash of "ModelName" => [:searchable, :field, :names, :as, :keys]
+        
+        # Below are common Refinery models that you might want indexed.
+        # Uncomment any that you wish to use, and then run:
+        #       rake refinery:search:rebuild
+        # To rebuild the search index.
+
+        # Refinery::Page
+        # We defined a special method called #all_parts to allow
+        # all of the content in the different Page Parts to be indexed
+        # simply under the parent page.
+        
+        "Refinery::Page" => [:title, :all_parts],
+
+        # Refinery::Blog::Post and Refinery::News::Item
+        # These are simple, only indexing fields on the model.
+
+        # "Refinery::Blog::Post" => [:title, :body],
+        # "Refinery::News::Item" => [:title, :body]
+    }
+end

data/lib/refinery/search.rb

@@ -0,0 +1,23 @@
+require "refinerycms-core"
+
+module Refinery
+  autoload :SearchGenerator, 'generators/refinery/search/search_generator'
+
+  module Search
+    require "refinery/search/engine"
+
+    class << self
+      attr_writer :root
+      mattr_accessor :searchable_models
+
+      def root
+        @root ||= Pathname.new(File.expand_path('../../../', __FILE__))
+      end
+
+      def configure
+        yield self
+      end
+    end
+  end
+end
+

data/lib/refinery/search/engine.rb

@@ -0,0 +1,47 @@
+module Refinery
+    module Search
+        class Engine < Rails::Engine
+            include Refinery::Engine
+
+            initializer "register refinery_search plugin" do
+                Refinery::Plugin.register do |plugin|
+                    plugin.name = 'refinery_search'
+                    plugin.version = 2.0
+                    plugin.hide_from_menu = true
+                end
+            end
+
+            config.to_prepare do
+                ::Refinery::Search.searchable_models ||= {"Refinery::Page" => [:title, :all_parts]}
+            end
+
+            config.after_initialize do
+                require 'pg_search'
+
+                PgSearch.multisearch_options = {
+                    using: {
+                        tsearch: {
+                            prefix: true,
+                            dictionary: "english",
+                            tsvector_column: 'tsv'
+                        }
+                    },
+                    ignoring: :accents
+                }
+
+                ::Refinery::Search.searchable_models.each do |model, fields|
+                    model.constantize.module_eval do
+                        include PgSearch
+                        multisearchable :against => fields
+                        if fields.include?(:all_parts)
+                            def all_parts
+                                @all_parts ||= parts.pluck(:body).join(' ')
+                            end
+                        end
+                    end
+                end
+            end
+
+        end
+    end
+end

data/lib/refinerycms-pgsearch.rb

@@ -0,0 +1 @@
+require "refinery/search"

data/lib/tasks/search.rake

@@ -0,0 +1,15 @@
+namespace :refinery do
+    namespace :search do
+
+        task :rebuild => :environment do
+            # Get searchable models from hash keys.
+            Refinery::Search.searchable_models.keys.each do |model|
+                # Delete the old search documents
+                PgSearch::Document.delete_all(:searchable_type => model.to_s)
+                # Add some new ones!
+                model.constantize.find_each{|record| record.update_pg_search_document }
+            end
+        end
+
+    end
+end

data/readme.md

@@ -0,0 +1,55 @@
+# Search plugin for [RefineryCMS](http://www.refinerycms.com)
+[Github](http://github.com/resolve/refinerycms)
+
+By: [JGW Maxwell](http://jgwmaxwell.com)
+
+Powered by: [pg_search](http://github.com/Casecommons/pg_search). **This only works on PostgreSQL databases, ideally 9.0+.**
+
+## Installation
+
+Simply use this by adding the following to your `Gemfile`:
+
+```ruby
+gem 'refinerycms-pgsearch'
+# or for the latest and greatest
+gem 'refinerycms-pgsearch', github: 'jgwmaxwell/refinerycms-pgsearch'
+```
+Then run `bundle install`, and `rails g refinery:search` to generate the migrations. Finally, run `rake db:migrate` and `rake db:seed` to finish setting up.
+
+# # Check The Initializer
+
+The default installation will search in Pages. If you wish to find results in other plugins you have created or installed, you can specify these in `config/initializers/refinery/search.rb` like so:
+
+```ruby
+Refinery::Search.configure do |config|
+    config.searchable_models = {
+        "Refinery::Page" => [:title, :all_parts],
+        "Refinery::Blog::Post" => [:title, :body]
+    }
+end
+```
+This will index Pages and Blog Posts for you. The format is: `"STRING_OF_MODEL_CLASS" => [:array, :of, :attribute, :symbols]`. You might notice that Pages are indexing `:all_parts` - this is a convenience to get the content out of multiple page parts that will be defined if you use it.
+
+# # To use your own Models
+
+Simple pass another line into the hash in the initializer, such as:
+
+```ruby
+"Employee" => [:name, :bio]
+```
+You can use any public method, as well. So if you have `:first_name` and `:last_name` but a method like `name` to join them, it can be indexed.
+
+# # Existing Data and Rebuilding
+
+If at any point you need to rebuild your search index, run `rake refinery:search:rebuild` to update all your search records!
+
+# # Searching and Viewing
+
+A sample search form can be found in [views/refinery/shared/_search.html.erb](http://github.com/jgwmaxwell/refinerycms-pgsearch/blob/master/app/views/refinery/shared/_search.html.erb).
+You can either use this partial directly, or copy the appropriate parts.
+
+If you wish to override the url used in the search results just add a `url` method to your model and the result of this method will be used instead.
+
+# # Migrating from refinerycms-search
+
+You'll need to run the generator, migrate the database, update the new initializer and remove the old code from `application.rb`. Then remove the `acts_as_indexed` statements from your models but otherwise it should be good to go. Let me know if you need help.

data/refinerycms-pgsearch.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name              = %q{refinerycms-pgsearch}
+  s.version           = %q{0.1}
+  s.date              = "#{Date.today.strftime("%Y-%m-%d")}"
+  s.summary           = %q{PostgreSQL search handling for Refinery CMS}
+  s.description       = %q{Provides extra functionality for searching your frontend website using Refinery CMS.}
+  s.homepage          = %q{http://refinerycms.com}
+  s.email             = %q{jgwmaxwell@gmail.com}
+  s.authors           = ["JGW Maxwell"]
+  s.require_paths     = %w(lib)
+
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- spec/*`.split("\n")
+
+  s.add_dependency    'refinerycms-core', '~> 2.0.4'
+  s.add_dependency    'pg_search', '~> 0.5'
+end

data/spec/models/refinery/search_engine_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+module Refinery
+  describe SearchEngine do
+    describe "#search" do
+      context "when page exist" do
+        # we're using page factory because search engine uses
+        # page model as default model
+        let!(:page) { FactoryGirl.create(:page, :title => "testy") }
+
+        it "returns an array consisting of mathcing pages" do
+          result = SearchEngine.search("testy")
+          result.should include(page)
+        end
+      end
+
+      context "when page does not exist" do
+        it "returns empty array" do
+          result = SearchEngine.search("ugisozols")
+          result.should be_empty
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+$VERBOSE = ENV['VERBOSE'] || false
+
+require 'rubygems'
+
+ENGINE_RAILS_ROOT = File.join(File.dirname(__FILE__), '../') unless defined?(ENGINE_RAILS_ROOT)
+
+def setup_environment
+  # Configure Rails Environment
+  ENV["RAILS_ENV"] ||= 'test'
+
+  require File.expand_path("../dummy/config/environment", __FILE__)
+
+  require 'rspec/rails'
+  require 'capybara/rspec'
+
+  Rails.backtrace_cleaner.remove_silencers!
+
+  RSpec.configure do |config|
+    config.mock_with :rspec
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+    config.filter_run :focus => true
+    config.run_all_when_everything_filtered = true
+  end
+
+  # Set javascript driver for capybara
+  Capybara.javascript_driver = :selenium
+end
+
+def each_run
+  Rails.cache.clear
+  ActiveSupport::Dependencies.clear
+  FactoryGirl.reload
+
+  # Requires supporting files with custom matchers and macros, etc,
+  # in ./support/ and its subdirectories including factories.
+  ([ENGINE_RAILS_ROOT, Rails.root.to_s].uniq | Refinery::Plugins.registered.pathnames).map{|p|
+    Dir[File.join(p, 'spec', 'support', '**', '*.rb').to_s]
+  }.flatten.sort.each do |support_file|
+    require support_file
+  end
+end
+
+# If spork is available in the Gemfile it'll be used but we don't force it.
+unless (begin; require 'spork'; rescue LoadError; nil end).nil?
+  Spork.prefork do
+    # Loading more in this block will cause your tests to run faster. However,
+    # if you change any configuration or code from libraries loaded here, you'll
+    # need to restart spork for it take effect.
+    setup_environment
+  end
+
+  Spork.each_run do
+    # This code will be run each time you run your specs.
+    each_run
+  end
+else
+  setup_environment
+  each_run
+end

data/tasks/rspec.rake

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: refinerycms-pgsearch
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- JGW Maxwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: refinerycms-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: pg_search
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Provides extra functionality for searching your frontend website using
+  Refinery CMS.
+email: jgwmaxwell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- Rakefile
+- app/controllers/refinery/search_controller.rb
+- app/helpers/refinery/search_helper.rb
+- app/models/refinery/search_engine.rb
+- app/views/refinery/search/show.html.erb
+- app/views/refinery/shared/_search.html.erb
+- config/locales/bg.yml
+- config/locales/en.yml
+- config/routes.rb
+- db/seeds.rb
+- lib/generators/refinery/search/search_generator.rb
+- lib/generators/refinery/search/templates/01_create_search_page.rb
+- lib/generators/refinery/search/templates/02_create_pg_search_table.rb
+- lib/generators/refinery/search/templates/03_initializer.rb
+- lib/refinery/search.rb
+- lib/refinery/search/engine.rb
+- lib/refinerycms-pgsearch.rb
+- lib/tasks/search.rake
+- readme.md
+- refinerycms-pgsearch.gemspec
+- spec/models/refinery/search_engine_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: http://refinerycms.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: PostgreSQL search handling for Refinery CMS
+test_files:
+- spec/models/refinery/search_engine_spec.rb
+- spec/spec_helper.rb
+has_rdoc: