refinerycms-search 0.9.8

data/app/controllers/search_controller.rb

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

data/app/helpers/search_helper.rb

@@ -0,0 +1,9 @@
+module SearchHelper
+	
+	# this is where you register your result URLs based on the
+	# type of result we're dealing with
+	def result_url(result)
+		result.respond_to?(:url) ? result.url : url_for(result)
+	end
+	
+end

data/app/models/search_engine.rb

@@ -0,0 +1,17 @@
+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)
+		results = []
+
+		Refinery.searchable_models.each do |model|
+			results << model.limit(RESULTS_LIMIT).with_query(query)
+		end if query.present?
+
+		results.flatten[0..(RESULTS_LIMIT - 1)]
+	end
+
+end

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

@@ -0,0 +1,37 @@
+<% content_for :body_content_page_title do %>
+  Search Results for '<%=h params[:query] %>'
+<% end %>
+
+<% content_for :body_content_left do %>
+  <ul id="search_results">
+    <% @results.each do |result| %>
+      <li>
+        <span class='result_type'>
+          <%= result.class.to_s.titleize %>
+        </span>
+        <%= link_to raw(result.title.gsub(/(#{params[:query]})/i,'<mark>\1</mark>')), result_url(result) %>
+      </li>
+    <% end %>
+  </ul>
+
+<% end %>
+
+<%= render :partial => "/shared/content_page" %>
+<% content_for :head do %>
+  <style type='text/css'>
+    #search_results {
+      list-style: none;
+      padding: 0;
+      margin: 0;
+    }
+
+    #search_results li {
+      border-bottom: 1px solid #CCC;
+    }
+
+    #search_results li span.result_type {
+      float: right;
+      color: #CCC;
+    }
+  </style>
+<% end %>

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

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

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  plugins:
+    refinerycms_search:
+      title: Search
+      description: Extra search handling for Refinery CMS

data/config/routes.rb

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

data/lib/gemspec.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+version = '0.9.8'
+raise "Could not get version so gemspec can not be built" if version.nil?
+files = Dir.glob("**/*").flatten.reject do |file|
+  file =~ /\.gem$/
+end
+
+gemspec = <<EOF
+Gem::Specification.new do |s|
+  s.name              = %q{refinerycms-search}
+  s.version           = %q{#{version}}
+  s.date              = %q{#{Time.now.strftime('%Y-%m-%d')}}
+  s.summary           = %q{Extra 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{info@refinerycms.com}
+  s.authors           = ["Resolve Digital"]
+  s.require_paths     = %w(lib)
+
+  s.add_dependency    'refinerycms', '>= 0.9.8'
+
+  s.files             = [
+    '#{files.join("',\n    '")}'
+  ]
+  s.require_path = 'lib'
+end
+EOF
+
+File.open(File.expand_path("../../refinerycms-search.gemspec", __FILE__), 'w').puts(gemspec)

data/lib/refinerycms-search.rb

@@ -0,0 +1,27 @@
+require 'refinery'
+
+module Refinery
+  module Search
+    class Engine < Rails::Engine
+      config.to_prepare do
+        module ::Refinery
+          class << self
+            attr_accessor :searchable_models
+
+            def searchable_models
+              @searchable_models ||= [Page]
+            end
+          end
+        end
+      end
+
+      config.after_initialize do
+        ::Refinery::Plugin.register do |plugin|
+          plugin.name = 'refinerycms_search'
+          plugin.version = 1.0
+          plugin.hide_from_menu = true
+        end
+      end
+    end
+  end
+end

data/readme.md

@@ -0,0 +1,43 @@
+# Search plugin for [RefineryCMS](http://www.refinerycms.com)
+[Github](http://github.com/resolve/refinerycms)
+
+By: [Resolve Digital](http://www.resolvedigital.com)
+
+## Installation
+
+Simply use this by adding the following to your ``Gemfile``:
+
+    gem 'refinerycms-search', '~> 0.9.8'
+
+You'll also need to create a page (from the 'Pages' tab) with a custom URL of '/search'.
+You can set a custom URL for a page in the Advanced Options.
+It's probably also a good idea to uncheck the 'show in menu' option for this page.
+
+Remember to restart your web server.
+
+A sample search form can be found in [views/shared/_search.html.erb](http://github.com/blob/master/app/views/shared/_search.html.erb).
+You can either use this partial directly, or copy the appropriate parts.
+
+## Searching
+
+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/settings.rb`` like so:
+
+    Refinery.searchable_models = [Page]
+
+Simply add any additional models you wish to search to this array.  For example, if you have the [portfolio plugin](http://github.com/resolve/refinerycms-portfolio) installed:
+
+    Refinery.searchable_models = [Page, PortfolioEntry]
+
+Any model you wish to search will need to be indexed using acts as indexed. To add indexing, simple add:
+
+    acts_as_indexed :fields => [:title, :body]
+
+If your model doesn't use a ``:title attribute``, remember to add an ``alias_attribute``:
+
+    alias_attribute :title, :name #for example
+
+You will need to replace the indexed fields with those appropriate for your model.
+The above line will add indexing to PortfolioEntry in the portfolio plugin, which does not come indexed.
+
+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.

data/refinerycms-search.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name              = %q{refinerycms-search}
+  s.version           = %q{0.9.8}
+  s.date              = %q{2010-10-01}
+  s.summary           = %q{Extra 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{info@refinerycms.com}
+  s.authors           = ["Resolve Digital"]
+  s.require_paths     = %w(lib)
+
+  s.add_dependency    'refinerycms', '>= 0.9.8'
+
+  s.files             = [
+    'app',
+    'app/controllers',
+    'app/controllers/search_controller.rb',
+    'app/helpers',
+    'app/helpers/search_helper.rb',
+    'app/models',
+    'app/models/search_engine.rb',
+    'app/views',
+    'app/views/search',
+    'app/views/search/show.html.erb',
+    'app/views/shared',
+    'app/views/shared/_search.html.erb',
+    'config',
+    'config/locales',
+    'config/locales/en.yml',
+    'config/routes.rb',
+    'lib',
+    'lib/gemspec.rb',
+    'lib/refinerycms-search.rb',
+    'readme.md',
+    'refinerycms-search.gemspec'
+  ]
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: refinerycms-search
+version: !ruby/object:Gem::Version 
+  hash: 43
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 8
+  version: 0.9.8
+platform: ruby
+authors: 
+- Resolve Digital
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-01 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: refinerycms
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :runtime
+  version_requirements: *id001
+description: Provides extra functionality for searching your frontend website using Refinery CMS.
+email: info@refinerycms.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/controllers/search_controller.rb
+- app/helpers/search_helper.rb
+- app/models/search_engine.rb
+- app/views/search/show.html.erb
+- app/views/shared/_search.html.erb
+- config/locales/en.yml
+- config/routes.rb
+- lib/gemspec.rb
+- lib/refinerycms-search.rb
+- readme.md
+- refinerycms-search.gemspec
+has_rdoc: true
+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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Extra search handling for Refinery CMS
+test_files: []
+