DesigningPatterns-hanna 0.1.2

data/README.markdown

@@ -0,0 +1,85 @@
+# Hanna -- a better RDoc template
+
+Hanna is an RDoc template that scales. It's implemented in Haml, making the
+sources clean and readable. It's built with simplicity, beauty and ease of
+browsing in mind. (See more in [the wiki][wiki].)
+
+Hanna was made by [Mislav][] and is available from [GitHub][]:
+
+    gem install mislav-hanna
+
+
+## Usage
+
+After installing, you have three options. You can use the command-line tool:
+
+    hanna -h
+
+For repeated generation of API docs, it's better to set up a Rake task. If you
+already have an `RDocTask` set up, the only thing you need to change is this:
+
+    # replace this:
+    require 'rake/rdoctask'
+    # with this:
+    require 'hanna/rdoctask'
+
+Tip: you can do this in the Rakefile of your Rails project before running `rake
+doc:rails`.
+
+Here is an example of a task for the [will_paginate library][wp]:
+
+    # instead of 'rake/rdoctask':
+    require 'hanna/rdoctask'
+    
+    desc 'Generate RDoc documentation for the will_paginate plugin.'
+    Rake::RDocTask.new(:rdoc) do |rdoc|
+      rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'CHANGELOG').
+        include('lib/**/*.rb').
+        exclude('lib/will_paginate/named_scope*').
+        exclude('lib/will_paginate/array.rb').
+        exclude('lib/will_paginate/version.rb')
+      
+      rdoc.main = "README.rdoc" # page to start on
+      rdoc.title = "will_paginate documentation"
+      
+      rdoc.rdoc_dir = 'doc' # rdoc output folder
+      rdoc.options << '--webcvs=http://github.com/mislav/will_paginate/tree/master/'
+    end
+    
+Either way, it's the same as using RDoc.
+
+The last thing you can do with Hanna is generate documentation for installed
+gems. This is a replacement for the "gem rdoc" command.
+
+    [sudo] hanna --gems haml will_paginate
+
+Hanna also can be used with standard rdoc options:
+    --inline-source -T hanna
+
+## A work in progress
+
+Hanna is far from done, but it is the first RDoc template that's actually
+_maintainable_.  First thing I have done is converted the original HTML
+template to Haml and Sass, cleaning up and removing the (ridiculous amount of)
+duplication.
+
+Also, the template fragments are now in _separate files_. You would have
+fainted if you seen how it was before. (It's really no wonder why there are no
+other RDoc templates around ... save one: [Allison][].)
+
+Ultimately, I'd like to lose the frameset. Currently that is far from possible
+because the whole RDoc HTML Generator is built for frames. Still, that is my
+goal.
+
+## You can help
+
+Don't like something? Think you can design better? (You probably can.)
+
+This is git. I welcome all submissions towards my goal.
+
+
+[wiki]: http://github.com/mislav/hanna/wikis/home "Hanna wiki"
+[GitHub]: http://gems.github.com/ "GitHub gem source"
+[wp]: http://github.com/mislav/will_paginate
+[Mislav]: http://mislav.caboo.se/ "Mislav Marohnić"
+[Allison]: http://blog.evanweaver.com/files/doc/fauna/allison/ "A modern, pretty RDoc template"

data/Rakefile

