rokko 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,3 @@
+Rokko -- fat-free [Rocco](http://rtomayko.github.com/rocco/)
+=============================================================
+

data/Rakefile

@@ -0,0 +1,4 @@
+$:.unshift(File.expand_path('lib'))
+require 'rokko/task'
+
+Rokko::Task.new(:rokko, 'docs', ['lib/**/*.rb', 'README.md'], {:index => true})

data/TODO

@@ -0,0 +1,6 @@
+[ ] documentation
+[ ] option for offline/online ready documentation
+[x] rake task
+[ ] tests
+[ ] explain key differences
+[ ] README and LICENSE

data/bin/rokko

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+#/ Usage: rokko [-i [INDEX_FILE]][-o <dir>] <file>...
+#/ Generate literate-programming-style documentation for Ruby source <file>s.
+#/
+#/ Options:
+#/   -i, --index=<file>     Also generate an index with links to HTML files or use <file> as
+#/                          index
+#/   -o, --output=<dir>     Directory where generated HTML files are written
+#/       --help             Show this help message
+
+require 'optparse'
+require 'fileutils'
+begin
+  $:.unshift(File.expand_path('../../lib', __FILE__).sub(/^#{Dir.pwd}\//, ''))
+  require 'rokko'
+rescue LoadError
+  if !defined?(Gem)
+    require 'rubygems'
+    retry
+  end
+  raise
+end
+
+# Write usage message to stdout and exit
+def usage(stream=$stderr, status=1)
+  stream.puts File.readlines(__FILE__).
+    grep(/^#\//).
+    map {|line| line.sub(/^#. ?/, '')}.
+    join
+  exit status
+end
+
+# Like `Kernel#abort` but writes a note encouraging the user to consult.
+# `rokko --help` for more information
+def abort_with_note(message=nil)
+  $stderr.puts message if message
+  abort "See `rokko --help' for usage information."
+end
+
+# Parse command line options, aborting if anything goes wrong.
+output_dir = '.'
+sources = []
+options = {}
+ARGV.options { |o|
+  o.program_name = File.basename($0)
+  o.on("-o", "--output=DIR") {|dir| output_dir = dir}
+  o.on("-i", "--index [FILE]") {|index| index ? options[:index] = index : options[:generate_index] = true}
+  o.on_tail("-h", "--help") {usage($stdout, 0)}
+  o.parse!
+} or abort_with_note
+
+# Eat sources from ARGV.
+sources << ARGV.shift while ARGV.any?
+
+# Make sure we have some files to work with.
+if sources.empty?
+  abort_with_note "#{File.basename($0)}: no input <file>s given"
+end
+
+# Find README file for `index.html` and delete it from `sources`
+if options[:generate_index]
+  readme_source = sources.detect {|f| File.basename(f) =~ /README(\.(md|text|markdown|mdown|mkd|mkdn)$)?/i}
+  readme = readme_source ? File.read(sources.delete(readme_source)) : ''
+end
+
+# Run each file through Rokko and write output.
+sources.each do |filename|
+  rokko = Rokko::Rokko.new(filename, sources, options)
+  dest = File.join(output_dir, filename.sub(Regexp.new("#{File.extname(filename)}$"), ".html"))
+  puts "rokko: #{filename} -> #{dest}"
+  FileUtils.mkdir_p File.dirname(dest)
+  File.open(dest, 'wb') {|fd| fd.write(rokko.to_html)}
+end
+
+# Generate index.html if needed.
+if options[:generate_index]
+  require 'rokko/index_layout'
+  dest = File.join(output_dir, 'index.html')
+  puts "rokko: #{dest}"
+  File.open(dest, 'wb') {|fd| fd.write(Rokko::IndexLayout.new(sources, readme).render)}
+end
+
+# Generate and use specified file as index.
+if options[:index] && source_index = sources.delete(options[:index])
+  rokko = Rokko::Rokko.new(source_index, sources, options.merge(:preserve_urls => true))
+  dest = File.join(output_dir, 'index.html')
+  puts "rokko: #{source_index} -> index.html"
+  File.open(dest, 'wb') {|fd| fd.write(rokko.to_html)}
+end

data/lib/rokko/assets/docco.css

@@ -0,0 +1,121 @@
+/*--------------------- Layout and Typography ----------------------------*/
+body {
+  font-family: 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif;
+  font-size: 15px;
+  line-height: 22px;
+  color: #252519;
+  margin: 0; padding: 0;
+  text-align: left;
+}
+a {
+  color: #261a3b;
+}
+  a:visited {
+    color: #261a3b;
+  }
+p {
+  margin: 0 0 15px 0;
+}
+h1, h2, h3, h4, h5, h6 {
+  margin: 0px 0 15px 0;
+}
+  h1 {
+    margin-top: 40px;
+  }
+#container {
+  position: relative;
+}
+#background {
+  position: fixed;
+  top: 0; left: 525px; right: 0; bottom: 0;
+  background: #f5f5ff;
+  border-left: 1px solid #e5e5ee;
+  z-index: -1;
+}
+#jump_to, #jump_page {
+  background: white;
+  -webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777;
+  -webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px;
+  font: 10px Arial;
+  text-transform: uppercase;
+  cursor: pointer;
+  text-align: right;
+}
+#jump_to, #jump_wrapper {
+  position: fixed;
+  right: 0; top: 0;
+  padding: 5px 10px;
+}
+  #jump_wrapper {
+    padding: 0;
+    display: none;
+  }
+    #jump_to:hover #jump_wrapper {
+      display: block;
+    }
+    #jump_page {
+      padding: 5px 0 3px;
+      margin: 0 0 25px 25px;
+    }
+      #jump_page .source {
+        display: block;
+        padding: 5px 10px;
+        text-decoration: none;
+        border-top: 1px solid #eee;
+      }
+        #jump_page .source:hover {
+          background: #f5f5ff;
+        }
+        #jump_page .source:first-child {
+        }
+table td {
+  border: 0;
+  outline: 0;
+}
+  td.docs, th.docs {
+    max-width: 450px;
+    min-width: 450px;
+    min-height: 5px;
+    padding: 10px 25px 1px 50px;
+    overflow-x: hidden;
+    vertical-align: top;
+    text-align: left;
+  }
+    .docs pre {
+      margin: 15px 0 15px;
+      padding-left: 15px;
+    }
+    .docs p tt, .docs p code {
+      background: #f8f8ff;
+      border: 1px solid #dedede;
+      font-size: 12px;
+      padding: 0 0.2em;
+    }
+    .pilwrap {
+      position: relative;
+    }
+      .pilcrow {
+        font: 12px Arial;
+        text-decoration: none;
+        color: #454545;
+        position: absolute;
+        top: 3px; left: -20px;
+        padding: 1px 2px;
+        opacity: 0;
+        -webkit-transition: opacity 0.2s linear;
+      }
+        td.docs:hover .pilcrow {
+          opacity: 1;
+        }
+  td.code, th.code {
+    padding: 14px 15px 16px 25px;
+    width: 100%;
+    vertical-align: top;
+    background: #f5f5ff;
+    border-left: 1px solid #e5e5ee;
+  }
+    pre, tt, code {
+      font-size: 12px; line-height: 18px;
+      font-family: Monaco, Consolas, "Lucida Console", monospace;
+      margin: 0; padding: 0;
+    }

