rdoc 4.0.1 → 4.1.0.preview.3

data/lib/rdoc/comment.rb

@@ -118,9 +118,6 @@ class RDoc::Comment
       seq.gsub!(/^\s*/, '')
       method.call_seq = seq
     end
-    #elsif @text.sub!(/\A\/\*\s*call-seq:(.*?)\*\/\Z/, '') then
-    #  method.call_seq = $1.strip
-    #end
 
     method
   end

data/lib/rdoc/constant.rb

@@ -63,7 +63,15 @@ class RDoc::Constant < RDoc::CodeObject
   # for a documented class or module.
 
   def documented?
-    super or is_alias_for && is_alias_for.documented?
+    return true if super
+    return false unless @is_alias_for
+    case @is_alias_for
+    when String then
+      found = @store.find_class_or_module @is_alias_for
+      return false unless found
+      @is_alias_for = found
+    end
+    @is_alias_for.documented?
   end
 
   ##

data/lib/rdoc/context.rb

@@ -167,6 +167,24 @@ class RDoc::Context < RDoc::CodeObject
     full_name <=> other.full_name
   end
 
+  ##
+  # Adds an item of type +klass+ with the given +name+ and +comment+ to the
+  # context.
+  #
+  # Currently only RDoc::Extend and RDoc::Include are supported.
+
+  def add klass, name, comment
+    if RDoc::Extend == klass then
+      ext = RDoc::Extend.new name, comment
+      add_extend ext
+    elsif RDoc::Include == klass then
+      incl = RDoc::Include.new name, comment
+      add_include incl
+    else
+      raise NotImplementedError, "adding a #{klass} is not implemented"
+    end
+  end
+
   ##
   # Adds +an_alias+ that is automatically resolved
 
@@ -1041,8 +1059,8 @@ class RDoc::Context < RDoc::CodeObject
   #--
   # TODO mark the visibility of attributes in the template (if not public?)
 
-  def remove_invisible(min_visibility)
-    return if min_visibility == :private
+  def remove_invisible min_visibility
+    return if [:private, :nodoc].include? min_visibility
     remove_invisible_in @method_list, min_visibility
     remove_invisible_in @attributes, min_visibility
   end

data/lib/rdoc/cross_reference.rb

@@ -18,7 +18,7 @@ class RDoc::CrossReference
   #
   # See CLASS_REGEXP_STR
 
-  METHOD_REGEXP_STR = '([a-z]\w*[!?=]?|%|===)(?:\([\w.+*/=<>-]*\))?'
+  METHOD_REGEXP_STR = '([a-z]\w*[!?=]?|%|===|\[\]=?|<<|>>)(?:\([\w.+*/=<>-]*\))?'
 
   ##
   # Regular expressions matching text that should potentially have

data/lib/rdoc/extend.rb

@@ -1,117 +1,9 @@
 ##
-# A Module extension in a class with \#extend
+# A Module extension to a class with \#extend
+#
+#   RDoc::Extend.new 'Enumerable', 'comment ...'
 
-class RDoc::Extend < RDoc::CodeObject
-
-  ##
-  # Name of extension module
-
-  attr_accessor :name
-
-  ##
-  # Creates a new Extend for +name+ with +comment+
-
-  def initialize(name, comment)
-    super()
-    @name = name
-    self.comment = comment
-    @module = nil # cache for module if found
-  end
-
-  ##
-  # Extends are sorted by name
-
-  def <=> other
-    return unless self.class === other
-
-    name <=> other.name
-  end
-
-  def == other # :nodoc:
-    self.class === other and @name == other.name
-  end
-
-  alias eql? ==
-
-  ##
-  # Full name based on #module
-
-  def full_name
-    m = self.module
-    RDoc::ClassModule === m ? m.full_name : @name
-  end
-
-  def hash # :nodoc:
-    [@name, self.module].hash
-  end
-
-  def inspect # :nodoc:
-    "#<%s:0x%x %s.extend %s>" % [
-      self.class,
-      object_id,
-      parent_name, @name,
-    ]
-  end
-
-  ##
-  # Attempts to locate the extend module object.  Returns the name if not
-  # known.
-  #
-  # The scoping rules of Ruby to resolve the name of an extension module are:
-  # - first look into the children of the current context;
-  # - if not found, look into the children of extension modules,
-  #   in reverse extend order;
-  # - if still not found, go up the hierarchy of names.
-  #
-  # This method has <code>O(n!)</code> behavior when the module calling
-  # extend is referencing nonexistent modules.  Avoid calling #module until
-  # after all the files are parsed.  This behavior is due to ruby's constant
-  # lookup behavior.
-
-  def module
-    return @module if @module
-
-    # search the current context
-    return @name unless parent
-    full_name = parent.child_name(@name)
-    @module = @store.modules_hash[full_name]
-    return @module if @module
-    return @name if @name =~ /^::/
-
-    # search the includes before this one, in reverse order
-    searched = parent.extends.take_while { |i| i != self }.reverse
-    searched.each do |i|
-      ext = i.module
-      next if String === ext
-      full_name = ext.child_name(@name)
-      @module = @store.modules_hash[full_name]
-      return @module if @module
-    end
-
-    # go up the hierarchy of names
-    up = parent.parent
-    while up
-      full_name = up.child_name(@name)
-      @module = @store.modules_hash[full_name]
-      return @module if @module
-      up = up.parent
-    end
-
-    @name
-  end
-
-  ##
-  # Sets the store for this class or module and its contained code objects.
-
-  def store= store
-    super
-
-    @file = @store.add_file @file.full_name if @file
-  end
-
-  def to_s # :nodoc:
-    "extend #@name in: #{parent}"
-  end
+class RDoc::Extend < RDoc::Mixin
 
 end
 

