ActionItem25: providing a nice-looking and extensible search engine

git-svn-id: https://svn.colivre.coop.br/svn/noosfero/trunk@1002 3f533792-8f58-4932-b0fe-aaf55b0a4547

ActionItem25: providing a nice-looking and extensible search engine
git-svn-id: https://svn.colivre.coop.br/svn/noosfero/trunk@1002 3f533792-8f58-4932-b0fe-aaf55b0a4547
AntonioTerceiro
1 parent b910579d
Showing 13 changed files with 88 additions and 15 deletions Show diff stats
app/controllers/public/search_controller.rb
app/helpers/search_helper.rb
app/models/article.rb
app/models/profile.rb
app/views/search/_article.rhtml
app/views/search/_profile.rhtml
app/views/search/index.rhtml
config/ferret_server.yml
lib/acts_as_searchable.rb
public/designs/icons/default/README
public/designs/icons/default/style.css
public/designs/icons/default/user_icon.png
public/stylesheets/search.css
 class SearchController < ApplicationController  
+
+  SEARCHES = []
+
+  def self.search(&block)
+    SEARCHES << block
+  end
+
+  protected
+
+  #############################################
+  # XXX add yours searches here
+  #############################################
+
+  search do |query|
+    Article.find_tagged_with(query)
+  end
+
+  search do |query|
+    Article.find_by_contents(query)
+  end
+
+  search do |query|
+    Profile.find_by_contents(query)
+  end
+
+  # auxiliary method to search in all defined searches and collect the results 
+  def search(query)
+    SEARCHES.inject([]) do |acc,finder|
+      acc += finder.call(query)
+    end.sort_by do |hit|
+      (hit.respond_to? :ferret_score) ? (1.0 - hit.ferret_score) : (-1.0)
+    end
+  end
+
+  public
+
   def index
     @query = params[:query] || ''
-    # TODO: uncomment find_by_contents when ferret start working 
-    @results = Article.find_tagged_with(@query) + Article.find_all_by_title(@query) + Profile.find_all_by_name(@query)
+    @results = search(@query)
   end
+
 end
 module SearchHelper
+  def partial_for_hit(klass)
+    name = klass.name.underscore
+    if File.exists?(File.join(RAILS_ROOT, 'app', 'views', 'search', "_#{name}.rhtml"))
+      name
+    else
+      partial_for_hit(klass.superclass)
+    end
+  end
 end
@@ -14,6 +14,8 @@ class Article &lt; ActiveRecord::Base
  
   acts_as_versioned
  
+  acts_as_searchable :fields => [ :name, :abstract, :body ]
+
   # retrieves all articles belonging to the given +profile+ that are not
   # sub-articles of any other article.
   def self.top_level_for(profile)
@@ -15,7 +15,7 @@ class Profile &lt; ActiveRecord::Base
  
   acts_as_design
  
-  acts_as_ferret :fields => [ :name ]
+  acts_as_searchable :fields => [ :name, :identifier ]
  
   # Valid identifiers must match this format.
   IDENTIFIER_FORMAT = /^[a-z][a-z0-9_]*[a-z0-9]$/
@@ -0,0 +1,10 @@
+<div>
+  <strong>
+    <%= design_display_icon('cms') %>
+    <%= link_to_document(hit) %>
+  </strong>
+</div>
+<div>
+  <%= hit.abstract %>
+</div>
+
@@ -0,0 +1,9 @@
+<%# FIXME add photo if available %>
+<%# FIXME add more information %>
+
+<div>
+  <strong>
+    <%= design_display_icon('person') %>
+    <%= link_to_homepage(hit.name, hit.identifier) %>
+  </strong>
+</div>
 <h2> <%= _('Listing articles found')  %> </h2>
  
 <h3> <%= _('Searching for ') + @query  %></h3>
-<% @results.each do |a| %>
-  <h4> <%= link_to_document(a) if a.kind_of?(Article) %> </h4>
-  <h4> <%= link_to_homepage(a.name, a.identifier) if a.kind_of?(Profile) %> </h4>
-
+<% @results.each do |hit| %>
+  <%= render :partial => partial_for_hit(hit.class), :locals => { :hit => hit } %>
+  <div class='search-relevance'>
+    <%= _('Relevance: %d%%') % (hit.respond_to?(:ferret_score) ? (hit.ferret_score * 100.0).round : 100) %>
+  </div>
+  <br style='clear: left'/>
 <% end %>
 production:
-  host: ferret.yourdomain.com
-  port: 9010
-  pid_file: log/ferret.pid
-development:
   host: localhost
   port: 9010
   pid_file: log/ferret.pid
-test:
-  host: localhost
-  port: 9009
-  pid_file: log/ferret.pid
@@ -0,0 +1,7 @@
+class << ActiveRecord::Base
+
+  def acts_as_searchable(options = {}, ferret_options = {})
+    acts_as_ferret({ :remote => true }.merge(options), ferret_options)
+  end
+
+end
@@ -15,6 +15,7 @@ abiword_48.png            dlg-neu      apps/
 gtk-save.png              Nuovo        stock/
 gtk-go-up.png             Nuovo        stock/
 gtk-cancel.png            Nuovo        stock/
+user_icon.png             Nuovo        apps/
  
 Licensing of GNOME themes
 =========================
@@ -7,3 +7,4 @@
 .button.save { background-image: url(gtk-save.png); }
 .button.up { background-image: url(gtk-go-up.png); }
 .button.cancel { background-image: url(gtk-cancel.png); }
