ddollar-hanna 0.1.4

data/lib/hanna/template_helpers.rb

@@ -0,0 +1,108 @@
+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
+    
+    # +method_text+ is in the form of "ago (ActiveSupport::TimeWithZone)".
+    def link_to_method(method_text, url = nil, classname = nil)
+      method_text =~ /\A(.+) \((.+)\)\Z/
+      method_name, module_name = $1, $2
+      link_to %Q(<span class="method_name">#{h method_name}</span> <span class="module_name">(#{h module_name})</span>), url, classname
+    end
+    
+    def read(*names)
+      RDoc::Generator::HTML::HANNA.read(*names)
+    end
+
+    # We need to suppress warnings before calling into HAML because
+    # HAML has lots of uninitialized instance variable accesses.
+    def silence_warnings
+      save = $-w
+      $-w = false
+      
+      begin
+        yield
+      ensure
+        $-w = save
+      end
+    end
+    module_function :silence_warnings
+
+    def debug(text)
+      "<pre>#{h YAML::dump(text)}</pre>"
+    end
+
+    def h(html)
+      CGI::escapeHTML(html)
+    end
+    
+    # +entries+ is an array of hashes, each which has a "name" and "href" element.
+    # An entry name is in the form of "ago (ActiveSupport::TimeWithZone)".
+    # +entries+ must be already sorted by name.
+    def build_javascript_search_index(entries)
+      result = "var search_index = [\n"
+      entries.each do |entry|
+        entry["name"] =~ /\A(.+) \((.+)\)\Z/
+        method_name, module_name = $1, $2
+        html = link_to_method(entry["name"], entry["href"])
+        result << "  { method: '#{method_name.downcase}', " <<
+                      "module: '#{module_name.downcase}', " <<
+                      "html: '#{html}' },\n"
+      end
+      result << "]"
+      result
+    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 || (subtree.keys.size == 1 && !subtree['_href'])
+            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,38 @@
+require 'hanna/template_helpers'
+
+RDoc::TemplatePage.class_eval do
+
+  include Hanna::TemplateHelpers
+  
+  # overwrite the original method
+  alias :old_write_html_on :write_html_on # suppresses the overwrite warning
+  def write_html_on(io, values)
+    result = @templates.reverse.inject(nil) do |previous, template|
+      case template
+      when Haml::Engine
+        silence_warnings do
+          template.to_html(get_binding, :values => values) { previous }
+        end
+      when Sass::Engine
+        silence_warnings { 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,130 @@
+--- !ruby/object:Gem::Specification 
+name: ddollar-hanna
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- "Mislav Marohni\xC4\x87"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-18 00:00:00 -08:00
+default_executable: hanna
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  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
+- 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/method_search.js
+- lib/hanna/template_files/page.haml
+- lib/hanna/template_files/prototype-1.6.0.3.js
+- lib/hanna/template_files/sections.haml
+- lib/hanna/template_files/styles.sass
+- lib/hanna/template_helpers.rb
+- lib/hanna/template_page_patch.rb
+- lib/hanna.rb
+- README.markdown
+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/method_search.js
+- lib/hanna/template_files/page.haml
+- lib/hanna/template_files/prototype-1.6.0.3.js
+- lib/hanna/template_files/sections.haml
+- lib/hanna/template_files/styles.sass
+- lib/hanna/template_helpers.rb
+- lib/hanna/template_page_patch.rb
+- lib/hanna.rb
+- Rakefile
+- README.markdown
+- Manifest
+- hanna.gemspec
+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
+signing_key: 
+specification_version: 2
+summary: An RDoc template that rocks
+test_files: []
+