yard-slipstream 0.1.2 → 0.1.3

data/.gitignore

@@ -16,6 +16,8 @@ tmtags
 ## PROJECT::GENERAL
 coverage
 rdoc
+doc
+.yardoc
 pkg
 
 ## PROJECT::SPECIFIC

data/Rakefile

@@ -49,11 +49,19 @@ end
 
 task :default => :spec
 
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
-  end
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.after = lambda { `touch doc/.nojekyll` }
+end
+
+Jeweler::GhpagesTasks.new do |ghpages|
+  ghpages.push_on_release   = true
+  ghpages.set_repo_homepage = true
+  ghpages.user_github_com   = false
+  ghpages.doc_task    = "yard"
+  ghpages.keep_files  = []
+  ghpages.map_paths   = {
+    ".nojekyll" => "",
+    "doc" => "",
+  }
 end

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/yard-slipstream.rb

@@ -1,5 +1,26 @@
 dir = File.dirname(__FILE__)
 $LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
 
+require 'rubygems'
+require 'yard/core_ext/symbol_hash'
+require 'yard/templates/helpers/html_helper'
+
+module YARD
+  module Templates
+    module Helpers
+      module HtmlHelper
+        def link_url(url, title = nil, params = {})
+          params = SymbolHash.new(false).update(
+            :href => url,
+            :title  => h(title || url),
+            :target => "_self"
+          ).update(params)
+          "<a #{tag_attrs(params)}>#{title}</a>"
+        end
+      end
+    end
+  end
+end
+
 YARD::Templates::Engine.register_template_path dir + '/../templates'
 

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

@@ -20,7 +20,7 @@
 		window.onload = frame_saver;
 	</script>
 </head>
-<frameset cols="20%,*">
+<frameset cols="20%,*" border="1" bordercolor="CCC">
   <frame name="list" src="class_list.html" />
   <frame name="main" />
 </frameset>

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

@@ -18,7 +18,7 @@ function createDefineLinks() {
         tHeight = $(this).parent().prev().height();
         $(this).prev().show();
         $(this).parent().prev().height($(this).parent().height());
-        $(this).text("(less)");
+        $(this).text("...less");
     },
     function() {
         $(this).prev().hide();

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

@@ -1,6 +1,10 @@
 <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; 
+		<% if object.root? || object.type == :method %>
+			<%= link_url('object_index.html', 'Index') %>
+		<% else %>
+			<%= link_url('object_index.html', "Index (#{object.name.to_s[0,1]})") %>
+		<% end %> &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>

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

@@ -10,6 +10,7 @@
   relpath = '<%= url_for('') %>';
   if (relpath != '') relpath += '/';
 </script>
+<base id="base_target" target="_top" />
 <script type="text/javascript" charset="utf-8" src="<%= url_for("js/jquery.js") %>"></script>
 <script type="text/javascript" charset="utf-8" src="<%= url_for("js/autocomplete.js") %>"></script>
 <script type="text/javascript" charset="utf-8" src="<%= url_for("js/app.js") %>"></script>

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

@@ -1,22 +1,6 @@
 <% n = 1 %>
 <div id="info_box">
   <dl class="box">
-    <!-- <% if CodeObjects::ClassObject === object && object.superclass %>
-      <dt class="r<%=n%>">Inherits:</dt>
-      <dd class="r<%=n%>">
-        <span class="inheritName"><%= linkify object.superclass %></span>
-        <% if object.superclass.name != :BasicObject %>
-          <ul class="fullTree">
-            <li><%= linkify P(:Object) %></li>
-            <% object.inheritance_tree.reverse.each_with_index do |obj, i| %>
-              <li class="next"><%= obj == object ? obj.path : linkify(obj) %></li>
-            <% end %>
-          </ul>
-          <a href="#" class="inheritanceTree">show all</a>
-        <% end %>
-        </dd>
-      <% n = 2 %>
-    <% end %> -->
     <% [[:class, "Extends"], [:instance, "Includes"]].each do |scope, name| %>
       <% if (mix = object.mixins(scope)).size > 0 %>
         <dt class="r<%=n%>"><%= name %>:</dt>
@@ -29,10 +13,10 @@
     <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>
-    <% end %>
+    <dt class="r<%=n%> last">Defined in:</dt>
+		<dd class="r<%=n%> last">
+  		<%= erb(:defines) %>
+		</dd>
   </dl>
 </div>
 <div class="clear"></div>

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

@@ -0,0 +1,8 @@
+<% if object.root? %>
+		<%= child_files[0].first %><% if child_files.size > 1 %><span class="defines">,<br />
+		<%= child_files[1..-1].map {|f| f.first }.join(",<br /> ") %></span><% end %>
+<% else %>
+  <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
+    <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></span>
+  <% else %><span class="defines">,<br /></span><% end %>
+<% end %>

data/templates/default/module/setup.rb

@@ -16,6 +16,24 @@ def init
     :method_details_list, [T('method_details')]
 end
 
+def uniq_by(array, &blk)
+  require 'set'
+  result = []
+  values = Set.new
+  array.each do |elem|
+    value = yield elem
+    unless values.include? value
+      values << value
+      result << elem
+    end
+  end
+  result
+end
+
+def child_files
+  @child_files ||= uniq_by(object.children.map { |child| child.files }.flatten(1)) {|f| f.first}
+end
+
 def localmethods(include_specials = true)
   method_listing(include_specials)
 end

data/yard-slipstream.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{yard-slipstream}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   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.date = %q{2010-04-11}
   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 = [
@@ -53,6 +53,7 @@ Gem::Specification.new do |s|
     "templates/default/module/html/attribute_summary.erb",
     "templates/default/module/html/box_info.erb",
     "templates/default/module/html/children.erb",
+    "templates/default/module/html/defines.erb",
     "templates/default/module/html/local_methods.erb",
     "templates/default/module/setup.rb",
     "yard-slipstream.gemspec"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Dreamcat4
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-10 00:00:00 +01:00
+date: 2010-04-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -125,6 +125,7 @@ files:
 - templates/default/module/html/attribute_summary.erb
 - templates/default/module/html/box_info.erb
 - templates/default/module/html/children.erb
+- templates/default/module/html/defines.erb
 - templates/default/module/html/local_methods.erb
 - templates/default/module/setup.rb
 - yard-slipstream.gemspec