@@ -0,0 +1,25 @@
+desc %{Update ".manifest" with the latest list of project filenames. Respect .gitignore by excluding everything that git ignores. Update `files` and `test_files` arrays in "*.gemspec" file if it's present.}
+task :manifest do
+  list = Dir['**/*'].sort
+  spec_file = Dir['*.gemspec'].first
+  list -= [spec_file] if spec_file
+  
+  File.read('.gitignore').each_line do |glob|
+    glob = glob.chomp.sub(/^\//, '')
+    list -= Dir[glob]
+    list -= Dir["#{glob}/**/*"] if File.directory?(glob) and !File.symlink?(glob)
+    puts "excluding #{glob}"
+  end if File.exists?('.gitignore')
+
+  if spec_file
+    spec = File.read spec_file
+    spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+      assignment = $1
+      bunch = $2 ? list.grep(/^test\//) : list
+      '%s%%w(%s)' % [assignment, bunch.join(' ')]
+    end
+      
+    File.open(spec_file,   'w') {|f| f << spec }
+  end
+  File.open('.manifest', 'w') {|f| f << list.join("\n") }
+end

data/bin/hanna

@@ -0,0 +1,79 @@
+#!/usr/bin/ruby
+if ARGV.size == 1 and ARGV.first == '-h'
+  puts <<-HELP
+Hanna -- a better RDoc template
+Synopsis:
+  hanna [options]  [file names...]
+  [sudo] hanna --gems  [gem names...]
+  
+Example usage:
+
+  hanna lib/**/*.rb
+
+Hanna passes all arguments to RDoc. To find more about RDoc options, see
+"rdoc -h". Default options are:
+
+  -o doc --inline-source --charset=UTF-8
+
+The second form, with the "--gems" argument, serves the same purpose as
+the "gem rdoc" command: it generates documentation for installed gems.
+When no gem names are given, "hanna --gems" will install docs for EACH of
+the gems, which can, uh, take a little while.
+
+HELP
+  exit 0
+end
+
+require 'rubygems'
+begin
+  gem 'rdoc', '~> 2.0.0'
+rescue Gem::LoadError
+  $stderr.puts "Hanna requires the RDoc 2.0 gem."
+  exit 1
+else
+  require 'rdoc/rdoc'
+end
+
+hanna_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(hanna_dir) unless $:.include?(hanna_dir)
+
+options = []
+
+options << '-T' << 'hanna/hanna.rb'
+options << '--inline-source' << '--charset=UTF-8'
+
+if ARGV.first == '--gems'
+  require 'rubygems/doc_manager'
+  Gem::DocManager.configured_args = options
+  
+  gem_names = ARGV.dup
+  gem_names.shift
+  
+  unless gem_names.empty?
+    specs = gem_names.inject([]) do |arr, name|
+      found = Gem::SourceIndex.from_installed_gems.search(name)
+      spec = found.sort_by {|s| s.version }.last
+      arr << spec if spec
+      arr
+    end
+  else
+    specs = Gem::SourceIndex.from_installed_gems.inject({}) do |all, pair|
+      full_name, spec = pair
+      if spec.has_rdoc? and (!all[spec.name] or spec.version > all[spec.name].version)
+        all[spec.name] = spec
+      end
+      all
+    end
+    specs = specs.values
+    puts "Hanna is installing documentation for #{specs.size} gem#{specs.size > 1 ? 's' : ''} ..."
+  end
+
+  specs.each do |spec|
+    Gem::DocManager.new(spec).generate_rdoc
+  end
+else
+  options << '-o' << 'doc' unless ARGV.include?('-o') or ARGV.include?('--op')
+  options.concat ARGV
+
+  RDoc::RDoc.new.document(options)
+end

data/lib/hanna.rb

@@ -0,0 +1 @@
+require 'hanna/hanna'

data/lib/hanna/hanna.rb

@@ -0,0 +1,55 @@
+require 'haml'
+require 'sass'
+require 'rdoc/generator/html'
+require 'hanna/template_page_patch'
+
+# = A better RDoc HTML template
+#
+# Many different kinds of awesome.
+#
+# Author: Mislav Marohnić <mislav.marohnic@gmail.com>
+# Based on the work of Michael Granger <ged@FaerieMUD.org>
+
+module RDoc::Generator::HTML::HANNA
+  class << self
+    def dir
+      @dir ||= File.join File.dirname(__FILE__), 'template_files'
+    end
+
+    def read(*names)
+      extension = nil
+      
+      content = names.map { |name|
+        if extension
+          name += '.' + extension
+        else
+          extension = name =~ /\.(\w+)$/ && $1
+        end
+        File.read File.join(dir, name)
+      }.join('')
+
+      case extension
+      when 'sass'
+        Sass::Engine.new(content)
+      when 'haml'
+        Haml::Engine.new(content)
+      else
+        content
+      end
+    end
+  end
+
+  STYLE = read('styles.sass')
+
+  CLASS_PAGE  = read('page.haml')
+  FILE_PAGE   = CLASS_PAGE
+  METHOD_LIST = read('method_list.haml', 'sections')
+
+  FR_INDEX_BODY = BODY = read('layout.haml')
+
+  FILE_INDEX   = read('file_index.haml')
+  CLASS_INDEX  = read('class_index.haml')
+  METHOD_INDEX = FILE_INDEX
+
+  INDEX = read('index.haml')
+end 

data/lib/hanna/rdoctask.rb

@@ -0,0 +1,45 @@
+require 'rake'
+require 'rake/rdoctask'
+
+Rake::RDocTask.class_eval do
+  # don't allow it
+  undef :external=
+    
+  # Create the tasks defined by this task lib.
+  def define
+    unless @template and @template != 'html'
+      @template = File.dirname(__FILE__) + '/hanna'
+    end
+    options << '--inline-source' unless options.include? '--inline-source' or options.include? '-S'
+    options << '--charset=UTF-8' if options.grep(/^(--charset$|-c\b)/).empty?
+    
+    desc "Build the HTML documentation"
+    task name
+    
+    desc "Force a rebuild of the RDOC files"
+    task paste("re", name) => [paste("clobber_", name), name]
+
+    desc "Remove rdoc products" 
+    task paste("clobber_", name) do
+      rm_r rdoc_dir rescue nil
+    end
+
+    task :clobber => [paste("clobber_", name)]
+      
+    directory @rdoc_dir
+    task name => [rdoc_target]
+    file rdoc_target => @rdoc_files + [$rakefile] do
+      rm_r @rdoc_dir rescue nil
+      
+      begin
+        gem 'rdoc', '~> 2.0.0'
+      rescue Gem::LoadError
+        $stderr.puts "Couldn't load RDoc 2.0 gem"
+      end
+      require 'rdoc/rdoc'
+      
+      RDoc::RDoc.new.document(option_list + @rdoc_files)
+    end
+    self
+  end
+end

data/lib/hanna/template_files/class_index.haml

@@ -0,0 +1,3 @@
+%h1= values["list_title"]
+%ol#index-entries.classes
+  = render_class_tree make_class_tree(values["entries"])

data/lib/hanna/template_files/file_index.haml

@@ -0,0 +1,13 @@
+%h1= values["list_title"]
+- type = values["list_title"].downcase
+- any_hidden = false
+
+%ol#index-entries{ :class => type }
+  - for entry in values["entries"]
+    - hide = type == 'files' && entry['name'] =~ /\.rb$/
+    - any_hidden = true if hide
+    %li{ :class => hide ? 'other' : nil }= link_to entry['name'], entry['href']
+
+  - if any_hidden
+    %li
+      %a.show{ :href => '#', :onclick => 'this.parentNode.parentNode.className += " expanded"; this.parentNode.removeChild(this); return false' } show all

data/lib/hanna/template_files/index.haml

@@ -0,0 +1,11 @@
+!!! Frameset
+%html{ "xml:lang" => "en", :lang => "en", :xmlns => "http://www.w3.org/1999/xhtml" }
+  %head
+    %title= values["title"]
+    %meta{ :content => "text/html; charset=#{values['charset']}", "http-equiv" => "Content-Type" }
+  %frameset{ :cols => "20%, *" }
+    %frameset{ :rows => "15%, 35%, 50%" }
+      %frame{ :name => "Files", :title => "Files", :src => "fr_file_index.html" }
+      %frame{ :name => "Classes", :src => "fr_class_index.html" }
+      %frame{ :name => "Methods", :src => "fr_method_index.html" }
+    %frame{ :name => "docwin", :src => values['initial_page'] }

data/lib/hanna/template_files/layout.haml

@@ -0,0 +1,37 @@
+!!! strict
+- index = values['list_title']
+%html{ :xmlns => "http://www.w3.org/1999/xhtml", 'xml:lang' => "en", :lang => "en" }
+  %head
+    %title= index || values['title']
+    %meta{ 'http-equiv' => "Content-Type", :content => "text/html; charset=#{values['charset']}" }
+    %link{ :rel => "stylesheet", :href => values["style_url"], :type => "text/css", :media => "screen" }
+    - unless index
+      %script{ :type => "text/javascript" }
+        :plain
+          function popupCode(url) {
+            window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+          }
+
+          function toggleCode(id) {
+            var code = document.getElementById(id)
+
+            code.style.display = code.style.display != 'block' ? 'block' : 'none'
+            return true
+          }
+
+          // Make codeblocks hidden by default
+          document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
+    - else
+      %base{ :target => 'docwin' }/
+        
+  %body{ :class => index ? 'list' : 'page' }
+    - if index
+      #index= yield
+    - else
+      #wrapper{ :class => values["classmod"] ? 'class' : 'file' }
+        = yield
+        #footer-push
+      #footer
+        = link_to '<strong>Hanna</strong> RDoc template', 'http://github.com/mislav/hanna'
+        hand-crafted by
+        %strong= link_to 'Mislav', 'http://mislav.caboo.se/'

data/lib/hanna/template_files/method_list.haml

@@ -0,0 +1,34 @@
+- methods = methods_from_sections values["sections"]
+- unless methods.empty?
+  #method-list
+    %h2 Methods
+    - for type in ['public class', 'protected class', 'public instance', 'protected instance']
+      - unless (list = methods[type]).empty?
+        %h3= type
+        %ol
+          - for method in list
+            %li= link_to method["name"], '#' + method["aref"]
+
+- if values["requires"] or values["toc"] or values["includes"]
+  #context
+    - if values["requires"]
+      #requires
+        %h2 Required files
+        %ol
+          - for req in values["requires"]
+            %li= link_to req["name"], req["aref"]
+            
+    - if values["toc"]
+      #contents
+        %h2 Contents
+        %ol
+          - for item in values["toc"]
+            %li= link_to values["secname"], values["href"]
+
+    - if values["includes"]
+      #includes
+        %h2 Included modules
+        %ol
+          - for inc in values["includes"]
+            %li= link_to inc["name"], inc["aref"]
+

data/lib/hanna/template_files/page.haml

@@ -0,0 +1,50 @@
+- file_page = !values["classmod"]
+- title_in_description = values["description"] && values["description"] =~ /^\s*<h1>/m
+
+.header
+  - title = capture_haml do
+    - if file_page
+      = values["short_name"]
+    - else
+      %span.type= values["classmod"]
+      = values["full_name"]
+  - if title_in_description
+    .name= title
+  - else
+    %h1.name= title
+    
+  - if file_page
+    .paths
+      = values["full_path"]
+      - if values["cvsurl"]
+        == (#{link_to 'view online', values["cvsurl"]})
+  - else
+    %ol.paths
+      - values["infiles"].each_with_index do |file, index|
+        %li{ :class => index > 0 ? 'other' : nil }
+          = link_to file["full_path"], file["full_path_url"]
+          - if file["cvsurl"]
+            == (#{link_to 'view online', file["cvsurl"]})
+      - if values["infiles"].size > 1
+        %li
+          %a.show{ :href => '#', :onclick => 'this.parentNode.parentNode.className += " expanded"; this.parentNode.removeChild(this); return false' } show all
+          
+  - if values["parent"] then
+    .parent
+      Parent:
+      %strong= link_to values["parent"], values["par_url"]
+
+  - if values["dtm_modified"]
+    .last-update
+      Last Update:
+      %span.datetime= values["dtm_modified"]
+    
+#content
+  - if values["diagram"]
+    #diagram= values["diagram"]
+
+  #text
+    - if values["description"]
+      #description~ values["description"]
+
+    = yield

data/lib/hanna/template_files/sections.haml

@@ -0,0 +1,97 @@
+- for section in values["sections"]
+  #section
+    - if section["sectitle"]
+      %h2= link_to section["sectitle"], section["secsequence"]
+      - if section["seccomment"]
+        .section-comment= section["seccomment"]
+    - if section["classlist"]
+      #class-list
+        %h3 Classes and Modules
+        = section["classlist"]
+        
+    - if section["constants"]
+      #constants-list
+        %h3.section-bar Constants
+        .name-list
+          %table{ :summary => "Constants" }
+            - for const in section["constants"]
+              %tr.top-aligned-row.context-row
+                %td.context-item-name
+                  = const["name"]
+                %td
+                  \=
+                %td.context-item-value
+                  = const["value"]
+                - if const["desc"] then
+                  %td{ :width => "3em" }
+                     
+                  %td.context-item-desc
+                    = const["desc"]
+                    
+    - if section["aliases"]
+      #aliases-list
+        %h3.section-bar External Aliases
+        .name-list
+          %table{ :summary => "aliases" }
+            - for alia in section["aliases"]
+              %tr.top-aligned-row.context-row
+                %td.context-item-name
+                  = alia["old_name"]
+                %td
+                  \->
+                %td.context-item-value
+                  = alia["new_name"]
+              - if alia["desc"] then
+                %tr.top-aligned-row.context-row
+                  %td
+                     
+                  %td.context-item-desc{ :colspan => "2" }
+                    = alia["desc"]
+                    
+    - if section["attributes"]
+      #attribute-list
+        %h3.section-bar Attributes
+        .name-list
+          %table
+            - for attr in section["attributes"]
+              %tr.top-aligned-row.context-row
+                %td.context-item-name
+                  = attr["name"]
+                - if attr["rw"] then
+                  %td.context-item-value
+                    = "[#{attr['rw']}]"
+                - else
+                  %td.context-item-value  
+                %td.context-item-desc
+                  = attr["a_desc"]
+    
+    - if section["method_list"]
+      #methods
+        - for list in section["method_list"]
+          - if list["methods"] then
+            %h3== #{list["type"]} #{list["category"].downcase} methods
+            
+            - for method in list["methods"]
+              .method{ :id => "method-#{method['aref']}", :class => "#{list['type']}-#{list['category']}".downcase }
+                %a{ :name => method["aref"] }
+                .synopsis
+                  - method_html = capture_haml do
+                    - if method["callseq"]
+                      %span.name= method["callseq"]
+                    - else
+                      %span.name= method["name"]
+                      %span.arguments= method["params"]
+                  - if method["codeurl"]
+                    %a.method-signature{ :href => method["codeurl"], :onclick => "popupCode(this.href); return false", :target => "Code" }
+                      = method_html
+                  - else
+                    = method_html
+                - if method["m_desc"]
+                  .description
+                    ~ method["m_desc"]
+                - if method["sourcecode"]
+                  .source
+                    - name = "#{method['aref']}-source"
+                    %a.source-toggle{ :href => "#", :onclick => "toggleCode('#{name}'); return false" }
+                      [show source]
+                    ~ "<pre id='#{name}'>#{method["sourcecode"]}</pre>"

data/lib/hanna/template_files/styles.sass

@@ -0,0 +1,334 @@
+!title_font = Georgia, serif
+!code_font_family = Monaco, "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New", monospace
+!code_font_size   = 14px
+!code_font = !code_font_size !code_font_family
+
+!light_link = #369
+!link = !light_link - 40
+!light_text = #666
+!dark_blue_text = #0E3062
+
+html, body
+  :height 100%
+body
+  :font-family Verdana, Arial, Helvetica, sans-serif
+  :font-size 90%
+  :margin 0
+  :padding 0
+  :background white
+    
+#wrapper
+  :min-height 100%
+  :height auto !important
+  :height 100%
+  :margin 0 auto -43px
+#footer-push
+  :height 43px
+div.header, #footer
+  :background #eee
+#footer
+  :border-top 1px solid silver
+  :margin-top 12px
+  :padding 0 2em
+  :line-height 30px
+  :text-align center
+  :font-variant small-caps
+  :font-size 95%
+
+// self-clearing
+.clearing
+  &:after
+    :content "."
+    :visibility hidden
+    :height 0
+    :display block
+    :clear both
+  * html &
+    :height 1px
+  *:first-child + html
+    :overflow hidden
+
+h1, h2, h3, h4, h5, h6
+  :margin 0
+  :font-weight normal
+
+a
+  :color = !link
+  &:hover
+    :background = !light_link
+    :text-decoration none
+    :color #eef
+#description, .method .description, .header
+  a
+    :color = !light_link
+    &:hover
+      :color #eee
+  h1, h2, h3, h4, h5, h6
+    a
+      :color = !link
+
+ol
+  :margin 0
+  :padding 0
+  :list-style none
+  li
+    :margin-left 0
+    :white-space nowrap
+    &.other
+      :display none
+ol.expanded li.other
+  :display list-item
+      
+table
+  :margin-bottom 1em
+  :font-size 1em
+  :border-collapse collapse
+  td, th
+    :padding .4em .8em
+  thead
+    :background-color #e8e8e8
+    th
+      :font-variant small-caps
+      :color = !light_text
+  tr
+    :border-bottom 1px solid silver
+
+#index, div.header
+  a.show
+    :text-decoration underline
+    :font-style italic
+    :color = !light_text
+    &:after
+      :content " ..."
+    &:hover
+      :color black
+      :background #ffe
+      
+#index
+  :font 85%/1.2 Arial, Helvetica, sans-serif
+  a
+    :text-decoration none
+  h1
+    :padding .2em .5em .1em
+    :background #ccc
+    :font = "small-caps 1.2em" !title_font
+    :color #333
+    :border-bottom 1px solid gray
+  ol
+    :padding .4em .5em
+    li
+      :white-space nowrap
+  #index-entries.classes
+    :font-size 1.1em
+    ol
+      :padding 0
+    span.nodoc
+      :display none
+    span.nodoc, a
+      :font-weight bold
+    .parent
+      :font-weight normal
+  
+div.header
+  :font-size 80%
+  :padding .5em 2%
+  :font-family Arial, Helvetica, sans-serif
+  :border-bottom 1px solid silver
+  .name
+    :font-size 1.6em
+    :font-family = !title_font
+    .type
+      :color = !light_text
+      :font-size 80%
+      :font-variant small-caps
+  h1.name
+    :font-size 2.2em
+  .paths, .last-update, .parent
+    :color = !light_text
+  .last-update .datetime
+    :color = !light_text - 30
+  .parent
+    :margin-top .3em
+    strong
+      :font-weight normal
+      :color = !light_text - 30
+
+#content
+  :padding 12px 2%
+  div.class &
+    :position relative
+    :width 72%
+  
+  pre, .method .synopsis
+    :font = !code_font
+  pre
+    :color black
+    :background #eee
+    :border 1px solid silver
+    :padding 0 .5em .8em .5em
+    :overflow auto
+  p, li, dd
+    code, tt
+      :font = !code_font
+      :background #ffffe3
+      :padding 2px 3px
+  h1, h2, h3, h4, h5, h6
+    code, tt
+      :font-size 1.1em
+
+  #text
+    :position relative
+  
+  #description
+    // :max-width 60em
+    p
+      :margin-top .5em
+    h1, h2, h3, h4, h5, h6
+      :font-family = !title_font
+    h1
+      :font-size 2.2em
+      :margin-bottom .2em
+      :border-bottom 3px double #d8d8d8
+      :padding-bottom .1em
+    h2
+      :font-size 1.8em
+      :color = !dark_blue_text
+      :margin .8em 0 .3em 0
+    h3
+      :font-size 1.6em
+      :margin .8em 0 .3em 0
+      :color = !light_text
+    h4
+      :font-size 1.4em
+      :margin .8em 0 .3em 0
+    h5
+      :font-size 1.2em
+      :margin .8em 0 .3em 0
+      :color = !dark_blue_text
+    h6
+      :font-size 1.0em
+      :margin .8em 0 .3em 0
+      :color = !light_text
+
+  #description, .method .description
+    ul
+      :margin .8em 0
+      :padding-left 1.5em
+
+#method-list
+  :position absolute
+  :top 0px
+  :right -33%
+  :width 28%
+  :background #eee
+  :border 1px solid silver
+  :padding .4em 1%
+  :overflow hidden
+  h2
+    :font-size 1.3em
+  h3
+    :font-variant small-caps
+    :text-transform capitalize
+    :font-family = !title_font
+    :color #666
+    :font-size 1.1em
+  ol
+    :padding 0 0 .5em .5em
+
+#context
+  :font-size 85%
+  :padding-left 1.5em
+  :border-top 1px dashed silver
+  :margin-top 1em
+  h2
+    :color #333
+    :font = "bold small-caps 1.3em" !title_font
+    :margin .5em 0 .1em 0
+    
+#methods
+  h3
+    :font = "small-caps 1.2em" !title_font
+    :color #444
+    :margin 1em 0 .2em 0
+  h4
+    :font = "1.1em" !title_font
+    :color = !dark_blue_text
+    :margin 1em 0 .2em 0
+    
+  .method
+    :border 1px solid silver
+    :margin-top .5em
+    :background #eee
+    .synopsis
+      :color black
+      :background silver
+      :padding .2em 1em
+      .name
+        :font-weight bold
+      a
+        :text-decoration none
+    .description
+      :padding 0 1em
+      pre
+        :background #f8f8f8
+    .source
+      :margin .5em 0
+    .source-toggle
+      :font-size 85%
+      :margin-left 1em
+  .public-class
+    :background #ffffe4
+  .public-instance .synopsis
+    :color #eee
+    :background = !light_link
+
+#content .method .source pre
+  :background #262626
+  :color #ffdead
+  :margin 1em
+  :padding 0.5em
+  :border 1px dashed #999
+  :overflow hidden
+
+  .standalone-code
+    :background #221111
+    :color #ffdead
+    :overflow hidden
+
+  .ruby-constant
+    :color #7fffd4
+    :background transparent
+
+  .ruby-keyword
+    :color #00ffff
+    :background transparent
+
+  .ruby-ivar
+    :color #eedd82
+    :background transparent
+
+  .ruby-operator
+    :color #00ffee
+    :background transparent
+
+  .ruby-identifier
+    :color #ffdead
+    :background transparent
+
+  .ruby-node
+    :color #ffa07a
+    :background transparent
+
+  .ruby-comment
+    :color #b22222
+    :font-weight bold
+    :background transparent
+
+  .ruby-regexp
+    :color #ffa07a
+    :background transparent
+
+  .ruby-value
+    :color #7fffd4
+    :background transparent
+

data/lib/hanna/template_helpers.rb

@@ -0,0 +1,66 @@
+require 'yaml'
+require 'cgi'
+
+module Hanna
+  module TemplateHelpers
+    protected
+
+    def link_to(text, url = nil, classname = nil)
+      class_attr = classname ? %[ class="#{classname}"] : ''
+      
+      if url
+        %[<a href="#{url}"#{class_attr}>#{text}</a>]
+      elsif classname
+        %[<span#{class_attr}>#{text}</span>]
+      else
+        text
+      end
+    end
+
+    def debug(text)
+      "<pre>#{h YAML::dump(text)}</pre>"
+    end
+
+    def h(html)
+      CGI::escapeHTML html
+    end
+
+    def methods_from_sections(sections)
+      sections.inject(Hash.new {|h, k| h[k] = []}) do |methods, section|
+        section['method_list'].each do |ml|
+          methods["#{ml['type']} #{ml['category']}".downcase].concat ml['methods']
+        end if section['method_list']
+        methods
+      end
+    end
+
+    def make_class_tree(entries)
+      entries.inject({}) do |tree, entry|
+        if entry['href']
+          leaf = entry['name'].split('::').inject(tree) do |branch, klass|
+            branch[klass] ||= {}
+          end
+          leaf['_href'] = entry['href']
+        end
+        tree
+      end
+    end
+
+    def render_class_tree(tree, parent = nil)
+      parent = parent + '::' if parent
+      tree.keys.sort.inject('') do |out, name|
+        unless name == '_href'
+          subtree = tree[name]
+          text = parent ? %[<span class="parent">#{parent}</span>#{name}] : name
+          out << '<li>'
+          out << (subtree['_href'] ? link_to(text, subtree['_href']) : %[<span class="nodoc">#{text}</span>])
+          if subtree.keys.size > 1
+            out << "\n<ol>" << render_class_tree(subtree, parent.to_s + name) << "\n</ol>"
+          end
+          out << '</li>'
+        end
+        out
+      end
+    end
+  end
+end

data/lib/hanna/template_page_patch.rb

@@ -0,0 +1,35 @@
+require 'hanna/template_helpers'
+
+RDoc::TemplatePage.class_eval do
+
+  include Hanna::TemplateHelpers
+  
+  # overwrite the original method
+  def write_html_on(io, values)
+    result = @templates.reverse.inject(nil) do |previous, template|
+      case template
+        when Haml::Engine
+          template.to_html(get_binding, :values => values) { previous }
+        when Sass::Engine
+          template.to_css
+        when String
+          ERB.new(template).result(get_binding(values){ previous })
+        when nil
+          previous
+        else
+          raise "don't know how to handle a template of class '#{template.class.name}'"
+        end
+    end
+
+    io.write result
+  rescue
+    $stderr.puts "error while writing to #{io.inspect}"
+    raise
+  end
+
+  private
+
+    def get_binding(values = nil)
+      binding
+    end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: DesigningPatterns-hanna
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- "Mislav Marohni\xC4\x87"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: Hanna is an RDoc template that scales. It's implemented in Haml, making its source clean and maintainable. It's built with simplicity, beauty and ease of browsing in mind.
+email: mislav.marohnic@gmail.com
+executables: 
+- hanna
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- bin
+- bin/hanna
+- lib
+- lib/hanna.rb
+- lib/hanna
+- lib/hanna/hanna.rb
+- lib/hanna/rdoctask.rb
+- lib/hanna/template_files
+- lib/hanna/template_files/class_index.haml
+- lib/hanna/template_files/file_index.haml
+- lib/hanna/template_files/index.haml
+- lib/hanna/template_files/layout.haml
+- lib/hanna/template_files/method_list.haml
+- lib/hanna/template_files/page.haml
+- lib/hanna/template_files/sections.haml
+- lib/hanna/template_files/styles.sass
+- lib/hanna/template_helpers.rb
+- lib/hanna/template_page_patch.rb
+has_rdoc: false
+homepage: http://github.com/mislav/hanna
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An RDoc template that rocks
+test_files: []
+