+.button.person { background-image: url(user_icon.png); }
@@ -0,0 +1,5 @@
+.search-relevance {
+  font-size: smaller;
+  font-style: italic;
+  color: gray;
+}
1	1	class SearchController < ApplicationController
	2	+
	3	+ SEARCHES = []
	4	+
	5	+ def self.search(&block)
	6	+ SEARCHES << block
	7	+ end
	8	+
	9	+ protected
	10	+
	11	+ #############################################
	12	+ # XXX add yours searches here
	13	+ #############################################
	14	+
	15	+ search do \|query\|
	16	+ Article.find_tagged_with(query)
	17	+ end
	18	+
	19	+ search do \|query\|
	20	+ Article.find_by_contents(query)
	21	+ end
	22	+
	23	+ search do \|query\|
	24	+ Profile.find_by_contents(query)
	25	+ end
	26	+
	27	+ # auxiliary method to search in all defined searches and collect the results
	28	+ def search(query)
	29	+ SEARCHES.inject([]) do \|acc,finder\|
	30	+ acc += finder.call(query)
	31	+ end.sort_by do \|hit\|
	32	+ (hit.respond_to? :ferret_score) ? (1.0 - hit.ferret_score) : (-1.0)
	33	+ end
	34	+ end
	35	+
	36	+ public
	37	+
2	38	def index
3	39	@query = params[:query] \|\| ''
4		- # TODO: uncomment find_by_contents when ferret start working
5		- @results = Article.find_tagged_with(@query) + Article.find_all_by_title(@query) + Profile.find_all_by_name(@query)
	40	+ @results = search(@query)
6	41	end
	42	+
7	43	end
...	...
1	1	module SearchHelper
	2	+ def partial_for_hit(klass)
	3	+ name = klass.name.underscore
	4	+ if File.exists?(File.join(RAILS_ROOT, 'app', 'views', 'search', "_#{name}.rhtml"))
	5	+ name
	6	+ else
	7	+ partial_for_hit(klass.superclass)
	8	+ end
	9	+ end
2	10	end
...	...
...	...	@@ -14,6 +14,8 @@ class Article < ActiveRecord::Base
14	14
15	15	acts_as_versioned
16	16
	17	+ acts_as_searchable :fields => [ :name, :abstract, :body ]
	18	+
17	19	# retrieves all articles belonging to the given +profile+ that are not
18	20	# sub-articles of any other article.
19	21	def self.top_level_for(profile)
...	...
...	...	@@ -15,7 +15,7 @@ class Profile < ActiveRecord::Base
15	15
16	16	acts_as_design
17	17
18		- acts_as_ferret :fields => [ :name ]
	18	+ acts_as_searchable :fields => [ :name, :identifier ]
19	19
20	20	# Valid identifiers must match this format.
21	21	IDENTIFIER_FORMAT = /^[a-z][a-z0-9_]*[a-z0-9]$/
...	...
...	...	@@ -0,0 +1,10 @@
	1	+<div>
	2	+ <strong>
	3	+ <%= design_display_icon('cms') %>
	4	+ <%= link_to_document(hit) %>
	5	+ </strong>
	6	+</div>
	7	+<div>
	8	+ <%= hit.abstract %>
	9	+</div>
	10	+
...	...
...	...	@@ -0,0 +1,9 @@
	1	+<%# FIXME add photo if available %>
	2	+<%# FIXME add more information %>
	3	+
	4	+<div>
	5	+ <strong>
	6	+ <%= design_display_icon('person') %>
	7	+ <%= link_to_homepage(hit.name, hit.identifier) %>
	8	+ </strong>
	9	+</div>
...	...
1	1	<h2> <%= _('Listing articles found') %> </h2>
2	2
3	3	<h3> <%= _('Searching for ') + @query %></h3>
4		-<% @results.each do \|a\| %>
5		- <h4> <%= link_to_document(a) if a.kind_of?(Article) %> </h4>
6		- <h4> <%= link_to_homepage(a.name, a.identifier) if a.kind_of?(Profile) %> </h4>
7		-
	4	+<% @results.each do \|hit\| %>
	5	+ <%= render :partial => partial_for_hit(hit.class), :locals => { :hit => hit } %>
	6	+ <div class='search-relevance'>
	7	+ <%= _('Relevance: %d%%') % (hit.respond_to?(:ferret_score) ? (hit.ferret_score * 100.0).round : 100) %>
	8	+ </div>
	9	+ <br style='clear: left'/>
8	10	<% end %>
...	...
1	1	production:
2		- host: ferret.yourdomain.com
3		- port: 9010
4		- pid_file: log/ferret.pid
5		-development:
6	2	host: localhost
7	3	port: 9010
8	4	pid_file: log/ferret.pid
9		-test:
10		- host: localhost
11		- port: 9009
12		- pid_file: log/ferret.pid
...	...
...	...	@@ -0,0 +1,7 @@
	1	+class << ActiveRecord::Base
	2	+
	3	+ def acts_as_searchable(options = {}, ferret_options = {})
	4	+ acts_as_ferret({ :remote => true }.merge(options), ferret_options)
	5	+ end
	6	+
	7	+end
...	...
...	...	@@ -15,6 +15,7 @@ abiword_48.png dlg-neu apps/
15	15	gtk-save.png Nuovo stock/
16	16	gtk-go-up.png Nuovo stock/
17	17	gtk-cancel.png Nuovo stock/
	18	+user_icon.png Nuovo apps/
18	19
19	20	Licensing of GNOME themes
20	21	=========================
...	...