hanna_gudao 0.3.0

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rake", "~> 0.9.2.2"
+  gem "bundler", "~> 1.1.3"
+  gem "jeweler", "~> 1.8.3"
+  gem 'rdoc', "~> 3.12"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.3)
+  jeweler (~> 1.8.3)
+  rake (~> 0.9.2.2)
+  rdoc (~> 3.12)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Mislav Marohnić
+Copyright (c) 2010, 2011 Erik Hollensbe
+
+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.rdoc

@@ -0,0 +1,81 @@
+= Hanna Nouveau — a better RDoc template, now for RDoc 2.5 and 3.0.
+
+Based on the original Hanna by Mislav.
+
+Hanna is an RDoc generator 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}[http://github.com/mislav/hanna/wikis/home].)
+
+Hanna gem is available from http://rubygems.org:
+
+    gem install hanna-nouveau
+
+The template was created by {Mislav}[http://mislav.caboo.se/] and since then
+has seen contributions from:
+
+1. {Tony Strauss}[http://github.com/DesigningPatterns], who participated from
+   the early start and made tons of fixes and enhancements to the template;
+2. {Hongli Lai}[http://blog.phusion.nl/] with the search filter for methods.
+3. {Erik Hollensbe}[http://github.com/erikh] a serious refactoring and up to
+   date with RDoc 2.5.x and 3.x, now named 'hanna-nouveau'.
+4. {James Tucker}[http://github.com/raggi] minor cleanups for Erik.
+
+== Usage
+
+    rdoc -o doc -f hanna lib/*.rb
+
+An alternative is to set the `RDOCOPT` environment variable:
+
+    RDOCOPT="-f hanna"
+
+This will make RDoc always use Hanna unless it is explicitly overridden.
+
+== Integrating with RubyGems
+
+Another neat trick is to put the following line in your .gemrc, this will make
+RubyGems use Hanna for all rdoc generation:
+
+    rdoc: -f hanna
+
+This will make RubyGems use Hanna when generating documentation for installed
+gems. Remember, if you wish to have all your gems be formatted in hanna:
+
+    gem rdoc --all --overwrite
+
+The first time. To easily browse your newly created documentation, use:
+
+    gem server
+
+== Rake task
+
+For repeated generation of API docs, it's better to set up a Rake task. Simply
+add the hanna format argument to your RDoc::Task options:
+
+    gem 'rdoc'
+    require 'rdoc/task'
+    RDoc::Task.new do |rdoc|
+      # this only works with RDoc 3.1 or greater
+      rdoc.generator = 'hanna'
+      # this is what you use pre RDoc 3.1:
+      rdoc.options.push '-f', 'hanna'
+    end
+
+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 {rdbi
+library}[http://github.com/rdbi/rdbi/tree/master/Rakefile]:
+
+    gem 'rdoc'
+    require 'rdoc/task'
+    RDoc::Task.new do |rdoc|
+      version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+      rdoc.generator = 'hanna'
+      rdoc.main = 'README.rdoc'
+      rdoc.rdoc_dir = 'rdoc'
+      rdoc.title = "RDBI #{version} Documentation"
+      rdoc.rdoc_files.include('README*')
+      rdoc.rdoc_files.include('lib/**/*.rb')
+    end

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "hanna_gudao"
+  gem.homepage = "http://github.com/erikh/hanna-nouveau"
+  gem.license = "MIT"
+  gem.summary = %Q{A rework of the Hanna generator for RDoc 2.5 and 3.x}
+  gem.description = %Q{}
+  gem.email = "erik@hollensbe.org"
+  gem.authors = ["Erik Hollensbe", "James Tucker", "Mislav Marohnic"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'haml', "= 3.0.25"
+  gem.add_runtime_dependency 'rdoc', "~> 3.12"
+  gem.add_development_dependency 'jeweler', "~> 1.8.3"
+  gem.add_development_dependency 'rake', "~> 0.9.2.2"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hanna-nouveau #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/hanna_gudao.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "hanna_gudao"
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Erik Hollensbe", "James Tucker", "Mislav Marohnic"]
+  s.date = "2012-05-22"
+  s.description = ""
+  s.email = "erik@hollensbe.org"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "hanna_gudao.gemspec",
+    "lib/hanna_gudao.rb",
+    "lib/hanna_gudao/template_files/class_index.haml",
+    "lib/hanna_gudao/template_files/file_index.haml",
+    "lib/hanna_gudao/template_files/index.haml",
+    "lib/hanna_gudao/template_files/layout.haml",
+    "lib/hanna_gudao/template_files/method_index.haml",
+    "lib/hanna_gudao/template_files/method_list.haml",
+    "lib/hanna_gudao/template_files/method_search.js",
+    "lib/hanna_gudao/template_files/page.haml",
+    "lib/hanna_gudao/template_files/prototype-1.6.0.3.js",
+    "lib/hanna_gudao/template_files/sections.haml",
+    "lib/hanna_gudao/template_files/styles.sass",
+    "lib/rdoc/discover.rb"
+  ]
+  s.homepage = "http://github.com/erikh/hanna-nouveau"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.22"
+  s.summary = "A rework of the Hanna generator for RDoc 2.5 and 3.x"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, ["~> 0.9.2.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_runtime_dependency(%q<haml>, ["= 3.0.25"])
+      s.add_runtime_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rake>, ["~> 0.9.2.2"])
+    else
+      s.add_dependency(%q<rake>, ["~> 0.9.2.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<haml>, ["= 3.0.25"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rake>, ["~> 0.9.2.2"])
+    end
+  else
+    s.add_dependency(%q<rake>, ["~> 0.9.2.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<haml>, ["= 3.0.25"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rake>, ["~> 0.9.2.2"])
+  end
+end
+

data/lib/hanna_gudao/template_files/class_index.haml

@@ -0,0 +1,3 @@
+%h1= values[:list_title]
+%ol#index-entries.classes
+  = render_class_tree values[:classes].select { |x| x.full_name !~ /::/ }

data/lib/hanna_gudao/template_files/file_index.haml

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

data/lib/hanna_gudao/template_files/index.haml

@@ -0,0 +1,11 @@
+!!! Frameset
+%html{ "xml:lang" => "en", :lang => "en", :xmlns => "http://www.w3.org/1999/xhtml" }
+  %head
+    %title= @options.title
+    %meta{ :content => "text/html; charset=#{@options.charset}", "http-equiv" => "Content-Type" }
+  %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" }
+      %frame{ :name => "Methods", :src => "fr_method_index.html" }
+    %frame{ :name => "docwin", :src => @main_page_uri }=""

data/lib/hanna_gudao/template_files/layout.haml

@@ -0,0 +1,34 @@
+!!! strict
+- index = values[:list_title]
+%html{ :lang => "en" }
+  %head
+    %title= values[:title]
+    %meta{ 'http-equiv' => "Content-Type", :content => "text/html; charset=#{@options.charset}" }
+    %link{ :rel => "stylesheet", :href => values[:stylesheet], :type => "text/css", :media => "screen" }
+    - unless index
+      :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)
+
+          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/tree/master'

data/lib/hanna_gudao/template_files/method_index.haml

@@ -0,0 +1,15 @@
+%h1= values[:list_title]
+
+%script{:type => 'text/javascript'}
+  = File.read(File.join(@templatedir, "prototype-1.6.0.3.js"))
+  = build_javascript_search_index(values[:methods] + values[:attributes])
+  = File.read(File.join(@templatedir, "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' }
+  - values[:attributes].each do |entry|
+    %li= link_to_method entry, [classfile(entry.parent), "method-#{entry.html_name}"].join('#')
+  - values[:methods].each do |entry|
+    %li= link_to_method entry, [classfile(entry.parent), entry.aref].join('#')

data/lib/hanna_gudao/template_files/method_list.haml

@@ -0,0 +1,56 @@
+- entry = values[:entry]
+- sections = values[:sections].keys if values.has_key?(:sections)
+- methods = entry.method_list + entry.attributes
+- unless methods.empty?
+  #method-list
+    %h2 Methods
+    - %w[attr attr_accessor attr_reader attr_writer class instance].each do |type|
+      - (RDoc::VISIBILITIES rescue RDoc::Context::VISIBILITIES).each do |vis|
+        -# FIXME ugly
+        - list = methods.reject { |x| x.respond_to?(:is_alias_for) && x.is_alias_for }.select { |x| x.visibility == vis && x.type == type.to_s }.sort
+        - unless list.empty?
+          - type_result = ""
+          - if type =~ /^attr_/
+            - type_result += type.sub(/^attr_/, '').capitalize
+          - else
+            - type_result += type.capitalize
+          - type_result = "#{vis.to_s.capitalize} #{type_result}"
+          %h3= type_result
+          %ol
+            - list.each do |method|
+              - if method.respond_to?(:aref)
+                - if method.name.to_s.empty? && method.call_seq
+                  %li= link_to method.call_seq.gsub(/<br\s*\/?>/, "").split(/[\r\n]+/).map{ |s| s.split(/([({]+|\[\{|\s+(#?=>|&rarr;)\s+)/).first.sub(/^[A-Za-z0-9_:]+\./, "").sub(/\s+=\s+.*/, "=").strip }.uniq.join("<br />\n"), '#' + method.aref
+                - else
+                  %li= link_to method.name, '#' + method.aref
+              - elsif method.respond_to?(:html_name)
+                %li= link_to method.name, "#method-#{method.html_name}"
+              - else
+                %li= method.name
+
+- if entry.requires or sections or entry.includes
+  #context
+    - unless entry.requires.empty?
+      #requires
+        %h2 Required files
+        %ol
+          - entry.requires.each do |req|
+            %li= req.name
+
+    - if sections && (sections.length > 1 || sections.first.title.to_s != '')
+      #contents
+        %h2 Contents
+        %ol
+          - sections.sort_by{|s| s.title.to_s}.each do |section|
+            %li= link_to section.title, "##{section.aref}"
+
+    - unless entry.includes.empty?
+      #includes
+        %h2 Included modules
+        %ol
+          - entry.includes.each do |inc|
+            - if (mod = inc.module).is_a?(String)
+              %li= inc.name
+            - else
+              %li= link_to inc.name, entry.aref_to(mod.path)
+

data/lib/hanna_gudao/template_files/method_search.js

@@ -0,0 +1,63 @@
+$(document).observe('dom:loaded', function() {
+	// Setup search-during-typing.
+	new Form.Element.Observer('search', 0.3, function(element, value) {
+		performSearch();
+	});
+	
+	// Remove the default search box value when the user puts the focus on
+	// the search box for the first time.
+	var search_box = $('search');
+	if ($F('search') == 'Enter search terms...') {
+		search_box.observe('focus', function() {
+			if (search_box.hasClassName('untouched')) {
+				search_box.removeClassName('untouched');
+				search_box.value = '';
+			}
+		});
+	} else {
+		search_box.removeClassName('untouched');
+	}
+	
+	search_box.insert({
+	  after: new Element('span', { 'class': 'clear_button' }).update('x').observe('click', function(e) {
+	    e.stopPropagation()
+  	  search_box.setValue('')
+  	  search_box.focus()
+  	})
+  })
+});
+
+function searchInIndex(query) {
+	var i;
+	var results = [];
+	query = query.toLowerCase();
+	for (i = 0; i < search_index.length; i++) {
+		if (search_index[i].method.indexOf(query) != -1) {
+			results.push(search_index[i]);
+		}
+	}
+	return results;
+}
+
+function buildHtmlForResults(results) {
+	var html = "";
+	var i;
+	for (i = 0; i < results.length; i++) {
+		html += '<li>' + results[i].html + '</li>';
+	}
+	return html;
+}
+
+function performSearch() {
+	var query = $F('search');
+	if (query == '') {
+		$('index-entries').show();
+		$('search-results').hide();
+	} else {
+		var results = searchInIndex(query);
+		$('search-results').update(buildHtmlForResults(results));
+		$('index-entries').hide();
+		$('search-results').show();
+	}
+	return false;
+}

data/lib/hanna_gudao/template_files/page.haml

@@ -0,0 +1,45 @@
+- file_page = !values[:classmod]
+- title_in_description = values[:entry].description && values[:entry].description =~ /^\s*<h1>/m
+
+.header
+  - title = capture_haml do
+    - if file_page
+      = values[:file].name
+    - else
+      %span.type= values[:classmod]
+      = values[:entry].full_name
+  - if title_in_description
+    .name= title
+  - else
+    %h1.name= title
+    
+  - if file_page
+    .paths
+      = values[:file].relative_name
+  - else
+    %ol.paths
+      - values[:entry].in_files.each_with_index do |file, index|
+        %li{ :class => index > 0 ? 'other' : nil }
+          -# FIXME cleanup
+          = link_to file.full_name, Pathname.new(file.path).relative_path_from(Pathname.new(values[:entry].path).dirname)
+      - if values[:entry].in_files.size > 1
+        %li
+          %a.show{ :href => '#', :onclick => 'this.parentNode.parentNode.className += " expanded"; this.parentNode.removeChild(this); return false' } show all
+          
+  - if values[:entry].parent 
+    .parent
+      Parent:
+      -# FIXME helper method
+      %strong= link_to values[:entry].parent.name, Pathname.new(class_dir) + Pathname.new(values[:entry].parent.path).relative_path_from(Pathname.new values[:entry].path)
+
+  - if values[:entry].respond_to?(:last_modified) and values[:entry].last_modified
+    .last-update
+      Last Update:
+      %span.datetime= values[:entry].last_modified
+    
+#content
+  #text
+    - if values[:description]
+      #description~ sanitize_code_blocks frame_link values[:description]
+
+    = frame_link yield