mislav-hanna 0.1.5 → 0.1.6

data/Manifest

@@ -7,6 +7,7 @@ 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_index.haml
 lib/hanna/template_files/method_list.haml
 lib/hanna/template_files/page.haml
 lib/hanna/template_files/sections.haml

data/README.markdown

@@ -19,9 +19,9 @@ The template was created by [Mislav][] and since then has seen contributions fro
 The most basic usage is to specify Hanna as a template when invoking RDoc on the
 command-line:
 
-    rdoc -o doc --inline-sorce -T hanna lib/*.rb
+    rdoc -o doc --inline-source -T hanna lib/*.rb
     
-Hanna requires the `--inline-sorce` (or `-S`) flag.
+Hanna requires the `--inline-source` (or `-S`) flag.
 
 An alternative is to set the `RDOCOPT` environment variable:
 

data/Rakefile

@@ -2,18 +2,18 @@ require 'echoe'
 require 'lib/hanna/rdoc_version'
 
 Echoe.new('hanna') do |p|
-  p.version = '0.1.5'
+  p.version = '0.1.6'
   
-  p.summary = "An RDoc template that rocks"
-  p.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."
+  p.summary     = "An RDoc template that scales"
+  p.description = "Hanna is an RDoc implemented in Haml, making its source clean and maintainable. It's built with simplicity, beauty and ease of browsing in mind."
   
   p.author = 'Mislav Marohnić'
   p.email  = 'mislav.marohnic@gmail.com'
   p.url    = 'http://github.com/mislav/hanna'
   
-  p.executable_pattern = ['bin/hanna']
+  p.project = nil
   p.has_rdoc = false
-  p.runtime_dependencies = []
+  
   p.runtime_dependencies << ['rdoc', Hanna::RDOC_VERSION_REQUIREMENT]
   p.runtime_dependencies << ['haml', '~> 2.0.4']
   p.runtime_dependencies << ['rake', '~> 0.8.2']

data/hanna.gemspec

@@ -2,23 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hanna}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mislav Marohni\304\207"]
-  s.date = %q{2008-11-24}
+  s.date = %q{2008-12-03}
   s.default_executable = %q{hanna}
-  s.description = %q{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.}
+  s.description = %q{Hanna is an RDoc implemented in Haml, making its source clean and maintainable. It's built with simplicity, beauty and ease of browsing in mind.}
   s.email = %q{mislav.marohnic@gmail.com}
   s.executables = ["hanna"]
-  s.extra_rdoc_files = ["bin/hanna", "lib/hanna/hanna.rb", "lib/hanna/rdoc_version.rb", "lib/hanna/rdoctask.rb", "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_files/prototype-1.6.0.3.js", "lib/hanna/template_files/method_search.js", "lib/hanna/template_helpers.rb", "lib/hanna/template_page_patch.rb", "lib/hanna.rb", "README.markdown"]
-  s.files = ["bin/hanna", "hanna.gemspec", "lib/hanna/hanna.rb", "lib/hanna/rdoc_version.rb", "lib/hanna/rdoctask.rb", "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_files/prototype-1.6.0.3.js", "lib/hanna/template_files/method_search.js", "lib/hanna/template_helpers.rb", "lib/hanna/template_page_patch.rb", "lib/hanna.rb", "Manifest", "Rakefile", "README.markdown"]
+  s.files = ["bin/hanna", "hanna.gemspec", "lib/hanna/hanna.rb", "lib/hanna/rdoc_version.rb", "lib/hanna/rdoctask.rb", "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_index.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_files/prototype-1.6.0.3.js", "lib/hanna/template_files/method_search.js", "lib/hanna/template_helpers.rb", "lib/hanna/template_page_patch.rb", "lib/hanna.rb", "Manifest", "Rakefile", "README.markdown"]
   s.homepage = %q{http://github.com/mislav/hanna}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Hanna", "--main", "README.markdown"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{hanna}
   s.rubygems_version = %q{1.3.1}
-  s.summary = %q{An RDoc template that rocks}
+  s.summary = %q{An RDoc template that scales}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/hanna/hanna.rb

@@ -42,7 +42,7 @@ module RDoc::Generator::HTML::HANNA
 
   FILE_INDEX   = read('file_index.haml')
   CLASS_INDEX  = read('class_index.haml')
-  METHOD_INDEX = FILE_INDEX
+  METHOD_INDEX = read('method_index.haml')
 
   INDEX = read('index.haml')
 end 

data/lib/hanna/template_files/file_index.haml

@@ -1,24 +1,11 @@
 %h1= values["list_title"]
-- type = values["list_title"].downcase
 - any_hidden = false
 
-- if type == 'methods'
-  %script{:type => 'text/javascript'}
-    = read("prototype-1.6.0.3.js")
-    = build_javascript_search_index(values["entries"])
-    = read("method_search.js")
-  %form{:onsubmit => 'return performSearch()'}
-    %input{:type => 'text', :id => 'search', :class => 'untouched', :value => 'Enter search terms...'}
-  %ol#search-results{ :class => type, :style => 'display: none' }
-
-%ol#index-entries{ :class => type }
+%ol#index-entries{ :class => 'files' }
   - for entry in values["entries"]
-    - hide = type == 'files' && entry['name'] =~ /\.rb$/
+    - hide = entry['name'] =~ /\.rb$/
     - any_hidden = true if hide
-    - if type == 'methods'
-      %li{ :class => hide ? 'other' : nil }= link_to_method entry['name'], entry['href']
-    - else
-      %li{ :class => hide ? 'other' : nil }= link_to entry['name'], entry['href']
+    %li{ :class => hide ? 'other' : nil }= link_to entry['name'], entry['href']
 
   - if any_hidden
     %li

data/lib/hanna/template_files/index.haml

@@ -3,7 +3,7 @@
   %head
     %title= values["title"]
     %meta{ :content => "text/html; charset=#{values['charset']}", "http-equiv" => "Content-Type" }
-  %frameset{ :cols => "20%, *" }
+  %frameset{ :cols => "20%, *", :border => "1", :frameborder => "1", :bordercolor => "gray" }
     %frameset{ :rows => "15%, 35%, 50%" }
       %frame{ :name => "Files", :title => "Files", :src => "fr_file_index.html" }
       %frame{ :name => "Classes", :src => "fr_class_index.html" }

data/lib/hanna/template_files/layout.haml

@@ -31,6 +31,4 @@
         = 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.uniqpath.com/'
+        = link_to '<strong>Hanna</strong> RDoc template', 'http://github.com/mislav/hanna/tree/master'

data/lib/hanna/template_files/method_index.haml

@@ -0,0 +1,13 @@
+%h1= values["list_title"]
+
+%script{:type => 'text/javascript'}
+  = read("prototype-1.6.0.3.js")
+  = build_javascript_search_index(values["entries"])
+  = read("method_search.js")
+%form{:onsubmit => 'return performSearch()'}
+  %input{:type => 'text', :id => 'search', :class => 'untouched', :value => 'Enter search terms...'}
+%ol#search-results{ :class => 'methods', :style => 'display: none' }
+
+%ol#index-entries{ :class => 'methods' }
+  - for entry in values["entries"]
+    %li= link_to_method entry['name'], entry['href']

data/lib/hanna/template_files/page.haml

@@ -45,6 +45,6 @@
 
   #text
     - if values["description"]
-      #description~ values["description"]
+      #description~ sanitize_code_blocks values["description"]
 
     = yield

data/lib/hanna/template_files/sections.haml

@@ -4,72 +4,58 @@
       %h2= link_to section["sectitle"], section["secsequence"]
       - if section["seccomment"]
         .section-comment= section["seccomment"]
+        
     - if section["classlist"]
       #class-list
-        %h3 Classes and Modules
+        %h2 Classes and Modules
         = section["classlist"]
         
     - if section["constants"]
       #constants-list
-        %h3.section-bar Constants
+        %h2 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"]
+                %td.context-item-name= const["name"]
+                %td =
+                %td.context-item-value= const["value"]
                 - if const["desc"] then
-                  %td
-                     
-                  %td.context-item-desc
-                    = const["desc"]
+                  %td  
+                  %td.context-item-desc= const["desc"]
                     
     - if section["aliases"]
       #aliases-list
-        %h3.section-bar External Aliases
+        %h2 External Aliases
         .name-list
-          %table{ :summary => "aliases" }
+          %table{ :summary => "External 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"]
+                %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  
                   %td.context-item-desc{ :colspan => "2" }
                     = alia["desc"]
                     
     - if section["attributes"]
       #attribute-list
-        %h3.section-bar Attributes
+        %h2.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"]
+                %td.context-item-name= attr["name"]
+                %td.context-item-value= attr["rw"] ? "[#{attr['rw']}]" : ' '
+                %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
+            %h2== #{list["type"]} #{list["category"].downcase} methods
             
             - for method in list["methods"]
               .method{ :id => "method-#{method['aref']}", :class => "#{list['type']}-#{list['category']}".downcase }
@@ -88,7 +74,7 @@
                     = method_html
                 - if method["m_desc"]
                   .description
-                    ~ method["m_desc"]
+                    ~ sanitize_code_blocks method["m_desc"]
                 - if method["sourcecode"]
                   .source
                     - name = "#{method['aref']}-source"

data/lib/hanna/template_files/styles.sass

@@ -1,4 +1,5 @@
 !title_font = Georgia, serif
+!body_font = "Lucida Grande", Verdana, Arial, Helvetica, "sans-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
@@ -11,7 +12,7 @@
 html, body
   :height 100%
 body
-  :font-family Verdana, Arial, Helvetica, sans-serif
+  :font-family = !body_font
   :font-size 90%
   :margin 0
   :padding 0
@@ -133,6 +134,8 @@ table
     :padding .4em .5em
     li
       :white-space nowrap
+  #index-entries li a
+    :padding 1px 2px
   #index-entries.classes
     :font-size 1.1em
     ol
@@ -151,6 +154,8 @@ table
           :margin-right 0.25em
         .module_name
           :color #666666
+        &:hover .module_name
+          :color #ddd
   
 div.header
   :font-size 80%
@@ -188,7 +193,7 @@ div.header
     :color black
     :background #eee
     :border 1px solid silver
-    :padding 0 .5em .8em .5em
+    :padding .5em .8em
     :overflow auto
   p, li, dl
     code, tt
@@ -267,25 +272,14 @@ div.header
   :border-top 1px dashed silver
   :margin-top 1em
   :margin-bottom 1em
-  h2
-    :color #333
-    :font = "bold small-caps 1.3em" !title_font
-    :margin .5em 0 .1em 0
-
-#section
-  h3
-    :margin-top 1em
 
-#methods
-  h3
+#context, #section
+  h2
     :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
-    
+
+#methods
   .method
     :border 1px solid silver
     :margin-top .5em

data/lib/hanna/template_helpers.rb

@@ -104,5 +104,16 @@ module Hanna
         out
       end
     end
+    
+    # primarily for removing leading whitespace in <pre> tags
+    def sanitize_code_blocks(text)
+      text.gsub(/<pre>(.+?)<\/pre>/m) do
+        code = $1.sub(/^\s*\n/, '')
+        indent = code.gsub(/\n[ \t]*\n/, "\n").scan(/^ */).map{ |i| i.size }.min
+        code.gsub!(/^#{' ' * indent}/, '') if indent > 0
+        
+        "<pre>#{code}</pre>"
+      end
+    end
   end
 end

data/lib/hanna/template_page_patch.rb

@@ -11,7 +11,7 @@ RDoc::TemplatePage.class_eval do
       case template
       when Haml::Engine
         silence_warnings do
-          template.to_html(get_binding, :values => values) { previous }
+          template.to_html(binding, :values => values) { previous }
         end
       when Sass::Engine
         silence_warnings { template.to_css }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mislav-hanna
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - "Mislav Marohni\xC4\x87"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-24 00:00:00 -08:00
+date: 2008-12-03 00:00:00 -08:00
 default_executable: hanna
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,31 +48,14 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     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.
+description: Hanna is an RDoc 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: 
-- bin/hanna
-- lib/hanna/hanna.rb
-- lib/hanna/rdoc_version.rb
-- lib/hanna/rdoctask.rb
-- 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_files/prototype-1.6.0.3.js
-- lib/hanna/template_files/method_search.js
-- lib/hanna/template_helpers.rb
-- lib/hanna/template_page_patch.rb
-- lib/hanna.rb
-- README.markdown
+extra_rdoc_files: []
+
 files: 
 - bin/hanna
 - hanna.gemspec
@@ -83,6 +66,7 @@ files:
 - lib/hanna/template_files/file_index.haml
 - lib/hanna/template_files/index.haml
 - lib/hanna/template_files/layout.haml
+- lib/hanna/template_files/method_index.haml
 - lib/hanna/template_files/method_list.haml
 - lib/hanna/template_files/page.haml
 - lib/hanna/template_files/sections.haml
@@ -98,13 +82,8 @@ files:
 has_rdoc: false
 homepage: http://github.com/mislav/hanna
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Hanna
-- --main
-- README.markdown
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -121,10 +100,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: hanna
+rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: An RDoc template that rocks
+summary: An RDoc template that scales
 test_files: []