mislav-hanna 0.1.4 → 0.1.5

data/Manifest

@@ -11,6 +11,8 @@ 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

data/README.markdown

@@ -1,41 +1,51 @@
 # 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 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][]:
+Hanna gem is available from [GitHub][]:
 
     gem install mislav-hanna
 
+The template was created by [Mislav][] 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.
 
 ## Usage
 
-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:
+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
+    
+Hanna requires the `--inline-sorce` (or `-S`) flag.
+
+An alternative is to set the `RDOCOPT` environment variable:
+
+    RDOCOPT="-S -T hanna"
+
+This will make RDoc always use Hanna unless it is explicitly overridden.
+
+You can also use the command-line tool included in the Hanna gem:
 
     hanna -h
 
-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:
+This is a wrapper over rdoc and it forwards all the parameters to it.
+
+### Rake task
+
+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'
     # with this:
     require 'hanna/rdoctask'
 
-Tip: you can do this in the Rakefile of your Rails project before running `rake
-doc:rails`.
+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]:
 
@@ -56,51 +66,31 @@ Here is an example of a task for the [will_paginate library][wp]:
       rdoc.rdoc_dir = 'doc' # rdoc output folder
       rdoc.options << '--webcvs=http://github.com/mislav/will_paginate/tree/master/'
     end
-    
-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.
 
-A third alternative is to set the +RDOCOPT+ environment variable to
+### Generating documentation for installed gems
 
-    -T hanna -S
+You can generate documentation for installed gems, which might be more convenient than the
+`gem rdoc` command with the +RDOCOPT+ environment variable set as described. For instance,
+to generate docs for "actionpack" and "activerecord" type:
 
-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
-
-## 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.
+    [sudo] hanna --gems actionpack activerecord
 
 ## 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.
+I think of Hanna as 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_.
+
+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.
+
+This is git. Fork it, hack away, tell me about it!
 
 
 [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
+[GitHub]: http://gems.github.com/ "GitHub gem server"
+[wp]: http://github.com/mislav/will_paginate/tree/master/Rakefile
 [Mislav]: http://mislav.caboo.se/ "Mislav Marohnić"
-[Allison]: http://blog.evanweaver.com/files/doc/fauna/allison/ "A modern, pretty RDoc template"

data/Rakefile

@@ -1,12 +1,8 @@
-#
-# This can be made cleaner by using the relative gem.
-#
-require File.join(File.dirname(__FILE__), "lib/hanna/rdoc_version")
-
 require 'echoe'
+require 'lib/hanna/rdoc_version'
 
 Echoe.new('hanna') do |p|
-  p.version = '0.1.4'
+  p.version = '0.1.5'
   
   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."
@@ -19,6 +15,6 @@ Echoe.new('hanna') do |p|
   p.has_rdoc = false
   p.runtime_dependencies = []
   p.runtime_dependencies << ['rdoc', Hanna::RDOC_VERSION_REQUIREMENT]
-  p.runtime_dependencies << ['haml', '~> 2.0']
+  p.runtime_dependencies << ['haml', '~> 2.0.4']
   p.runtime_dependencies << ['rake', '~> 0.8.2']
 end

data/bin/hanna

@@ -24,11 +24,17 @@ HELP
   exit 0
 end
 
-require 'rubygems'
+unless RUBY_PLATFORM =~ /(:?mswin|mingw)/
+  require 'pathname'
+  hanna_dir = Pathname.new(__FILE__).realpath.dirname + '../lib'
+else
+  # windows
+  hanna_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+end
 
-hanna_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 $:.unshift(hanna_dir) unless $:.include?(hanna_dir)
 
+require 'rubygems'
 require 'hanna/rdoc_version'
 Hanna::require_rdoc
 require 'rdoc/rdoc'
@@ -47,7 +53,7 @@ if ARGV.first == '--gems'
   
   unless gem_names.empty?
     specs = gem_names.inject([]) do |arr, name|
-      found = Gem::SourceIndex.from_installed_gems.search(name)
+      found = Gem::SourceIndex.from_installed_gems.find_name(name)
       spec = found.sort_by {|s| s.version }.last
       arr << spec if spec
       arr

data/hanna.gemspec

@@ -1,131 +1,44 @@
+# -*- encoding: utf-8 -*-
 
-# Gem::Specification for Hanna-0.1.4
-# Originally generated by Echoe
+Gem::Specification.new do |s|
+  s.name = %q{hanna}
+  s.version = "0.1.5"
 
---- !ruby/object:Gem::Specification 
-name: hanna
-version: !ruby/object:Gem::Version 
-  version: 0.1.4
-platform: ruby
-authors: 
-- "Mislav Marohni\xC4\x87"
-autorequire: 
-bindir: bin
+  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.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.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.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}
 
-date: 2008-09-22 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: rake
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.8.2
-    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: []
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
 
-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_helpers.rb
-- lib/hanna/template_page_patch.rb
-- lib/hanna.rb
-- README.markdown
-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_helpers.rb
-- lib/hanna/template_page_patch.rb
-- lib/hanna.rb
-- Manifest
-- Rakefile
-- README.markdown
-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: []
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rdoc>, ["~> 2.2.0"])
+      s.add_runtime_dependency(%q<haml>, ["~> 2.0.4"])
+      s.add_runtime_dependency(%q<rake>, ["~> 0.8.2"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<rdoc>, ["~> 2.2.0"])
+      s.add_dependency(%q<haml>, ["~> 2.0.4"])
+      s.add_dependency(%q<rake>, ["~> 0.8.2"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rdoc>, ["~> 2.2.0"])
+    s.add_dependency(%q<haml>, ["~> 2.0.4"])
+    s.add_dependency(%q<rake>, ["~> 0.8.2"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/lib/hanna/template_files/file_index.haml

@@ -2,11 +2,23 @@
 - 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 }
   - 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 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']
 
   - if any_hidden
     %li

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

@@ -33,4 +33,4 @@
       #footer
         = link_to '<strong>Hanna</strong> RDoc template', 'http://github.com/mislav/hanna'
         hand-crafted by
-        %strong= link_to 'Mislav', 'http://mislav.caboo.se/'
+        %strong= link_to 'Mislav', 'http://mislav.uniqpath.com/'

data/lib/hanna/template_files/method_search.js

@@ -0,0 +1,55 @@
+$(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');
+	}
+});
+
+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;
+}