mislav-hanna 0.1.2 → 0.1.3

data/Manifest

@@ -0,0 +1,19 @@
+hanna.gemspec
+bin/hanna
+README.markdown
+Manifest
+lib/hanna/template_page_patch.rb
+lib/hanna/rdoc_version.rb
+lib/hanna/template_helpers.rb
+lib/hanna/template_files/method_list.haml
+lib/hanna/template_files/styles.sass
+lib/hanna/template_files/class_index.haml
+lib/hanna/template_files/layout.haml
+lib/hanna/template_files/index.haml
+lib/hanna/template_files/page.haml
+lib/hanna/template_files/sections.haml
+lib/hanna/template_files/file_index.haml
+lib/hanna/rdoctask.rb
+lib/hanna/hanna.rb
+lib/hanna.rb
+Rakefile

data/README.markdown

@@ -11,12 +11,23 @@ Hanna was made by [Mislav][] and is available from [GitHub][]:
 
 ## Usage
 
-After installing, you have three options. You can use the command-line tool:
+After installing, you have several options.
+---
+Hanna can be used as a normal RDoc template by specifying
+  -S -T hanna
+to rdoc.  Note that Hanna requires the -S option, which inlines source
+code.
+---
+You can use the command-line tool included in the Hanna gem:
 
     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:
+This is a wrapper over the rdoc script that makes RDoc use the Hanna
+template.
+---
+For repeated generation of API docs, it's better to set up a Rake task.
+If you already have an RDocTask set up in your Rakefile, the only thing
+you need to change is this:
 
     # replace this:
     require 'rake/rdoctask'
@@ -46,10 +57,23 @@ Here is an example of a task for the [will_paginate library][wp]:
       rdoc.options << '--webcvs=http://github.com/mislav/will_paginate/tree/master/'
     end
     
-Either way, it's the same as using RDoc.
+Alternatively, you can use the the standard RDocTask and simply set the
+task's +template+ attribute to +hanna+ and append +--inline-source+ to its
+options attribute.
 
-The last thing you can do with Hanna is generate documentation for installed
-gems. This is a replacement for the "gem rdoc" command.
+A third alternative is to set the +RDOCOPT+ environment variable to
+
+    -T hanna -S
+
+which will make RDoc always use Hanna unless this is overridden on the
+command-line.
+--
+You also can generate documentation for installed gems, which might be more
+convenient than the
+
+  gem rdoc
+
+command (with the +RDOCOPT+ environment variable set as above).  For this, do:
 
     [sudo] hanna --gems haml will_paginate
 

data/Rakefile

@@ -1,25 +1,23 @@
-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')
+#
+# This can be made cleaner by using the relative gem.
+#
+require File.join(File.dirname(__FILE__), "lib/hanna/rdoc_version")
+
+require 'echoe'
 
-  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") }
+Echoe.new('hanna') do |p|
+  p.version = '0.1.3'
+  
+  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.author = 'Mislav Marohnić'
+  p.email  = 'mislav.marohnic@gmail.com'
+  p.url    = 'http://github.com/mislav/hanna'
+  
+  p.executable_pattern = ['bin/hanna']
+  p.has_rdoc = false
+  p.runtime_dependencies = []
+  p.runtime_dependencies << ['rdoc', Hanna::RDOC_VERSION_REQUIREMENT]
+  p.runtime_dependencies << ['haml', '~> 2.0']
 end

data/bin/hanna

@@ -25,19 +25,13 @@ HELP
 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)
 
-require 'hanna/rdoc_patch'
+require 'hanna/rdoc_version'
+Hanna::require_rdoc
+require 'rdoc/rdoc'
 
 options = []
 

data/hanna.gemspec

