emerald 0.0.1.alpha2 → 0.0.1.alpha3

data/VERSION

@@ -1 +1 @@
-0.0.1-alpha2
+0.0.1-alpha3

data/data/templates/classmodule.html.erb

@@ -4,10 +4,11 @@
 <% else %>
   <h1 class="classmodule"><span class="leader">Class</span> <%= classmod.full_name %></h1>
   <p class="superclass">
-    <% if classmod.superclass.kind_of?(String) %>
-      Parent: <%= classmod.superclass %>
+    <% klass = classmod.superclass %>
+    <% if klass.kind_of?(String) %>
+      Parent: <%= klass %>
     <% else %>
-      Parent: <a href="<%= root_path + rdocize_classmod(classmod.superclass) %>"><%= classmod.superclass.full_name %></a>
+      Parent: <a href="<%= root_path + rdocize_classmod(klass) %>"><%= klass.full_name %></a>
     <% end %>
   </p>
 <% end %>
@@ -34,7 +35,7 @@
 <% unless classmod.includes.empty? %>
   <h2 id="includes">Includes</h2>
   <ul>
-    <% classmod.includes.sort_by(&:name).each do |inc| %>
+    <% classmod.includes.each do |inc| %>
       <li>
         <% result = inc.module %>
         <% if result.kind_of?(String) %>
@@ -52,8 +53,8 @@
   <h2 id="constants">Constants</h2>
   <table class="constants">
     <tr><th>Name</th><th>Value</th><th>Description</th></tr>
-    <% classmod.constants.each do |const| %>
-      <% abbrev_value = const.value.chars.count > 20 ? const.value.chars.first(20).join + "..." : const.value %>
+    <% classmod.constants.sort_by(&:name).each do |const| %>
+      <% abbrev_value = const.value.chars.count > 20 ? "#{const.value.chars.first(20).join}..." : const.value %>
       <tr><td><%= const.name %></td><td style="font-family: monospace"><%= abbrev_value %></td><td><%= const.description %></td></tr>
     <% end %>
   </table>
@@ -63,7 +64,7 @@
 <% unless classmod.attributes.empty? %>
   <h2 id="attributes">Attributes</h2>
   <ul class="attribute-list">
-    <% classmod.attributes.sort_by(&:name).each do |attr| %>
+    <% classmod.attributes.each do |attr| %>
       <li><strong><%= "#{attr.name}<sup>[#{attr.rw}]</sup>" %></strong><br/><%= attr.description %></li>
     <% end %>
   </ul>
@@ -79,7 +80,7 @@
 
     <h2 id="<%= "#{visibility}-#{type}-methods" %>"><%= "#{visibility.capitalize} #{type.capitalize} Methods" %></h2>
 
-    <% methods_by_type[type][visibility].sort_by(&:name).each do |method| %>
+    <% methods_by_type[type][visibility].each do |method| %>
       <div class="method <%= "#{visibility}-#{type}" %>" id="<%= method.aref %>">
         <div class="header">
           <%= method.arglists.gsub("\n", "<br/>") %>

data/lib/rdoc/generator/emerald.rb

@@ -79,22 +79,6 @@ class RDoc::Generator::Emerald
     options.extend(RDoc::Generator::Emerald::Options)
   end
 
-  class << self
-
-    protected
-
-    # Protected foo.
-    def foo
-    end
-
-    private
-
-    # Private bar.
-    def bar
-    end
-
-  end
-
   # Instanciates this generator. Automatically called
   # by RDoc.
   # ==Parameter
@@ -105,7 +89,15 @@ class RDoc::Generator::Emerald
     @op_dir = Pathname.pwd.expand_path + @options.op_dir
   end
 
+  # Outputs a string on standard output, but only if RDoc
+  # was invoked with the <tt>--debug</tt> switch.
+  def debug(str)
+    puts(str) if $DEBUG_RDOC
+  end
+
+  # Main hook method called by RDoc, triggers the generation process.
   def generate(top_levels)
