yard 0.6.0 → 0.6.1

data/ChangeLog

@@ -1,5 +1,98 @@
+2010-09-06  Loren Segal <lsegal@soen.ca>
+
+  * ChangeLog, README.md, lib/yard.rb, yard.gemspec: Bump to version 0.6.1
+
+  * templates/default/fulldoc/html/js/app.js: Fix TOC id links to include some
+  punctuation and digits
+
+  * spec/code_objects/base_spec.rb: Add spec for relative_path
+
+  * templates/default/fulldoc/html/css/style.css,
+  templates/default/fulldoc/html/js/app.js: Refactor inheritance arrow and
+  inheritance box display code
+
+  * lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb: Fix relative
+  path linking with common substrings
+
+  * lib/yard/tags/default_factory.rb: Gracefully error out if @example tag is
+  misformatted
+
+2010-09-03  Loren Segal <lsegal@soen.ca>
+
+  * spec/templates/helpers/html_helper_spec.rb: Fix broken spec of #link_object
+
+2010-09-03  Arthur Schreiber <schreiber.arthur@gmail.com>
+
+  * spec/registry_store_spec.rb: Update specs to match reading marshal data as
+  binary.
+
+2010-09-02  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/parser/source_parser.rb: Fix printing of debugging information
+  when displaying parser paths in 1.8.x
+
+2010-09-02  Arthur Schreiber <schreiber.arthur@gmail.com>
+
+  * lib/yard/registry_store.rb: Fix remaining cases where Marshal data was not
+  read as binary.
+
+2010-09-02  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb: Fix matching
+  of common namespace in Base#relative_path
+
+2010-09-01  Loren Segal <lsegal@soen.ca>
+
+  * templates/default/fulldoc/html/css/full_list.css,
+  templates/default/fulldoc/html/js/full_list.js: Improve inline JS search
+  responsiveness on large lists
+
+2010-09-01  Arthur Schreiber <schreiber.arthur@gmail.com>
+
+  * lib/yard/serializers/yardoc_serializer.rb, spec/registry_store_spec.rb: Fix
+  #168 - open files with serialized contents in binary mode.
+
+2010-09-01  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb,
+  spec/templates/helpers/html_helper_spec.rb: Fix
+  CodeObjects::Base#relative_path to work with parent namespaces and methods in
+  sibling namespaces
+
+  * lib/yard/code_objects/proxy.rb: Fix proxy implementation of name to match
+  Base#name
+
+2010-08-31  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/registry.rb, lib/yard/server/commands/search_command.rb: Avoid
+  exception when Registry.at(nil) is accessed (for search command)
+
+  * lib/yard/server/rack_adapter.rb: Print startup message for `yard server` if
+  Mongrel is being used
+
+  * lib/yard/server/rack_adapter.rb: Remove trap(INT) and server.shutdown, Rack
+  does this on its own.  Closes gh-165
+
+  * lib/yard/core_ext/string.rb, spec/core_ext/string_spec.rb,
+  spec/spec_helper.rb: Removed String#underscore and String#camelcase.  These
+  methods were not being used in YARD's codebase (minus a few small utility
+  functions) and they were causing incompatibility issues with other frameworks
+  like Rails.  Closes gh-167
+
+2010-08-30  Loren Segal <lsegal@soen.ca>
+
+  * templates/default/fulldoc/html/css/style.css: Put class list above ToC
+  (take 2)  Closes gh-164
+
 2010-08-29  Loren Segal <lsegal@soen.ca>
 
+  * templates/default/fulldoc/html/css/style.css: Lower z-index so class list
+  shows up above
+
+  * yard.gemspec: Update release date in gemspec
+
+  * ChangeLog: Update ChangeLog
+
   * templates/default/fulldoc/html/css/style.css: Fix positioning for TOC
 
   * lib/yard/templates/helpers/html_helper.rb: Fix encoding issue where

data/README.md

@@ -8,8 +8,8 @@ YARD: Yay! A Ruby Documentation Tool
 **Contributors**: See Contributors section below    
 **Copyright**:    2007-2010    
 **License**:      MIT License    
-**Latest Version**: 0.6.0 (codename "The Cubic")    
-**Release Date**: August 29th 2010    
+**Latest Version**: 0.6.1 (codename "The Cubic")    
+**Release Date**: September 6th 2010    
 
 Synopsis
 --------