@@ -0,0 +1,121 @@
+
+# Gem::Specification for Hanna-0.1.3
+# Originally generated by Echoe
+
+--- !ruby/object:Gem::Specification 
+name: hanna
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- "Mislav Marohni\xC4\x87"
+autorequire: 
+bindir: bin
+
+date: 2008-09-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !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.
+email: mislav.marohnic@gmail.com
+executables: 
+- hanna
+extensions: []
+
+extra_rdoc_files: 
+- bin/hanna
+- README.markdown
+- lib/hanna/template_page_patch.rb
+- lib/hanna/rdoc_version.rb
+- lib/hanna/template_helpers.rb
+- lib/hanna/template_files/method_list.haml
+- lib/hanna/template_files/styles.sass
+- lib/hanna/template_files/class_index.haml
+- lib/hanna/template_files/layout.haml
+- lib/hanna/template_files/index.haml
+- lib/hanna/template_files/page.haml
+- lib/hanna/template_files/sections.haml
+- lib/hanna/template_files/file_index.haml
+- lib/hanna/rdoctask.rb
+- lib/hanna/hanna.rb
+- lib/hanna.rb
+files: 
+- hanna.gemspec
+- bin/hanna
+- README.markdown
+- Manifest
+- lib/hanna/template_page_patch.rb
+- lib/hanna/rdoc_version.rb
+- lib/hanna/template_helpers.rb
+- lib/hanna/template_files/method_list.haml
+- lib/hanna/template_files/styles.sass
+- lib/hanna/template_files/class_index.haml
+- lib/hanna/template_files/layout.haml
+- lib/hanna/template_files/index.haml
+- lib/hanna/template_files/page.haml
+- lib/hanna/template_files/sections.haml
+- lib/hanna/template_files/file_index.haml
+- lib/hanna/rdoctask.rb
+- lib/hanna/hanna.rb
+- lib/hanna.rb
+- Rakefile
+has_rdoc: false
+homepage: http://github.com/mislav/hanna
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Hanna
+- --main
+- README.markdown
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: hanna
+rubygems_version: 1.2.0
+specification_version: 2
+summary: An RDoc template that rocks
+test_files: []

data/lib/hanna.rb

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

data/lib/hanna/hanna.rb

@@ -16,24 +16,18 @@ module RDoc::Generator::HTML::HANNA
     end
 
     def read(*names)
-      extension = nil
-      
-      content = names.map { |name|
-        if extension
-          name += '.' + extension
+      content = names.inject('') { |all, name| all << File.read(File.join(dir, name)) }
+      extension = names.first =~ /\.(\w+)$/ && $1
+
+      Hanna::TemplateHelpers.with_no_warnings do
+        case extension
+        when 'sass'
+          Sass::Engine.new(content)
+        when 'haml'
+          Haml::Engine.new(content, :format => :html4)
         else
-          extension = name =~ /\.(\w+)$/ && $1
+          content
         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
@@ -42,7 +36,7 @@ module RDoc::Generator::HTML::HANNA
 
   CLASS_PAGE  = read('page.haml')
   FILE_PAGE   = CLASS_PAGE
-  METHOD_LIST = read('method_list.haml', 'sections')
+  METHOD_LIST = read('method_list.haml', 'sections.haml')
 
   FR_INDEX_BODY = BODY = read('layout.haml')
 

data/lib/hanna/rdoc_version.rb

@@ -0,0 +1,21 @@
+module Hanna
+  #
+  # The version of RDoc that Hanna should use.
+  #
+  RDOC_VERSION = '2.2.0'
+  RDOC_VERSION_REQUIREMENT = "~> #{RDOC_VERSION}"
+
+  #
+  # This method loads the correct version of RDoc.  If the correct
+  # version of RDoc is not present, this method will terminate the
+  # program with a helpful error message.
+  #
+  def self.require_rdoc
+    begin
+      gem 'rdoc', RDOC_VERSION_REQUIREMENT
+    rescue Gem::LoadError
+      $stderr.puts "Error: hanna requires the RDoc #{RDOC_VERSION} gem!"
+      exit 1
+    end 
+  end
+end

data/lib/hanna/rdoctask.rb

@@ -1,3 +1,5 @@
+require 'hanna/rdoc_version'
+
 require 'rake'
 require 'rake/rdoctask'
 
@@ -8,7 +10,7 @@ Rake::RDocTask.class_eval do
   # Create the tasks defined by this task lib.
   def define
     unless @template and @template != 'html'
-      @template = File.dirname(__FILE__) + '/hanna'
+      @template = 'hanna'
     end
     # inline source and UTF-8 are defaults:
     options << '--inline-source' unless options.include? '--inline-source' or options.include? '-S'
@@ -31,14 +33,8 @@ Rake::RDocTask.class_eval do
     task name => [rdoc_target]
     file rdoc_target => @rdoc_files + [$rakefile] do
       rm_r @rdoc_dir rescue nil
-      
-      begin
-        gem 'rdoc', '~> 2.1.0'
-      rescue Gem::LoadError
-        $stderr.puts "Couldn't load RDoc 2.1 gem"
-      end
+      Hanna::require_rdoc
       require 'rdoc/rdoc'
-      require 'hanna/rdoc_patch'
       
       RDoc::RDoc.new.document(option_list + @rdoc_files)
     end

data/lib/hanna/template_files/index.haml

@@ -8,4 +8,4 @@
       %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'] }
+    %frame{ :name => "docwin", :src => values['initial_page'] }=""

data/lib/hanna/template_files/layout.haml

@@ -1,26 +1,25 @@
 !!! strict
 - index = values['list_title']
-%html{ :xmlns => "http://www.w3.org/1999/xhtml", 'xml:lang' => "en", :lang => "en" }
+%html{ :lang => "en" }
   %head
-    %title= index || values['title']
+    %title= 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")
-          }
+      :javascript
+        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)
+        function toggleCode(id) {
+          var code = document.getElementById(id)
 
-            code.style.display = code.style.display != 'block' ? 'block' : 'none'
-            return true
-          }
+          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>')
+        // Make codeblocks hidden by default
+        document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
     - else
       %base{ :target => 'docwin' }/
         