+    debug "Sorting classes, modules, and methods..."
     @toplevels = top_levels
     @classes_and_modules = RDoc::TopLevel.all_classes_and_modules.sort_by{|klass| klass.full_name}
     @methods = @classes_and_modules.map{|mod| mod.method_list}.flatten.sort
@@ -184,12 +176,13 @@ class RDoc::Generator::Emerald
   # done by RDoc’s crossref-HTML formatter are honoured. Note you
   # have to prepend #root_path to get a complete href.
   def rdocize_classmod(classmod)
-    Pathname.new(classmod.full_name.split("::").join("/") + ".html")
+    Pathname.new("#{classmod.full_name.split("::").join("/")}.html")
   end
 
   private
 
   def copy_base_files
+    debug "Copying base base files..."
     mkdir @op_dir + "stylesheets" unless File.directory?(@op_dir + "stylesheets")
 
     cp   Dir[DATA_DIR + "stylesheets" + "*.css"], @op_dir + "stylesheets"
@@ -199,6 +192,8 @@ class RDoc::Generator::Emerald
 
   def evaluate_toplevels
     @toplevels.each do |toplevel|
+      debug "Processing toplevel #{toplevel.name}..."
+
       root_path("../" * (toplevel.relative_name.split("/").count - 1)) # Last component is a filename
       title toplevel.relative_name
 
@@ -208,12 +203,15 @@ class RDoc::Generator::Emerald
 
       # Evaluate the actual file documentation
       File.open(path, "w") do |file|
+        debug  "  => #{path}"
         file.write(render(:toplevel, binding))
       end
 
       # If this toplevel is supposed to be the main file,
       # copy it’s content to the index.html file.
       if toplevel.relative_name == @options.main_page
+        debug "  => This is the main page. Writing index.html."
+
         root_path "./" # We *are* at the top here
 
         File.open(@op_dir + "index.html", "w") do |file|
@@ -225,6 +223,7 @@ class RDoc::Generator::Emerald
 
   def evaluate_classes_and_modules
     @classes_and_modules.each do |classmod|
+      debug "Processing class/module #{classmod.full_name} (#{classmod.method_list.count} methods)..."
 
       path = @op_dir + rdocize_classmod(classmod)
 
@@ -234,6 +233,7 @@ class RDoc::Generator::Emerald
 
 
       File.open(path, "w") do |file|
+        debug "  => #{path}"
         file.write(render(:classmodule, binding))
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emerald
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha2
+  version: 0.0.1.alpha3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-18 00:00:00.000000000 Z
+date: 2012-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -54,27 +54,27 @@ email: quintus@quintilianus.eu
 executables: []
 extensions: []
 extra_rdoc_files:
-- COPYING.rdoc
-- LEGAL.rdoc
-- CHANGELOG.rdoc
 - README.rdoc
+- CHANGELOG.rdoc
+- LEGAL.rdoc
+- COPYING.rdoc
 files:
-- lib/rdoc/discover.rb
-- lib/rdoc/generator/emerald/options.rb
 - lib/rdoc/generator/emerald.rb
-- COPYING.rdoc
-- LEGAL.rdoc
-- CHANGELOG.rdoc
+- lib/rdoc/generator/emerald/options.rb
+- lib/rdoc/discover.rb
 - README.rdoc
+- CHANGELOG.rdoc
+- LEGAL.rdoc
+- COPYING.rdoc
 - data/stylesheets/rdoc.css
-- data/javascripts/toc.js
 - data/javascripts/jquery.js
+- data/javascripts/toc.js
 - data/javascripts/emerald.js
 - data/images/zoom.png
 - data/images/tag_blue.png
-- data/templates/layout.html.erb
-- data/templates/classmodule.html.erb
 - data/templates/toplevel.html.erb
+- data/templates/classmodule.html.erb
+- data/templates/layout.html.erb
 - VERSION
 homepage: https://github.com/Quintus/emerald
 licenses: []