webgen-tipue_search-bundle 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDQyNWZhZGM2NDVhYjUyYjRkMjBjYzc3ZDMyMDlkMDhjOWNlZGRmNg==
+  data.tar.gz: !binary |-
+    ZTBkYjhmNTAwYWNkZGUxYzA1NzA5MWZmNGY5NTgxMDZiNjk3OWNlMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDNkNWFiOWJhODkxMmRkYThmOGMwMTljNGJjM2E2MjM2MjllNWY1NzM3NDk4
+    YzhmY2IwYjRmMjFmNjkxNzRmZjZlNzIxNDRiNjRmNWQ1NzUwN2YyNGU0NDUx
+    OGRlYTkxOTkzMjNlYzY5OWE4MWEyOTY4M2RkOTk3NGI4MmM5MmQ=
+  data.tar.gz: !binary |-
+    NGE0N2ViZjgwYzI4M2Q3ODYwZjg2YjJlMmRjZGFjNWEyZWI4YjEyMGQ5NWIz
+    Y2FhNTA0MzQ5NmJiY2JiNWQ3NzgzY2QwMGVjODE4M2YxMDQ0OGNmZTRkNWQ2
+    Mzk5NzNkMGIwMjg1OWZkYzQxZDdkY2VhZmRmYjg3MDQwYmI4NjU=

data/ChangeLog

@@ -0,0 +1,3 @@
+# 2013-08-25, Version 1.0.0
+
+  - Initial release with Tipue Search 3.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Thomas Leitner
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE-TIPUESEARCH