data/lib/rokko/assets/highlight.css

@@ -0,0 +1,127 @@
+/*
+
+github.com style (c) Vasily Polovnyov <vast@whiteants.net>
+
+*/
+
+pre code {
+  display: block;
+  color: #000
+}
+
+pre .comment,
+pre .template_comment,
+pre .diff .header,
+pre .javadoc {
+  color: #998;
+  font-style: italic
+}
+
+pre .keyword,
+pre .css .rule .keyword,
+pre .winutils,
+pre .javascript .title,
+pre .lisp .title,
+pre .subst {
+  color: #000;
+  font-weight: bold
+}
+
+pre .number,
+pre .hexcolor {
+  color: #40a070
+}
+
+pre .string,
+pre .tag .value,
+pre .phpdoc,
+pre .tex .formula {
+  color: #d14
+}
+
+pre .title,
+pre .id {
+  color: #900;
+  font-weight: bold
+}
+
+pre .javascript .title,
+pre .lisp .title,
+pre .subst {
+  font-weight: normal
+}
+
+pre .class .title,
+pre .tex .command {
+  color: #458;
+  font-weight: bold
+}
+
+pre .tag,
+pre .css .keyword,
+pre .html .keyword,
+pre .tag .title,
+pre .django .tag .keyword {
+  color: #000080;
+  font-weight: normal
+}
+
+pre .attribute,
+pre .variable,
+pre .instancevar,
+pre .lisp .body {
+  color: #008080
+}
+
+pre .regexp {
+  color: #009926
+}
+
+pre .class {
+  color: #458;
+  font-weight: bold
+}
+
+pre .symbol,
+pre .ruby .symbol .string,
+pre .ruby .symbol .keyword,
+pre .ruby .symbol .keymethods,
+pre .lisp .keyword,
+pre .tex .special {
+  color: #990073
+}
+
+pre .builtin,
+pre .built_in,
+pre .lisp .title {
+  color: #0086b3
+}
+
+pre .preprocessor,
+pre .pi,
+pre .doctype,
+pre .shebang,
+pre .cdata {
+  color: #999;
+  font-weight: bold
+}
+
+pre .deletion {
+  background: #fdd
+}
+
+pre .addition {
+  background: #dfd
+}
+
+pre .diff .change {
+  background: #0086b3
+}
+
+pre .chunk {
+  color: #aaa
+}
+
+pre .tex .formula {
+  opacity: 0.5;
+}

data/lib/rokko/assets/highlight.pack.js