data/lib/hanna/template_files/sections.haml

@@ -23,7 +23,7 @@
                 %td.context-item-value
                   = const["value"]
                 - if const["desc"] then
-                  %td{ :width => "3em" }
+                  %td
                      
                   %td.context-item-desc
                     = const["desc"]

data/lib/hanna/template_files/styles.sass

@@ -58,6 +58,11 @@ a
     :background = !light_link
     :text-decoration none
     :color #eef
+
+#diagram
+  img
+    :border = 0
+
 #description, .method .description, .header
   a
     :color = !light_link
@@ -218,7 +223,7 @@ div.header
     ol
       :list-style decimal
       li
-        :white-space wrap
+        :white-space normal
 
 #method-list
   :position absolute
@@ -293,12 +298,7 @@ div.header
   :margin 1em
   :padding 0.5em
   :border 1px dashed #999
-  :overflow hidden
-
-  .standalone-code
-    :background #221111
-    :color #ffdead
-    :overflow hidden
+  :overflow auto
 
   .ruby-constant
     :color #7fffd4
@@ -336,4 +336,3 @@ div.header
   .ruby-value
     :color #7fffd4
     :background transparent
-

data/lib/hanna/template_helpers.rb

@@ -17,12 +17,28 @@ module Hanna
       end
     end
 
+    #
+    # We need to suppress warnings before calling into HAML because
+    # HAML has lots of uninitialized instance variable accesses.
+    #
+    def with_no_warnings
+      save = $-w
+      $-w = false
+      
+      begin
+        yield
+      ensure
+        $-w = save
+      end
+    end
+    module_function :with_no_warnings
+
     def debug(text)
       "<pre>#{h YAML::dump(text)}</pre>"
     end
 
     def h(html)
-      CGI::escapeHTML html
+      CGI::escapeHTML(html)
     end
 
     def methods_from_sections(sections)
@@ -54,7 +70,7 @@ module Hanna
           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
+          if subtree.keys.size > 1 || (subtree.keys.size == 1 && !subtree['_href'])
             out << "\n<ol>" << render_class_tree(subtree, parent.to_s + name) << "\n</ol>"
           end
           out << '</li>'