@@ -288,7 +288,16 @@ More options can be seen by typing `yard-graph --help`, but here is an example:
 Changelog
 ---------
 
-- **August.28.10**: 0.6.0 release
+- **September.06.10**: 0.6.1 release
+    - Fixed TOC showing on top of class/method list in no-frames view
+    - A message now displays when running `yard server` with Rack/Mongrel installed
+    - Improved performance of JS inline search for large class/method lists
+    - Improved link titles for relative object links
+    - Removed `String#camelcase` and `String#underscore` for better Rails compat.
+    - Fixed support for loading .yardoc files under Windows
+    - Fixed inheritance tree arrows not displaying in certain environments
+
+- **August.29.10**: 0.6.0 release
     - Added dynamic local documentation server
     - Added @group/@endgroup declarations to organize methods into groups
     - Added `yard` executable to serve as main CLI tool with pluggable commands

data/lib/yard.rb

@@ -1,5 +1,5 @@
 module YARD
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
   
   # The root path for YARD source libraries
   ROOT = File.expand_path(File.dirname(__FILE__))

data/lib/yard/code_objects/base.rb

@@ -402,7 +402,11 @@ module YARD
       def relative_path(other)
         other = other.path if other.respond_to?(:path)
         return other unless namespace
-        other.gsub(/^#{Regexp.quote namespace.path}(::|\.)?/, '')
+        common = [path, other].join(" ").match(/^(\S*)\S*(?: \1\S*)*$/)[1]
+        common = path unless common =~ /(\.|::|#)$/
+        common = common.sub(/(\.|::|#)[^:#\.]*?$/, '')
+        result = other.sub(/^#{Regexp.quote common}(::|\.|)?/, '')
+        result.empty? ? other : result
       end
       
       # Renders the object using the {Templates::Engine templating system}.

data/lib/yard/code_objects/proxy.rb

@@ -18,7 +18,7 @@ module YARD
     class Proxy
       def self.===(other) other.is_a?(self) end
 
-      attr_reader :namespace, :name
+      attr_reader :namespace
       alias_method :parent, :namespace
 
       # Creates a new Proxy
@@ -59,6 +59,11 @@ module YARD
           @namespace = Registry.root
         end
       end
+      
+      # (see Base#name)
+      def name(prefix = false)
+        prefix ? (@imethod ? ISEP : '') + @name.to_s : @name
+      end
 
       # Returns a text representation of the Proxy
       # @return [String] the object's #inspect method or P(OBJECTPATH)

data/lib/yard/core_ext/string.rb

@@ -1,25 +1,4 @@
 class String
-  # Separates capital letters following lower case letters by an underscore
-  # and returns the entire string in lower case
-  # 
-  # @example
-  #   "FooBar".underscore # => "foo_bar"
-  #   "Foo::Bar".underscore # => "foo/bar"
-  # @return [String] the underscored lower case string
-  def underscore
-    gsub(/([a-z])([A-Z])/, '\1_\2').downcase.gsub('::', '/')
-  end
-  
-  # Camel cases any underscored text.
-  # 
-  # @example
-  #   "foo_bar_baz".camelcase # => "FooBarBaz"
-  #   "foo/bar".camelcase # => "Foo::Bar"
-  # @return [String] the camel cased text
-  def camelcase
-    gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(?:^|_)(.)/) { $1.upcase }
-  end
-  
   # Splits text into tokens the way a shell would, handling quoted
   # text as a single token. Use '\"' and "\'" to escape quotes and
   # '\\' to escape a backslash.

data/lib/yard/parser/source_parser.rb

@@ -48,7 +48,7 @@ module YARD
         #   {YARD::Logger}
         # @return the parser object that was used to parse the source. 
         def parse(paths = ["lib/**/*.rb", "ext/**/*.c"], excluded = [], level = log.level)
-          log.debug("Parsing #{paths} with `#{parser_type}` parser")
+          log.debug("Parsing #{paths.inspect} with `#{parser_type}` parser")
           excluded = excluded.map do |path|
             case path
             when Regexp; path

data/lib/yard/registry.rb

@@ -215,7 +215,7 @@ module YARD
       #   returns the {root} object.
       # @return [CodeObjects::Base] the object at path
       # @return [nil] if no object is found
-      def at(path) @store[path] end
+      def at(path) path ? @store[path] : nil end
       alias_method :[], :at
     
       # The root namespace object.

data/lib/yard/registry_store.rb

@@ -198,14 +198,14 @@ module YARD
     end
     
     def load_yardoc_old
-      @store, @proxy_types = *Marshal.load(File.read(@file))
+      @store, @proxy_types = *Marshal.load(File.read_binary(@file))
     end
     
     private
     
     def load_proxy_types
       return unless File.file?(proxy_types_path)
-      @proxy_types = Marshal.load(File.read(proxy_types_path))
+      @proxy_types = Marshal.load(File.read_binary(proxy_types_path))
     end
     
     def load_checksums

data/lib/yard/serializers/yardoc_serializer.rb

@@ -68,7 +68,7 @@ module YARD
         path = File.join(basepath, serialized_path(path)) unless is_path
         if File.file?(path)
           log.debug "Deserializing #{path}..."
-          Marshal.load(File.read(path))
+          Marshal.load(File.read_binary(path))
         else
           log.debug "Could not find #{path}"
           nil

data/lib/yard/server/commands/search_command.rb

@@ -7,7 +7,7 @@ module YARD
         def run
           Registry.load_all
           self.query = request.query['q']
-          redirect("/#{adapter.router.docs_prefix}/#{single_library ? library : ''}") if query =~ /\A\s*\Z/
+          redirect("/#{adapter.router.docs_prefix}/#{single_library ? library : ''}") if query.nil? || query =~ /\A\s*\Z/
           if found = Registry.at(query)
             redirect(serializer.serialized_path(found))
           end

data/lib/yard/server/rack_adapter.rb

@@ -24,9 +24,21 @@ module YARD
       def start
         server = Rack::Server.new(server_options)
         server.instance_variable_set("@app", self)
-        trap("INT") { server.shutdown }
+        print_start_message(server)
         server.start
       end
+      
+      private
+      
+      def print_start_message(server)
+        opts = server.default_options.merge(server.options)
+        puts ">> YARD #{YARD::VERSION} documentation server at http://#{opts[:Host]}:#{opts[:Port]}"
+
+        # Only happens for Mongrel
+        return unless server.server.to_s == "Rack::Handler::Mongrel"
+        puts ">> #{server.server.class_name} web server (running on Rack)"
+        puts ">> Listening on #{opts[:Host]}:#{opts[:Port]}, CTRL+C to stop"
+      end
     end
   end
 end

data/lib/yard/tags/default_factory.rb

@@ -82,6 +82,7 @@ module YARD
       end
             
       def extract_title_and_desc_from_text(text)
+        raise TagFormatError if text.nil? || text.empty?
         title, desc = nil, nil
         if text =~ /\A[ \t]\n/
           desc = text

data/spec/code_objects/base_spec.rb

@@ -229,21 +229,40 @@ describe YARD::CodeObjects::Base do
     it "should return the relative path when they share a common namespace" do
       YARD.parse_string "module A; class B; end; class C; end; end"
       Registry.at('A::B').relative_path(Registry.at('A::C')).should == 'C'
+      YARD.parse_string "module Foo; module A; end; module B; def foo; end end end"
+      Registry.at('Foo::A').relative_path(Registry.at('Foo::B#foo')).should == 'B#foo'
     end
     
     it "should return the full path if they don't have a common namespace" do
       YARD.parse_string "module A; class B; end; end; module D; class C; end; end"
       Registry.at('A::B').relative_path('D::C').should == 'D::C'
+      YARD.parse_string 'module C::B::C; module Apple; end; module Ant; end end'
+      Registry.at('C::B::C::Apple').relative_path('C::B::C::Ant').should == 'Ant'
+      YARD.parse_string 'module OMG::ABC; end; class Object; end'
+      Registry.at('OMG::ABC').relative_path('Object').should == "Object"
     end
     
     it "should return a relative path for class methods" do
       YARD.parse_string "module A; def self.b; end; def self.c; end; end"
       Registry.at('A.b').relative_path('A.c').should == 'c'
+      Registry.at('A').relative_path('A.c').should == 'c'
     end
 
     it "should return a relative path for instance methods" do
       YARD.parse_string "module A; def b; end; def c; end; end"
       Registry.at('A#b').relative_path('A#c').should == '#c'
+      Registry.at('A').relative_path('A#c').should == '#c'
+    end
+    
+    it "should return full path if relative path is to parent namespace" do
+      YARD.parse_string "module A; module B; end end"
+      Registry.at('A::B').relative_path('A').should == 'A'
+    end
+    
+    it "should only return name for relative path to self" do
+      YARD.parse_string("class A::B::C; def foo; end end")
+      Registry.at('A::B::C').relative_path('A::B::C').should == 'C'
+      Registry.at('A::B::C#foo').relative_path('A::B::C#foo').should == '#foo'
     end
   end
   

data/spec/core_ext/string_spec.rb

@@ -4,30 +4,6 @@ require File.dirname(__FILE__) + '/../spec_helper'
 #described_in_docs String, '#underscore'
 
 describe String do
-  describe '#underscore' do
-    it 'should turn HelloWorld into hello_world' do
-      "HelloWorld".underscore.should == "hello_world"
-    end
-  
-    it "should turn Hello::World into hello/world" do
-      "Hello::World".underscore.should == "hello/world"
-    end
-  end
-
-  describe '#camelcase' do
-    it 'should turn hello_world into HelloWorld' do
-      "hello_world".camelcase.should == "HelloWorld"
-    end
-
-    it "should turn hello/world into Hello::World" do
-      "hello/world".camelcase.should == "Hello::World"
-    end
-    
-    it "should not camelcase _foo" do
-      "_foo".camelcase.should == "_foo"
-    end
-  end
-  
   describe '#shell_split' do
     it "should split simple non-quoted text" do
       "a b c".shell_split.should == %w(a b c)

data/spec/registry_store_spec.rb

@@ -7,7 +7,7 @@ describe YARD::RegistryStore do
     it "should load old yardoc format if .yardoc is a file" do
       File.should_receive(:directory?).with('foo').and_return(false)
       File.should_receive(:file?).with('foo').and_return(true)
-      File.should_receive(:read).with('foo').and_return('FOO')
+      File.should_receive(:read_binary).with('foo').and_return('FOO')
       Marshal.should_receive(:load).with('FOO')
 
       @store.load('foo')
@@ -25,7 +25,7 @@ describe YARD::RegistryStore do
     it "should return true if .yardoc is loaded (file)" do
       File.should_receive(:directory?).with('myyardoc').and_return(false)
       File.should_receive(:file?).with('myyardoc').and_return(true)
-      File.should_receive(:read).with('myyardoc').and_return(Marshal.dump(''))
+      File.should_receive(:read_binary).with('myyardoc').and_return(Marshal.dump(''))
       @store.load('myyardoc').should == true
     end
 
@@ -62,7 +62,7 @@ describe YARD::RegistryStore do
       File.should_receive(:file?).with('foo/checksums').and_return(false)
       File.should_receive(:file?).with('foo/proxy_types').and_return(true)
       File.should_receive(:file?).with('foo/objects/root.dat').and_return(false)
-      File.should_receive(:read).with('foo/proxy_types').and_return(Marshal.dump({'a' => 'b'}))
+      File.should_receive(:read_binary).with('foo/proxy_types').and_return(Marshal.dump({'a' => 'b'}))
       @store.load('foo').should == true
       @store.proxy_types.should == {'a' => 'b'}
     end
@@ -72,7 +72,7 @@ describe YARD::RegistryStore do
       File.should_receive(:file?).with('foo/checksums').and_return(false)
       File.should_receive(:file?).with('foo/proxy_types').and_return(false)
       File.should_receive(:file?).with('foo/objects/root.dat').and_return(true)
-      File.should_receive(:read).with('foo/objects/root.dat').and_return(Marshal.dump('foo'))
+      File.should_receive(:read_binary).with('foo/objects/root.dat').and_return(Marshal.dump('foo'))
       @store.load('foo').should == true
       @store.root.should == 'foo'
     end

data/spec/spec_helper.rb

@@ -17,7 +17,8 @@ def described_in_docs(klass, meth, file = nil)
     filename = File.join(YARD::ROOT, file)
     YARD::Parser::SourceParser.new.parse(filename)
   else
-    $".find_all {|p| p.include? klass.class_name.underscore }.each do |filename|
+    underscore = klass.class_name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.gsub('::', '/')
+    $".find_all {|p| p.include? underscore }.each do |filename|
       next unless File.exists? filename
       YARD::Parser::SourceParser.new.parse(filename)
     end
@@ -47,7 +48,8 @@ end
 
 def docspec(objname = self.class.description, klass = self.class.described_type)
   # Parse the file (could be multiple files)
-  $".find_all {|p| p.include? klass.class_name.underscore }.each do |filename|
+  underscore = klass.class_name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.gsub('::', '/')
+  $".find_all {|p| p.include? underscore }.each do |filename|
     filename = File.join(YARD::ROOT, filename)
     next unless File.exists? filename
     YARD::Parser::SourceParser.new.parse(filename)

data/spec/templates/helpers/html_helper_spec.rb

@@ -152,6 +152,15 @@ describe YARD::Templates::Helpers::HtmlHelper do
       stub!(:serializer).and_return(serializer)
       link_object("Bar").should =~ %r{>Bar</a>}
     end
+    
+    it "should use relative path to parent class in title" do
+      root = CodeObjects::ModuleObject.new(:root, :YARD)
+      obj = CodeObjects::ModuleObject.new(root, :SubModule)
+      stub!(:object).and_return(obj)
+      serializer = Serializers::FileSystemSerializer.new
+      stub!(:serializer).and_return(serializer)
+      link_object("YARD").should =~ %r{>YARD</a>}
+    end
   end
 
   describe '#url_for' do

data/templates/default/fulldoc/html/css/full_list.css

@@ -8,11 +8,13 @@ body {
 
 h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
 .clear { clear: both; }
-#search { position: absolute; right: 5px; top: 9px; }
+#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
+#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }
 #full_list { padding: 0; list-style: none; margin-left: 0; }
 #full_list ul { padding: 0; }
 #full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; }
-#noresults { display: none; padding: 7px 12px; }
+#noresults { padding: 7px 12px; }
+#content.insearch #noresults { margin-left: 7px; }
 ul.collapsed ul, ul.collapsed li { display: none; }
 li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
 li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
@@ -40,7 +42,8 @@ li.collapsed.clicked a.toggle { background-position: top right; }
 .frames li small:before { content: ""; }
 .frames li small:after { content: ""; }
 .frames li small.search_info { display: none; }
-.frames #search { position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; }
+.frames #search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
+.frames #content.insearch #search { background-position: center right; }
 .frames #search input { width: 110px; }
 .frames #nav { display: block; }
 

data/templates/default/fulldoc/html/css/style.css

@@ -183,8 +183,11 @@ p.children strong.modules { padding-left: 5px; }
 
 ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
 ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
-ul.fullTree li { text-align: center; }
-ul.fullTree li.next:before { font-size: 1.2em; content: '\2B06'; color: #bbb; display: block; margin-top: 3px; }
+ul.fullTree li { text-align: center; padding-top: 18px; padding-bottom: 12px; background: url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAHtJREFUeNqMzrEJAkEURdGzuhgZbSoYWcAWoBVsB4JgZAGmphsZCZYzTQgWNCYrDN9RvMmHx+X916SUBFbo8CzD1idXrLErw1mQttgXtyrOcQ/Ny5p4Qh+2XqLYYazsPWNTiuMkRxa4vcV+evuNAUOLIx5+c2hyzv7hNQC67Q+/HHmlEwAAAABJRU5ErkJggg==) no-repeat top center; }
+ul.fullTree li:first-child { padding-top: 0; background: transparent; }
+ul.fullTree li:last-child { padding-bottom: 0; }
+.showAll ul.fullTree { display: block; }
+.showAll .inheritName { display: none; }
 
 #search { position: absolute; right: 14px; top: 0px; }
 #search a:link, #search a:visited { 
@@ -229,6 +232,7 @@ li.r1 { background: #f0f0f0; }
 li.r2 { background: #fafafa; }
 
 #search_frame {
+  z-index: 9999;
   background: #fff;
   display: none;
   position: absolute; 
@@ -253,7 +257,7 @@ li.r2 { background: #fafafa; }
   max-width: 300px;
   -webkit-box-shadow: -2px 2px 6px #bbb;
   -moz-box-shadow: -2px 2px 6px #bbb;
-  z-index: 9999;
+  z-index: 5000;
   position: relative;
 }
 #toc.nofloat { float: none; max-width: none; border: none; padding: 0; margin: 20px 0; -webkit-box-shadow: none; -moz-box-shadow: none; }

data/templates/default/fulldoc/html/js/app.js

@@ -31,14 +31,12 @@ function createFullTreeLinks() {
     var tHeight = 0;
     $('.inheritanceTree').toggle(function() {
         tHeight = $(this).parent().prev().height();
-        $(this).prev().prev().hide();
-        $(this).prev().show();
+        $(this).parent().toggleClass('showAll');
         $(this).text("(hide)");
         $(this).parent().prev().height($(this).parent().height());
     },
     function() {
-        $(this).prev().prev().show();
-        $(this).prev().hide();
+        $(this).parent().toggleClass('showAll');
         $(this).parent().prev().height(tHeight);
         $(this).text("show all")
     });
@@ -154,7 +152,7 @@ function generateTOC() {
     show = true;
     var thisTag = parseInt(this.tagName[1]);
     if (this.id.length == 0) {
-      var proposedId = $(this).text().replace(/[^a-z]/ig, '_');
+      var proposedId = $(this).text().replace(/[^a-z0-9:'"\.()=-]/ig, '_');
       if ($('#' + proposedId).length > 0) proposedId += counter++;
       this.id = proposedId;
     }

data/templates/default/fulldoc/html/js/full_list.js

@@ -1,9 +1,24 @@
+var inSearch = null;
+var searchIndex = 0;
+var searchCache = [];
+var searchString = '';
+
 function fullListSearch() {
+  // generate cache
+  searchCache = [];
+  $('#full_list li').each(function() {
+    var link = $(this).find('.object_link a');
+    searchCache.push({name:link.text(), node:$(this), link:link});
+  });
+  
   $('#search input').keyup(function() {
-    var value = this.value.toLowerCase();
-    if (value == "") {
-      $('#full_list').removeClass('insearch');
-      $('#full_list li').each(function() {
+    searchString = this.value.toLowerCase();
+    if (searchString == "") {
+      clearTimeout(inSearch);
+      inSearch = null;
+      $('#full_list, #content').removeClass('insearch');
+      $('#full_list li').removeClass('found').each(function() {
+        
         var link = $(this).find('.object_link a');
         link.text(link.text()); 
       });
@@ -15,34 +30,56 @@ function fullListSearch() {
       highlight();
     }
     else {
-      $('#full_list').addClass('insearch');
-      $('#full_list li').each(function() {
-        var link = $(this).find('.object_link a');
-        var text = link.text();
-        if (text.toLowerCase().indexOf(value) == -1) {
-          $(this).removeClass('found');
-          link.text(link.text());
-        }
-        else {
-          $(this).css('padding-left', '10px').addClass('found');
-          link.html(link.text().replace(new RegExp("(" + 
-            value.replace(/([\/.*+?|()\[\]{}\\])/g, "\\$1") + ")", "ig"), 
-            '<strong>$1</strong>'));
-        }
-      });
-      highlight(true);
-    }
-    
-    if ($('#full_list li:visible').size() == 0) {
-      $('#noresults').fadeIn();
-    }
-    else {
-      $('#noresults').hide();
+      if (inSearch) clearTimeout(inSearch);
+      searchIndex = 0;
+      lastRowClass = '';
+      $('#full_list, #content').addClass('insearch');
+      $('#noresults').text('');
+      searchItem();
     }
   });
   
   $('#search input').focus();
-  $('#full_list').after("<div id='noresults'>No results were found.</div>")
+  $('#full_list').after("<div id='noresults'></div>")
+}
+
+var lastRowClass = '';
+function searchItem() {
+  for (var i = 0; i < searchCache.length / 50; i++) {
+    var item = searchCache[searchIndex];
+    if (item.name.toLowerCase().indexOf(searchString) == -1) {
+      item.node.removeClass('found');
+    }
+    else {
+      item.node.css('padding-left', '10px').addClass('found');
+      item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
+      lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
+      item.link.html(item.name.replace(new RegExp("(" + 
+        searchString.replace(/([\/.*+?|()\[\]{}\\])/g, "\\$1") + ")", "ig"), 
+        '<strong>$1</strong>'));
+    }
+
+    if (searchCache.length == searchIndex + 1) {
+      return searchDone();
+    }
+    else {
+      searchIndex++;
+    }
+  }
+  inSearch = setTimeout('searchItem()', 0);
+}
+
+function searchDone() {
+  highlight(true);
+  if ($('#full_list li:visible').size() == 0) {
+    $('#noresults').text('No results were found.').hide().fadeIn();
+  }
+  else {
+    $('#noresults').text('');
+  }
+  $('#content').removeClass('insearch');
+  clearTimeout(inSearch);
+  inSearch = null;
 }
 
 clicked = null;

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Loren Segal
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-29 00:00:00 -04:00
+date: 2010-09-06 00:00:00 -04:00
 default_executable: 
 dependencies: []