@@ -0,0 +1 @@
+var hljs=new function(){var p={};var a={};function n(c){return c.replace(/&/gm,"&amp;").replace(/</gm,"&lt;").replace(/>/gm,"&gt;")}function k(s,r){if(!s){return false}for(var c=0;c<s.length;c++){if(s[c]==r){return true}}return false}function e(s,r,c){var t="m"+(s.cI?"i":"")+(c?"g":"");return new RegExp(r,t)}function j(r){for(var c=0;c<r.childNodes.length;c++){node=r.childNodes[c];if(node.nodeName=="CODE"){return node}if(!(node.nodeType==3&&node.nodeValue.match(/\s+/))){return null}}}function h(u,t){var s="";for(var r=0;r<u.childNodes.length;r++){if(u.childNodes[r].nodeType==3){var c=u.childNodes[r].nodeValue;if(t){c=c.replace(/\n/g,"")}s+=c}else{if(u.childNodes[r].nodeName=="BR"){s+="\n"}else{s+=h(u.childNodes[r])}}}s=s.replace(/\r/g,"\n");return s}function b(t){var r=t.className.split(/\s+/);r=r.concat(t.parentNode.className.split(/\s+/));for(var c=0;c<r.length;c++){var s=r[c].replace(/^language-/,"");if(p[s]||s=="no-highlight"){return s}}}function d(c){var r=[];(function(t,u){for(var s=0;s<t.childNodes.length;s++){if(t.childNodes[s].nodeType==3){u+=t.childNodes[s].nodeValue.length}else{if(t.childNodes[s].nodeName=="BR"){u+=1}else{r.push({event:"start",offset:u,node:t.childNodes[s]});u=arguments.callee(t.childNodes[s],u);r.push({event:"stop",offset:u,node:t.childNodes[s]})}}}return u})(c,0);return r}function m(z,A,y){var s=0;var x="";var u=[];function v(){if(z.length&&A.length){if(z[0].offset!=A[0].offset){return(z[0].offset<A[0].offset)?z:A}else{return(z[0].event=="start"&&A[0].event=="stop")?A:z}}else{return z.length?z:A}}function t(E){var F="<"+E.nodeName.toLowerCase();for(var C=0;C<E.attributes.length;C++){var D=E.attributes[C];F+=" "+D.nodeName.toLowerCase();if(D.nodeValue!=undefined){F+='="'+n(D.nodeValue)+'"'}}return F+">"}function B(C){return"</"+C.nodeName.toLowerCase()+">"}while(z.length||A.length){var w=v().splice(0,1)[0];x+=n(y.substr(s,w.offset-s));s=w.offset;if(w.event=="start"){x+=t(w.node);u.push(w.node)}else{if(w.event=="stop"){var r=u.length;do{r--;var c=u[r];x+=B(c)}while(c!=w.node);u.splice(r,1);while(r<u.length){x+=t(u[r]);r++}}}}x+=y.substr(s);return x}function g(K,E){function A(r,N){for(var M=0;M<N.sm.length;M++){if(N.sm[M].bR.test(r)){return N.sm[M]}}return null}function x(M,r){if(D[M].e&&D[M].eR.test(r)){return 1}if(D[M].eW){var N=x(M-1,r);return N?N+1:0}return 0}function y(r,M){return M.iR&&M.iR.test(r)}function B(P,O){var N=[];for(var M=0;M<P.sm.length;M++){N.push(P.sm[M].b)}var r=D.length-1;do{if(D[r].e){N.push(D[r].e)}r--}while(D[r+1].eW);if(P.i){N.push(P.i)}return e(O,"("+N.join("|")+")",true)}function t(N,M){var O=D[D.length-1];if(!O.t){O.t=B(O,I)}O.t.lastIndex=M;var r=O.t.exec(N);if(r){return[N.substr(M,r.index-M),r[0],false]}else{return[N.substr(M),"",true]}}function c(P,r){var M=I.cI?r[0].toLowerCase():r[0];for(var O in P.keywordGroups){if(!P.keywordGroups.hasOwnProperty(O)){continue}var N=P.keywordGroups[O].hasOwnProperty(M);if(N){return[O,N]}}return false}function G(N,Q){if(!Q.k||!Q.l){return n(N)}if(!Q.lR){var P="("+Q.l.join("|")+")";Q.lR=e(I,P,true)}var O="";var R=0;Q.lR.lastIndex=0;var M=Q.lR.exec(N);while(M){O+=n(N.substr(R,M.index-R));var r=c(Q,M);if(r){u+=r[1];O+='<span class="'+r[0]+'">'+n(M[0])+"</span>"}else{O+=n(M[0])}R=Q.lR.lastIndex;M=Q.lR.exec(N)}O+=n(N.substr(R,N.length-R));return O}function L(r,N){if(N.subLanguage&&a[N.subLanguage]){var M=g(N.subLanguage,r);u+=M.keyword_count;C+=M.r;return M.value}else{return G(r,N)}}function J(N,r){var M=N.nM?"":'<span class="'+N.displayClassName+'">';if(N.rB){s+=M;N.buffer=""}else{if(N.eB){s+=n(r)+M;N.buffer=""}else{s+=M;N.buffer=r}}D[D.length]=N}function F(M,O,R){var P=D[D.length-1];if(R){s+=L(P.buffer+M,P);return false}var S=A(O,P);if(S){s+=L(P.buffer+M,P);J(S,O);C+=S.r;return S.rB}var r=x(D.length-1,O);if(r){var T=P.nM?"":"</span>";if(P.rE){s+=L(P.buffer+M,P)+T}else{if(P.eE){s+=L(P.buffer+M,P)+T+n(O)}else{s+=L(P.buffer+M+O,P)+T}}while(r>1){T=D[D.length-2].nM?"":"</span>";s+=T;r--;D.length--}var Q=D[D.length-1];D.length--;D[D.length-1].buffer="";if(Q.starts){for(var N=0;N<I.m.length;N++){if(I.m[N].cN==Q.starts){J(I.m[N],"");break}}}return P.rE}if(y(O,P)){throw"Illegal"}}var I=p[K];var D=[I.dM];var C=0;var u=0;var s="";try{var w=0;I.dM.buffer="";do{var z=t(E,w);var v=F(z[0],z[1],z[2]);w+=z[0].length;if(!v){w+=z[1].length}}while(!z[2]);if(D.length>1){throw"Illegal"}return{language:K,r:C,keyword_count:u,value:s}}catch(H){if(H=="Illegal"){return{language:null,r:0,keyword_count:0,value:n(E)}}else{throw H}}}function i(){function r(y,x){if(y.compiled){return}if(y.b){y.bR=e(x,"^"+y.b)}if(y.e){y.eR=e(x,"^"+y.e)}if(y.i){y.iR=e(x,"^(?:"+y.i+")")}if(y.r==undefined){y.r=1}if(!y.displayClassName){y.displayClassName=y.cN}if(!y.cN){y.nM=true}for(var w in y.k){if(!y.k.hasOwnProperty(w)){continue}if(y.k[w] instanceof Object){y.keywordGroups=y.k}else{y.keywordGroups={keyword:y.k}}break}y.sm=[];if(y.c){for(var v=0;v<y.c.length;v++){if(y.c[v] instanceof Object){y.sm.push(y.c[v])}else{for(var u=0;u<x.m.length;u++){if(x.m[u].cN==y.c[v]){y.sm.push(x.m[u])}}}}}y.compiled=true;for(var v=0;v<y.sm.length;v++){r(y.sm[v],x)}}for(var t in p){if(!p.hasOwnProperty(t)){continue}var c=[p[t].dM].concat(p[t].m);for(var s=0;s<c.length;s++){r(c[s],p[t])}}}function f(){if(f.called){return}f.called=true;i();a=p}function q(v,A,r){f();var C=h(v,r);var t=b(v);if(t=="no-highlight"){return}if(t){var y=g(t,C)}else{var y={language:"",keyword_count:0,r:0,value:n(C)};var z=y;for(var B in a){if(!a.hasOwnProperty(B)){continue}var w=g(B,C);if(w.keyword_count+w.r>z.keyword_count+z.r){z=w}if(w.keyword_count+w.r>y.keyword_count+y.r){z=y;y=w}}}var u=v.className;if(!u.match(y.language)){u=u?(u+" "+y.language):y.language}var c=d(v);if(c.length){var s=document.createElement("pre");s.innerHTML=y.value;y.value=m(c,d(s),C)}if(A){y.value=y.value.replace(/^((<[^>]+>|\t)+)/gm,function(D,G,F,E){return G.replace(/\t/g,A)})}if(r){y.value=y.value.replace(/\n/g,"<br>")}if(/MSIE [678]/.test(navigator.userAgent)&&v.tagName=="CODE"&&v.parentNode.tagName=="PRE"){var s=v.parentNode;var x=document.createElement("div");x.innerHTML="<pre><code>"+y.value+"</code></pre>";v=x.firstChild.firstChild;x.firstChild.cN=s.cN;s.parentNode.replaceChild(x.firstChild,s)}else{v.innerHTML=y.value}v.className=u;v.dataset={};v.dataset.result={language:y.language,kw:y.keyword_count,re:y.r};if(z&&z.language){v.dataset.second_best={language:z.language,kw:z.keyword_count,re:z.r}}}function l(){if(l.called){return}l.called=true;f();if(arguments.length){for(var c=0;c<arguments.length;c++){if(p[arguments[c]]){a[arguments[c]]=p[arguments[c]]}}}var s=document.getElementsByTagName("pre");for(var c=0;c<s.length;c++){var r=j(s[c]);if(r){q(r,hljs.tabReplace)}}}function o(){var c=arguments;var r=function(){l.apply(null,c)};if(window.addEventListener){window.addEventListener("DOMContentLoaded",r,false);window.addEventListener("load",r,false)}else{if(window.attachEvent){window.attachEvent("onload",r)}else{window.onload=r}}}this.LANGUAGES=p;this.initHighlightingOnLoad=o;this.highlightBlock=q;this.initHighlighting=l;this.IMR="\\b|\\B";this.IR="[a-zA-Z][a-zA-Z0-9_]*";this.UIR="[a-zA-Z_][a-zA-Z0-9_]*";this.NR="\\b\\d+(\\.\\d+)?";this.CNR="\\b(0x[A-Za-z0-9]+|\\d+(\\.\\d+)?)";this.RSR="!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|\\.|-|-=|/|/=|:|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~";this.ASM={cN:"string",b:"'",e:"'",i:"\\n",c:["escape"],r:0};this.QSM={cN:"string",b:'"',e:'"',i:"\\n",c:["escape"],r:0};this.BE={cN:"escape",b:"\\\\.",e:this.IMR,nM:true,r:0};this.CLCM={cN:"comment",b:"//",e:"$",r:0};this.CBLCLM={cN:"comment",b:"/\\*",e:"\\*/"};this.HCM={cN:"comment",b:"#",e:"$"};this.NUMBER_MODE={cN:"number",b:this.NR,e:this.IMR,r:0};this.CNM={cN:"number",b:this.CNR,e:this.IMR,r:0};this.inherit=function(c,t){var s={};for(var r in c){s[r]=c[r]}if(t){for(var r in t){s[r]=t[r]}}return s}}();var initHighlightingOnLoad=hljs.initHighlightingOnLoad;hljs.LANGUAGES.ruby=function(){var a="[a-zA-Z_][a-zA-Z0-9_]*(\\!|\\?)?";var c="[a-zA-Z_]\\w*[!?=]?|[-+~]\\@|<<|>>|=~|===?|<=>|[<>]=?|\\*\\*|[-/+%^&*~`|]|\\[\\]=?";var b=["comment","string","char","class","function","constant","symbol","number","variable","identifier","regexp_container"];var d={keyword:{and:1,"false":1,then:1,defined:1,module:1,"in":1,"return":1,redo:1,"if":1,BEGIN:1,retry:1,end:1,"for":1,"true":1,self:1,when:1,next:1,until:1,"do":1,begin:1,unless:1,END:1,rescue:1,nil:1,"else":1,"break":1,undef:1,not:1,"super":1,"class":1,"case":1,require:1,yield:1,alias:1,"while":1,ensure:1,elsif:1,or:1,def:1},keymethods:{__id__:1,__send__:1,abort:1,abs:1,"all?":1,allocate:1,ancestors:1,"any?":1,arity:1,assoc:1,at:1,at_exit:1,autoload:1,"autoload?":1,"between?":1,binding:1,binmode:1,"block_given?":1,call:1,callcc:1,caller:1,capitalize:1,"capitalize!":1,casecmp:1,"catch":1,ceil:1,center:1,chomp:1,"chomp!":1,chop:1,"chop!":1,chr:1,"class":1,class_eval:1,"class_variable_defined?":1,class_variables:1,clear:1,clone:1,close:1,close_read:1,close_write:1,"closed?":1,coerce:1,collect:1,"collect!":1,compact:1,"compact!":1,concat:1,"const_defined?":1,const_get:1,const_missing:1,const_set:1,constants:1,count:1,crypt:1,"default":1,default_proc:1,"delete":1,"delete!":1,delete_at:1,delete_if:1,detect:1,display:1,div:1,divmod:1,downcase:1,"downcase!":1,downto:1,dump:1,dup:1,each:1,each_byte:1,each_index:1,each_key:1,each_line:1,each_pair:1,each_value:1,each_with_index:1,"empty?":1,entries:1,eof:1,"eof?":1,"eql?":1,"equal?":1,"eval":1,exec:1,exit:1,"exit!":1,extend:1,fail:1,fcntl:1,fetch:1,fileno:1,fill:1,find:1,find_all:1,first:1,flatten:1,"flatten!":1,floor:1,flush:1,for_fd:1,foreach:1,fork:1,format:1,freeze:1,"frozen?":1,fsync:1,getc:1,gets:1,global_variables:1,grep:1,gsub:1,"gsub!":1,"has_key?":1,"has_value?":1,hash:1,hex:1,id:1,include:1,"include?":1,included_modules:1,index:1,indexes:1,indices:1,induced_from:1,inject:1,insert:1,inspect:1,instance_eval:1,instance_method:1,instance_methods:1,"instance_of?":1,"instance_variable_defined?":1,instance_variable_get:1,instance_variable_set:1,instance_variables:1,"integer?":1,intern:1,invert:1,ioctl:1,"is_a?":1,isatty:1,"iterator?":1,join:1,"key?":1,keys:1,"kind_of?":1,lambda:1,last:1,length:1,lineno:1,ljust:1,load:1,local_variables:1,loop:1,lstrip:1,"lstrip!":1,map:1,"map!":1,match:1,max:1,"member?":1,merge:1,"merge!":1,method:1,"method_defined?":1,method_missing:1,methods:1,min:1,module_eval:1,modulo:1,name:1,nesting:1,"new":1,next:1,"next!":1,"nil?":1,nitems:1,"nonzero?":1,object_id:1,oct:1,open:1,pack:1,partition:1,pid:1,pipe:1,pop:1,popen:1,pos:1,prec:1,prec_f:1,prec_i:1,print:1,printf:1,private_class_method:1,private_instance_methods:1,"private_method_defined?":1,private_methods:1,proc:1,protected_instance_methods:1,"protected_method_defined?":1,protected_methods:1,public_class_method:1,public_instance_methods:1,"public_method_defined?":1,public_methods:1,push:1,putc:1,puts:1,quo:1,raise:1,rand:1,rassoc:1,read:1,read_nonblock:1,readchar:1,readline:1,readlines:1,readpartial:1,rehash:1,reject:1,"reject!":1,remainder:1,reopen:1,replace:1,require:1,"respond_to?":1,reverse:1,"reverse!":1,reverse_each:1,rewind:1,rindex:1,rjust:1,round:1,rstrip:1,"rstrip!":1,scan:1,seek:1,select:1,send:1,set_trace_func:1,shift:1,singleton_method_added:1,singleton_methods:1,size:1,sleep:1,slice:1,"slice!":1,sort:1,"sort!":1,sort_by:1,split:1,sprintf:1,squeeze:1,"squeeze!":1,srand:1,stat:1,step:1,store:1,strip:1,"strip!":1,sub:1,"sub!":1,succ:1,"succ!":1,sum:1,superclass:1,swapcase:1,"swapcase!":1,sync:1,syscall:1,sysopen:1,sysread:1,sysseek:1,system:1,syswrite:1,taint:1,"tainted?":1,tell:1,test:1,"throw":1,times:1,to_a:1,to_ary:1,to_f:1,to_hash:1,to_i:1,to_int:1,to_io:1,to_proc:1,to_s:1,to_str:1,to_sym:1,tr:1,"tr!":1,tr_s:1,"tr_s!":1,trace_var:1,transpose:1,trap:1,truncate:1,"tty?":1,type:1,ungetc:1,uniq:1,"uniq!":1,unpack:1,unshift:1,untaint:1,untrace_var:1,upcase:1,"upcase!":1,update:1,upto:1,"value?":1,values:1,values_at:1,warn:1,write:1,write_nonblock:1,"zero?":1,zip:1}};return{dM:{l:[a],c:b,k:d},m:[{cN:"comment",b:"#",e:"$",c:["yardoctag"]},{cN:"comment",b:"^\\=begin",e:"^\\=end",c:["yardoctag"],r:10},{cN:"comment",b:"^__END__",e:"\\n$"},{cN:"yardoctag",b:"@[A-Za-z]+",e:hljs.IMR},{cN:"function",b:"\\bdef\\s+",e:" |$|;",l:[a],k:d,c:[{cN:"ftitle",displayClassName:"title",b:c,e:hljs.IMR,l:[a],k:d},{cN:"params",b:"\\(",e:"\\)",l:[a],k:d,c:b},"comment"]},{cN:"class",b:"\\b(class|module)\\b",e:"$|;",l:[hljs.UIR],k:d,c:[{cN:"title",b:"[A-Za-z_]\\w*(::\\w+)*(\\?|\\!)?",e:hljs.IMR,r:0},{cN:"inheritance",b:"<\\s*",e:hljs.IMR,c:[{cN:"parent",b:"("+hljs.IR+"::)?"+hljs.IR,e:hljs.IMR}]},"comment"],k:{"class":1,module:1}},{cN:"number",b:"(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b",e:hljs.IMR,r:0},{cN:"number",b:"\\?\\w",e:hljs.IMR},{cN:"string",b:"'",e:"'",c:["escape","subst"],r:0},{cN:"string",b:'"',e:'"',c:["escape","subst"],r:0},{cN:"string",b:"%[qw]?\\(",e:"\\)",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?\\[",e:"\\]",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?{",e:"}",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?<",e:">",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?/",e:"/",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?%",e:"%",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?-",e:"-",c:["escape","subst"],r:10},{cN:"string",b:"%[qw]?\\|",e:"\\|",c:["escape","subst"],r:10},{cN:"constant",b:"(::)?([A-Z]\\w*(::)?)+",e:hljs.IMR,r:0},{cN:"symbol",b:":",e:hljs.IMR,c:["string","identifier"]},{cN:"identifier",b:a,e:hljs.IMR,l:[a],k:d,r:0},hljs.BE,{cN:"subst",b:"#\\{",e:"}",l:[a],k:d,c:b},{cN:"regexp_container",b:"("+hljs.RSR+")\\s*",e:hljs.IMR,nM:true,c:["comment","regexp"],r:0},{cN:"regexp",b:"/",e:"/[a-z]*",i:"\\n",c:["escape"]},{cN:"variable",b:"(\\$\\W)|((\\$|\\@\\@?)(\\w+))",e:hljs.IMR}]}}();

