rdoc-generator-fivefish 0.0.1.pre.44 → 0.0.1.pre.46

data/data/rdoc-generator-fivefish/css/fivefish.min.css

@@ -41,6 +41,34 @@ body {
 	     url('../fonts/IstokWeb-Bold.woff') format('woff');
 }
 
+ul.typeahead.dropdown-menu {
+	right: 0;
+}
+ul.typeahead.dropdown-menu li {
+	border-bottom: 1px solid #eee;
+	padding: 2px 4px;
+}
+ul.typeahead.dropdown-menu li:last-child {
+	border: none;
+}
+ul.typeahead.dropdown-menu .search-item-name {
+	font-weight: 600;
+}
+ul.typeahead.dropdown-menu .search-item-rank {
+	font-size: 9px;
+	padding: 0 4px;
+	color: #ccc;
+}
+ul.typeahead.dropdown-menu i {
+	padding: 0 2px;
+}
+ul.typeahead.dropdown-menu .search-item-snippet {
+	overflow: hidden;
+	display: block;
+	margin: 0 14px;
+}
+
+
 /* Page header */
 h2.namespace {
 	color: #666;
@@ -140,9 +168,22 @@ section.protected-methods div.method header i {
 }
 
 
+section.methods a[name] {
+	position: relative;
+	top: -35px;
+	display: none;
+}
+
 
 /* Individual method */
-div.method {
+div.method {}
+a:target + div.method {
+	border: 2px solid #666;
+	border-radius: 2px;
+	background: rgba( 255,255,255, 0.7 );
+	-moz-box-shadow: 0 0 3px rgba(0, 0, 0, 0.35);
+	-webkit-box-shadow: 0 0 3px rgba(0, 0, 0, 0.35);
+	box-shadow: 0 0 3px rgba(0, 0, 0, 0.35);
 }
 div.method + div.method {
 	margin-top: 1em;
@@ -163,40 +204,6 @@ div.method div.method-description p {
 }
 
 
-/* Incremental search modal dialog */
-#incremental-search header {
-	background: #eee;
-	border-radius: 3px;
-	padding: 2px;
-}
-#incremental-search .search-string {
-	padding: 0 0 1em;
-}
-#incremental-search .search-input-label {
-	width: 20%;
-}
-#incremental-search .search-input {
-	background-color: rgba(153, 203, 255, 0.64);
-	font: 22px monospace;
-	padding: 1px 4px;
-	display: inline-block;
-	width: 80%;
-}
-#incremental-search .search-input:empty:after {
-	color: #999;
-	content: "(Start typing to search)";
-}
-#incremental-search .search-input-label {
-	vertical-align: baseline;
-}
-#incremental-search header h4 {
-	font-size: 14px;
-}
-#incremental-search .search-results dl:empty:after {
-	content: "No matches.";
-	color: #666;
-}
-
 /* @group Source Code */
 
 div.method-source-code {
@@ -251,23 +258,21 @@ div.file-metadata {
  by Cory LaViska
  http://labs.abeautifulsite.net/jquery-dropdown/
  */
-.dropdown-menu {
+div.dropdown-menu {
 	font: 14px sans-serif;
 	position: absolute;
 	z-index: 9999999;
 	display: none;
+	background: white;
 }
 
-.dropdown-menu UL {
+.dropdown-menu ul {
 	min-width: 160px;
 	list-style: none;
 	background: #FFF;
-	border: solid 1px #DDD;
-	border: solid 1px rgba(0, 0, 0, .2);
 	border-radius: 6px;
-	box-shadow: 0 5px 10px rgba(0, 0, 0, .2);
 	overflow: visible;
-	padding: 4px 0;
+	padding: 0;
 	margin: 0;
 }
 

data/data/rdoc-generator-fivefish/js/fivefish.min.js

@@ -9,30 +9,57 @@
  *
 */
 jQuery&&function(a){function b(b){var d=a(this),e=a(a(this).attr("data-dropdown")),f=d.hasClass("dropdown-open");b.preventDefault(),b.stopPropagation(),c();if(f||d.hasClass("dropdown-disabled"))return;e.css({left:e.hasClass("anchor-right")?d.offset().left-(e.outerWidth()-d.outerWidth()):d.offset().left,top:d.offset().top+d.outerHeight()}).show(),d.addClass("dropdown-open")}function c(b){var c=b?a(b.target).parents().andSelf():null;if(c&&c.is(".dropdown-menu")&&!c.is("A"))return;a("BODY").find(".dropdown-menu").hide().end().find("[data-dropdown]").removeClass("dropdown-open")}a.extend(a.fn,{dropdown:function(b,d){switch(b){case"hide":return c(),a(this);case"attach":return a(this).attr("data-dropdown",d);case"detach":return c(),a(this).removeAttr("data-dropdown");case"disable":return a(this).addClass("dropdown-disabled");case"enable":return c(),a(this).removeClass("dropdown-disabled")}}}),a(function(){a("BODY").on("click.dropdown","[data-dropdown]",b),a("HTML").on("click.dropdown",c)})}(jQuery);
-/*
- * jQuery Hotkeys Plugin
- * Copyright 2010, John Resig
- * Dual licensed under the MIT or GPL Version 2 licenses.
+/*!
+ * string_score.js: String Scoring Algorithm 0.1.10 
+ *
+ * http://joshaven.com/string_score
+ * https://github.com/joshaven/string_score
  *
- * Based upon the plugin by Tzury Bar Yochay:
- * http://github.com/tzuryby/hotkeys
+ * Copyright (C) 2009-2011 Joshaven Potter <yourtech@gmail.com>
+ * Special thanks to all of the contributors listed here https://github.com/joshaven/string_score
+ * MIT license: http://www.opensource.org/licenses/mit-license.php
  *
- * Original idea by:
- * Binny V A, http://www.openjs.com/scripts/events/keyboard_shortcuts/
+ * Date: Tue Mar 1 2011
 */
-(function(a){function b(b){if(typeof b.data!="string")return;var c=b.handler,d=b.data.toLowerCase().split(" ");b.handler=function(b){if(!(this===b.target||!/textarea|select/i.test(b.target.nodeName)&&b.target.type!=="text"))return;var e=b.type!=="keypress"&&a.hotkeys.specialKeys[b.which],f=String.fromCharCode(b.which).toLowerCase(),g,h="",i={};b.altKey&&e!=="alt"&&(h+="alt+"),b.ctrlKey&&e!=="ctrl"&&(h+="ctrl+"),b.metaKey&&!b.ctrlKey&&e!=="meta"&&(h+="meta+"),b.shiftKey&&e!=="shift"&&(h+="shift+"),e?i[h+e]=!0:(i[h+f]=!0,i[h+a.hotkeys.shiftNums[f]]=!0,h==="shift+"&&(i[a.hotkeys.shiftNums[f]]=!0));for(var j=0,k=d.length;j<k;j++)if(i[d[j]])return c.apply(this,arguments)}}a.hotkeys={version:"0.8",specialKeys:{8:"backspace",9:"tab",13:"return",16:"shift",17:"ctrl",18:"alt",19:"pause",20:"capslock",27:"esc",32:"space",33:"pageup",34:"pagedown",35:"end",36:"home",37:"left",38:"up",39:"right",40:"down",45:"insert",46:"del",96:"0",97:"1",98:"2",99:"3",100:"4",101:"5",102:"6",103:"7",104:"8",105:"9",106:"*",107:"+",109:"-",110:".",111:"/",112:"f1",113:"f2",114:"f3",115:"f4",116:"f5",117:"f6",118:"f7",119:"f8",120:"f9",121:"f10",122:"f11",123:"f12",144:"numlock",145:"scroll",191:"/",224:"meta"},shiftNums:{"`":"~",1:"!",2:"@",3:"#",4:"$",5:"%",6:"^",7:"&",8:"*",9:"(",0:")","-":"_","=":"+",";":": ","'":'"',",":"<",".":">","/":"?","\\":"|"}},a.each(["keydown","keyup","keypress"],function(){a.event.special[this]={add:b}})})(jQuery);
+/**
+ * Scores a string against another string.
+ *  'Hello World'.score('he');     //=> 0.5931818181818181
+ *  'Hello World'.score('Hello');  //=> 0.7318181818181818
+ */
+String.prototype.score=function(a,b){if(this==a)return 1;if(a=="")return 0;var c=0,d=a.length,e=this,f=e.length,g,h,i=1,j;for(var k=0,l,m,n,o,p,q;k<d;++k){n=a.charAt(k),o=e.indexOf(n.toLowerCase()),p=e.indexOf(n.toUpperCase()),q=Math.min(o,p),m=q>-1?q:Math.max(o,p);if(m===-1){if(b){i+=1-b;continue}return 0}l=.1,e[m]===n&&(l+=.1),m===0?(l+=.6,k===0&&(g=1)):e.charAt(m-1)===" "&&(l+=.8),e=e.substring(m+1,f),c+=l}return h=c/d,j=(h*(d/f)+h)/2,j/=i,g&&j+.15<1&&(j+=.15),j};
 /**
  * Fivefish Javascript
  * $Id$
  *
  * @author Michael Granger <ged@FaerieMUD.org>
  *
-*/
-/**
- * A Bootstrap component for the index search interface. Inherits from Bootstrap's
- * modal component, and borrows a bunch of code from the typeahead component.
+ * Copyright © 2012, Michael Granger
+ * All rights reserved.
  *
- * @version $Rev$
- * @requires bootstrap.modal.js
- */
-function initFivefish(){console.debug("Loaded. Waiting for DOM to be ready."),$(document).ready(onReady)}function hookTooltips(){$("header.hero-unit h1").popover({placement:"right"})}function hookKeyboardShortcuts(){$.each(keyboardShortcuts,function(a,b){console.debug("Registering shortcut: %s -> %o",a,b),$("body").bind("keyup",a,b)})}function hookSourceToggles(){$("div.method header i").click(function(a){var b=a.target,c=$(b).parents("div").get(0),d=$(c).find("div.method-source-code");console.debug("Toggling: %o",d),d.fadeToggle()})}function doIncrementalSearch(){}function hookSearchOverlay(){console.debug("Setting up searchbox"),$("#incremental-search").searchbox(SearchIndex),$("#search-button").click(function(){$("#incremental-search").searchbox("show")})}function onReady(){console.debug("Ready!"),hookTooltips(),hookKeyboardShortcuts(),hookSourceToggles(),hookSearchOverlay()}(function(a){"use strict";var b=function(a,b,c){this.init(a,b,c)};b.prototype=a.extend({},a.fn.modal.Constructor.prototype,{constructor:b,searchTimeout:null,data:[],relPrefix:".",init:function(b,c,d){this.$element=a(b),this.$input=this.$element.find(".search-input"),this.$meth_list=this.$element.find(".method-search-results dl"),this.$mod_list=this.$element.find(".module-search-results dl"),this.$file_list=this.$element.find(".file-search-results dl"),this.options=d,this.data=c,this.relPrefix=a("link[rel=prefix]").attr("href"),this.$element.on("shown",a.proxy(this.shown,this)).on("hide",a.proxy(this.hided,this)).on("search",a.proxy(this.startSearch,this)).on("clear",a.proxy(this.clearSearch,this))},shown:function(){console.debug("Listening for keyboard input."),a(document).on("keypress",a.proxy(this.keypress,this)).on("keyup",a.proxy(this.keyup,this)),(a.browser.webkit||a.browser.msie)&&a(document).on("keydown",a.proxy(this.keypress,this))},hided:function(b){console.debug("Done listening for keyboard input."),a(document).off("keypress keyup keydown")},keyup:function(a){var b=a.which,c=a.shiftKey;console.debug("Keycode: %d, shifted: %o",b,c);if(a.ctrlKey)switch(b){case 85:this.$element.trigger("clear")}else if(b>=65&&b<=90||b==32||b>=48&&b<=57){var d=String.fromCharCode(b);c||(d=d.toLowerCase()),this.$input.append(d),this.$element.trigger("search")}else switch(b){case 27:this.hide();break;case 8:this.$input.html(this.$input.html().slice(0,-1)),this.$element.trigger("search")}a.stopPropagation(),a.preventDefault()},keypress:function(a){console.debug("Keypress event: %o",a)},clearSearch:function(){console.debug("Clearing the search input."),this.$input.html(""),this.$element.trigger("search")},startSearch:function(a){var b=this;this.searchTimeout&&(console.debug("Interrupting a previous search."),clearTimeout(this.searchTimeout)),console.debug("Scheduling a search..."),this.searchTimeout=setTimeout(function(){b.search()},500)},search:function(){var b=this.$input.html();console.debug("Searching for: '%s'!",b);if(b=="")this.displayMatches(this.data);else{var c=new RegExp(b,"i");console.debug("  pattern is: %s",c);var d=a.grep(this.data,function(a){return console.debug("    testing: %s",a.name),c.test(a.name)});this.displayMatches(d,c)}},displayMatches:function(b,c){var d=0,e=0,f=0,g=5,h,i=this;this.$element.find(".search-results dl").empty(),console.debug("Sorting %d matching items...",b.length),a.each(b,function(b,j){h=null;switch(j.type){case"anymethod":d<g&&(console.debug("  adding method '%s'",j.name),h=i.$meth_list,d++);break;case"normalclass":case"normalmodule":e<g&&(console.debug("  adding mod '%s'",j.name),h=i.$mod_list,e++);break;case"toplevel":f<g&&(console.debug("  adding file '%s'",j.name),h=i.$file_list,f++);break;default:console.debug("ignoring unknown item '%s'",j.type)}if(h){var k;c?k=j.name.replace(c,'<span class="highlight">$&</span>'):k=j.name,a("<a>").attr("href",i.relPrefix+"/"+j.link).html(k).wrap("<dt>").appendTo(h),a("<dd>").html(j.snippet).appendTo(h)}else console.debug("  no more room for %s '%s'",j.type,j.name)})},blur:function(a){var b=this;setTimeout(function(){b.hide()},150)},click:function(a){a.stopPropagation(),a.preventDefault(),this.select()}}),a.fn.searchbox=function(c,d){return this.each(function(){var e=a(this),f=e.data("searchbox"),g=typeof c=="object"?c:[],h=a.extend({},a.fn.modal.defaults,e.data(),typeof d=="object"&&d);f||(console.debug("Creating a new searchbox for data: %s",typeof g),f=new b(this,g,h),e.data("searchbox",f)),typeof c=="string"&&f[c]()})},a.fn.searchbox.Constructor=b,a.fn.searchbox.defaults=a.extend({},a.fn.modal.defaults)})(window.jQuery);var keyboardShortcuts={"/":function(a){$("#incremental-search").searchbox("show")},"shift+/":function(a){$("#shortcut-help").modal()}};
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice,
+ *   this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the author/s, nor the names of the project's
+ *   contributors may be used to endorse or promote products derived from this
+ *   software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+*/
+function initFivefish(){console.debug("Loaded. Waiting for DOM to be ready."),$(document).ready(onReady)}function hookTooltips(){$("header.hero-unit h1").popover({placement:"right"})}function hookSourceToggles(){$("div.method header i").click(function(a){var b=a.target,c=$(b).parents("div").get(0),d=$(c).find("div.method-source-code");console.debug("Toggling: %o",d),d.fadeToggle()})}function makeRankingTerm(a){return a.name.replace(/.*::/,"").toLowerCase()}function matchIndexItem(a){var b=this.query,c=makeRankingTerm(a),d=c.score(b,RankFuzziness);return d>=MatchThreshold?!0:!1}function sortIndexItems(a){var b=this.query;return a.sort(function(a,c){var d=makeRankingTerm(a),e=makeRankingTerm(c),f=d.score(b,RankFuzziness),g=e.score(b,RankFuzziness);return f>g?-1:f<g?1:0})}function pickItemIcon(a){var b;switch(a.type){case"anymethod":case"metamethod":b="plus-sign";break;case"normalmodule":b="gift";break;case"normalclass":b="briefcase";break;case"toplevel":b="file";break;default:b="question-sign"}return b}function highlightMatchingItem(a){var b=a.snippet.replace(/<\/?p>/g,"").replace(/\.(.|\n)*/,"."),c=pickItemIcon(a),d=makeRankingTerm(a),e=d.score(this.query,RankFuzziness),f='<span class="search-item"><i class="icon-'+c+'"></i>'+'<span class="search-item-name">'+a.name+"</span>"+'<span class="search-item-rank">'+(e*10).toFixed()+"</span>"+"<br />"+'<span class="search-item-snippet">'+b+"</span>"+"</span>",g=$(f);return g.data("searchitem",a),g}function updateSearchInput(a){var b=this.$menu.find(".active .search-item").data("searchitem");return $("#navbar-search-target").val(b.link),b.name}function hookSearchForm(){$(".navbar-search .search-query").typeahead({source:SearchIndex,matcher:matchIndexItem,sorter:sortIndexItems,updater:updateSearchInput,highlighter:highlightMatchingItem}).change(function(){var a=$("link[rel=prefix]").attr("href"),b=$("#navbar-search-target").val();window.location.assign(a+"/"+b)})}function onReady(){console.debug("Ready!"),hookTooltips(),hookSourceToggles(),hookSearchForm()}const MatchThreshold=.5,RankFuzziness=.5;

data/data/rdoc-generator-fivefish/templates/class.tmpl

@@ -21,6 +21,32 @@
 			<span class="label"><?call klass.type ?></span>
 		</header>
 
+		<section class="module-relations">
+			<dl>
+				<?unless klass.module? ?>
+				<dt>Superclass</dt>
+				<?if klass.superclass.respond_to?(:path) ?>
+				<dd class="superclass"><a href="[?attr rel_prefix ?]/[?call klass.superclass.path ?]"><?call
+					klass.superclass.full_name ?></a></dd>
+				<?else?>
+				<dd class="superclass"><?call klass.superclass ?></dd>
+				<?end if ?>
+				<?end unless ?>
+
+				<?unless klass.includes.empty? ?>
+				<dt>Included Modules</dt>
+				<?for inc in klass.includes ?>
+				<?if inc.module.respond_to?(:path) ?>
+				<dd class="include"><a href="[?call klass.aref_to(inc.module.path) ?]"><?call
+					inc.module.full_name ?></a></dd>
+				<?else ?>
+				<dd class="include"><?call inc.name ?></dd>
+				<?end if ?>
+				<?end for ?>
+				<?end unless ?>
+			</dl>
+		</section>
+
 		<section class="description">
 			<?call klass.description ?>
 		</section>
@@ -92,7 +118,8 @@
 				</header>
 
 				<?for meth in methodlist ?>
-				<div id="<?call meth.aref ?>" class="method[?if meth.is_alias_for
+				<a name="[?call meth.aref ?]">anchor</a>
+				<div id="<?call meth.aref ?>-doc" class="method[?if meth.is_alias_for
 					?] method-alias[?end if ?]">
 
 					<header>

data/data/rdoc-generator-fivefish/templates/layout.tmpl

@@ -74,10 +74,11 @@
 					</ul>
 				</div><!--/.nav-collapse -->
 				<span class="pull-right">
-					<button id="search-button" class="btn">
-						<i class="icon-search"></i>
-						Search
-					</button>
+					<form class="navbar-search">
+						<input type="hidden" id="navbar-search-target" value="" />
+						<input type="text" class="search-query" value=""
+							placeholder="Method, Class, or Filename" />
+					</form>
 				</form>
 			</div>
 		</div>
@@ -117,58 +118,5 @@
 	</ul>
 	</div>
 
-	<!-- Keyboard shortcut help -->
-	<div class="modal" id="shortcut-help">
-		<div class="modal-header">
-			<a class="close" data-dismiss="modal">×</a>
-			<h3>Keyboard Shortcuts</h3>
-		</div>
-		<div class="modal-body">
-			<table>
-				<tbody>
-					<tr>
-						<th>/</th>
-						<td>Search</td>
-					</tr>
-					<tr>
-						<th>?</th>
-						<td>Show this help</td>
-					</tr>
-				</tbody>
-			</table>
-		</div>
-	</div>
-
-	<div class="modal" id="incremental-search">
-		<div class="modal-header">
-			<a class="close" data-dismiss="modal">×</a>
-			<h3>Search Index</h3>
-		</div>
-
-		<div class="modal-body">
-			<section class="search-string">
-				<span class="search-input-label">Searching for:</span>
-				<span class="search-input"></span>
-			</section>
-
-			<section class="search-results method-search-results">
-				<header><h4>Methods</h4></header>
-				<dl></dl>
-			</section>
-			<section class="search-results module-search-results">
-				<header><h4>Classes/Modules</h4></header>
-				<dl></dl>
-			</section>
-			<section class="search-results file-search-results">
-				<header><h4>Files</h4></header>
-				<dl></dl>
-			</section>
-		</div>
-
-		<div class="modal-footer">
-			<a href="#" class="btn">Close</a>
-		</div>
-	</div>
-
 </body>
 </html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-generator-fivefish
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.44
+  version: 0.0.1.pre.46
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-05-02 00:00:00.000000000 Z
+date: 2012-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inversion
@@ -102,6 +102,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: hoe-highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: uglifier
   requirement: !ruby/object:Gem::Requirement