Ticket #523: search_extension.diff

vendor/extensions/search/test/unit/search_page_test.rb

@@ +1 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class SearchPageTest < Test::Unit::TestCase
+
+  test_helper :render
+  fixtures :pages, :page_parts
+  
+  def setup
+    @page = pages(:search)
+    
+    @request = ActionController::TestRequest.new(:url => '/search/')
+    @response = ActionController::TestResponse.new
+  end
+  
+  def test_search_simple_found
+    expected_result = [pages(:homepage)]
+    ['home', 'HOME', 'homE', 'home page'].each do |query|
+      @request.parameters[:q] = query
+      @page.process(@request, @response)
+      assert_response(:success)
+      assert(@page.query_result.eql?(expected_result))
+      assert_equal(query, @page.query)
+    end
+  end
+  
+  def test_search_in_title
+    query = @request.parameters[:q] = 'services title'
+    @page.process(@request, @response)
+    assert_response(:success)
+    assert(@page.query_result.eql?([pages(:services)]))
+    assert_equal(query, @page.query)
+  end
+  
+  def test_search_blank
+    @page.process(@request, @response)
+    assert_response(:success)
+    assert(@page.query_result.empty?)
+    assert_equal("", @page.query)
+  end
+  
+  def test_search_not_found
+    @request.parameters[:q] = 'not_existent_word'
+    @page.process(@request, @response)
+    assert_response(:success)
+    assert(@page.query_result.empty?)
+  end
+  
+  def test_search_with_exclusion
+    search_page = pages(:search)
+    home_page = pages(:homepage)
+    # full result contains :homepage and :search
+    query = @request.parameters[:q] = 'page'
+    @page.process(@request, @response)
+    assert_response(:success)
+    assert(@page.query_result.eql?([home_page, search_page]))
+    # exclude :search
+    @request.parameters[:exclude_pages] = search_page.url
+    @page.process(@request, @response)
+    assert_response(:success)
+    assert(@page.query_result.eql?([home_page]))
+    # exclude multiple pages
+    @request.parameters[:exclude_pages] = search_page.url + "," + home_page.url
+    @page.process(@request, @response)
+    assert_response(:success)
+    assert(@page.query_result.eql?([]))
+  end
+  
+  def test_ajax_search_renders_ajax_body
+    @request.parameters[:q] = 'home'
+    @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
+    #assert(@request.xhr?)
+    @page.process(@request, @response)
+    assert_response(:success)
+    assert_equal(@page.render_part(:ajax_body), @response.body)
+    @page.part('ajax_body').destroy
+    @page.process(@request, @response)
+    assert_response(:success)
+    assert_equal(@page.render_part(:body), @response.body)
+  end
+end

vendor/extensions/search/test/unit/search_tags_test.rb

