yard 0.6.8 → 0.7.0

data/lib/yard/server/rack_adapter.rb

@@ -5,19 +5,19 @@ module YARD
   module Server
     # This class wraps the {RackAdapter} into a Rack-compatible middleware.
     # See {#initialize} for a list of options to pass via Rack's +#use+ method.
-    # 
+    #
     # @note You must pass a +:libraries+ option to the RackMiddleware via +#use+. To
     #   read about how to return a list of libraries, see {LibraryVersion} or look
     #   at the example below.
     # @example Using the RackMiddleware in a Rack application
     #   libraries = {:mylib => [YARD::Server::LibraryVersion.new('mylib', nil, '/path/to/.yardoc')]}
     #   use YARD::Server::RackMiddleware, :libraries => libraries
-    # 
+    #
     class RackMiddleware
       # Creates a new Rack-based middleware for serving YARD documentation.
-      # 
+      #
       # @param app the next Rack middleware in the stack
-      # @option opts [Hash{String=>Array<LibraryVersion>}] :libraries ({}) 
+      # @option opts [Hash{String=>Array<LibraryVersion>}] :libraries ({})
       #   the map of libraries to serve through the adapter. This option is *required*.
       # @option opts [Hash] :options ({}) a list of options to pass to the adapter.
       #   See {Adapter#options} for a list.
@@ -28,7 +28,7 @@ module YARD
         @app = app
         @adapter = RackAdapter.new(*args)
       end
-      
+
       def call(env)
         status, headers, body = *@adapter.call(env)
         if status == 404
@@ -38,11 +38,11 @@ module YARD
         end
       end
     end
-    
+
     # A server adapter to respond to requests using the Rack server infrastructure.
     class RackAdapter < Adapter
       include WEBrick::HTTPUtils
-      
+
       # Responds to Rack requests and builds a response with the {Router}.
       # @return [Array(Number,Hash,Array)] the Rack-style response
       def call(env)
@@ -50,7 +50,7 @@ module YARD
         request.path_info = unescape(request.path_info) # unescape things like %3F
         router.call(request)
       end
-      
+
       # Starts the +Rack::Server+. This method will pass control to the server and
       # block.
       # @return [void]
@@ -60,9 +60,9 @@ module YARD
         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]}"

data/lib/yard/server/router.rb

@@ -2,21 +2,21 @@ module YARD
   module Server
     # A router class implements the logic used to recognize a request for a specific
     # URL and run specific {Commands::Base commands}.
-    # 
+    #
     # == Subclassing Notes
     # To create a custom router, subclass this class and pass it into the adapter
-    # options through {Adapter#initialize} or by directly modifying {Adapter#router}. 
-    # 
-    # The most general customization is to change the URL prefixes recognized by 
-    # routing, which can be done by overriding {#docs_prefix}, {#list_prefix} 
+    # options through {Adapter#initialize} or by directly modifying {Adapter#router}.
+    #
+    # The most general customization is to change the URL prefixes recognized by
+    # routing, which can be done by overriding {#docs_prefix}, {#list_prefix}
     # and {#search_prefix}.
-    # 
+    #
     # == Implementing Custom Caching
     # By default, the Router class performs static disk-based caching on all
     # requests through the +#check_static_cache+. To override this behaviour,
     # or create your own caching mechanism, mixin your own custom module with
     # this method implemented as per {StaticCaching#check_static_cache}.
-    # 
+    #
     # @example Creating a subclassed router
     #   # Adds 'my' to all routing prefixes
     #   class MyRouter < YARD::Server::Router
@@ -24,29 +24,29 @@ module YARD
     #     def list_prefix; 'mylist' end
     #     def search_prefix; 'mysearch' end
     #   end
-    # 
+    #
     #   # Using it:
     #   WebrickAdapter.new(libraries, :router => MyRouter).start
     class Router
       include StaticCaching
       include Commands
-      
+
       # @return [Adapter Dependent] the request data coming in with the routing
       attr_accessor :request
-      
+
       # @return [Adapter] the adapter used by the router
       attr_accessor :adapter
-      
+
       # Creates a new router for a specific adapter
-      # 
+      #
       # @param [Adapter] adapter the adapter to route requests to
       def initialize(adapter)
         self.adapter = adapter
       end
-      
+
       # Perform routing on a specific request, serving the request as a static
       # file through {Commands::StaticFileCommand} if no route is found.