data/lib/rdoc/generator/darkfish.rb

@@ -57,6 +57,21 @@ class RDoc::Generator::Darkfish
 
   include ERB::Util
 
+  ##
+  # Stylesheets, fonts, etc. that are included in RDoc.
+
+  BUILTIN_STYLE_ITEMS = # :nodoc:
+    %w[
+      fonts.css
+      fonts/Lato-Light.ttf
+      fonts/Lato-LightItalic.ttf
+      fonts/Lato-Regular.ttf
+      fonts/Lato-RegularItalic.ttf
+      fonts/SourceCodePro-Bold.ttf
+      fonts/SourceCodePro-Regular.ttf
+      rdoc.css
+  ]
+
   ##
   # Path to this file's parent directory. Used to find templates and other
   # resources.
@@ -127,6 +142,11 @@ class RDoc::Generator::Darkfish
 
   attr_reader :store
 
+  ##
+  # The directory where the template files live
+
+  attr_reader :template_dir # :nodoc:
+
   ##
   # The output directory
 
@@ -195,7 +215,13 @@ class RDoc::Generator::Darkfish
     debug_msg "Copying static files"
     options = { :verbose => $DEBUG_RDOC, :noop => @dry_run }
 
-    FileUtils.cp @template_dir + 'rdoc.css', '.', options
+    BUILTIN_STYLE_ITEMS.each do |item|
+      install_rdoc_static_file @template_dir + item, "./#{item}", options
+    end
+
+    @options.template_stylesheets.each do |stylesheet|
+      FileUtils.cp stylesheet, '.', options
+    end
 
     Dir[(@template_dir + "{js,images}/**/*").to_s].each do |path|
       next if File.directory? path
@@ -203,11 +229,7 @@ class RDoc::Generator::Darkfish
 
       dst = Pathname.new(path).relative_path_from @template_dir
 
-      # I suck at glob
-      dst_dir = dst.dirname
-      FileUtils.mkdir_p dst_dir, options unless File.exist? dst_dir
-
-      FileUtils.cp @template_dir + path, dst, options
+      install_rdoc_static_file @template_dir + path, dst, options
     end
   end
 
@@ -447,7 +469,7 @@ class RDoc::Generator::Darkfish
   ##
   # Generates the 404 page for the RDoc servlet
 
-  def generate_servlet_not_found path
+  def generate_servlet_not_found message
     setup
 
     template_file = @template_dir + 'servlet_not_found.rhtml'
@@ -530,6 +552,23 @@ class RDoc::Generator::Darkfish
     raise error
   end
 
+  def install_rdoc_static_file source, destination, options # :nodoc:
+    return unless source.exist?
+
+    begin
+      FileUtils.mkdir_p File.dirname(destination), options
+
+      begin
+        FileUtils.ln source, destination, options
+      rescue Errno::EEXIST
+        FileUtils.rm destination
+        retry
+      end
+    rescue
+      FileUtils.cp source, destination, options
+    end
+  end
+
   ##
   # Prepares for generation of output from the current directory
 

data/lib/rdoc/generator/template/darkfish/_footer.rhtml

@@ -1,5 +1,5 @@
-<footer id="validator-badges">
-  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
-  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> <%= RDoc::VERSION %>.
-  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> <%= RDoc::Generator::Darkfish::VERSION %>.
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> <%= RDoc::VERSION %>.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
 </footer>

data/lib/rdoc/generator/template/darkfish/_head.rhtml

@@ -1,16 +1,22 @@
-<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type">
+<meta charset="<%= @options.charset %>">
 
 <title><%= h @title %></title>
 
