yard-slipstream 0.0.0 → 0.1.1

data/templates/default/fulldoc/html/json_search_index.erb

@@ -0,0 +1 @@
+<%= @json_search_index %>

data/templates/default/fulldoc/html/setup.rb

@@ -1,4 +1,5 @@
 include Helpers::ModuleHelper
+require 'json'
 
 def init
   options[:objects] = objects = run_verifier(options[:objects])
@@ -7,7 +8,7 @@ def init
   options[:title] ||= "Documentation by YARD #{YARD::VERSION}"
   
   generate_assets
-  serialize('_index.html')
+  serialize('object_index.html')
   options[:files].each_with_index do |file, i| 
     serialize_file(file, i == 0 ? options[:title] : nil) 
   end
@@ -28,7 +29,7 @@ end
 
 def serialize(object)
   options[:object] = object
-  serialize_index(options) if object == '_index.html' && options[:files].empty?
+  serialize_index(options) if object == 'object_index.html' && options[:files].empty?
   Templates::Engine.with_serializer(object, options[:serializer]) do
     T('layout').run(options)
   end
@@ -60,7 +61,7 @@ def asset(path, content)
 end
 
 def generate_assets
-  %w( js/jquery.js js/app.js js/full_list.js js/live.js js/autocomplete.js 
+  %w( js/jquery.js js/app.js js/full_list.js js/autocomplete.js js/live.js 
       css/style.css css/custom.css css/full_list.css css/common.css ).each do |file|
     asset(file, file(file, true))
   end
@@ -70,6 +71,7 @@ def generate_assets
   generate_class_list
   generate_file_list
   generate_frameset
+  generate_json_search_index
 end
 
 def generate_method_list
@@ -82,6 +84,7 @@ def generate_method_list
 end
 
 def generate_class_list
+  @items = options[:objects]
   @list_title = "Class List"
   @list_type = "class"
   asset('class_list.html', erb(:full_list))
@@ -96,6 +99,45 @@ def generate_file_list
   @file_list = nil
 end
 
+def generate_json_search_index
+  @search_index = []
+
+  @search_index << options[:files].map do |f|
+    {
+      :text => File.basename(f).gsub(/\.[^.]+$/, ''),
+      :href_tag => link_file(f)
+    }
+  end
+
+  @search_index << [
+    {
+      :text => "Top Level Namespace",
+      :href_tag => link_object(Registry.root, nil, nil, false)
+    }
+  ]
+
+  @search_index << options[:objects].map do |o|
+    {
+      :text => o,
+      :href_tag => link_object(o)
+    }
+  end
+
+  method_listing = prune_method_listing(Registry.all(:method), false)
+  method_listing = method_listing.reject {|m| m.name.to_s =~ /=$/ && m.is_attribute? }
+  method_listing = method_listing.sort_by {|m| m.name.to_s }
+  @search_index << method_listing.map do |m|
+    {
+      :text => m,
+      :href_tag => linkify(m,m.name(true))
+    }
+  end
+
+  @search_index.flatten!
+  @json_search_index = JSON.dump(@search_index)
+  asset('search_index.json', erb(:json_search_index))
+end
+
 def generate_frameset
   asset('frames.html', erb(:frames))
 end
@@ -104,8 +146,7 @@ def class_list(root = Registry.root)
   out = ""
   children = run_verifier(root.children)
   if root == Registry.root
-    children += Registry.all(:class, :module).select {|o| o.namespace.is_a?(CodeObjects::Proxy) }
-    children = run_verifier(children)
+    children += @items.select {|o| o.namespace.is_a?(CodeObjects::Proxy) }
   end
   children.sort_by {|child| child.path }.map do |child|
     if child.is_a?(CodeObjects::NamespaceObject)

data/templates/default/layout/html/breadcrumb.erb

@@ -0,0 +1,18 @@
+<div id="menu">
+  <% if object.is_a?(CodeObjects::Base) && @file.nil? %>
+    <a href="<%= url_for('object_index.html') %>"><% if object.root? || object.type == :method %>Index<% else %>Index (<%= object.name.to_s[0,1] %>)<% 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>
+  <% else %>
+    <% if object != 'object_index.html' %><%= link_url('object_index.html', 'Index') %> &raquo; <% end %>
+    <span class="title"><%= @breadcrumb_title %></span>
+  <% end %>
+  
+  <div class="noframes">
+    <span class="title"></span>
+    <a id="frames_link" class="link_disabled">Frames</a> | 
+    <a target="_top" id="noframes_link" class="link_disabled">No Frames</a>
+    <span class="title"></span>
+  </div>
+</div>

data/templates/default/layout/html/footer.erb

@@ -0,0 +1,7 @@
+<div id="footer">
+  Generated on <%= Time.now.strftime("%c") %> by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+  <%= YARD::VERSION %>  and the 
+  <a href="http://github.com/dreamcat4/yard-slipstream">yard-slipstream</a> plugin
+	(ruby-<%= RUBY_VERSION %>).
+</div>

data/templates/default/layout/html/headers.erb

@@ -1,6 +1,7 @@
 <meta name="Content-Type" content="text/html; charset=<%= charset %>" />
 <title><%= @page_title %></title>
 <link rel="stylesheet" href="<%= url_for("css/style.css") %>" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="<%= url_for("css/common.css") %>" type="text/css" media="screen" charset="utf-8" />
 <link rel="stylesheet" href="<%= url_for("css/custom.css") %>" type="text/css" media="screen" charset="utf-8" />
 <% if @extra_css %>
   <link rel="stylesheet" href="<%= url_for @extra_css %>" type="text/css" media="screen" charset="utf-8" />

data/templates/default/layout/html/index.erb

@@ -16,7 +16,7 @@
 
   <h2>Namespace Listing A-Z</h2>
   
-   <ul class="toplevel"><li><%= linkify(Registry.root) %></li></ul>
+  <ul class="toplevel" id="files_ribbon"><li class="r1"><%= linkify(Registry.root) %></li></ul>
 
   <% i = 0 %>
   <table>

data/templates/default/layout/html/search.erb

@@ -1,27 +1,27 @@
 <div id="search2">
   <% @yardoc_org = "http://yardoc.org" %>
   <% @project = "yard" %>
-  <form class="search2" method="get" action="<%= @yardoc_org %>/search/<%= @project %>"> 
-    Search: <input name="q" type="search" placeholder="Search" id="search_box2" size="30" value="" /> 
-  </form> 
+  <div class="search2_center">
+    <form class="search2" onsubmit="return false;" action="">
+      <input name="q" type="search" placeholder="Search" id="search_box2" size="30" value="" />
+    </form>
+  </div>
   <script type="text/javascript" charset="utf-8"> 
-    $('#search_box2').autocomplete('<%= @yardoc_org %>/search/<%= @project %>', {
-      width: 340,
-      formatItem: function(item) {
-        var values = item[0].split(",");
-        return values[0] + (values[1] == '' ? "" : " <small>(" + values[1] + ")</small>");
+    $('#search_box2').focus(function(){
+      var search_index = relpath + 'search_index.json';
+      jQuery.getJSON(search_index, go_data);
+
+      function go_data(adata) {
+        $('#search_box2').autocomplete(adata, {
+          width: 300,
+          matchContains: true,
+          formatItem: function(item) {
+            return item.text;
+          }
+        }).result(function(event, item) {
+          location.href = relpath + $(item.href_tag).attr("href");
+        });
       }
-    }).result(function(event, item) {
-      var values = item[0].split(",")
-      $('#search_box2').val(values[1]);
-      location.href = values[3];
-      return false;
     });
   </script> 
-  <style> 
-    .frames form.search2 { position: absolute; right: 14px; top: -6px; padding-top: 10px; }
-    .frames #menu .noframes { float: none; }
-    .frames #menu { float: left; }
-    .frames #content h1 { margin-top: 15px; }
-  </style> 
 </div>

data/templates/default/layout/html/setup.rb

@@ -0,0 +1,69 @@
+def init
+  @breadcrumb = []
+
+  if @file
+    @contents = File.read_binary(@file)
+    @file = File.basename(@file)
+    @fname = @file.gsub(/\.[^.]+$/, '')
+    @breadcrumb_title = "File: " + @fname
+    @page_title ||= @breadcrumb_title
+    sections :layout, [:diskfile]
+  elsif object
+    case object
+    when 'object_index.html'
+      @page_title = options[:title]
+      sections :layout, [:index]
+    when CodeObjects::Base
+      unless object.root?
+        cur = object.namespace
+        while !cur.root?
+          @breadcrumb.unshift(cur)
+          cur = cur.namespace
+        end
+      end
+    
+      @page_title = format_object_title(object)
+      type = object.root? ? :module : object.type
+      sections :layout, [T(type)]
+    end
+  else
+    sections :layout, [:contents]
+  end
+end
+
+def contents
+  @contents
+end
+
+def index
+  @objects_by_letter = {}
+  objects = @objects.reject {|o| o.root? }.sort_by {|o| o.name.to_s }
+  objects.each {|o| (@objects_by_letter[o.name.to_s[0,1].upcase] ||= []) << o }
+  erb(:index)
+end
+
+def diskfile
+  "<div id='filecontents'>" +
+  case (File.extname(@file)[1..-1] || '').downcase
+  when 'htm', 'html'
+    @contents
+  when 'txt'
+    "<pre>#{@contents}</pre>"
+  when 'textile', 'txtile'
+    htmlify(@contents, :textile)
+  when 'markdown', 'md', 'mdown', 'mkd'
+    htmlify(@contents, :markdown)
+  else
+    htmlify(@contents, diskfile_shebang_or_default)
+  end +
+  "</div>"
+end
+
+def diskfile_shebang_or_default
+  if @contents =~ /\A#!(\S+)\s*$/ # Shebang support
+    @contents = $'
+    $1.to_sym
+  else
+    options[:markup]
+  end
+end

data/templates/default/method_details/html/header.erb

@@ -0,0 +1,3 @@
+<div class="method_details <%= @index == 0 ? 'first' : '' %>" id="<%= anchor_for(object) %>">
+  <%= yieldall %>
+</div>

data/templates/default/method_details/html/method_signature.erb

@@ -0,0 +1,18 @@
+<p class="signature <%= 'first' if @index == 0 %>"">
+  <% if object.tags(:overload).size == 1 %>
+    <%= signature(object.tag(:overload), false) %>
+  <% elsif object.tags(:overload).size > 1 %>
+    <% object.tags(:overload).each do |overload| %>
+      <span class="overload"><%= signature(overload, false) %></span>
+    <% end %>
+  <% else %>
+    <%= signature(object, false) %>
+  <% end %>
+
+  <% if object.aliases.size > 0 %>
+    <span class="aliases">Also known as:
+    <span class="names"><%= object.aliases.map {|o| 
+      "<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
+    </span>
+  <% end %>
+</p>

data/templates/default/module/html/attribute_details.erb

@@ -0,0 +1,8 @@
+<% scopes(attr_listing) do |list, scope| %>
+  <div id="<%= scope %>_attr_details" class="attr_details">
+    <h2><%= scope.to_s.capitalize %> Attribute Details</h2>
+    <% list.each_with_index do |meth, i| %>
+      <%= yieldall :object => meth, :index => i %>
+    <% end %>
+  </div>
+<% end %>

data/templates/default/module/html/box_info.erb

@@ -24,6 +24,11 @@
         <% n = n == 2 ? 1 : 2 %>
       <% end %>
     <% end %>
+  <% if (mixed_into = mixed_into(object)).size > 0 %>
+    <dt class="r<%=n%>">Included in:</dt>
+    <dd class="r<%=n%>"><%= mixed_into.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
+    <% n = n == 2 ? 1 : 2 %>
+  <% end %>
     <% unless object.root? %>
       <dt class="r<%=n%> last">Defined in:</dt>
       <dd class="r<%=n%> last"><%= erb(:defines) %></dd>

data/templates/default/module/html/children.erb

@@ -0,0 +1,14 @@
+<p class="children">
+  <% @inner.each do |name, list| %> 
+    <% if list.size > 0 %>
+			<h3 class="inherited"><%= name.to_s.capitalize %></h3>
+	    <ul id="<%= name %>_ribbon">
+	    <% n = 1 %>
+	    <% list.each do |child| %>
+	      <li class="r<%= n %>"><%= linkify(child,child.name) %></li>
+	      <% n = n == 2 ? 1 : 2 %>
+	    <% end %>
+	    </ul>
+    <% end %>
+  <% end %>
+</p>

data/templates/default/module/setup.rb

@@ -2,14 +2,14 @@ include Helpers::ModuleHelper
 
 def init
   sections \
-    :box_info, 
     :header, 
+    :box_info, 
     :children, 
     :local_methods,
     :inherited_methods,
     # :method_summary, [:item_summary], 
     :pre_docstring, T('docstring'), 
-    :constant_summary, :inherited_constants, 
+    :constant_summary, [T('docstring')], :inherited_constants, 
     :attribute_summary, [:item_summary], 
     :methodmissing, [T('method_details')],
     # :attribute_details, [T('method_details')], 
@@ -79,7 +79,7 @@ def sort_listing(list)
   list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
 end
 
-def docstring_summary(obj)
+def docstring_full(obj)
   docstring = ""
   if obj.tags(:overload).size == 1 && obj.docstring.empty?
     docstring = obj.tag(:overload).docstring
@@ -91,7 +91,11 @@ def docstring_summary(obj)
     docstring = Docstring.new(obj.tag(:return).text.gsub(/\A([a-z])/) {|x| x.upcase }.strip)
   end
 
-  docstring.summary
+  docstring
+end
+
+def docstring_summary(obj)
+  docstring_full(obj).summary
 end
 
 def scopes(list)

data/yard-slipstream.gemspec

@@ -0,0 +1,94 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yard-slipstream}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dreamcat4"]
+  s.date = %q{2010-04-10}
+  s.description = %q{yard-slipstream is a yard plugin for Yard-0.5.3 and higher. Slipstream gives users an option for faster page navigation in their yard documents. We just want to optimize the most frequent lookups and remove any duplicate info. Other than that its just plain straight Yard, with all the same "look and feel" as the default template.}
+  s.email = %q{dreamcat4@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".gitignore",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "features/step_definitions/yard-slipstream_steps.rb",
+    "features/support/env.rb",
+    "features/yard-slipstream.feature",
+    "lib/yard-slipstream.rb",
+    "lib/yard-slipstream/handler.rb",
+    "lib/yard-slipstream/legacy.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/yard-slipstream_spec.rb",
+    "templates/default/class/html/subclasses.erb",
+    "templates/default/fulldoc/html/css/custom.css",
+    "templates/default/fulldoc/html/css/style.css",
+    "templates/default/fulldoc/html/js/app.js",
+    "templates/default/fulldoc/html/js/autocomplete.js",
+    "templates/default/fulldoc/html/js/live.js",
+    "templates/default/fulldoc/html/json_search_index.erb",
+    "templates/default/fulldoc/html/setup.rb",
+    "templates/default/layout/html/breadcrumb.erb",
+    "templates/default/layout/html/footer.erb",
+    "templates/default/layout/html/headers.erb",
+    "templates/default/layout/html/index.erb",
+    "templates/default/layout/html/search.erb",
+    "templates/default/layout/html/setup.rb",
+    "templates/default/method_details/html/header.erb",
+    "templates/default/method_details/html/method_signature.erb",
+    "templates/default/module/html/attribute_details.erb",
+    "templates/default/module/html/attribute_summary.erb",
+    "templates/default/module/html/box_info.erb",
+    "templates/default/module/html/children.erb",
+    "templates/default/module/html/local_methods.erb",
+    "templates/default/module/setup.rb",
+    "yard-slipstream.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dreamcat4/yard-slipstream}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Streamlined Navigation for the default yard template}
+  s.test_files = [
+    "spec/spec_helper.rb",
+    "spec/yard-slipstream_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<yard>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+    else
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+  end
+end
+