data/lib/hanna/template_page_patch.rb

@@ -5,13 +5,18 @@ RDoc::TemplatePage.class_eval do
   include Hanna::TemplateHelpers
   
   # overwrite the original method
+  alias :old_write_html_on :write_html_on # suppresses a warning
   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 }
+          with_no_warnings do
+            template.to_html(get_binding, :values => values) { previous }
+          end
         when Sass::Engine
-          template.to_css
+          with_no_warnings do
+            template.to_css
+          end
         when String
           ERB.new(template).result(get_binding(values){ previous })
         when nil

metadata

@@ -1,34 +1,45 @@
 --- !ruby/object:Gem::Specification 
 name: mislav-hanna
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - "Mislav Marohni\xC4\x87"
 autorequire: 
 bindir: bin
-cert_chain: []
-
-date: 2008-05-03 00:00:00 -07:00
+cert_chain: 
+date: 2008-09-18 21:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rdoc
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.1.0
+        version: 2.2.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: haml
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        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.
 email: mislav.marohnic@gmail.com
@@ -36,35 +47,53 @@ executables:
 - hanna
 extensions: []
 
-extra_rdoc_files: []
-
-files: 
-- README.markdown
-- Rakefile
-- bin
+extra_rdoc_files: 
 - bin/hanna
-- lib
-- lib/hanna.rb
-- lib/hanna
-- lib/hanna/hanna.rb
-- lib/hanna/rdoc_patch.rb
-- lib/hanna/rdoctask.rb
-- lib/hanna/template_files
+- README.markdown
+- lib/hanna/template_page_patch.rb
+- lib/hanna/rdoc_version.rb
+- lib/hanna/template_helpers.rb
+- lib/hanna/template_files/method_list.haml
+- lib/hanna/template_files/styles.sass
 - 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/index.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_files/file_index.haml
+- lib/hanna/rdoctask.rb
+- lib/hanna/hanna.rb
+- lib/hanna.rb
+files: 
+- hanna.gemspec
+- bin/hanna
+- README.markdown
+- Manifest
 - lib/hanna/template_page_patch.rb
+- lib/hanna/rdoc_version.rb
+- lib/hanna/template_helpers.rb
+- lib/hanna/template_files/method_list.haml
+- lib/hanna/template_files/styles.sass
+- lib/hanna/template_files/class_index.haml
+- lib/hanna/template_files/layout.haml
+- lib/hanna/template_files/index.haml
+- lib/hanna/template_files/page.haml
+- lib/hanna/template_files/sections.haml
+- lib/hanna/template_files/file_index.haml
+- lib/hanna/rdoctask.rb
+- lib/hanna/hanna.rb
+- lib/hanna.rb
+- Rakefile
 has_rdoc: false
 homepage: http://github.com/mislav/hanna
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Hanna
+- --main
+- README.markdown
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -75,13 +104,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - "="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: hanna
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2

data/lib/hanna/rdoc_patch.rb

@@ -1,22 +0,0 @@
-require 'rdoc/generator/html'
-
-# RDoc 2.0.0 is inflexible in a way that it doesn't handle absolute paths for
-# templates well. We fix that by catching an NameError in load_html_template:
-RDoc::Generator::HTML.class_eval do
-  private
-  alias :load_html_template_original :load_html_template
-  
-  def load_html_template
-    load_html_template_original
-  rescue NameError => e
-    raise unless e.message.index(@options.template.upcase)
-    name = File.basename(@options.template).sub(/\.rb$/, '')
-    klass = name.split('_').map{ |n| n.capitalize }.join
-    @options.template_class = @template = RDoc::Generator::HTML::const_get(klass)
-  end
-end
-
-# Don't ask. This works around a bug in Markup where it tries to call
-# HTML.gen_url, but RDoc::Markup::ToHtml::HTML doesn't exist. (What were they
-# thinking, I don't know.)
-RDoc::Markup::ToHtml.const_set :HTML, RDoc::Generator