-<link type="text/css" media="screen" href="<%= asset_rel_prefix %>/rdoc.css" rel="stylesheet">
+<link href="<%= asset_rel_prefix %>/fonts.css" rel="stylesheet">
+<link href="<%= asset_rel_prefix %>/rdoc.css" rel="stylesheet">
+<% if @options.template_stylesheets.flatten.any? then %>
+<%   @options.template_stylesheets.flatten.each do |stylesheet| %>
+<link href="<%= asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
+<%   end %>
+<% end %>
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "<%= rel_prefix %>/";
 </script>
 
-<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="<%= search_index_rel_prefix %>/js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/darkfish.js"></script>
+<script src="<%= asset_rel_prefix %>/js/jquery.js"></script>
+<script src="<%= asset_rel_prefix %>/js/navigation.js"></script>
+<script src="<%= search_index_rel_prefix %>/js/search_index.js"></script>
+<script src="<%= asset_rel_prefix %>/js/search.js"></script>
+<script src="<%= asset_rel_prefix %>/js/searcher.js"></script>
+<script src="<%= asset_rel_prefix %>/js/darkfish.js"></script>

data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml

@@ -1,6 +1,7 @@
 <% if !svninfo.empty? then %>
-<nav id="file-svninfo-section" class="section">
-  <h3 class="section-header">VCS Info</h3>
+<div id="file-svninfo-section" class="nav-section">
+  <h3>VCS Info</h3>
+
   <div class="section-body">
     <dl class="svninfo">
       <dt>Rev
@@ -14,5 +15,5 @@
       <dd><%= svninfo[:committer] %>
     </dl>
   </div>
-</nav>
+</div>
 <% end %>

data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml

@@ -1,9 +1,9 @@
-<nav id="classindex-section" class="section project-section">
-  <h3 class="section-header">Class and Module Index</h3>
+<div id="classindex-section" class="nav-section">
+  <h3>Class and Module Index</h3>
 
   <ul class="link-list">
   <% @modsort.each do |index_klass| %>
     <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a>
   <% end %>
   </ul>
-</nav>
+</div>

data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml

@@ -1,7 +1,6 @@
 <% unless klass.extends.empty? then %>
-<!-- Extension Modules -->
-<nav id="extends-section" class="section">
-  <h3 class="section-header">Extended With Modules</h3>
+<div id="extends-section" class="nav-section">
+  <h3>Extended With Modules</h3>
 
   <ul class="link-list">
     <% klass.each_extend do |ext| %>
@@ -12,5 +11,5 @@
   <% end %>
   <% end %>
   </ul>
-</nav>
+</div>
 <% end %>

data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml

@@ -1,8 +1,9 @@
-<nav id="file-list-section" class="section">
-  <h3 class="section-header">Defined In</h3>
+<div id="file-list-section" class="nav-section">
+  <h3>Defined In</h3>
+
   <ul>
 <% klass.in_files.each do |tl| %>
     <li><%= h tl.relative_name %>
 <% end %>
   </ul>
-</nav>
+</div>

data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml

@@ -1,7 +1,6 @@
 <% unless klass.includes.empty? then %>
-<!-- Included Modules -->
-<nav id="includes-section" class="section">
-  <h3 class="section-header">Included Modules</h3>
+<div id="includes-section" class="nav-section">
+  <h3>Included Modules</h3>
 
   <ul class="link-list">
   <% klass.each_include do |inc| %>
@@ -12,5 +11,5 @@
   <% end %>
   <% end %>
   </ul>
-</nav>
+</div>
 <% end %>

data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml

@@ -1,5 +1,5 @@
-<nav id="home-section" class="section">
-  <h3 class="section-header">Documentation</h3>
+<div id="home-section" class="nav-section">
+  <h3>Documentation</h3>
 
   <ul>
   <% installed.each do |name, href, exists, type, _| %>
@@ -12,4 +12,4 @@
     <% end %>
   <% end %>
   </ul>
-</nav>
+</div>

data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml

@@ -1,12 +1,12 @@
 <% unless klass.method_list.empty? then %>
 <!-- Method Quickref -->
-<nav id="method-list-section" class="section">
-  <h3 class="section-header">Methods</h3>
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
 
-  <ul class="link-list">
+  <ul class="link-list" role="directory">
     <% klass.each_method do |meth| %>
     <li <% if meth.calls_super %>class="calls-super" <% end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name %></a>
     <% end %>
   </ul>
-</nav>
+</div>
 <% end %>

data/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml

@@ -1,7 +1,11 @@
-<nav id="home-section" class="section">
-  <h3 class="section-header">
-    <a href="<%= rel_prefix %>/index.html">Home</a>
+<div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="<%= rel_prefix %>/index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="<%= rel_prefix %>/table_of_contents.html#pages">Pages</a>
     <a href="<%= rel_prefix %>/table_of_contents.html#classes">Classes</a>
     <a href="<%= rel_prefix %>/table_of_contents.html#methods">Methods</a>
-  </h3>
-</nav>
+  </div>
+</div>