@@ +1 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class SearchTagsTest < Test::Unit::TestCase
+
+  test_helper :render
+  fixtures :pages
+  
+  def setup
+    @page = pages(:homepage)
+  end
+  
+  def test_global_tags
+    assert_tag_defined @page, "search:form"
+    assert_tag_defined @page, "search:form:input"
+  end
+  
+  def test_tag_search_form_minimal
+    assert_render_error "`search:form' tag must contain `action' attribute", "<r:search:form />"
+    assert_render_match %r{<form [^>]*action="/search/".*>}, "<r:search:form action='/search/'></r:search:form>"
+    assert_render_match %r{<form [^>]*action="/another_search/".*>}, "<r:search:form action='/another_search/'></r:search:form>"
+  end
+  
+  def test_tag_search_form_with_custom_attributes
+    add_atts = {:action => "/search/", :id => "search_form", 
+      :class => "default", :method => "get"}
+      
+    add_atts.each do |att, value|
+      assert_render_match(
+        %r{<form [^>]*#{att}="#{value}".*>},
+        "<r:search:form " + 
+          add_atts.collect {|key, value| %{#{key}="#{value}"}}.join(" ") + 
+          "/>"
+      )
+    end
+  end
+  
+  def test_tag_search_form_input
+    assert_render_error "`search:form' tag must contain `action' attribute", 
+      "<r:search:form:input />"
+    assert_render_match %r{<input[\s]+type="text"[\s]+name="q"[\s]+id="q"[\s]+/>}, 
+      %{<r:search:form action="/search/"><r:input /></r:search:form>}
+  end
+  
+  def test_tag_search_form_input_with_custom_attributes
+    add_atts = {:id => "q", :size => 10,
+      :class => "query_input", :maxlength => 15}
+      
+    add_atts.each do |att, value|
+      assert_render_match(
+        %r{<input[\s]+[^>]*#{att}="#{value}".*>},
+        "<r:search:form action='/search/'><r:input " + 
+          add_atts.collect {|key, value| %{#{key}="#{value}"}}.join(" ") + 
+          "/></r:search:form>"
+      )
+    end
+  end
+  
+  def test_tag_search_form_input_with_restricted_attributes
+    add_atts = {:name => "blah", :type => "checkbox"}
+    
+    add_atts.each do |att, value|
+      assert_render_error "`search:form:input' tag can't contain `#{att}' attribute", 
+        %{<r:search:form action='/search/'><r:input #{att}="#{value}" />
+          </r:search:form>}
+    end
+  end
+  
+  def test_tag_search_form_input_with_custom_id
+    ids = ['my_id1', 'my_id2']
+    ids.each do |id|
+      assert_render_match %r{<input[\s]+[^/>]*id="#{id}"[\s]+[^\>]*/>},
+        %{<r:search:form action="/search/"><r:input id="#{id}" />
+          </r:search:form>}
+    end
+  end
+
+end

vendor/extensions/search/test/functional/search_extension_test.rb

@@ -10 +10 @@
-  end  
-  
-  def test_initialization
-RADIANT_ROOT + '/vendor/extensions/search'
+File.join(File.expand_path(RAILS_ROOT), 'vendor', 'extensions', 'search')
-    assert_equal 'Search', SearchExtension.extension_name
-  end
-  

vendor/extensions/search/test/fixtures/pages.yml

@@ +1 @@
+homepage:
+  id: 1
+  title: Ruby Home Page
+  breadcrumb: Home
+  slug: /
+  status_id: 100
+  parent_id:
+  published_at: 2006-01-30 08:41:07 
+search:
+  id: 2
+  title: Search
+  slug: search
+  status_id: 100
+  parent_id: 1
+  published_at: 2006-02-05 08:44:07
+  class_name: SearchPage
+services:
+  id: 3
+  title: Services Title
+  slug: services
+  status_id: 100
+  parent_id: 1
+  published_at: 2006-02-05 08:44:07

vendor/extensions/search/test/fixtures/page_parts.yml

@@ +1 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+homepage_body:
+  id: 1
+  name: body
+  content: This is the body portion of the Ruby home page.
+  page_id: 1
+homepage_extended:
+  id: 2
+  name: extended
+  content: This is an extended portion of the Ruby home page.
+  page_id: 1
+search_body:
+  id: 3
+  name: body
+  content: This is the body of the Search page.
+  page_id: 2
+services_body:
+  id: 4
+  name: body
+  content: We provide great services.
+  page_id: 3
+search_ajax_body:
+  id: 5
+  name: ajax_body
+  content: AJAX body of the Search page.
+  page_id: 2

vendor/extensions/search/app/models/search_page.rb

@@ -7 +7 @@
-    tag.expand
-  end
-
-
-
-
-
-
-
-
+#
+#
+#
+#
+#
+#
+#
-   
-  desc %{    Renders the passed query.}
-  tag 'search:query' do |tag|
@@ -64 +64 @@
-    @query_result = []
-    @query = ""
-    q = @request.parameters[:q]
+    exclude_pages = (@request.parameters[:exclude_pages] || '').split(",")
-    unless (@query = q.to_s.strip).blank?
-      tokens = query.split.collect { |c| "%#{c.downcase}%"}
-      pages = Page.find(:all, :include => [ :parts ],
-          :conditions => [(["((LOWER(content) LIKE ?) OR (LOWER(title) LIKE ?))"] * tokens.size).join(" AND "), 
-                         *tokens.collect { |token| [token] * 2 }.flatten])
-
+
+
-    end
-
-
-
+
+
+
+
+
+
+
-    else
-render_page_part(:body)
+super
-    end
-  end
-  

vendor/extensions/search/app/models/search_tags.rb

@@ +1 @@
+module SearchTags
+  include Radiant::Taggable
+
+  desc %{    The namespace for all search tags.}
+  tag 'search' do |tag|
+    tag.expand
+  end
+  
+  desc %{    Outputs <form> element of the search form.
+    <r:search:form action="controller_url"[ ajax_results="element_id"[ ajax_delay="500"]][exclude_pages="/url/1/,/url/2/"]>
+    
+    action        - url to the page of type Search that will handle search request
+    ajax_results  - if you want your form to be AJAX enabled, specify ID of element that will contain search results
+    ajax_delay    - time of inactivity before search request submitted to the server
+    exclude_pages - comma separated list of page URLs to exclude from results. Don't forget trailing slashes
+    
+    Any additional parameters will be added to the tag as attributes.
+    If you use AJAX enabled form you can have separate page part for displaying AJAX results. It should be called `ajax_body'. 
+    
+    *Usage:*
+<pre><code><r:search:form action="controller_url">
+  <r:search:form:input />
+  <input type="submit" />
+  ...
+</r:search:form></code></pre>
+  }
+  tag 'search:form' do |tag|
+    unless action = tag.attr['action']
+      raise StandardTags::TagError.new("`search:form' tag must contain `action' attribute")
+    end
+    result_id = tag.attr['ajax_results'] || nil
+    ajax_delay = tag.attr['ajax_delay'] || 500
+    exclude_pages = tag.attr['exclude_pages'] || ''
+    int_attrs = ['ajax_results', 'ajax_delay', 'exclude_pages']
+    output = %{<form method="get"} +
+      tag.attr.delete_if {|key, value| int_attrs.include?(key)
+        }.collect {|key, value| %{#{key}="#{value}"}}.join(" ") +
+      %{>
+        <input type="hidden" name="exclude_pages" value="#{exclude_pages}" />
+        #{tag.expand}
+      </form>}
+    # if result_id not given, skip AJAX form init
+    return output if result_id.nil?
+    # otherwise init AJAX
+    output << %{      <script type="text/javascript">
+      var search_previous_value = '';
+      var search_handler;
+      Event.observe("q", "keyup", function(ev){
+        clearTimeout(search_handler);
+        search_form = Event.findElement(ev, 'form');
+        search_handler = setTimeout(function(ev){
+          if (this.getValue() == search_previous_value) { return; }
+          search_previous_value = this.getValue();
+          new Ajax.Updater("#{result_id}", search_form.action, {
+            parameters: $(search_form).serialize(true),
+            evalScripts: true,
+            onLoading: function(){
+              search_form.addClassName('loading');
+            },
+            onComplete: function(){
+              search_form.removeClassName('loading');
+              $("#{result_id}").show();
+            }
+          });
+        }.bind(this, ev), #{ajax_delay});
+      }.bindAsEventListener($('q')));
+    </script>
+    }
+  end
+  
+  desc %{    Outputs input element for search form. All additional parameters will
+    be added as tag attributes. However don't use type and name. ID attribute
+    can be overwritten}
+  tag 'search:form:input' do |tag|
+    ["type", "name"].each do |attr|
+      if tag.attr[attr]
+        raise StandardTags::TagError.new("`search:form:input' tag can't contain `#{attr}' attribute")
+      end
+    end
+    
+    tag_id = tag.attr['id'] || "q"
+    
+    output = %{<input type="text" name="q" id="#{tag_id}" } + 
+      tag.attr.delete_if {|attr, value| attr == 'id'
+      }.collect {|key, value| %{#{key}="#{value}"}}.join(" ") +
+      "/>"
+  end
+  
+end

vendor/extensions/search/search_extension.rb

@@ -9 +9 @@
-  
-  def activate
-    # admin.tabs.add "Search", "/admin/search", :after => "Layouts", :visibility => [:all]
+    Page.send :include, SearchTags
-    SearchPage
-  end
-