rokko 0.1.3 → 0.5.0

data/.gitignore

@@ -1,3 +1,6 @@
 pkg/*
 *.gem
 .bundle
+.rbenv-version
+Gemfile.lock
+.DS_Store

data/README.md

@@ -7,7 +7,7 @@ the quick-and-dirty, hundred-line-long, literate-programming-style documentation
 Rokko reads Ruby source files and produces annotated source documentation in HTML format.
 Comments are formatted with Markdown and presented alongside syntax highlighted code so as to give an annotation effect.
 
-##Why Rokko?
+## Why Rokko?
 
 * Rokko supports only Ruby source files (consider using [Rocco](http://rtomayko.github.com/rocco/)
   if you need more languages).
@@ -15,7 +15,7 @@ Comments are formatted with Markdown and presented alongside syntax highlighted
 * Rokko can generate offline-ready documentation (all assets are bundled).
 * Rokko can generate an index file with links to everything (like Table of Contents).
 
-##Installation
+## Installation
 
 Install with Rubygems:
 
@@ -25,7 +25,7 @@ or Bundler:
 
     gem 'rokko'
 
-##Usage
+## Usage
 
 `rokko` command can be used to generate documentation for a set of Ruby source files:
 
@@ -35,19 +35,23 @@ It is also possible to use Rokko as a Rake task:
 
     require 'rokko/task'
 
-    Rokko::Task.new(:rokko, 'docs', ['lib/**/*.rb', 'README.md'], {:index => true, :local => true})
+    Rokko::Task.new(:rokko, 'docs', # task name, output directory
+                    ['lib/**/*.rb', 'README.md'],
+                    {:index => true, :local => true})
 
 And run:
 
     rake rokko
 
-##Options and configuration
+## Options and configuration
 
-* `-i`, `--index=<file>` -- generate an index with links to HTML files or use `<file>` as index.
 * `-l`, `--local` -- generate offline-ready documentation.
+* `-i`, `--index` -- generate index.html with links (TOC) to all generated HTML files.
+* `-i <file>`, `--index=<file>` -- use `<file>` as index.html.
 * `-o`, `--output=<dir>` -- directory where generated HTML files are written.
+* `-s`, `--stylesheet=<url>` -- CSS stylesheet to use instead of default one.
 
-###Rake task
+### Rake task
 
 Usage:
 
@@ -56,6 +60,7 @@ Usage:
 Available options:
 
 * `:local` -- generate offline-ready documentation.
-* `:index` -- if value is a file name, then it will be used as an index. If value is `true` then
-  an index file with table of contents will be generated.
+* `:index => true` -- generate index.html with links (TOC) to all generated HTML files.
+* `:index => <file>` -- use `<file>` as index.html.
+* `:stylesheet` -- CSS stylesheet to use instead of default one.
 

data/Rakefile

@@ -1,4 +1,10 @@
 $:.unshift(File.expand_path('lib'))
 require 'rokko/task'
+require 'rake/testtask'
 
-Rokko::Task.new(:rokko, 'docs', ['lib/**/*.rb', 'README.md'], {:index => true, :local => true})
+Rokko::Task.new(:rokko, 'docs', ['lib/**/*.rb', 'README.md'], {:index => true, :local => true})
+
+Rake::TestTask.new do |t|
+  t.test_files = ['test/tests.rb']
+  t.verbose = true
+end

data/bin/rokko

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-#/ Usage: rokko [-i [INDEX_FILE]][-o <dir>] <file>...
+#/ Usage: rokko [-i [INDEX_FILE]] [-o <dir>] [-s <stylesheet>] <file>...
 #/ Generate literate-programming-style documentation for Ruby source <file>s.
 #/
 #/ Options:
@@ -8,6 +8,7 @@
 #/                          index
 #/   -l, --local            Generate offline-ready documentation
 #/   -o, --output=<dir>     Directory where generated HTML files are written
+#/   -s, --stylesheet=<url> CSS stylesheet to use instead of default one
 #/       --help             Show this help message
 
 require 'optparse'