-      # 
+      #
       # @param [Adapter Dependent] request the request object
       # @return [Array(Number,Hash,Array)] the Rack-style server response data
       def call(request)
@@ -57,20 +57,20 @@ module YARD
           StaticFileCommand.new(adapter.options).call(request)
         end
       end
-      
+
       # @group Route Prefixes
 
       # @return [String] the URI prefix for all object documentation requests
       def docs_prefix; 'docs' end
-      
+
       # @return [String] the URI prefix for all class/method/file list requests
       def list_prefix; 'list' end
-      
+
       # @return [String] the URI prefix for all search requests
       def search_prefix; 'search' end
-      
+
       # @group Routing Methods
-      
+
       # @return [Array(LibraryVersion, Array<String>)] the library followed
       #   by the rest of the path components in the request path. LibraryVersion
       #   will be nil if no matching library was found.
@@ -89,10 +89,10 @@ module YARD
       end
 
       protected
-      
+
       # Performs routing algorithm to find which prefix is called, first
       # parsing out library name/version information.
-      # 
+      #
       # @return [Array(Numeric,Hash,Array<String>)] the Rack-style response
       # @return [nil] if no route is matched
       def route
@@ -112,7 +112,7 @@ module YARD
         end
         nil
       end
-      
+
       # Routes requests from {#docs_prefix} and calls the appropriate command
       # @param [LibraryVersion] library the library to route for
       # @param [Array<String>] paths path components (split by '/')
@@ -132,7 +132,7 @@ module YARD
         cmd = cmd.new(final_options(library, paths))
         cmd.call(request)
       end
-      
+
       # Routes for the index of a library / multiple libraries
       # @return (see #route)
       def route_index
@@ -142,7 +142,7 @@ module YARD
           LibraryIndexCommand.new(adapter.options.merge(:path => '')).call(request)
         end
       end
-      
+
       # Routes requests from {#list_prefix} and calls the appropriate command
       # @param (see #route_docs)
       # @return (see #route_docs)
@@ -156,7 +156,7 @@ module YARD
         end
         cmd.new(final_options(library, paths)).call(request)
       end
-      
+
       # Routes requests from {#search_prefix} and calls the appropriate command
       # @param (see #route_docs)
       # @return (see #route_docs)
@@ -164,12 +164,12 @@ module YARD
         return unless paths.empty?
         SearchCommand.new(final_options(library, paths)).call(request)
       end
-      
+
       # @group Utility Methods
-      
+
       # Adds extra :library/:path option keys to the adapter options.
       # Use this method when passing options to a command.
-      # 
+      #
       # @param (see #route_docs)
       # @return [Hash] finalized options
       def final_options(library, paths)

data/lib/yard/server/static_caching.rb

@@ -1,31 +1,31 @@
 module YARD
   module Server
     # Implements static caching for requests.
-    # 
+    #
     # @see Router Router documentation for "Caching"
     module StaticCaching
       # Called by a router to return the cached object. By default, this
       # method performs disk-based caching. To perform other forms of caching,
       # implement your own +#check_static_cache+ method and mix the module into
       # the Router class.
-      # 
+      #
       # Note that caching does not occur here. This method simply checks for
       # the existence of cached data. To actually cache a response, see
       # {Commands::Base#cache}.
-      # 
+      #
       # @example Implementing In-Memory Cache Checking
       #   module MemoryCaching
       #     def check_static_cache
       #       # $memory_cache is filled by {Commands::Base#cache}
       #       cached_data = $memory_cache[request.path]
-      #       if cached_data 
+      #       if cached_data
       #         [200, {'Content-Type' => 'text/html'}, [cached_data]]
       #       else
       #         nil
       #       end
       #     end
       #   end
-      # 
+      #
       #   class YARD::Server::Router; include MemoryCaching; end
       # @return [Array(Number,Hash,Array)] the Rack-style response
       # @return [nil] if no cache is available and routing should continue

data/lib/yard/server/templates/default/fulldoc/html/css/custom.css

@@ -8,7 +8,7 @@
 form.search {
   position: relative;
   color: #fff;
-  margin-top: 3px; padding: 7px; border: 1px solid #99f; width: 315px; background: #05a; 
+  margin-top: 3px; padding: 7px; border: 1px solid #99f; width: 315px; background: #05a;
   -moz-border-radius: 4px; -webkit-border-radius: 4px;
   margin-bottom: 10px;
 }
