documentation 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5e399e51d0a72a5c02f5f3ca8f685db8bd1c108
-  data.tar.gz: 87fd194fa118aab0f340dfe7e2d309aeda1316b3
+  metadata.gz: a6a7eb85e7b85787e4d484056de4034f93aea7b8
+  data.tar.gz: 235d5670da70ba8f1b7468dac9584eb2fdfe52cb
 SHA512:
-  metadata.gz: 0e55f1375b4c19e75f6a3fa5b3f9abc2bd151d57f963da9a0b39e52170ac9079a1acb31178e6f7f1adc3c0cf2bd7a30427c3fd5051976f4bdc04e10d992981bf
-  data.tar.gz: a93324934c94310c07f929aabf6b0531a6f93c5e106f8c371172608ee7162f15d43e8e0688698491f99c3f4f43b6e70c0e14c7341923c9a7c812fb4853ebf82d
+  metadata.gz: cfc40c753fe359e3697e9fedd1cd30245c0e73f5df68e8aa4f0f17f416a7bec369a71d441bf3adfdef9401e37715269ab48c23ec540e1d45909be3ca74b9f918
+  data.tar.gz: e2a26c2538c3bdaccce81624ad5bee3d3566bfd6b3ad7ba5e8ee243880037c272a75c3281076f79e5819e0aeabec881674b551e420ffc9f3b993d323bd70893f

data/app/views/documentation/pages/search.html.haml

@@ -6,21 +6,7 @@
     %p.noSearchResults= t('.no_results', :query => params[:query])
   - else
     %h1= t('.title', :query => params[:query])
-    %p.searchSummary= t('.summary', :total_results => @result.total_results, :start_result => @result.start_result_number, :end_result => @result.end_result_number)
-    
-    %ul.searchResults
-      - for page in @result.results
-        %li
-          %h4= link_to page.title, page_path(page.full_permalink)
-          - unless page.parents.empty?
-            %p.in
-              = t('.in')
-              = page.parents.map { |c| link_to(h(c.title), page_path(c.full_permalink))}.join(" ⇒ ").html_safe
-          %p.excerpt= @result.excerpt_for(page)
-        
-  
-    %p.pagination
-      - unless @result.first_page?
-        = link_to t('.previous_page'), search_path(:query => params[:query], :page => @result.page - 1), :class => 'button'
-      - unless @result.last_page?
-        = link_to t('.next_page'), search_path(:query => params[:query], :page => @result.page + 1), :class => 'button'
+    %p.searchSummary= documentation_search_summary(@result)
+    = documentation_search_results(@result)        
+    %p.pagination= documentation_search_pagination(@result, :link_class => 'button')
+    

data/config/locales/en.yml

@@ -14,7 +14,14 @@ en:
     helpers:
       documentation_breadcrumb_for:
         default_root_link: Home
-    
+      documentation_search_summary:
+        text: "Found %{total_results} pages matching your query. Showing results %{start_result} to %{end_result}"
+      documentation_search_results:
+        in: in
+      documentation_search_pagination:
+        next: Next page
+        previous: Previous page
+        
     pages:
       index:
         welcome_title: Welcome to Documentation
@@ -50,7 +57,5 @@ en:
       search:
         title: "Search results for '%{query}'"
         no_results: "No pages were found matching '%{query}'"
-        summary: "Found %{total_results} pages matching your query. Showing results %{start_result} to %{end_result}"
-        in: in
         next_page: Next page
         previous_page: Previous page

data/lib/documentation/version.rb

@@ -1,3 +1,3 @@
 module Documentation
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/documentation/view_helpers.rb

@@ -109,5 +109,51 @@ module Documentation
       @documentation_authorizer ||= Documentation.config.authorizer.new(controller)
     end
     
+    # 
+    # Return summary information for search results
+    #
+    def documentation_search_summary(result)
+      t('documentation.helpers.documentation_search_summary.text', :total_results => result.total_results, :start_result => result.start_result_number, :end_result => result.end_result_number, :query => result.query)
+    end
+    
+    #
+    # Return the search results
+    #
+    def documentation_search_results(result, options = {})
+      options[:class] ||= 'searchResults'
+      String.new.tap do |s|
+        s << "<ul class='#{options[:class]}'>"
+        result.results.each do |page|
+          s << "<li>"
+          s << "<h4><a href='#{documentation_doc_root}/#{page.full_permalink}'>#{page.title}</a></h4>"
+          unless page.parents.empty?
+            s << "<p class='in'>#{t('documentation.helpers.documentation_search_results.in')} "
+            s << page.parents.map { |c| link_to(h(c.title), "#{documentation_doc_root}/#{c.full_permalink}")}.join(" &#8658; ").html_safe
+            s << "</p>"
+          end
+          s << "<p class='excerpt'>#{result.excerpt_for(page)}</p>"
+          s << "</li>"
+        end
+        s << "</ul>"
+      end.html_safe
+    end
+    
+    #
+    # Return search pagination links
+    #
+    def documentation_search_pagination(result, options = {})
+      String.new.tap do |s|
+        unless result.first_page?
+          querystring = {:query => result.query, :page => result.page - 1}.to_query
+          s << link_to(t('documentation.helpers.documentation_search_pagination.previous'), "#{documentation_doc_root}/search?#{querystring}", :class => [options[:link_class], options[:previous_link_class]].compact.join(' '))
+        end
+
+        unless result.last_page?
+          querystring = {:query => result.query, :page => result.page + 1}.to_query
+          s << link_to(t('documentation.helpers.documentation_search_pagination.next'), "#{documentation_doc_root}/search?#{querystring}", :class => [options[:link_class], options[:next_link_class]].compact.join(' '))
+        end
+      end.html_safe
+    end
+    
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -98,14 +98,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: uglifier
   requirement: !ruby/object:Gem::Requirement