@@ -37,6 +38,7 @@ options = {}
 ARGV.options { |o|
   o.program_name = File.basename($0)
   o.on("-o", "--output=DIR") {|dir| output_dir = dir}
+  o.on("-s", "--stylesheet=STYLESHEET") {|stylesheet| options[:stylesheet] = stylesheet}
   o.on("-i", "--index [FILE]") {|index| index ? options[:index] = index : options[:generate_index] = true}
   o.on("-l", "--local") {options[:local] = true}
   o.on_tail("-h", "--help") {usage($stdout, 0)}
@@ -75,7 +77,7 @@ if options[:generate_index]
 end
 
 # Generate and use specified file as index.
-if options[:index] && source_index = sources.delete(options[:index])
+if options[:index] && source_index = sources.find{|s| s == 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"

data/lib/rokko/assets/docco.css

@@ -27,7 +27,7 @@ h1, h2, h3, h4, h5, h6 {
 #background {
   position: fixed;
   top: 0; left: 525px; right: 0; bottom: 0;
-  background: #f5f5ff;
+  background: #f8f8ff;
   border-left: 1px solid #e5e5ee;
   z-index: -1;
 }
@@ -110,7 +110,7 @@ table td {
     padding: 14px 15px 16px 25px;
     width: 100%;
     vertical-align: top;
-    background: #f5f5ff;
+    background: #f8f8ff;
     border-left: 1px solid #e5e5ee;
   }
     pre, tt, code {

data/lib/rokko/assets/highlight.css

@@ -4,72 +4,42 @@ 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 {
+pre .comment {
   color: #998;
   font-style: italic
 }
 
 pre .keyword,
-pre .css .rule .keyword,
-pre .winutils,
-pre .javascript .title,
-pre .lisp .title,
 pre .subst {
-  color: #000;
+  color: #333;
   font-weight: bold
 }
 
 pre .number,
-pre .hexcolor {
-  color: #40a070
+pre .ruby .constant {
+  color: #099;
 }
 
-pre .string,
-pre .tag .value,
-pre .phpdoc,
-pre .tex .formula {
+pre .string {
   color: #d14
 }
 
-pre .title,
-pre .id {
+pre .title {
   color: #900;
   font-weight: bold
 }
 
-pre .javascript .title,
-pre .lisp .title,
 pre .subst {
   font-weight: normal
 }
 
-pre .class .title,
-pre .haskell .label,
-pre .tex .command {
+pre .class .title {
   color: #458;
   font-weight: bold
 }
 
-pre .tag,
-pre .tag .title,
-pre .rules .property,
-pre .django .tag .keyword {
-  color: #000080;
-  font-weight: normal
-}
-
 pre .attribute,
-pre .variable,
-pre .instancevar,
-pre .lisp .body {
+pre .variable {
   color: #008080
 }
 
@@ -83,46 +53,11 @@ pre .class {
 }
 
 pre .symbol,
-pre .ruby .symbol .string,
-pre .ruby .symbol .keyword,
-pre .ruby .symbol .keymethods,
-pre .lisp .keyword,
-pre .tex .special,
-pre .input_number {
+pre .ruby .symbol .string {
   color: #990073
 }
 
-pre .builtin,
-pre .built_in,
-pre .lisp .title {
-  color: #0086b3
-}
-
-pre .preprocessor,
-pre .pi,
-pre .doctype,
-pre .shebang,
-pre .cdata {
+pre .shebang {
   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

@@ -1 +1 @@
-var hljs=new function(){function m(p){return p.replace(/&/gm,"&amp;").replace(/</gm,"&lt;")}function c(r,q,p){return RegExp(q,"m"+(r.cI?"i":"")+(p?"g":""))}function j(r){for(var p=0;p<r.childNodes.length;p++){var q=r.childNodes[p];if(q.nodeName=="CODE"){return q}if(!(q.nodeType==3&&q.nodeValue.match(/\s+/))){break}}}function g(t,s){var r="";for(var q=0;q<t.childNodes.length;q++){if(t.childNodes[q].nodeType==3){var p=t.childNodes[q].nodeValue;if(s){p=p.replace(/\n/g,"")}r+=p}else{if(t.childNodes[q].nodeName=="BR"){r+="\n"}else{r+=g(t.childNodes[q])}}}if(/MSIE [678]/.test(navigator.userAgent)){r=r.replace(/\r/g,"\n")}return r}function a(s){var q=s.className.split(/\s+/);q=q.concat(s.parentNode.className.split(/\s+/));for(var p=0;p<q.length;p++){var r=q[p].replace(/^language-/,"");if(d[r]||r=="no-highlight"){return r}}}function b(p){var q=[];(function(s,t){for(var r=0;r<s.childNodes.length;r++){if(s.childNodes[r].nodeType==3){t+=s.childNodes[r].nodeValue.length}else{if(s.childNodes[r].nodeName=="BR"){t+=1}else{if(s.childNodes[r].nodeType==1){q.push({event:"start",offset:t,node:s.childNodes[r]});t=arguments.callee(s.childNodes[r],t);q.push({event:"stop",offset:t,node:s.childNodes[r]})}}}}return t})(p,0);return q}function l(y,z,x){var r=0;var w="";var t=[];function u(){if(y.length&&z.length){if(y[0].offset!=z[0].offset){return(y[0].offset<z[0].offset)?y:z}else{return z[0].event=="start"?y:z}}else{return y.length?y:z}}function s(C){var D="<"+C.nodeName.toLowerCase();for(var A=0;A<C.attributes.length;A++){var B=C.attributes[A];D+=" "+B.nodeName.toLowerCase();if(B.value!==undefined&&B.value!==false&&B.value!==null){D+='="'+m(B.value)+'"'}}return D+">"}while(y.length||z.length){var v=u().splice(0,1)[0];w+=m(x.substr(r,v.offset-r));r=v.offset;if(v.event=="start"){w+=s(v.node);t.push(v.node)}else{if(v.event=="stop"){var p,q=t.length;do{q--;p=t[q];w+=("</"+p.nodeName.toLowerCase()+">")}while(p!=v.node);t.splice(q,1);while(q<t.length){w+=s(t[q]);q++}}}}return w+m(x.substr(r))}function i(){function p(w,u,x){if(w.compiled){return}var t;if(!x){w.bR=c(u,w.b?w.b:"\\B|\\b");if(!w.e&&!w.eW){w.e="\\B|\\b"}if(w.e){w.eR=c(u,w.e)}}if(w.i){w.iR=c(u,w.i)}if(w.r===undefined){w.r=1}if(w.k){w.lR=c(u,w.l||hljs.IR,true);for(var v in w.k){if(!w.k.hasOwnProperty(v)){continue}if(w.k[v] instanceof Object){t=w.k[v]}else{t=w.k;v="keyword"}for(var s in t){if(!t.hasOwnProperty(s)){continue}w.k[s]=[v,t[s]]}}}if(!w.c){w.c=[]}w.compiled=true;for(var r=0;r<w.c.length;r++){if(w.c[r]=="self"){w.c[r]=w}p(w.c[r],u,false)}if(w.starts){p(w.starts,u,false)}}for(var q in d){if(!d.hasOwnProperty(q)){continue}p(d[q].dM,d[q],true)}}function e(J,D){if(!i.called){i();i.called=true}function z(r,M){for(var L=0;L<M.c.length;L++){if(M.c[L].bR.test(r)){return M.c[L]}}}function w(L,r){if(C[L].e&&C[L].eR.test(r)){return 1}if(C[L].eW){var M=w(L-1,r);return M?M+1:0}return 0}function x(r,L){return L.i&&L.iR.test(r)}function A(O,N){var M=[];for(var L=0;L<O.c.length;L++){M.push(O.c[L].b)}var r=C.length-1;do{if(C[r].e){M.push(C[r].e)}r--}while(C[r+1].eW);if(O.i){M.push(O.i)}return c(N,"("+M.join("|")+")",true)}function s(M,L){var N=C[C.length-1];if(!N.t){N.t=A(N,H)}N.t.lastIndex=L;var r=N.t.exec(M);if(r){return[M.substr(L,r.index-L),r[0],false]}else{return[M.substr(L),"",true]}}function p(N,r){var L=H.cI?r[0].toLowerCase():r[0];var M=N.k[L];if(M&&M instanceof Array){return M}return false}function F(M,O){M=m(M);if(!O.k){return M}var N="";var P=0;O.lR.lastIndex=0;var L=O.lR.exec(M);while(L){N+=M.substr(P,L.index-P);var r=p(O,L);if(r){t+=r[1];N+='<span class="'+r[0]+'">'+L[0]+"</span>"}else{N+=L[0]}P=O.lR.lastIndex;L=O.lR.exec(M)}return N+M.substr(P,M.length-P)}function K(r,M){if(M.sL&&d[M.sL]){var L=e(M.sL,r);t+=L.keyword_count;return L.value}else{return F(r,M)}}function I(M,r){var L=M.cN?'<span class="'+M.cN+'">':"";if(M.rB){q+=L;M.buffer=""}else{if(M.eB){q+=m(r)+L;M.buffer=""}else{q+=L;M.buffer=r}}C.push(M);B+=M.r}function E(O,L,Q){var R=C[C.length-1];if(Q){q+=K(R.buffer+O,R);return false}var M=z(L,R);if(M){q+=K(R.buffer+O,R);I(M,L);return M.rB}var r=w(C.length-1,L);if(r){var N=R.cN?"</span>":"";if(R.rE){q+=K(R.buffer+O,R)+N}else{if(R.eE){q+=K(R.buffer+O,R)+N+m(L)}else{q+=K(R.buffer+O+L,R)+N}}while(r>1){N=C[C.length-2].cN?"</span>":"";q+=N;r--;C.length--}var P=C[C.length-1];C.length--;C[C.length-1].buffer="";if(P.starts){I(P.starts,"")}return R.rE}if(x(L,R)){throw"Illegal"}}var H=d[J];var C=[H.dM];var B=0;var t=0;var q="";try{var y,v=0;H.dM.buffer="";do{y=s(D,v);var u=E(y[0],y[1],y[2]);v+=y[0].length;if(!u){v+=y[1].length}}while(!y[2]);if(C.length>1){throw"Illegal"}return{r:B,keyword_count:t,value:q}}catch(G){if(G=="Illegal"){return{r:0,keyword_count:0,value:m(D)}}else{throw G}}}function f(t){var r={keyword_count:0,r:0,value:m(t)};var q=r;for(var p in d){if(!d.hasOwnProperty(p)){continue}var s=e(p,t);s.language=p;if(s.keyword_count+s.r>q.keyword_count+q.r){q=s}if(s.keyword_count+s.r>r.keyword_count+r.r){q=r;r=s}}if(q.language){r.second_best=q}return r}function h(r,q,p){if(q){r=r.replace(/^((<[^>]+>|\t)+)/gm,function(t,w,v,u){return w.replace(/\t/g,q)})}if(p){r=r.replace(/\n/g,"<br>")}return r}function o(u,x,q){var y=g(u,q);var s=a(u);var w,r;if(s=="no-highlight"){return}if(s){w=e(s,y)}else{w=f(y);s=w.language}var p=b(u);if(p.length){r=document.createElement("pre");r.innerHTML=w.value;w.value=l(p,b(r),y)}w.value=h(w.value,x,q);var t=u.className;if(!t.match("(\\s|^)(language-)?"+s+"(\\s|$)")){t=t?(t+" "+s):s}if(/MSIE [678]/.test(navigator.userAgent)&&u.tagName=="CODE"&&u.parentNode.tagName=="PRE"){r=u.parentNode;var v=document.createElement("div");v.innerHTML="<pre><code>"+w.value+"</code></pre>";u=v.firstChild.firstChild;v.firstChild.cN=r.cN;r.parentNode.replaceChild(v.firstChild,r)}else{u.innerHTML=w.value}u.className=t;u.result={language:s,kw:w.keyword_count,re:w.r};if(w.second_best){u.second_best={language:w.second_best.language,kw:w.second_best.keyword_count,re:w.second_best.r}}}function k(){if(k.called){return}k.called=true;var r=document.getElementsByTagName("pre");for(var p=0;p<r.length;p++){var q=j(r[p]);if(q){o(q,hljs.tabReplace)}}}function n(){if(window.addEventListener){window.addEventListener("DOMContentLoaded",k,false);window.addEventListener("load",k,false)}else{if(window.attachEvent){window.attachEvent("onload",k)}else{window.onload=k}}}var d={};this.LANGUAGES=d;this.highlight=e;this.highlightAuto=f;this.fixMarkup=h;this.highlightBlock=o;this.initHighlighting=k;this.initHighlightingOnLoad=n;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(0[xX][a-fA-F0-9]+|(\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)";this.BINARY_NUMBER_RE="\\b(0b[01]+)";this.RSR="!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|\\.|-|-=|/|/=|:|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~";this.BE={b:"\\\\.",r:0};this.ASM={cN:"string",b:"'",e:"'",i:"\\n",c:[this.BE],r:0};this.QSM={cN:"string",b:'"',e:'"',i:"\\n",c:[this.BE],r:0};this.CLCM={cN:"comment",b:"//",e:"$"};this.CBLCLM={cN:"comment",b:"/\\*",e:"\\*/"};this.HCM={cN:"comment",b:"#",e:"$"};this.NM={cN:"number",b:this.NR,r:0};this.CNM={cN:"number",b:this.CNR,r:0};this.BINARY_NUMBER_MODE={cN:"number",b:this.BINARY_NUMBER_RE,r:0};this.inherit=function(p,s){var r={};for(var q in p){r[q]=p[q]}if(s){for(var q in s){r[q]=s[q]}}return r}}();hljs.LANGUAGES.ruby=function(){var c="[a-zA-Z_][a-zA-Z0-9_]*(\\!|\\?)?";var i="[a-zA-Z_]\\w*[!?=]?|[-+~]\\@|<<|>>|=~|===?|<=>|[<>]=?|\\*\\*|[-/+%^&*~`|]|\\[\\]=?";var a={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}};var d={cN:"yardoctag",b:"@[A-Za-z]+"};var k=[{cN:"comment",b:"#",e:"$",c:[d]},{cN:"comment",b:"^\\=begin",e:"^\\=end",c:[d],r:10},{cN:"comment",b:"^__END__",e:"\\n$"}];var e={cN:"subst",b:"#\\{",e:"}",l:c,k:a};var g=[hljs.BE,e];var f=[{cN:"string",b:"'",e:"'",c:g,r:0},{cN:"string",b:'"',e:'"',c:g,r:0},{cN:"string",b:"%[qw]?\\(",e:"\\)",c:g,r:10},{cN:"string",b:"%[qw]?\\[",e:"\\]",c:g,r:10},{cN:"string",b:"%[qw]?{",e:"}",c:g,r:10},{cN:"string",b:"%[qw]?<",e:">",c:g,r:10},{cN:"string",b:"%[qw]?/",e:"/",c:g,r:10},{cN:"string",b:"%[qw]?%",e:"%",c:g,r:10},{cN:"string",b:"%[qw]?-",e:"-",c:g,r:10},{cN:"string",b:"%[qw]?\\|",e:"\\|",c:g,r:10}];var h={cN:"function",b:"\\bdef\\s+",e:" |$|;",l:c,k:a,c:[{cN:"title",b:i,l:c,k:a},{cN:"params",b:"\\(",e:"\\)",l:c,k:a}].concat(k)};var j={cN:"identifier",b:c,l:c,k:a,r:0};var b=k.concat(f.concat([{cN:"class",b:"\\b(class|module)\\b",e:"$|;",k:{"class":1,module:1},c:[{cN:"title",b:"[A-Za-z_]\\w*(::\\w+)*(\\?|\\!)?",r:0},{cN:"inheritance",b:"<\\s*",c:[{cN:"parent",b:"("+hljs.IR+"::)?"+hljs.IR}]}].concat(k)},h,{cN:"constant",b:"(::)?([A-Z]\\w*(::)?)+",r:0},{cN:"symbol",b:":",c:f.concat([j]),r:0},{cN:"number",b:"(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b",r:0},{cN:"number",b:"\\?\\w"},{cN:"variable",b:"(\\$\\W)|((\\$|\\@\\@?)(\\w+))"},j,{b:"("+hljs.RSR+")\\s*",c:k.concat([{cN:"regexp",b:"/",e:"/[a-z]*",i:"\\n",c:[hljs.BE]}]),r:0}]));e.c=b;h.c[1].c=b;return{dM:{l:c,k:a,c:b}}}();
+var hljs=new function(){function l(o){return o.replace(/&/gm,"&amp;").replace(/</gm,"&lt;")}function b(p){for(var o=p.firstChild;o;o=o.nextSibling){if(o.nodeName=="CODE"){return o}if(!(o.nodeType==3&&o.nodeValue.match(/\s+/))){break}}}function h(p,o){return Array.prototype.map.call(p.childNodes,function(q){if(q.nodeType==3){return o?q.nodeValue.replace(/\n/g,""):q.nodeValue}if(q.nodeName=="BR"){return"\n"}return h(q,o)}).join("")}function a(q){var p=(q.className+" "+q.parentNode.className).split(/\s+/);p=p.map(function(r){return r.replace(/^language-/,"")});for(var o=0;o<p.length;o++){if(e[p[o]]||p[o]=="no-highlight"){return p[o]}}}function c(q){var o=[];(function p(r,s){for(var t=r.firstChild;t;t=t.nextSibling){if(t.nodeType==3){s+=t.nodeValue.length}else{if(t.nodeName=="BR"){s+=1}else{if(t.nodeType==1){o.push({event:"start",offset:s,node:t});s=p(t,s);o.push({event:"stop",offset:s,node:t})}}}}return s})(q,0);return o}function j(x,v,w){var p=0;var y="";var r=[];function t(){if(x.length&&v.length){if(x[0].offset!=v[0].offset){return(x[0].offset<v[0].offset)?x:v}else{return v[0].event=="start"?x:v}}else{return x.length?x:v}}function s(A){function z(B){return" "+B.nodeName+'="'+l(B.value)+'"'}return"<"+A.nodeName+Array.prototype.map.call(A.attributes,z).join("")+">"}while(x.length||v.length){var u=t().splice(0,1)[0];y+=l(w.substr(p,u.offset-p));p=u.offset;if(u.event=="start"){y+=s(u.node);r.push(u.node)}else{if(u.event=="stop"){var o,q=r.length;do{q--;o=r[q];y+=("</"+o.nodeName.toLowerCase()+">")}while(o!=u.node);r.splice(q,1);while(q<r.length){y+=s(r[q]);q++}}}}return y+l(w.substr(p))}function f(q){function o(s,r){return RegExp(s,"m"+(q.cI?"i":"")+(r?"g":""))}function p(y,w){if(y.compiled){return}y.compiled=true;var s=[];if(y.k){var r={};function z(A,t){t.split(" ").forEach(function(B){var C=B.split("|");r[C[0]]=[A,C[1]?Number(C[1]):1];s.push(C[0])})}y.lR=o(y.l||hljs.IR,true);if(typeof y.k=="string"){z("keyword",y.k)}else{for(var x in y.k){if(!y.k.hasOwnProperty(x)){continue}z(x,y.k[x])}}y.k=r}if(w){if(y.bWK){y.b="\\b("+s.join("|")+")\\s"}y.bR=o(y.b?y.b:"\\B|\\b");if(!y.e&&!y.eW){y.e="\\B|\\b"}if(y.e){y.eR=o(y.e)}y.tE=y.e||"";if(y.eW&&w.tE){y.tE+=(y.e?"|":"")+w.tE}}if(y.i){y.iR=o(y.i)}if(y.r===undefined){y.r=1}if(!y.c){y.c=[]}for(var v=0;v<y.c.length;v++){if(y.c[v]=="self"){y.c[v]=y}p(y.c[v],y)}if(y.starts){p(y.starts,w)}var u=[];for(var v=0;v<y.c.length;v++){u.push(y.c[v].b)}if(y.tE){u.push(y.tE)}if(y.i){u.push(y.i)}y.t=u.length?o(u.join("|"),true):{exec:function(t){return null}}}p(q)}function d(C,D){function o(r,M){for(var L=0;L<M.c.length;L++){var K=M.c[L].bR.exec(r);if(K&&K.index==0){return M.c[L]}}}function s(K,r){if(K.e&&K.eR.test(r)){return K}if(K.eW){return s(K.parent,r)}}function t(r,K){return K.i&&K.iR.test(r)}function y(L,r){var K=E.cI?r[0].toLowerCase():r[0];return L.k.hasOwnProperty(K)&&L.k[K]}function F(){var K=l(w);if(!A.k){return K}var r="";var N=0;A.lR.lastIndex=0;var L=A.lR.exec(K);while(L){r+=K.substr(N,L.index-N);var M=y(A,L);if(M){v+=M[1];r+='<span class="'+M[0]+'">'+L[0]+"</span>"}else{r+=L[0]}N=A.lR.lastIndex;L=A.lR.exec(K)}return r+K.substr(N)}function z(){if(A.sL&&!e[A.sL]){return l(w)}var r=A.sL?d(A.sL,w):g(w);if(A.r>0){v+=r.keyword_count;B+=r.r}return'<span class="'+r.language+'">'+r.value+"</span>"}function J(){return A.sL!==undefined?z():F()}function I(L,r){var K=L.cN?'<span class="'+L.cN+'">':"";if(L.rB){x+=K;w=""}else{if(L.eB){x+=l(r)+K;w=""}else{x+=K;w=r}}A=Object.create(L,{parent:{value:A}});B+=L.r}function G(K,r){w+=K;if(r===undefined){x+=J();return}var L=o(r,A);if(L){x+=J();I(L,r);return L.rB}var M=s(A,r);if(M){if(!(M.rE||M.eE)){w+=r}x+=J();do{if(A.cN){x+="</span>"}A=A.parent}while(A!=M.parent);if(M.eE){x+=l(r)}w="";if(M.starts){I(M.starts,"")}return M.rE}if(t(r,A)){throw"Illegal"}}var E=e[C];f(E);var A=E;var w="";var B=0;var v=0;var x="";try{var u,q=0;while(true){A.t.lastIndex=q;u=A.t.exec(D);if(!u){break}var p=G(D.substr(q,u.index-q),u[0]);q=u.index+(p?0:u[0].length)}G(D.substr(q),undefined);return{r:B,keyword_count:v,value:x,language:C}}catch(H){if(H=="Illegal"){return{r:0,keyword_count:0,value:l(D)}}else{throw H}}}function g(s){var o={keyword_count:0,r:0,value:l(s)};var q=o;for(var p in e){if(!e.hasOwnProperty(p)){continue}var r=d(p,s);r.language=p;if(r.keyword_count+r.r>q.keyword_count+q.r){q=r}if(r.keyword_count+r.r>o.keyword_count+o.r){q=o;o=r}}if(q.language){o.second_best=q}return o}function i(q,p,o){if(p){q=q.replace(/^((<[^>]+>|\t)+)/gm,function(r,v,u,t){return v.replace(/\t/g,p)})}if(o){q=q.replace(/\n/g,"<br>")}return q}function m(r,u,p){var v=h(r,p);var t=a(r);if(t=="no-highlight"){return}var w=t?d(t,v):g(v);t=w.language;var o=c(r);if(o.length){var q=document.createElement("pre");q.innerHTML=w.value;w.value=j(o,c(q),v)}w.value=i(w.value,u,p);var s=r.className;if(!s.match("(\\s|^)(language-)?"+t+"(\\s|$)")){s=s?(s+" "+t):t}r.innerHTML=w.value;r.className=s;r.result={language:t,kw:w.keyword_count,re:w.r};if(w.second_best){r.second_best={language:w.second_best.language,kw:w.second_best.keyword_count,re:w.second_best.r}}}function n(){if(n.called){return}n.called=true;Array.prototype.map.call(document.getElementsByTagName("pre"),b).filter(Boolean).forEach(function(o){m(o,hljs.tabReplace)})}function k(){window.addEventListener("DOMContentLoaded",n,false);window.addEventListener("load",n,false)}var e={};this.LANGUAGES=e;this.highlight=d;this.highlightAuto=g;this.fixMarkup=i;this.highlightBlock=m;this.initHighlighting=n;this.initHighlightingOnLoad=k;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="(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)";this.BNR="\\b(0b[01]+)";this.RSR="!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|\\.|-|-=|/|/=|:|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~";this.BE={b:"\\\\[\\s\\S]",r:0};this.ASM={cN:"string",b:"'",e:"'",i:"\\n",c:[this.BE],r:0};this.QSM={cN:"string",b:'"',e:'"',i:"\\n",c:[this.BE],r:0};this.CLCM={cN:"comment",b:"//",e:"$"};this.CBLCLM={cN:"comment",b:"/\\*",e:"\\*/"};this.HCM={cN:"comment",b:"#",e:"$"};this.NM={cN:"number",b:this.NR,r:0};this.CNM={cN:"number",b:this.CNR,r:0};this.BNM={cN:"number",b:this.BNR,r:0};this.inherit=function(q,r){var o={};for(var p in q){o[p]=q[p]}if(r){for(var p in r){o[p]=r[p]}}return o}}();hljs.LANGUAGES.ruby=function(e){var a="[a-zA-Z_][a-zA-Z0-9_]*(\\!|\\?)?";var j="[a-zA-Z_]\\w*[!?=]?|[-+~]\\@|<<|>>|=~|===?|<=>|[<>]=?|\\*\\*|[-/+%^&*~`|]|\\[\\]=?";var g={keyword:"and false then defined module in return redo if BEGIN retry end for true self when next until do begin unless END rescue nil else break undef not super class case require yield alias while ensure elsif or include"};var c={cN:"yardoctag",b:"@[A-Za-z]+"};var k=[{cN:"comment",b:"#",e:"$",c:[c]},{cN:"comment",b:"^\\=begin",e:"^\\=end",c:[c],r:10},{cN:"comment",b:"^__END__",e:"\\n$"}];var d={cN:"subst",b:"#\\{",e:"}",l:a,k:g};var i=[e.BE,d];var b=[{cN:"string",b:"'",e:"'",c:i,r:0},{cN:"string",b:'"',e:'"',c:i,r:0},{cN:"string",b:"%[qw]?\\(",e:"\\)",c:i},{cN:"string",b:"%[qw]?\\[",e:"\\]",c:i},{cN:"string",b:"%[qw]?{",e:"}",c:i},{cN:"string",b:"%[qw]?<",e:">",c:i,r:10},{cN:"string",b:"%[qw]?/",e:"/",c:i,r:10},{cN:"string",b:"%[qw]?%",e:"%",c:i,r:10},{cN:"string",b:"%[qw]?-",e:"-",c:i,r:10},{cN:"string",b:"%[qw]?\\|",e:"\\|",c:i,r:10}];var h={cN:"function",bWK:true,e:" |$|;",k:"def",c:[{cN:"title",b:j,l:a,k:g},{cN:"params",b:"\\(",e:"\\)",l:a,k:g}].concat(k)};var f=k.concat(b.concat([{cN:"class",bWK:true,e:"$|;",k:"class module",c:[{cN:"title",b:"[A-Za-z_]\\w*(::\\w+)*(\\?|\\!)?",r:0},{cN:"inheritance",b:"<\\s*",c:[{cN:"parent",b:"("+e.IR+"::)?"+e.IR}]}].concat(k)},h,{cN:"constant",b:"(::)?(\\b[A-Z]\\w*(::)?)+",r:0},{cN:"symbol",b:":",c:b.concat([{b:j}]),r:0},{cN:"symbol",b:a+":",r:0},{cN:"number",b:"(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b",r:0},{cN:"number",b:"\\?\\w"},{cN:"variable",b:"(\\$\\W)|((\\$|\\@\\@?)(\\w+))"},{b:"("+e.RSR+")\\s*",c:k.concat([{cN:"regexp",b:"/",e:"/[a-z]*",i:"\\n",c:[e.BE,d]}]),r:0}]));d.c=f;h.c[1].c=f;return{l:a,k:g,c:f}}(hljs);

data/lib/rokko/index_layout.rb

@@ -1,3 +1,5 @@
+# Layout containing README file and "Table of Contents" with links
+# to all generated HTML files
 class Rokko::IndexLayout < Rokko::Layout
   self.template_file = File.join(File.dirname(__FILE__), 'index_layout.mustache')
 

data/lib/rokko/layout.rb

@@ -20,7 +20,8 @@ module Rokko
 
         "<style type=\"text/css\" media=\"screen, projection\">#{docco}\n#{highlight}</style>"
       else
-        "<link rel=\"stylesheet\" href=\"http://vast.github.com/rokko/assets/v#{::Rokko::VERSION}/docco.css\" />
+        stylesheet_link = @options[:stylesheet] || "http://vast.github.com/rokko/assets/v#{::Rokko::VERSION}/docco.css"
+        "<link rel=\"stylesheet\" href=\"#{stylesheet_link}\" />
          <link rel=\"stylesheet\" href=\"http://vast.github.com/rokko/assets/v#{::Rokko::VERSION}/highlight.css\" />"
       end
     end
@@ -62,6 +63,8 @@ module Rokko
       if @doc.options[:index] || @doc.options[:generate_index]
         sources.unshift({:path => 'index.html', :basename => 'index', :url => relative_url('index.html')})
       end
+
+      sources
     end
     
     private

data/lib/rokko/task.rb

@@ -1,17 +1,25 @@
+# ### Rokko Rake task
+# 
 # Usage:
 #
-#     Rokko::Task.new(:task_name, output_dir, filelist, opts)
-#
-# Example:
-#     Rokko::Task.new(:rokko, 'docs',
+#     require 'rokko/task'
+# 
+#     Rokko::Task.new(:rokko, 'docs', # task name, output dir
 #                     ['lib/**/*.rb', 'README.md'],
 #                     {:index => true, :local => true})
 #
+# And run with:
+#     rake rokko
+# 
 # Available options:
 #
 # * `:local` -- generate offline-ready documentation.
-# * `:index` -- if value is a file name, then it will be used as an index. If value is `true` then
-#   an index file with table of contents will be generated.
+# * `:index => true` -- generate index.html with links (TOC) to all generated HTML files.
+# * `:index => <file>` -- use `<file>` as index.html.
+# * `:stylesheet` -- CSS stylesheet to use instead of default one.
+
+# `Rokko::Task.new` takes a task name, the destination directory,
+# a source file pattern or file list
 require 'rokko'
 
 module Rokko
@@ -30,6 +38,7 @@ module Rokko
       define
     end
 
+    # Actually setup the task
     def define
       desc "Generate rokko documentation"
       task @name do
@@ -57,7 +66,7 @@ module Rokko
         end
 
         # Run specified file through rokko and use it as index
-        if @options[:index] && source_index = @sources.delete(@options[:index])
+        if @options[:index] && source_index = @sources.find{|s| s == @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"

data/lib/rokko/version.rb

@@ -1,3 +1,3 @@
 module Rokko
-  VERSION = "0.1.3"
+  VERSION = "0.5.0"
 end

data/lib/rokko.rb

@@ -1,14 +1,40 @@
-# ##Rokko -- fat-free [Rocco](http://rtomayko.github.com/rocco/)
+# ## Rokko -- fat-free [Rocco](http://rtomayko.github.com/rocco/)
+# Rokko is an else one Ruby port of [Docco](http://jashkenas.github.com/docco/),
+# the quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.
+# 
+# Rokko reads Ruby source files and produces annotated source documentation in HTML format.
+# Comments are formatted with Markdown and presented alongside syntax highlighted code so as
+# to give an annotation effect.
+# 
+# ### Why Rokko?
+# 
+# * Rokko supports only Ruby source files (consider using [Rocco](http://rtomayko.github.com/rocco/)
+#   if you need more languages).
+# * Rokko uses awesome [highlight.js](http://softwaremaniacs.org/soft/highlight/en/) library
+#   for syntax highlighting.
+# * Rokko can generate offline-ready documentation (all assets are bundled).
+# * Rokko can generate an index file with links to everything (like Table of Contents).
+
+# We'll definitely need RDiscount (Markdown library)
+# and Mustache (templating engine)
 require 'rdiscount'
-require 'rokko/version'
+require 'mustache'
+require File.expand_path('../rokko/version', __FILE__)
 
+# ### Public interface
+# `Rokko.new` takes a filename, an optional list of source filenames
+# for other documentation sources, an options hash, and an optional block.
+# 
+# When `block` is given, it must return a string with file contents.
+# With no `block`, the file is read to retrieve data.
 module Rokko
   class Rokko
     attr_reader :file
     attr_reader :sections
     attr_reader :sources
     attr_reader :options
-    
+
+    # Comment patterns
     @@comment_pattern = /^\s*#(?!\{)\s?/
     @@block_comment_start = /^\s*=begin\s*$/
     @@block_comment_end = /^\s*=end\s*$/
@@ -26,7 +52,10 @@ module Rokko
       
       @sections = prettify(split(parse(@data)))
     end
-    
+
+    # Parse the raw file data into a list of two-tuples. Each tuple has the form
+    # `[docs, code]` where both elements are arrays containing the raw lines
+    # parsed from the input file, comment characters stripped.
     def parse(data)
       sections = []
       docs, code = [], []
@@ -117,8 +146,7 @@ module Rokko
     
     
     def to_html
-      require 'mustache'
-      require 'rokko/layout'
+      require File.expand_path('../rokko/layout', __FILE__)
       
       ::Rokko::Layout.new(self).render
     end

data/test/fixtures/block_comments.rb

@@ -0,0 +1,7 @@
+=begin
+  ruby block comment
+=end
+
+def hello
+  "world"
+end

data/test/fixtures/encoding.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+puts "hello"

data/test/fixtures/filename.rb

@@ -0,0 +1,5 @@
+# filename.rb perfecto!
+
+def perfecto
+  true
+end

data/test/fixtures/normalizing.rb

@@ -0,0 +1,6 @@
+# Hurrah!
+class Post
+  # save it
+  def save111111
+  end
+end

data/test/fixtures/shebang.rb

@@ -0,0 +1,3 @@
+#! /usr/bin/env ruby
+# test shebangs
+puts "bang! bang!"

data/test/helper.rb

@@ -0,0 +1,10 @@
+def rokkoize(contents, options = {})
+  options = {:filename => 'filename.rb'}.merge(options)
+  Rokko::Rokko.new(options[:filename], [options[:filename]], options) do
+    contents
+  end
+end
+
+def fixture(filename)
+  File.read(File.expand_path("../fixtures/#{filename}.rb", __FILE__))
+end

data/test/test_assets.rb

@@ -0,0 +1,39 @@
+class TestRokkoAssets < Test::Unit::TestCase
+  ROKKO_FIXTURE = fixture('filename')
+
+  def setup
+    @html = rokkoize(ROKKO_FIXTURE).to_html
+  end
+
+  def test_default_stylesheet_links
+    assert @html.include?("<link rel=\"stylesheet\" href=\"http://vast.github.com/rokko/assets/v#{::Rokko::VERSION}/docco.css\" />")
+    assert @html.include?("<link rel=\"stylesheet\" href=\"http://vast.github.com/rokko/assets/v#{::Rokko::VERSION}/highlight.css\" />")
+  end
+
+  def test_highlightjs_initialization
+    assert @html.include?("<script>hljs.initHighlightingOnLoad();</script>")
+  end
+
+  def test_default_scripts
+    assert @html.include?("<script src=\"http://vast.github.com/rokko/assets/v#{::Rokko::VERSION}/highlight.pack.js\"></script>")
+  end
+
+  def test_assets_embedding
+    contents = rokkoize(ROKKO_FIXTURE, :local => true).to_html
+
+    assert contents.include?(asset_contents('docco.css'))
+    assert contents.include?(asset_contents('highlight.css'))
+    assert contents.include?(asset_contents('highlight.pack.js'))
+  end
+
+  def test_custom_stylesheet
+    contents = rokkoize(ROKKO_FIXTURE, :stylesheet => 'http://ya.ru/base.css').to_html
+
+    assert contents.include?('<link rel="stylesheet" href="http://ya.ru/base.css" />')
+  end
+
+  private
+  def asset_contents(filename)
+    File.read(File.expand_path("../../lib/rokko/assets/#{filename}",__FILE__))
+  end
+end

data/test/test_basics.rb

@@ -0,0 +1,39 @@
+class RokkoBasicTests < Test::Unit::TestCase
+  ROKKO_FIXTURE = fixture('filename')
+
+  def test_rokko_exists_and_is_instancable
+    assert_nothing_raised do
+      r = rokkoize(ROKKO_FIXTURE)
+    end
+  end
+
+  def test_filename
+    assert_equal "filename.rb", rokkoize(ROKKO_FIXTURE).file
+  end
+
+  def test_sources
+    assert_equal ["filename.rb"], rokkoize(ROKKO_FIXTURE).sources
+  end
+
+  def test_sections
+    r = rokkoize(ROKKO_FIXTURE)
+    assert_equal 1, r.sections.length
+    assert_equal 2, r.sections[0].length # docs + code
+    assert_equal "<p>filename.rb perfecto!</p>\n", r.sections[0][0] # docs
+    assert_equal "\ndef perfecto\n  true\nend", r.sections[0][1] # code
+  end
+
+  def test_to_html
+    r = rokkoize(ROKKO_FIXTURE)
+    assert_nothing_raised do
+      html = r.to_html
+    end
+  end
+
+  def test_to_html_generates_proper_html
+    html = rokkoize(ROKKO_FIXTURE).to_html
+    assert html.include?('<h1>filename.rb</h1>')
+    assert html.include?('<p>filename.rb perfecto!</p>')
+    assert html.include?('def perfecto')
+  end
+end

data/test/test_parsing.rb

@@ -0,0 +1,22 @@
+class RokkoParsingTest < Test::Unit::TestCase
+  def test_shebang_first_line
+    html = rokkoize(fixture('shebang')).to_html
+    assert !html.include?('env ruby')
+  end
+
+  def test_block_comments
+    sections = rokkoize(fixture('block_comments')).sections
+    assert_equal "<p>ruby block comment</p>\n", sections[0][0]
+  end
+
+  def test_ruby_encoding
+    html = rokkoize(fixture('encoding')).to_html
+    assert !html.include?('encoding')
+  end
+
+  def test_normalizing
+    r = Rokko::Rokko.new('test.rb', ['test.rb']) {""}
+    sections = r.parse(fixture('normalizing'))
+    assert_equal "save it", sections[1][0][0]
+  end
+end

data/test/test_sources.rb

@@ -0,0 +1,22 @@
+class RokkoSourcesTest < Test::Unit::TestCase
+  def test_flat_source_list
+    r = Rokko::Rokko.new('filename.rb', ['a.rb', 'b.rb']) do
+      "# comment\n puts 'code'"
+    end
+    html = r.to_html
+
+    assert html.include?('<a class="source" href="./a.html">a.rb</a>')
+    assert html.include?('<a class="source" href="./b.html">b.rb</a>')
+  end
+
+  def test_heiarachical_sourcelist
+    r = Rokko::Rokko.new('filename.rb', ['a/a.rb', 'c/b.rb', '../d.rb']) do
+      "# comment\n puts 'code'"
+    end
+    html = r.to_html
+
+    assert html.include?('<a class="source" href="a/a.html">a.rb</a>')
+    assert html.include?('<a class="source" href="c/b.html">b.rb</a>')
+    assert html.include?('<a class="source" href="../d.html">d.rb</a>')
+  end
+end

data/test/tests.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require File.expand_path('../helper', __FILE__)
+require File.expand_path('../../lib/rokko', __FILE__)
+
+Dir[File.expand_path('../test_*.rb', __FILE__)].each {|f| require f}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rokko
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000Z
+date: 2012-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
-  requirement: &2157000060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157000060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &2156999640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156999640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: fat-free [rocco](http://rtomayko.github.com/rocco/)
 email:
 - vasily@polovnyov.ru
@@ -46,7 +56,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- TODO
 - bin/rokko
 - lib/rokko.rb
 - lib/rokko/assets/docco.css
@@ -59,6 +68,17 @@ files:
 - lib/rokko/task.rb
 - lib/rokko/version.rb
 - rokko.gemspec
+- test/fixtures/block_comments.rb
+- test/fixtures/encoding.rb
+- test/fixtures/filename.rb
+- test/fixtures/normalizing.rb
+- test/fixtures/shebang.rb
+- test/helper.rb
+- test/test_assets.rb
+- test/test_basics.rb
+- test/test_parsing.rb
+- test/test_sources.rb
+- test/tests.rb
 homepage: http://vast.github.com/rokko/
 licenses: []
 post_install_message: 
@@ -79,8 +99,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rokko
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Else one ruby port of [Docco](http://jashkenas.github.com/docco/)
-test_files: []
+test_files:
+- test/fixtures/block_comments.rb
+- test/fixtures/encoding.rb
+- test/fixtures/filename.rb
+- test/fixtures/normalizing.rb
+- test/fixtures/shebang.rb
+- test/helper.rb
+- test/test_assets.rb
+- test/test_basics.rb
+- test/test_parsing.rb
+- test/test_sources.rb
+- test/tests.rb

data/TODO

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