@@ -50,7 +50,7 @@ form.search input { margin-left: 5px; width: 250px; border: 1px solid #99f; -moz
 	line-height: 16px;
 	overflow: hidden;
 	
-} 
+}
 
 .ac_loading {
 	background: white url('/images/loading.gif') right center no-repeat;
@@ -69,7 +69,7 @@ form.search input { margin-left: 5px; width: 250px; border: 1px solid #99f; -moz
 }
 
 #fade { display: none; position: absolute; top: 0px; left: 0; background: #eee; z-index: -1; width: 100%; height: 100%; border-top: 1px solid #e0e0e0; }
-#processing { 
+#processing {
   position: absolute; width: 400px; height: 200px; margin: auto; background: #fff; padding: 10px 30px; z-index: 20;
   -webkit-box-shadow: 0px 0px 20px #444; -moz-box-shadow: 0px 0px 20px #444;
   -webkit-border-radius: 4px;

data/lib/yard/server/templates/default/fulldoc/html/js/live.js

@@ -14,7 +14,7 @@ function searchFrameLinks() {
 
 function methodPermalinks() {
   if ($($('#content h1')[0]).text().match(/^Method:/)) return;
-  
+
   $('#method_details .signature, #constructor_details .signature, ' +
       '.method_details .signature, #method_missing_details .signature').each(function() {
     var id = this.id;

data/lib/yard/server/templates/default/layout/html/breadcrumb.erb

@@ -31,7 +31,7 @@
   <% end %>
   <% if object.is_a?(CodeObjects::Base) && @file.nil? %>
     <% unless @single_library %>&raquo;<% end %>
-    <a href="/<%= base_path(router.docs_prefix) %>"><% if object.root? || object.type == :method %>Index<% else %>Index (<%= object.name.to_s[0] %>)<% end %></a> &raquo; 
+    <a href="/<%= base_path(router.docs_prefix) %>"><% if object.root? || object.type == :method %>Index<% else %>Index (<%= object.name.to_s[0] %>)<% end %></a> &raquo;
     <%= @breadcrumb.map {|obj| "<span class='title'>" + linkify(obj, obj.name) + "</span>" }.join(" &raquo; ") %>
     <%= @breadcrumb.size > 0 ? " &raquo; " : "" %>
     <span class='title'><%= object.root? ? "Top Level Namespace" : object.name(true) %></span>
@@ -40,7 +40,7 @@
     <% if object != '_index.html' %><a href="/<%= base_path(router.docs_prefix) %>">Index</a> &raquo; <% end %>
     <span class='title'><%= @breadcrumb_title %></span>
   <% end %>
-  
+
   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
 </div>
 

data/lib/yard/server/templates/default/layout/html/headers.erb

@@ -1,11 +1,16 @@
-<meta name="Content-Type" content="text/html; charset=UTF-8" />
-<title><%= @page_title %></title>
-<link rel="stylesheet" href="/css/style.css" type="text/css" media="screen" charset="utf-8" />
-<link rel="stylesheet" href="/css/custom.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="/js/autocomplete.js"></script>
-<script type="text/javascript" charset="utf-8" src="/js/app.js"></script>
-<script type="text/javascript" charset="utf-8" src="/js/live.js"></script>
+<meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
+<title>
+  <%= h @page_title %>
+  <% if options[:title] && @page_title != options[:title] %>
+    &mdash; <%= h options[:title] %>
+  <% end %>
+</title>
+<% stylesheets.each do |stylesheet| %>
+  <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" media="screen" charset="utf-8" />
+<% end %>
 <script type="text/javascript" charset="utf-8">
   library = '<%= base_path(router.list_prefix) %>';
 </script>
+<% javascripts.each do |javascript| %>
+  <script type="text/javascript" charset="utf-8" src="<%= url_for(javascript) %>"></script>
+<% end %>

data/lib/yard/server/templates/default/layout/html/setup.rb

@@ -0,0 +1,7 @@
+def javascripts
+  super + %w(js/autocomplete.js js/live.js)
+end
+
+def stylesheets
+  super + %w(css/custom.css)
+end

data/lib/yard/server/templates/doc_server/full_list/html/full_list.erb

@@ -2,7 +2,7 @@
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html>
   <head>
-    <meta name="Content-Type" content="text/html; charset=<%= charset %>" />
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
     <link rel="stylesheet" href="/css/full_list.css" type="text/css" media="screen" charset="utf-8" />
     <link rel="stylesheet" href="/css/common.css" type="text/css" media="screen" charset="utf-8" />
     <script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
@@ -19,7 +19,7 @@
     <div id="content">
       <h1 id="full_list_header"><%= @list_title %></h1>
       <div id="nav">
-        <a target="_self" href="/<%= base_path(router.list_prefix) %>/class">Classes</a> | 
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/class">Classes</a> |
         <a target="_self" href="/<%= base_path(router.list_prefix) %>/methods">Methods</a> |
         <a target="_self" href="/<%= base_path(router.list_prefix) %>/files">Files</a>
       </div>

data/lib/yard/server/templates/doc_server/full_list/html/setup.rb

@@ -2,9 +2,19 @@ include T('default/fulldoc/html')
 
 def init
   case @list_type.to_sym
-  when :class; @list_title = "Class List"
-  when :methods; @list_title = "Method List"
-  when :files; @list_title = "File List"
+  when :class
+    generate_class_list
+    @list_title = "Class List"
+  when :methods
+    generate_method_list
+    @list_title = "Method List"
+  when :files
+    generate_file_list
+    @list_title = "File List"
   end
   sections :full_list
-end
+end
+
+def asset(file, contents)
+  contents
+end

data/lib/yard/server/templates/doc_server/library_list/html/contents.erb

@@ -3,9 +3,9 @@
   <li class="r<%= @row = @row == 1 ? 2 : 1 %>">
     <% library_versions = library_versions.dup %>
     <% first_lib = library_versions.pop %>
-    <a href="/<%= router.docs_prefix %>/<%= first_lib %>/frames"><%= name %></a> 
+    <a href="/<%= router.docs_prefix %>/<%= first_lib %>/frames"><%= name %></a>
     <% if first_lib.version %>
-      <small>(<%= first_lib.version %><% if library_versions.size > 0 %>, 
+      <small>(<%= first_lib.version %><% if library_versions.size > 0 %>,
         <%= library_versions.reverse.map {|lib| "<a href=\"/#{router.docs_prefix}/#{lib}/frames\">#{lib.version}</a>" }.join(', ') %><% end %>)</small>
     <% end %>
   </li>

data/lib/yard/server/templates/doc_server/library_list/html/headers.erb

@@ -1,4 +1,4 @@
-<meta name="Content-Type" content="text/html; charset=UTF-8" />
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <title>YARD Documentation Server <%= YARD::VERSION %> - Library Listing</title>
 <link rel="stylesheet" href="/css/style.css" type="text/css" media="screen" charset="utf-8" />
 <link rel="stylesheet" href="/css/custom.css" type="text/css" media="screen" charset="utf-8" />
@@ -17,7 +17,7 @@
       });
     })
   }
-  
+
   $(framesLinks);
 </script>
 <style type="text/css" media="screen">

data/lib/yard/server/templates/doc_server/processing/html/processing.erb

@@ -42,7 +42,7 @@
     <div id="processing">
       <h1>Processing <%= @library.name %></h1>
       <p>
-        <strong><%= @library.name %></strong> <% if @library.version %>(<%= @library.version %>)<% end %> is being processed. 
+        <strong><%= @library.name %></strong> <% if @library.version %>(<%= @library.version %>)<% end %> is being processed.
         You'll be redirected when the pages are built, it shouldn't take much longer.
       </p>
       <img src="/images/processing.gif" align="center" />

data/lib/yard/server/templates/doc_server/search/html/search.erb

@@ -7,7 +7,7 @@
       <% name = result.type == :method ? result.name(true).to_s : result.name.to_s %>
       <% path = name.gsub(/(#{Regexp.quote @query})/i, '<strong>\1</strong>') %>
       <li class="r<%= n %>">
-        <a href="<%= serializer.serialized_path(result) %>" 
+        <a href="<%= serializer.serialized_path(result) %>"
           title="<%= result.path %>"><%= path %></a>
           <% if !result.namespace.root? %>
           <small>(<%= result.namespace.path %>)</small>

data/lib/yard/server/webrick_adapter.rb

@@ -18,12 +18,12 @@ module YARD
     # The main WEBrick servlet implementation, accepting only GET requests.
     class WebrickServlet < WEBrick::HTTPServlet::AbstractServlet
       attr_accessor :adapter
-      
+
       def initialize(server, adapter)
         super
         self.adapter = adapter
       end
-      
+
       def do_GET(request, response)
         status, headers, body = *adapter.router.call(request)
         response.status = status