@@ -0,0 +1,20 @@
+Tipue Search Copyright (c) 2012 Tipue
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,123 @@
+# Tipue Search integration for [webgen]
+
+[Tipue Search] is a site search engine which uses jQuery. It provides
+three modes of operation:
+
+* live mode where one supplies a list of URLs which are then searched
+  (not very fast, needs a web server),
+
+* json mode where the search data is loaded via an Ajax request (still
+  needs a web server) and
+
+* static mode where the search data is loaded directly by the HTML file
+  (fast, no web server needed).
+
+[Tipue Search]: http://www.tipue.com/search/
+[webgen]: http://webgen.rubyforge.org
+
+
+# Usage
+
+## Provided Paths
+
+This [webgen] extension bundle contains all needed Tipue Search files
+except jQuery. Remember that one needs to load the jQuery library before
+Tipue Search!
+
+The Tipue Search files are provided as passive paths at the following
+locations:
+
+* `/javascriptss/tipue_search/tipuesearch.min.js` - the main Tipue
+  Search javascript file
+
+* `/javascripts/tipue_search/tipuesearch_set.js` - defines stop and
+  replacement words as well as word stems
+
+* `/stylesheets/tipue_search/tipuesearch.css` - the CSS file that includes the
+  necessary styles
+
+* `/stylesheets/tipue_search/img/loader.gif`,
+  `/stylesheets/tipue_search/img/link.png`,
+  `/stylesheets/tipue_search/img/search.gif,
+  `/stylesheets/tipue_search/img/expand.png` - images needed by the CSS
+  file
+
+Additionally, the following paths are provided:
+
+* `/templates/tipue_search.template` - provides the blocks for rendering
+  the tag and the path handler contents
+
+
+## Easy Usage
+
+Tipue Search can easily be integrated into a webgen website by using the
+included `tipue_search` tag:
+
+    {tipue_search: {path: data.js, options: {mode: static},
+                    nodes: {alcn: /**/*.html}}}
+
+The option `options` can be used to set any [Tipue Search
+option][tipuset] and the option `nodes` specifies the nodes that should
+appear in the search index (more information on this below).
+
+If this tag occurs on a page, the needed nodes are automatically linked
+to it and a new node representing the search index at the specified path
+is created.
+
+[tipueset]: http://www.tipue.com/search/docs/set/
+
+
+## Manual Usage
+
+It is also possible to craft the needed HTML fragments manually and just
+use this extension for providing the necessary files. If you want to use
+it this way, have a look at the [Tipue Search documentation][tipuedoc]
+
+A search index node can be created by the path handler `tipue_search`
+which uses paths in Webgen Page Format. Since no path extension is
+registered for it, you need to explicitly specify the `handler` meta
+information for a path that should be handled by the tipue_search
+handler via a meta information path.
+
+The following meta information on a tipue search node should be set:
+
+* `entries` (mandatory): The node finder option set specifying the nodes
+  that should be used for the search index. It is assumed that the nodes
+  are valid HTML files.
+
+* `mode` (mandatory): The Tipue Search mode (static, live or json).
+
+* `content_css`: A CSS query for selecting the elements that contain the
+  text that should be indexed. Default is `body`.
+
+The template which defines the content of a search index node can be
+customized by adding a content block named 'tipue_search' to the path.
+
+[tipuedoc]: http://www.tipue.com/search/docs/
+
+
+
+# Installation
+
+The easiest way to install this extension bundle is by installing the
+corresponding Rubygem:
+
+    gem install webgen-tipue_search-bundle
+
+If you don't use Rubygems, copy the folder
+`lib/webgen/bundle/tipue_search` into your `ext` directory.
+
+After that you just need to tell webgen to use this extension bundle by
+adding the following line to your `ext/init.rb` file:
+
+    load("tipue_search")
+
+
+# Copyright and license
+
+Copyright (c) 2013 Thomas Leitner under the MIT License (see LICENSE)
+
+* * *
+
+The included Tipue Search files are also licensed under the MIT (see
+LICENSE-TIPUESEARCH).

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/webgen/bundle/tipue_search/data/javascripts/tipue_search/tipuesearch.min.js

@@ -0,0 +1,12 @@
+(function($){$.fn.tipuesearch=function(options){var set=$.extend({"show":7,"newWindow":false,"showURL":true,"minimumLength":3,"descriptiveWords":25,"highlightTerms":true,"highlightEveryTerm":false,"mode":"static","liveDescription":"*","liveContent":"*","contentLocation":"tipuesearch/tipuesearch_content.json"},options);return this.each(function(){var tipuesearch_in={pages:[]};$.ajaxSetup({async:false});if(set.mode=="live")for(var i=0;i<tipuesearch_pages.length;i++)$.get(tipuesearch_pages[i],"",function(html){var cont=
+$(set.liveContent,html).text();cont=cont.replace(/\s+/g," ");var desc=$(set.liveDescription,html).text();desc=desc.replace(/\s+/g," ");var t_1=html.toLowerCase().indexOf("<title>");var t_2=html.toLowerCase().indexOf("</title>",t_1+7);if(t_1!=-1&&t_2!=-1)var tit=html.slice(t_1+7,t_2);else var tit="No title";tipuesearch_in.pages.push({"title":tit,"text":desc,"tags":cont,"loc":tipuesearch_pages[i]})});if(set.mode=="json")$.getJSON(set.contentLocation,function(json){tipuesearch_in=$.extend({},json)});
+if(set.mode=="static")tipuesearch_in=$.extend({},tipuesearch);var tipue_search_w="";if(set.newWindow)tipue_search_w=' target="_blank"';function getURLP(name){return decodeURIComponent(((new RegExp("[?|&]"+name+"="+"([^&;]+?)(&|#|;|$)")).exec(location.search)||[,""])[1].replace(/\+/g,"%20"))||null}if(getURLP("q")){$("#tipue_search_input").val(getURLP("q"));getTipueSearch(0,true)}$("#tipue_search_button").click(function(){getTipueSearch(0,true)});$(this).keyup(function(event){if(event.keyCode=="13")getTipueSearch(0,
+true)});function getTipueSearch(start,replace){$("#tipue_search_content").hide();var out="";var results="";var show_replace=false;var show_stop=false;var d=$("#tipue_search_input").val().toLowerCase();d=$.trim(d);var d_w=d.split(" ");d="";for(var i=0;i<d_w.length;i++){var a_w=true;for(var f=0;f<tipuesearch_stop_words.length;f++)if(d_w[i]==tipuesearch_stop_words[f]){a_w=false;show_stop=true}if(a_w)d=d+" "+d_w[i]}d=$.trim(d);d_w=d.split(" ");if(d.length>=set.minimumLength){if(replace){var d_r=d;for(var i=
+0;i<d_w.length;i++)for(var f=0;f<tipuesearch_replace.words.length;f++)if(d_w[i]==tipuesearch_replace.words[f].word){d=d.replace(d_w[i],tipuesearch_replace.words[f].replace_with);show_replace=true}d_w=d.split(" ")}var d_t=d;for(var i=0;i<d_w.length;i++)for(var f=0;f<tipuesearch_stem.words.length;f++)if(d_w[i]==tipuesearch_stem.words[f].word)d_t=d_t+" "+tipuesearch_stem.words[f].stem;d_w=d_t.split(" ");var c=0;found=new Array;for(var i=0;i<tipuesearch_in.pages.length;i++){var score=1E9;var s_t=tipuesearch_in.pages[i].text;
+for(var f=0;f<d_w.length;f++){var pat=new RegExp(d_w[f],"i");if(tipuesearch_in.pages[i].title.search(pat)!=-1)score-=2E5-i;if(tipuesearch_in.pages[i].text.search(pat)!=-1)score-=15E4-i;if(set.highlightTerms){if(set.highlightEveryTerm)var patr=new RegExp("("+d_w[f]+")","gi");else var patr=new RegExp("("+d_w[f]+")","i");s_t=s_t.replace(patr,"<b>$1</b>")}if(tipuesearch_in.pages[i].tags.search(pat)!=-1)score-=1E5-i}if(score<1E9)found[c++]=score+"^"+tipuesearch_in.pages[i].title+"^"+s_t+"^"+tipuesearch_in.pages[i].loc}if(c!=
+0){if(show_replace==1){out+='<div id="tipue_search_warning_head">Showing results for '+d+"</div>";out+='<div id="tipue_search_warning">Search for <a href="javascript:void(0)" id="tipue_search_replaced">'+d_r+"</a></div>"}if(c==1)out+='<div id="tipue_search_results_count">1 result</div>';else{c_c=c.toString().replace(/\B(?=(\d{3})+(?!\d))/g,",");out+='<div id="tipue_search_results_count">'+c_c+" results</div>"}found.sort();var l_o=0;for(var i=0;i<found.length;i++){var fo=found[i].split("^");if(l_o>=
+start&&l_o<set.show+start){out+='<div class="tipue_search_content_title"><a href="'+fo[3]+'"'+tipue_search_w+">"+fo[1]+"</a></div>";var t=fo[2];var t_d="";var t_w=t.split(" ");if(t_w.length<set.descriptiveWords)t_d=t;else for(var f=0;f<set.descriptiveWords;f++)t_d+=t_w[f]+" ";t_d=$.trim(t_d);if(t_d.charAt(t_d.length-1)!=".")t_d+=" ...";out+='<div class="tipue_search_content_text">'+t_d+"</div>";if(set.showURL){t_url=fo[3];if(t_url.length>45)t_url=fo[3].substr(0,45)+" ...";out+='<div class="tipue_search_content_loc"><a href="'+
+fo[3]+'"'+tipue_search_w+">"+t_url+"</a></div>"}}l_o++}if(c>set.show){var pages=Math.ceil(c/set.show);var page=start/set.show;out+='<div id="tipue_search_foot"><ul id="tipue_search_foot_boxes">';if(start>0)out+='<li><a href="javascript:void(0)" class="tipue_search_foot_box" id="'+(start-set.show)+"_"+replace+'">Prev</a></li>';if(page<=2){var p_b=pages;if(pages>3)p_b=3;for(var f=0;f<p_b;f++)if(f==page)out+='<li class="current">'+(f+1)+"</li>";else out+='<li><a href="javascript:void(0)" class="tipue_search_foot_box" id="'+
+f*set.show+"_"+replace+'">'+(f+1)+"</a></li>"}else{var p_b=page+3;if(p_b>pages)p_b=pages;for(var f=page;f<p_b;f++)if(f==page)out+='<li class="current">'+(f+1)+"</li>";else out+='<li><a href="javascript:void(0)" class="tipue_search_foot_box" id="'+f*set.show+"_"+replace+'">'+(f+1)+"</a></li>"}if(page+1!=pages)out+='<li><a href="javascript:void(0)" class="tipue_search_foot_box" id="'+(start+set.show)+"_"+replace+'">Next</a></li>';out+="</ul></div>"}}else out+='<div id="tipue_search_warning_head">Nothing found</div>'}else if(show_stop)out+=
+'<div id="tipue_search_warning_head">Nothing found</div><div id="tipue_search_warning">Common words are largely ignored</div>';else{out+='<div id="tipue_search_warning_head">Search too short</div>';if(set.minimumLength==1)out+='<div id="tipue_search_warning">Should be one character or more</div>';else out+='<div id="tipue_search_warning">Should be '+set.minimumLength+" characters or more</div>"}$("#tipue_search_content").html(out);$("#tipue_search_content").slideDown(200);$("#tipue_search_replaced").click(function(){getTipueSearch(0,
+false)});$(".tipue_search_foot_box").click(function(){var id_v=$(this).attr("id");var id_a=id_v.split("_");getTipueSearch(parseInt(id_a[0]),id_a[1])})}})}})(jQuery);

data/lib/webgen/bundle/tipue_search/data/javascripts/tipue_search/tipuesearch_set.js

@@ -0,0 +1,23 @@
+
+/*
+Tipue Search 3.0.1
+Copyright (c) 2013 Tipue
+Tipue Search is released under the MIT License
+http://www.tipue.com/search
+*/
+
+
+var tipuesearch_stop_words = ["and", "be", "by", "do", "for", "he", "how", "if", "is", "it", "my", "not", "of", "or", "the", "to", "up", "what", "when"];
+
+var tipuesearch_replace = {"words": [
+     {"word": "tipua", replace_with: "tipue"},
+     {"word": "javscript", replace_with: "javascript"}
+]};
+
+var tipuesearch_stem = {"words": [
+     {"word": "e-mail", stem: "email"},
+     {"word": "javascript", stem: "script"},
+     {"word": "javascript", stem: "js"}
+]};
+
+

data/lib/webgen/bundle/tipue_search/data/stylesheets/tipue_search/metainfo

@@ -0,0 +1,4 @@
+--- paths
+tipuesearch.css:
+  handler: copy
+  pipeline: erb

data/lib/webgen/bundle/tipue_search/data/stylesheets/tipue_search/tipuesearch.css

@@ -0,0 +1,159 @@
+
+/*
+Tipue Search 3.0.1
+Copyright (c) 2013 Tipue
+Tipue Search is released under the MIT License
+http://www.tipue.com/search
+*/
+
+
+#tipue_search_input
+{
+     font: 12px/1.7 'open sans', sans-serif;
+	color: #333;
+	padding: 7px;
+	width: 150px;
+	border: 1px solid #e2e2e2;
+	border-radius: 0;
+	-moz-appearance: none;
+	-webkit-appearance: none;
+     box-shadow: none; 
+	outline: 0;
+	margin: 0;
+}
+#tipue_search_input:focus
+{
+     border: 1px solid #ccc;    
+}
+#tipue_search_button
+{
+     width: 70px;
+     height: 36px;
+     border: 0;
+     border-radius: 1px;
+     background: #5193fb url('<%= context.tag("relocatable", "img/search.gif") %>') no-repeat center;
+	outline: none;
+}
+#tipue_search_button:hover
+{
+     background-color: #4589fb;
+}
+
+#tipue_search_content
+{
+     clear: left;
+     max-width: 650px;
+	padding: 25px 0 13px 0;
+	margin: 0;
+}
+#tipue_search_loading
+{
+     padding-top: 60px;     
+     background: #fff url('<%= context.tag("relocatable", "img/loader.gif") %>') no-repeat left;
+}
+
+#tipue_search_warning_head
+{
+     font: 300 16px/1.6 'open sans', sans-serif;
+	color: #333;
+}
+#tipue_search_warning
+{
+     font: 12px/1.6 'open sans', sans-serif;
+	color: #333;
+	margin: 7px 0;
+}
+#tipue_search_warning a
+{
+     color: #3f72d8;
+     text-decoration: none;
+}
+#tipue_search_warning a:hover
+{
+	padding-bottom: 1px;
+	border-bottom: 1px solid #ccc;   
+}
+#tipue_search_results_count
+{
+     font: 13px/1.6 'open sans', sans-serif;
+	color: #333;
+}
+.tipue_search_content_title
+{
+     font: 300 23px/1.6 'open sans', sans-serif;
+	margin-top: 31px;
+}
+.tipue_search_content_title a
+{
+     color: #3f72d8;
+     text-decoration: none;
+}
+.tipue_search_content_title a:hover
+{
+	padding-bottom: 1px;
+	border-bottom: 1px solid #ccc;   
+}
+.tipue_search_content_text
+{
+     font: 12px/1.7 'open sans', sans-serif;
+	color: #333;
+	padding: 13px 0;
+}
+.tipue_search_content_loc
+{
+     font: 300 13px/1.7 'open sans', sans-serif;
+     overflow: auto;
+}
+.tipue_search_content_loc a
+{
+     color: #555;
+     text-decoration: none;
+}
+.tipue_search_content_loc a:hover
+{
+	padding-bottom: 1px;
+	border-bottom: 1px solid #ccc;     
+}
+#tipue_search_foot
+{
+     margin: 51px 0 21px 0;
+}
+#tipue_search_foot_boxes
+{
+	padding: 0;
+	margin: 0;
+     font: 12px/1 'open sans', sans-serif;
+}
+#tipue_search_foot_boxes li
+{
+	list-style: none;
+	margin: 0;
+	padding: 0;
+	display: inline;
+}
+#tipue_search_foot_boxes li a
+{
+	padding: 7px 13px 8px 13px;
+     background-color: #f1f1f1;
+     border: 1px solid #dcdcdc;
+     border-radius: 1px;
+	color: #333;
+	margin-right: 7px;
+	text-decoration: none;
+	text-align: center;
+}
+#tipue_search_foot_boxes li.current
+{
+	padding: 7px 13px 8px 13px;
+     background: #fff;
+     border: 1px solid #dcdcdc;
+     border-radius: 1px;
+	color: #333;
+	margin-right: 7px;
+	text-align: center;
+}
+#tipue_search_foot_boxes li a:hover
+{
+	border: 1px solid #ccc;
+	background-color: #f3f3f3;
+}

data/lib/webgen/bundle/tipue_search/data/templates/tipue_search.template

@@ -0,0 +1,24 @@
+--- name:tag.tipue_search pipeline:erb
+<%
+options = context[:config]['tag.tipue_search.options'].dup
+options['contentLocation'] = context[:data_node].url if options['mode'] == 'json'
+%>
+<input type="text" placeholder="search" id="tipue_search_input" />
+<input type="button" id="tipue_search_button" />
+<div id="tipue_search_content"></div>
+<script>
+$(document).ready(function() {
+     $('#tipue_search_input').tipuesearch(<%= JSON.dump(options) %>);
+});
+</script>
+--- name:tipue_search pipeline:ruby
+if context.node['mode'] == 'live'
+  context.content = "var tipuesearch_pages = #{JSON.dump(context.node.entries.map {|e| e.url})}"
+else
+  data = []
+  context.node.entries.each do |node|
+    data << {'loc' => node.url, 'title' => node['title'], 'tags' => '', 'text' => context.node.text_for(node)}
+  end
+
+  context.content = "var tipuesearch = {\"pages\": #{JSON.dump(data)}};"
+end

data/lib/webgen/bundle/tipue_search/info.yaml

@@ -0,0 +1,73 @@
+author: &author Thomas Leitner <t_leitner@gmx.at>
+summary: webgen extension bundle for Tipue Search javascript site search engine
+description: |
+  Tipue Search is a site search engine which uses jQuery. It can use a
+  pre-built search index to provide a fast search experience for a
+  static website.
+version: 1.0.0
+license: MIT
+homepage: http://github.com/gettalong/webgen-tipue_search-bundle
+
+extensions:
+  path_handler.tipue_search:
+    author: *author
+    summary: |
+      Creates a search index data file for the Tipue Search site search
+      engine
+
+  tag.tipue_search:
+    author: *author
+    summary: |
+      Creates a site search field and result area for displaying search
+      results
+
+options:
+  tag.tipue_search.path:
+    summary: |
+      The source path that should be used for creating the Tipue Search
+      data file. The destination path is derived from this path the
+      usual way. Don't use a path that does already exist!
+    syntax: |
+      `PATH` where `PATH` is a relative or absolute source path
+    example:
+      tag: |
+        {tipue_search: {path: data.js, options: {mode: static}, entries: {alcn: /**/*.html}}}
+
+  tag.tipue_search.options:
+    summary: |
+      Options passed to the Tipue Search engine (and partially to
+      path_handler.tipue_search). The keys 'mode' and 'liveDescription'
+      are mapped to the meta information keys 'mode' and 'content_css'
+      for path_handler.tipue_search.
+    syntax: |
+      `{KEY: VALUE, ...}` where `KEY` and `VALUE` are key-value pairs of
+      Tipue Search options
+    example:
+      config: |
+        tag.tipue_search.options: {}
+      tag: |
+        {tipue_search: {path: data.js, options: {mode: static}, entries: {alcn: /**/*.html}}}
+
+  tag.tipue_search.entries:
+    summary: |
+      Node finder option set defining the search index. The nodes of the
+      result set may only contain valid HTML content.
+    syntax: |
+      `OPTIONS` where `OPTIONS` is a hash with node finder options
+    example:
+      tag: |
+        {tipue_search: {path: data.js, options: {mode: static}, entries: {alcn: /**/*.html}}}
+
+  tag.tipue_search.template:
+    summary: |
+      The template node used for rendering the tag. It has to contain the block
+      'tag.tipue_search' because this block is used for rendering.
+    syntax: |
+      `PATH` where `PATH` is the (a)(l)cn of the template node
+    example:
+      config: |
+        tag.tipue_search.template: /other.template
+      tag: |
+        {tipue_search: {path: data.js, options: {mode: static},
+                        entries: {alcn: /**/*.html}, template: /my.template}}
+

data/lib/webgen/bundle/tipue_search/init.rb

@@ -0,0 +1,19 @@
+# Extension bundle initialization
+
+mount_passive('data/', '/')
+
+require_relative('tipue_search_tag')
+require_relative('tipue_search_path_handler')
+
+is_hash = lambda do |val|
+  raise "The value has to be a hash" unless val.kind_of?(Hash)
+  val
+end
+
+website.ext.tag.register('Webgen::Tag::TipueSearch', :mandatory => ['path', 'entries'])
+option('tag.tipue_search.path', '')
+option('tag.tipue_search.options', {'mode' => 'static'}, &is_hash)
+option('tag.tipue_search.entries', nil, &is_hash)
+option('tag.tipue_search.template', '/templates/tipue_search.template')
+
+website.ext.path_handler.register('Webgen::PathHandler::TipueSearch')

data/lib/webgen/bundle/tipue_search/tipue_search_path_handler.rb

@@ -0,0 +1,77 @@
+# -*- encoding: utf-8 -*-
+
+require 'json'
+require 'nokogiri'
+require 'webgen/path_handler/base'
+require 'webgen/path_handler/page_utils'
+require 'webgen/context'
+
+module Webgen
+  class PathHandler
+
+    # Path handler for creating a Tipue Search site index.
+    class TipueSearch
+
+      include Base
+      include PageUtils
+
+
+      # Provides custom methods for tipue search nodes.
+      class Node < PageUtils::Node
+
+        # Return the entries for the tipue search +node+.
+        def entries
+          tree.website.ext.node_finder.find(node_info[:entries], self)
+        end
+
+        # Return the text content of the given node.
+        def text_for(node)
+          if tree.website.ext.destination.exists?(node.dest_path)
+            Nokogiri::HTML(tree.website.ext.destination.read(node.dest_path)).
+              css(self['content_css'] || 'body').text.gsub(/\s+/, ' ')
+          else
+            ''
+          end
+        end
+
+      end
+
+
+      # The mandatory keys that need to be set in a tipue search file.
+      MANDATORY_INFOS = %W[mode entries]
+
+      # Create a Tipue Search site index from +path+.
+      def create_nodes(path, blocks)
+        if MANDATORY_INFOS.any? {|t| path.meta_info[t].nil?}
+          raise Webgen::NodeCreationError.new("At least one of #{MANDATORY_INFOS.join('/')} is missing",
+                                              "path_handler.tipue_search", path)
+        end
+
+        if @website.config['website.base_url'].empty?
+          raise Webgen::NodeCreationError.new("The configuration option 'website.base_url' needs to be set",
+                                              "path_handler.tipue_search", path)
+        end
+
+        path.ext = 'js'
+        path['node_class'] = Node.to_s
+        path['write_order'] = 'z'
+        create_node(path) do |node|
+          set_blocks(node, blocks)
+          node.node_info[:entries] = {:flatten => true, :and => node['entries']}
+          @website.ext.item_tracker.add(node, :nodes, :node_finder_option_set,
+                                        {:opts => node.node_info[:entries], :ref_alcn => node.alcn}, :content)
+        end
+      end
+
+      # Return the rendered feed represented by +node+.
+      def content(node)
+        context = Webgen::Context.new(@website)
+        context.render_block(:name => "tipue_search", :node => 'first',
+                             :chain => [node, node.resolve("/templates/tipue_search.template", node.lang, true),
+                                        node].compact)
+      end
+
+    end
+
+  end
+end

data/lib/webgen/bundle/tipue_search/tipue_search_tag.rb

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+require 'json'
+require 'webgen/tag'
+
+module Webgen
+  class Tag
+
+    # Generates the Tipue Search HTML fragments (input box, result area) and links the necessary
+    # nodes to the destination node.
+    module TipueSearch
+
+      # Generate the menu.
+      def self.call(tag, body, context)
+        path = Webgen::Path.append(context.ref_node.parent.alcn, context[:config]['tag.tipue_search.path'])
+        path = Webgen::Path.new(path)
+
+        path.meta_info['mode'] = context[:config]['tag.tipue_search.options']['mode'] || 'static'
+        path.meta_info['content_css'] = context[:config]['tag.tipue_search.options']['liveDescription'] || 'body'
+        path.meta_info['entries'] = context[:config]['tag.tipue_search.entries']
+        path.meta_info['handler'] = 'tipue_search'
+
+        node = context.website.ext.path_handler.create_secondary_nodes(path, '', context.ref_node.alcn).first
+
+        context.html_head.link_file(:css, '/stylesheets/tipue_search/tipuesearch.css')
+        context.html_head.link_file(:js, '/javascripts/tipue_search/tipuesearch_set.js')
+        context.html_head.link_file(:js, node.alcn) unless path.meta_info['mode'] == 'json'
+        context.html_head.link_file(:js, '/javascripts/tipue_search/tipuesearch.min.js')
+
+        context[:data_node] = node
+        Webgen::Tag.render_tag_template(context, "tipue_search")
+      end
+
+    end
+
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: webgen-tipue_search-bundle
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thomas Leitner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Tipue Search is a site search engine which uses jQuery. It can use
+  a
+
+  pre-built search index to provide a fast search experience for a
+
+  static website.
+
+'
+email:
+- t_leitner@gmx.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/webgen/bundle/tipue_search/data/javascripts/tipue_search/tipuesearch.min.js
+- lib/webgen/bundle/tipue_search/data/javascripts/tipue_search/tipuesearch_set.js
+- lib/webgen/bundle/tipue_search/data/stylesheets/tipue_search/img/expand.png
+- lib/webgen/bundle/tipue_search/data/stylesheets/tipue_search/img/link.png
+- lib/webgen/bundle/tipue_search/data/stylesheets/tipue_search/img/loader.gif
+- lib/webgen/bundle/tipue_search/data/stylesheets/tipue_search/img/search.gif
+- lib/webgen/bundle/tipue_search/data/stylesheets/tipue_search/metainfo
+- lib/webgen/bundle/tipue_search/data/stylesheets/tipue_search/tipuesearch.css
+- lib/webgen/bundle/tipue_search/data/templates/tipue_search.template
+- lib/webgen/bundle/tipue_search/info.yaml
+- lib/webgen/bundle/tipue_search/init.rb
+- lib/webgen/bundle/tipue_search/tipue_search_path_handler.rb
+- lib/webgen/bundle/tipue_search/tipue_search_tag.rb
+- README.md
+- ChangeLog
+- LICENSE
+- LICENSE-TIPUESEARCH
+- VERSION
+homepage: http://github.com/gettalong/webgen-tipue_search-bundle
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: webgen extension bundle for Tipue Search javascript site search engine
+test_files: []