rokko 0.0.3 → 0.1.0

data/LICENSE

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

data/README.md

@@ -1,3 +1,57 @@
 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).
+
+##Installation
+
+Install with Rubygems:
+
+    sudo gem install rokko
+
+##Usage
+
+`rokko` command can be used to generate documentation for a set of Ruby source files:
+
+    rokko -o docs lib/*.rb
+
+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})
+
+And run:
+
+    rake rokko
+
+##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.
+* `-o`, `--output=<dir>` -- directory where generated HTML files are written.
+
+###Rake task
+
+Usage:
+
+    Rokko::Task.new(:task_name, output_dir, filelist, opts)
+
+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.
+

data/Rakefile

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

data/TODO

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

data/bin/rokko

@@ -6,6 +6,7 @@
 #/ Options:
 #/   -i, --index=<file>     Also generate an index with links to HTML files or use <file> as
 #/                          index
+#/   -l, --local            Generate offline-ready documentation
 #/   -o, --output=<dir>     Directory where generated HTML files are written
 #/       --help             Show this help message
 
@@ -46,6 +47,7 @@ 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("-l", "--local") {options[:local] = true}
   o.on_tail("-h", "--help") {usage($stdout, 0)}
   o.parse!
 } or abort_with_note
@@ -78,7 +80,7 @@ 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)}
+  File.open(dest, 'wb') {|fd| fd.write(Rokko::IndexLayout.new(sources, readme, options).render)}
 end
 
 # Generate and use specified file as index.

data/lib/rokko/index_layout.mustache

@@ -3,10 +3,8 @@
 <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>
+  {{{ styles }}}
+  {{{ highlight_js }}}
 </head>
 <body>
 <div id="container">

data/lib/rokko/index_layout.rb

@@ -1,9 +1,10 @@
 class Rokko::IndexLayout < Rokko::Layout
   self.template_path = File.dirname(__FILE__)
 
-  def initialize(sources, readme = '')
+  def initialize(sources, readme = '', options = {})
     @sources = sources
     @readme = readme
+    @options = options
   end
 
   def title

data/lib/rokko/layout.mustache

@@ -3,10 +3,8 @@
 <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>
+  {{{ styles }}}
+  {{{ highlight_js }}}
 </head>
 <body>
 <div id="container">

data/lib/rokko/layout.rb

@@ -5,6 +5,7 @@ module Rokko
     
     def initialize(doc)
       @doc = doc
+      @options = @doc.options
     end
     
     def title
@@ -12,16 +13,25 @@ module Rokko
     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
+      if @options[:local]
+        docco = File.read(File.join(File.dirname(__FILE__), 'assets', 'docco.css'))
+        highlight = File.read(File.join(File.dirname(__FILE__), 'assets', 'highlight.css'))
+
+        "<style type=\"text/css\" media=\"screen, projection\">#{docco}\n#{highlight}</style>"
+      else
+        "<link rel=\"stylesheet\" href=\"http://github.com/vast/rokko/raw/v#{::Rokko::VERSION}/lib/rokko/assets/docco.css\" />
+         <link rel=\"stylesheet\" href=\"http://github.com/vast/rokko/raw/v#{::Rokko::VERSION}/lib/rokko/assets/highlight.css\" />"
+      end
     end
     
     def highlight_js
-      js = File.read(File.join(File.dirname(__FILE__), 'assets', 'highlight.pack.js'))
+      js = if @options[:local]
+        "<script>#{File.read(File.join(File.dirname(__FILE__), 'assets', 'highlight.pack.js'))}</script>"
+      else
+        "<script src=\"http://github.com/vast/rokko/raw/v#{::Rokko::VERSION}/lib/rokko/assets/highlight.pack.js\"></script>"
+      end
       
-      js + "\nhljs.initHighlightingOnLoad();\n"
+      js + "\n" + "<script>hljs.initHighlightingOnLoad();</script>\n"
     end
     
     def sections

data/lib/rokko/task.rb

@@ -38,7 +38,7 @@ module Rokko
           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)}
+          File.open(out_dest, 'wb') {|fd| fd.write(IndexLayout.new(@sources, readme, @options).render)}
         end
 
         # Run specified file through rokko and use it as index

data/lib/rokko/version.rb

@@ -1,3 +1,3 @@
 module Rokko
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/rokko.rb

@@ -1,5 +1,6 @@
 # ##Rokko -- fat-free [Rocco](http://rtomayko.github.com/rocco/)
 require 'rdiscount'
+require 'rokko/version'
 
 module Rokko
   class Rokko

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rokko
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Vasily Polovnyov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-17 00:00:00 +03:00
+date: 2011-03-23 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,6 +58,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - TODO