data/lib/rokko/index_layout.mustache

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <title>{{ title }}</title>
+  <style type="text/css" media="screen, projection">
+  {{ styles }}
+  </style>
+  <script>{{{ highlight_js }}}</script>
+</head>
+<body>
+<div id="container">
+  <div id="background"></div>
+  <table cellspacing="0" cellpadding="0">
+  <tbody>
+    <tr>
+      <th class="docs">
+        {{#readme?}}
+        {{{ readme }}}
+        {{/readme?}}
+      </th>
+      <th class="code">
+        <h1>{{ title }}</h1>
+        <ul class="toc">
+          {{#dirs}}
+          <li>
+            {{ dir }}
+            <ul>
+              {{#files}}
+              <li><a href="{{ url }}">{{ basename }}</a></li>
+              {{/files}}
+            </ul>
+          </li>
+          {{/dirs}}
+        </ul>
+      </th>
+    </tr>
+  </tbody>
+  </table>
+</div>
+</body>
+</html>

data/lib/rokko/index_layout.rb

@@ -0,0 +1,39 @@
+class Rokko::IndexLayout < Rokko::Layout
+  self.template_path = File.dirname(__FILE__)
+
+  def initialize(sources, readme = '')
+    @sources = sources
+    @readme = readme
+  end
+
+  def title
+    "Table of Contents"
+  end
+
+  def readme
+    Markdown.new(@readme, :smart).to_html
+  end
+
+  def readme?
+    @readme != ""
+  end
+
+  def sources
+    @sources.sort.map do |source|
+      {
+        :path => source,
+        :basename => File.basename(source),
+        :url => source.sub(Regexp.new("#{File.extname(source)}$"), ".html")
+      }
+    end
+  end
+
+  # Groupped sources by dirname
+  def dirs
+    sources.inject(Hash.new{|hsh, key| hsh[key] = []}) do |c, source|
+      c[File.dirname(source[:path])].push(source)
+      c
+    end.sort.collect {|k, v| {:dir => k, :files => v}}
+  end
+
+end

data/lib/rokko/layout.mustache

@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <title>{{ title }}</title>
+  <style type="text/css" media="screen, projection">
+  {{ styles }}
+  </style>
+  <script>{{{ highlight_js }}}</script>
+</head>
+<body>
+<div id="container">
+  <div id="background"></div>
+  {{#sources?}}
+  <div id="jump_to">
+    Jump To &hellip;
+    <div id="jump_wrapper">
+      <div id="jump_page">
+        {{#sources}}
+          <a class="source" href="{{ url }}">{{ basename }}</a>
+        {{/sources}}
+      </div>
+    </div>
+  </div>
+  {{/sources?}}
+  <table cellspacing="0" cellpadding="0">
+  <thead>
+    <tr>
+      <th class="docs"><h1>{{ title }}</h1></th>
+      <th class="code"></th>
+    </tr>
+  </thead>
+  <tbody>
+    {{#sections}}
+    <tr id="section-{{ num }}">
+      <td class="docs">
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-{{ num }}">&#182;</a>
+        </div>
+        {{{ docs }}}
+      </td>
+      <td class="code">
+        <pre class="ruby"><code>{{ code }}</code></pre>
+      </td>
+    </tr>
+    {{/sections}}
+  </tbody>
+  </table>
+</div>
+</body>
+</html>

data/lib/rokko/layout.rb

@@ -0,0 +1,63 @@
+require 'pathname'
+module Rokko
+  class Layout < Mustache
+    self.template_path = File.dirname(__FILE__)
+    
+    def initialize(doc)
+      @doc = doc
+    end
+    
+    def title
+      File.basename(@doc.file)
+    end
+    
+    def styles
+      docco = File.read(File.join(File.dirname(__FILE__), 'assets', 'docco.css'))
+      highlight = File.read(File.join(File.dirname(__FILE__), 'assets', 'highlight.css'))
+      
+      docco + "\n" + highlight
+    end
+    
+    def highlight_js
+      js = File.read(File.join(File.dirname(__FILE__), 'assets', 'highlight.pack.js'))
+      
+      js + "\nhljs.initHighlightingOnLoad();\n"
+    end
+    
+    def sections
+      num = 0
+      @doc.sections.map do |docs,code|
+        {
+          :docs => docs,
+          :code => code,
+          :num => (num += 1)
+        }
+      end
+    end
+    
+    def sources?
+      @doc.sources.length > 1
+    end
+    
+    def sources
+      @doc.sources.sort.map do |source|
+        {
+          :path => source,
+          :basename => File.basename(source),
+          :url => relative_url(source)
+        }
+      end
+    end
+    
+    private
+    def relative_url(source)
+      if(@doc.options[:preserve_urls])
+        source.sub(Regexp.new("#{File.extname(source)}$"), ".html")
+      else
+        relative_path = Pathname.new(File.dirname(source)).relative_path_from(Pathname(File.dirname(@doc.file))).to_s
+        "#{relative_path}/#{File.basename(source).sub(Regexp.new("#{File.extname(source)}$"), ".html")}"
+      end
+    end
+
+  end
+end

data/lib/rokko/task.rb

@@ -0,0 +1,56 @@
+require 'rokko'
+
+module Rokko
+  class Task
+
+    def initialize(task_name='rokko', dest='docs/', sources='lib/**/*.rb', options={})
+      @name = task_name
+      @dest = dest
+      @sources = FileList[sources]
+      @options = options
+      if options[:generate_index] || options[:index].is_a?(TrueClass)
+        @options[:generate_index] = true
+      end
+
+      define
+    end
+
+    def define
+      desc "Generate rokko documentation"
+      task @name do
+        # Find README file for `index.html` and delete it from `sources`
+        if @options[:generate_index]
+          readme_source = @sources.detect {|f| File.basename(f) =~ /README(\.(md|text|markdown|mdown|mkd|mkdn)$)?/i}
+          readme = readme_source ? File.read(@sources.delete(readme_source)) : ''
+        end
+
+        # Run each file through Rokko and write output
+        @sources.each do |filename|
+          rokko = Rokko.new(filename, @sources, @options)
+          out_dest = File.join(@dest, filename.sub(Regexp.new("#{File.extname(filename)}$"), ".html"))
+          puts "rokko: #{filename} -> #{out_dest}"
+          FileUtils.mkdir_p File.dirname(out_dest)
+          File.open(out_dest, 'wb') { |fd| fd.write(rokko.to_html) }
+        end
+
+        # Generate index.html if needed
+        if @options[:generate_index]
+          require 'rokko/index_layout'
+          out_dest = File.join(@dest, 'index.html')
+          puts "rokko: #{out_dest}"
+          File.open(out_dest, 'wb') {|fd| fd.write(IndexLayout.new(@sources, readme).render)}
+        end
+
+        # Run specified file through rokko and use it as index
+        if @options[:index] && source_index = @sources.delete(@options[:index])
+          rokko = Rokko.new(source_index, @sources, @options.merge(:preserve_urls => true))
+          out_dest = File.join(@dest, 'index.html')
+          puts "rokko: #{source_index} -> index.html"
+          File.open(out_dest, 'wb') {|fd| fd.write(rokko.to_html)}
+        end
+
+      end
+    end
+
+  end
+end

data/lib/rokko/version.rb

@@ -0,0 +1,3 @@
+module Rokko
+  VERSION = "0.0.1"
+end

data/lib/rokko.rb

@@ -0,0 +1,127 @@
+# ##Rokko -- fat-free [Rocco](http://rtomayko.github.com/rocco/)
+require 'rdiscount'
+
+module Rokko
+  class Rokko
+    attr_reader :file
+    attr_reader :sections
+    attr_reader :sources
+    attr_reader :options
+    
+    @@comment_pattern = /^\s*#\s?/
+    @@block_comment_start = /^\s*=begin\s*$/
+    @@block_comment_end = /^\s*=end\s*$/
+    
+    def initialize(filename, sources = [], options = {}, &block)
+      @file = filename
+      @sources = sources
+      @options = options
+      
+      @data = if block_given?
+        yield
+      else
+        File.read(filename)
+      end
+      
+      @sections = prettify(split(parse(@data)))
+    end
+    
+    def parse(data)
+      sections = []
+      docs, code = [], []
+      lines = data.split("\n")
+      
+      # Skip shebang and encoding information
+      lines.shift if lines[0] =~ /^\#\!/
+      lines.shift if lines[0] =~ /coding[:=]\s*[-\w.]+/
+      
+      in_comment_block = false
+      lines.each do |line|
+        # If we're currently in a comment block, check whether the line matches
+        # the _end_ of a comment block
+        if in_comment_block
+          if line.match(@@block_comment_end)
+            in_comment_block = false
+          else
+            docs << line
+          end
+        # Otherwise, check whether the line matches the beginning of a block, or
+        # a single-line comment all on it's lonesome. In either case, if there's
+        # code, start a new section  
+        else
+          if line.match(@@block_comment_start)
+            in_comment_block = true
+            if code.any?
+              sections << [docs, code]
+              docs, code = [], []
+            end
+          elsif line.match(@@comment_pattern)
+            if code.any?
+              sections << [docs, code]
+              docs, code = [], []
+            end
+            docs << line.sub(@@comment_pattern, '')
+          else
+            code << line
+          end
+        end
+      end
+      
+      sections << [docs, code] if docs.any? || code.any?
+      normalize_leading_spaces(sections)
+    end
+    
+    # Normalizes documentation whitespace by checking for leading whitespace,
+    # removing it, and then removing the same amount of whitespace from each
+    # succeeding line
+    def normalize_leading_spaces(sections)
+      sections.map do |section|
+        if section.any? && section[0].any?
+          leading_space = section[0][0].match("^\s+")
+          if leading_space
+            section[0] = section[0].map{|line| line.sub(/^#{leading_space.to_s}/, '')}
+          end
+        end
+        section
+      end
+    end
+    
+    # Take the list of paired *sections* two-tuples and split into two
+    # separate lists: one holding the comments with leaders removed and
+    # one with the code blocks
+    def split(sections)
+      docs_blocks, code_blocks = [], []
+      sections.each do |docs,code|
+        docs_blocks << docs.join("\n")
+        code_blocks << code.map do |line|
+          tabs = line.match(/^(\t+)/)
+          tabs ? line.sub(/^\t+/, '  ' * tabs.captures[0].length) : line
+        end.join("\n")
+      end
+      [docs_blocks, code_blocks]
+    end
+    
+    # Take the result of `split` and apply Markdown formatting to comments
+    def prettify(blocks)
+      docs_blocks, code_blocks = blocks
+      
+      # Combine all docs blocks into a single big markdown document with section
+      # dividers and run through the Markdown processor. Then split it back out
+      # into separate sections
+      markdown = docs_blocks.join("\n\n##### DIVIDER\n\n")
+      docs_html = Markdown.new(markdown, :smart).to_html.split(/\n*<h5>DIVIDER<\/h5>\n*/m)
+      
+      docs_html.zip(code_blocks)
+    end
+    
+    
+    def to_html
+      require 'mustache'
+      $:.unshift(File.dirname(__FILE__))
+      require 'rokko/layout'
+      
+      ::Rokko::Layout.new(self).render
+    end
+
+  end
+end

data/rokko.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rokko/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rokko"
+  s.version     = Rokko::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Vasily Polovnyov"]
+  s.email       = ["vasily@polovnyov.ru"]
+  s.homepage    = "http://vast.github.com/rokko/"
+  s.summary     = %q{Else one ruby port of [Docco](http://jashkenas.github.com/docco/)}
+  s.description = %q[fat-free [rocco](http://rtomayko.github.com/rocco/)]
+
+  s.rubyforge_project = "rokko"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency('mustache')
+  s.add_dependency('rdiscount')
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: rokko
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Vasily Polovnyov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-17 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mustache
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: fat-free [rocco](http://rtomayko.github.com/rocco/)
+email: 
+- vasily@polovnyov.ru
+executables: 
+- rokko
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- TODO
+- bin/rokko
+- lib/rokko.rb
+- lib/rokko/assets/docco.css
+- lib/rokko/assets/highlight.css
+- lib/rokko/assets/highlight.pack.js
+- lib/rokko/index_layout.mustache
+- lib/rokko/index_layout.rb
+- lib/rokko/layout.mustache
+- lib/rokko/layout.rb
+- lib/rokko/task.rb
+- lib/rokko/version.rb
+- rokko.gemspec
+has_rdoc: true
+homepage: http://vast.github.com/rokko/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rokko
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Else one ruby port of [Docco](http://jashkenas.github.com/docco/)
+test_files: []
+