RubyGems - rdoc - Versions diffs - 6.7.0 → 6.8.1 - Mend

rdoc 6.7.0 → 6.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (64) hide show

checksums.yaml +4 -4
data/ExampleMarkdown.md +2 -0
data/ExampleRDoc.rdoc +2 -0
data/History.rdoc +64 -62
data/LICENSE.rdoc +2 -0
data/README.rdoc +13 -0
data/RI.md +842 -0
data/TODO.rdoc +8 -7
data/lib/rdoc/{alias.rb → code_object/alias.rb} +1 -1
data/lib/rdoc/{class_module.rb → code_object/class_module.rb} +54 -0
data/lib/rdoc/{method_attr.rb → code_object/method_attr.rb} +3 -3
data/lib/rdoc/{top_level.rb → code_object/top_level.rb} +4 -4
data/lib/rdoc/code_object.rb +6 -0
data/lib/rdoc/generator/darkfish.rb +45 -3
data/lib/rdoc/generator/pot/message_extractor.rb +1 -1
data/lib/rdoc/generator/pot/po_entry.rb +1 -1
data/lib/rdoc/generator/template/darkfish/_head.rhtml +23 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +20 -11
data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +3 -8
data/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml +3 -0
data/lib/rdoc/generator/template/darkfish/class.rhtml +69 -43
data/lib/rdoc/generator/template/darkfish/css/rdoc.css +367 -392
data/lib/rdoc/generator/template/darkfish/index.rhtml +7 -6
data/lib/rdoc/generator/template/darkfish/js/darkfish.js +18 -1
data/lib/rdoc/generator/template/darkfish/page.rhtml +5 -5
data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +10 -8
data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +5 -2
data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +11 -0
data/lib/rdoc/markdown.kpeg +1 -1
data/lib/rdoc/markdown.rb +21 -11
data/lib/rdoc/markup/attribute_manager.rb +2 -2
data/lib/rdoc/markup/pre_process.rb +9 -6
data/lib/rdoc/markup/to_bs.rb +1 -1
data/lib/rdoc/markup/to_rdoc.rb +4 -4
data/lib/rdoc/markup.rb +18 -13
data/lib/rdoc/options.rb +22 -5
data/lib/rdoc/parser/c.rb +1 -1
data/lib/rdoc/parser/changelog.rb +2 -2
data/lib/rdoc/parser/ripper_state_lex.rb +7 -305
data/lib/rdoc/parser/ruby.rb +15 -6
data/lib/rdoc/parser.rb +2 -1
data/lib/rdoc/rdoc.rb +3 -2
data/lib/rdoc/ri/driver.rb +10 -6
data/lib/rdoc/task.rb +2 -3
data/lib/rdoc/tom_doc.rb +1 -7
data/lib/rdoc/version.rb +1 -1
data/lib/rdoc.rb +22 -22
metadata +28 -24
data/RI.rdoc +0 -57
/data/lib/rdoc/{anon_class.rb → code_object/anon_class.rb} +0 -0
/data/lib/rdoc/{any_method.rb → code_object/any_method.rb} +0 -0
/data/lib/rdoc/{attr.rb → code_object/attr.rb} +0 -0
/data/lib/rdoc/{constant.rb → code_object/constant.rb} +0 -0
/data/lib/rdoc/{context → code_object/context}/section.rb +0 -0
/data/lib/rdoc/{context.rb → code_object/context.rb} +0 -0
/data/lib/rdoc/{extend.rb → code_object/extend.rb} +0 -0
/data/lib/rdoc/{ghost_method.rb → code_object/ghost_method.rb} +0 -0
/data/lib/rdoc/{include.rb → code_object/include.rb} +0 -0
/data/lib/rdoc/{meta_method.rb → code_object/meta_method.rb} +0 -0
/data/lib/rdoc/{mixin.rb → code_object/mixin.rb} +0 -0
/data/lib/rdoc/{normal_class.rb → code_object/normal_class.rb} +0 -0
/data/lib/rdoc/{normal_module.rb → code_object/normal_module.rb} +0 -0
/data/lib/rdoc/{require.rb → code_object/require.rb} +0 -0
/data/lib/rdoc/{single_class.rb → code_object/single_class.rb} +0 -0

data/lib/rdoc/generator/template/darkfish/index.rhtml CHANGED Viewed

@@ -1,15 +1,16 @@
 <body id="top" role="document" class="file">
-<nav role="navigation">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
   <div id="project-navigation">
     <%= render '_sidebar_navigation.rhtml' %>
     <%= render '_sidebar_search.rhtml' %>
   </div>
-  <div id="project-metadata">
-    <%= render '_sidebar_pages.rhtml' %>
-    <%= render '_sidebar_classes.rhtml' %>
-  </div>
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_sidebar_classes.rhtml' %>
+  <%= render '_footer.rhtml' %>
 </nav>
 <main role="main">

data/lib/rdoc/generator/template/darkfish/js/darkfish.js CHANGED Viewed

@@ -34,7 +34,7 @@ function showSource( e ) {
 };
 function hookSourceViews() {
-  document.querySelectorAll('.method-heading').forEach(function (codeObject) {
+  document.querySelectorAll('.method-source-toggle').forEach(function (codeObject) {
     codeObject.addEventListener('click', showSource);
   });
 };
@@ -90,8 +90,25 @@ function hookFocus() {
   });
 }
+function hookSidebar() {
+  var navigation = document.querySelector('#navigation');
+  var navigationToggle = document.querySelector('#navigation-toggle');
+  navigationToggle.addEventListener('click', function() {
+    navigation.hidden = !navigation.hidden;
+    navigationToggle.ariaExpanded = navigationToggle.ariaExpanded !== 'true';
+  });
+  var isSmallViewport = window.matchMedia("(max-width: 1024px)").matches;
+  if (isSmallViewport) {
+    navigation.hidden = true;
+    navigationToggle.ariaExpanded = false;
+  }
+}
 document.addEventListener('DOMContentLoaded', function() {
   hookSourceViews();
   hookSearch();
   hookFocus();
+  hookSidebar();
 });

data/lib/rdoc/generator/template/darkfish/page.rhtml CHANGED Viewed

@@ -1,18 +1,18 @@
 <body id="top" role="document" class="file">
-<nav role="navigation">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
   <div id="project-navigation">
     <%= render '_sidebar_navigation.rhtml' %>
     <%= render '_sidebar_search.rhtml' %>
   </div>
   <%= render '_sidebar_table_of_contents.rhtml' %>
+  <%= render '_sidebar_pages.rhtml' %>
-  <div id="project-metadata">
-    <%= render '_sidebar_pages.rhtml' %>
-  </div>
+  <%= render '_footer.rhtml' %>
 </nav>
 <main role="main" aria-label="Page <%=h file.full_name%>">
 <%= file.description %>
 </main>

data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml CHANGED Viewed

@@ -1,13 +1,16 @@
 <body role="document">
-<nav role="navigation">
-  <%= render '_sidebar_navigation.rhtml' %>
+<%= render '_sidebar_toggle.rhtml' %>
-  <%= render '_sidebar_search.rhtml' %>
-  <div id="project-metadata">
-    <%= render '_sidebar_pages.rhtml' %>
-    <%= render '_sidebar_classes.rhtml' %>
+<nav id="navigation" role="navigation">
+  <div id="project-navigation">
+    <%= render '_sidebar_navigation.rhtml' %>
+    <%= render '_sidebar_search.rhtml' %>
   </div>
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_sidebar_classes.rhtml' %>
+  <%= render '_footer.rhtml' %>
 </nav>
 <main role="main">
@@ -15,4 +18,3 @@
   <p><%= message %>
 </main>

data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml CHANGED Viewed

@@ -1,5 +1,7 @@
 <body role="document">
-<nav role="navigation">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
   <div id="project-navigation">
     <div id="home-section" class="nav-section">
       <h2>
@@ -10,7 +12,8 @@
     <%= render '_sidebar_search.rhtml' %>
   </div>
-<%= render '_sidebar_installed.rhtml' %>
+  <%= render '_sidebar_installed.rhtml' %>
+  <%= render '_footer.rhtml' %>
 </nav>
 <main role="main">

data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml CHANGED Viewed

@@ -1,4 +1,15 @@
 <body id="top" class="table-of-contents">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
+  <div id="project-navigation">
+    <%= render '_sidebar_navigation.rhtml' %>
+    <%= render '_sidebar_search.rhtml' %>
+  </div>
+  <%= render '_footer.rhtml' %>
+</nav>
 <main role="main">
 <h1 class="class"><%= h @title %></h1>

data/lib/rdoc/markdown.kpeg CHANGED Viewed

@@ -530,7 +530,7 @@ AtxInline = !@Newline !(@Sp /#*/ @Sp @Newline) Inline
 AtxStart =  < /\#{1,6}/ >
             { text.length }
-AtxHeading = AtxStart:s @Sp AtxInline+:a (@Sp /#*/ @Sp)?  @Newline
+AtxHeading = AtxStart:s @Spacechar+ AtxInline+:a (@Sp /#*/ @Sp)?  @Newline
             { RDoc::Markup::Heading.new(s, a.join) }
 SetextHeading = SetextHeading1 | SetextHeading2

data/lib/rdoc/markdown.rb CHANGED Viewed

@@ -1158,7 +1158,7 @@ class RDoc::Markdown
     return _tmp
   end
-  # AtxHeading = AtxStart:s @Sp AtxInline+:a (@Sp /#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) }
+  # AtxHeading = AtxStart:s @Spacechar+ AtxInline+:a (@Sp /#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) }
   def _AtxHeading
     _save = self.pos
@@ -1169,12 +1169,22 @@ class RDoc::Markdown
         self.pos = _save
         break
       end
-      _tmp = _Sp()
+      _save1 = self.pos
+      _tmp = _Spacechar()
+      if _tmp
+        while true
+          _tmp = _Spacechar()
+          break unless _tmp
+        end
+        _tmp = true
+      else
+        self.pos = _save1
+      end
       unless _tmp
         self.pos = _save
         break
       end
-      _save1 = self.pos
+      _save2 = self.pos
       _ary = []
       _tmp = apply(:_AtxInline)
       if _tmp
@@ -1187,37 +1197,37 @@ class RDoc::Markdown
         _tmp = true
         @result = _ary
       else
-        self.pos = _save1
+        self.pos = _save2
       end
       a = @result
       unless _tmp
         self.pos = _save
         break
       end
-      _save2 = self.pos
       _save3 = self.pos
+      _save4 = self.pos
       while true # sequence
         _tmp = _Sp()
         unless _tmp
-          self.pos = _save3
+          self.pos = _save4
           break
         end
         _tmp = scan(/\G(?-mix:#*)/)
         unless _tmp
-          self.pos = _save3
+          self.pos = _save4
           break
         end
         _tmp = _Sp()
         unless _tmp
-          self.pos = _save3
+          self.pos = _save4
         end
         break
       end # end sequence
       unless _tmp
         _tmp = true
-        self.pos = _save2
+        self.pos = _save3
       end
       unless _tmp
         self.pos = _save
@@ -16539,7 +16549,7 @@ class RDoc::Markdown
   Rules[:_Plain] = rule_info("Plain", "Inlines:a { paragraph a }")
   Rules[:_AtxInline] = rule_info("AtxInline", "!@Newline !(@Sp /\#*/ @Sp @Newline) Inline")
   Rules[:_AtxStart] = rule_info("AtxStart", "< /\\\#{1,6}/ > { text.length }")
-  Rules[:_AtxHeading] = rule_info("AtxHeading", "AtxStart:s @Sp AtxInline+:a (@Sp /\#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) }")
+  Rules[:_AtxHeading] = rule_info("AtxHeading", "AtxStart:s @Spacechar+ AtxInline+:a (@Sp /\#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) }")
   Rules[:_SetextHeading] = rule_info("SetextHeading", "(SetextHeading1 | SetextHeading2)")
   Rules[:_SetextBottom1] = rule_info("SetextBottom1", "/={1,}/ @Newline")
   Rules[:_SetextBottom2] = rule_info("SetextBottom2", "/-{1,}/ @Newline")

data/lib/rdoc/markup/attribute_manager.rb CHANGED Viewed

@@ -260,7 +260,7 @@ class RDoc::Markup::AttributeManager
   def add_word_pair(start, stop, name, exclusive = false)
     raise ArgumentError, "Word flags may not start with '<'" if
-      start[0,1] == '<'
+      start[0, 1] == '<'
     bitmap = @attributes.bitmap_for name
@@ -271,7 +271,7 @@ class RDoc::Markup::AttributeManager
       @word_pair_map[pattern] = bitmap
     end
-    @protectable << start[0,1]
+    @protectable << start[0, 1]
     @protectable.uniq!
     @exclusive_bitmap |= bitmap if exclusive

data/lib/rdoc/markup/pre_process.rb CHANGED Viewed

@@ -97,15 +97,18 @@ class RDoc::Markup::PreProcess
   # RDoc::CodeObject#metadata for details.
   def handle text, code_object = nil, &block
+    first_line = 1
     if RDoc::Comment === text then
       comment = text
       text = text.text
+      first_line = comment.line || 1
     end
     # regexp helper (square brackets for optional)
     # $1      $2  $3        $4      $5
     # [prefix][\]:directive:[spaces][param]newline
-    text = text.gsub(/^([ \t]*(?:#|\/?\*)?[ \t]*)(\\?):(\w+):([ \t]*)(.+)?(\r?\n|$)/) do
+    text = text.lines.map.with_index(first_line) do |line, num|
+      next line unless line =~ /\A([ \t]*(?:#|\/?\*)?[ \t]*)(\\?):([\w-]+):([ \t]*)(.+)?(\r?\n|$)/
       # skip something like ':toto::'
       next $& if $4.empty? and $5 and $5[0, 1] == ':'
@@ -120,8 +123,8 @@ class RDoc::Markup::PreProcess
         next "#{$1.strip}\n"
       end
-      handle_directive $1, $3, $5, code_object, text.encoding, &block
-    end
+      handle_directive $1, $3, $5, code_object, text.encoding, num, &block
+    end.join
     if comment then
       comment.text = text
@@ -148,7 +151,7 @@ class RDoc::Markup::PreProcess
   # When 1.8.7 support is ditched prefix can be defaulted to ''
   def handle_directive prefix, directive, param, code_object = nil,
-                       encoding = nil
+                       encoding = nil, line = nil
     blankline = "#{prefix.strip}\n"
     directive = directive.downcase
@@ -220,11 +223,11 @@ class RDoc::Markup::PreProcess
       # remove parameter &block
       code_object.params = code_object.params.sub(/,?\s*&\w+/, '') if code_object.params
-      code_object.block_params = param
+      code_object.block_params = param || ''
       blankline
     else
-      result = yield directive, param if block_given?
+      result = yield directive, param, line if block_given?
       case result
       when nil then

data/lib/rdoc/markup/to_bs.rb CHANGED Viewed

@@ -24,7 +24,7 @@ class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
   def init_tags
     add_tag :BOLD, '+b', '-b'
     add_tag :EM,   '+_', '-_'
-    add_tag :TT,   ''  , ''   # we need in_tt information maintained
+    add_tag :TT,   '', ''   # we need in_tt information maintained
   end
   ##

data/lib/rdoc/markup/to_rdoc.rb CHANGED Viewed

@@ -249,8 +249,8 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   # Adds +table+ to the output
   def accept_table header, body, aligns
-    widths = header.zip(body) do |h, b|
-      [h.size, b.size].max
+    widths = header.zip(*body).map do |cols|
+      cols.map(&:size).max
     end
     aligns = aligns.map do |a|
       case a
@@ -262,12 +262,12 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
         :rjust
       end
     end
-    @res << header.zip(widths, aligns) do |h, w, a|
+    @res << header.zip(widths, aligns).map do |h, w, a|
       h.__send__(a, w)
     end.join("|").rstrip << "\n"
     @res << widths.map {|w| "-" * w }.join("|") << "\n"
     body.each do |row|
-      @res << row.zip(widths, aligns) do |t, w, a|
+      @res << row.zip(widths, aligns).map do |t, w, a|
         t.__send__(a, w)
       end.join("|").rstrip << "\n"
     end

data/lib/rdoc/markup.rb CHANGED Viewed

@@ -10,19 +10,24 @@
 # RDoc::Markup and other markup formats do no output formatting, this is
 # handled by the RDoc::Markup::Formatter subclasses.
 #
-# = Supported Formats
-#
-# Besides the RDoc::Markup format, the following formats are built in to RDoc:
-#
-# markdown::
-#   The markdown format as described by
-#   http://daringfireball.net/projects/markdown/.  See RDoc::Markdown for
-#   details on the parser and supported extensions.
-# rd::
-#   The rdtool format.  See RDoc::RD for details on the parser and format.
-# tomdoc::
-#   The TomDoc format as described by http://tomdoc.org/.  See RDoc::TomDoc
-#   for details on the parser and supported extensions.
+# = Markup Formats
+#
+# +RDoc+ supports these markup formats:
+#
+# - +rdoc+:
+#   the +RDoc+ markup format;
+#   see RDoc::MarkupReference.
+# - +markdown+:
+#   The +markdown+ markup format as described in
+#   the {Markdown Guide}[https://www.markdownguide.org];
+#   see RDoc::Markdown.
+# - +rd+:
+#   the +rd+ markup format format;
+#   see RDoc::RD.
+# - +tomdoc+:
+#   the TomDoc format as described in
+#   {TomDoc for Ruby}[http://tomdoc.org];
+#   see RDoc::TomDoc.
 #
 # You can choose a markup format using the following methods:
 #

data/lib/rdoc/options.rb CHANGED Viewed

@@ -233,9 +233,9 @@ class RDoc::Options
   attr_accessor :main_page
   ##
-  # The default markup format.  The default is 'rdoc'.  'markdown', 'tomdoc'
-  # and 'rd' are also built-in.
+  # The markup format.
+  # One of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
+  # See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
   attr_accessor :markup
   ##
@@ -344,6 +344,11 @@ class RDoc::Options
   # Indicates if files of test suites should be skipped
   attr_accessor :skip_tests
+  ##
+  # Embed mixin methods, attributes, and constants into class documentation. Set via
+  # +--[no-]embed-mixins+ (Default is +false+.)
+  attr_accessor :embed_mixins
   def initialize loaded_options = nil # :nodoc:
     init_ivars
     override loaded_options if loaded_options
@@ -351,6 +356,7 @@ class RDoc::Options
   def init_ivars # :nodoc:
     @dry_run = false
+    @embed_mixins = false
     @exclude = %w[
       ~\z \.orig\z \.rej\z \.bak\z
       \.gemspec\z
@@ -401,6 +407,7 @@ class RDoc::Options
     @encoding = encoding ? Encoding.find(encoding) : encoding
     @charset        = map['charset']
+    @embed_mixins   = map['embed_mixins']
     @exclude        = map['exclude']
     @generator_name = map['generator_name']
     @hyperlink_all  = map['hyperlink_all']
@@ -432,6 +439,7 @@ class RDoc::Options
     end
     @charset        = map['charset']        if map.has_key?('charset')
+    @embed_mixins   = map['embed_mixins']   if map.has_key?('embed_mixins')
     @exclude        = map['exclude']        if map.has_key?('exclude')
     @generator_name = map['generator_name'] if map.has_key?('generator_name')
     @hyperlink_all  = map['hyperlink_all']  if map.has_key?('hyperlink_all')
@@ -460,11 +468,12 @@ class RDoc::Options
   def == other # :nodoc:
     self.class === other and
       @encoding       == other.encoding       and
+      @embed_mixins   == other.embed_mixins   and
       @generator_name == other.generator_name and
       @hyperlink_all  == other.hyperlink_all  and
       @line_numbers   == other.line_numbers   and
       @locale         == other.locale         and
-      @locale_dir     == other.locale_dir and
+      @locale_dir     == other.locale_dir     and
       @main_page      == other.main_page      and
       @markup         == other.markup         and
       @op_dir         == other.op_dir         and
@@ -683,7 +692,7 @@ Usage: #{opt.program_name} [options] [names...]
       EOF
-      parsers = Hash.new { |h,parser| h[parser] = [] }
+      parsers = Hash.new { |h, parser| h[parser] = [] }
       RDoc::Parser.parsers.each do |regexp, parser|
         parsers[parser.name.sub('RDoc::Parser::', '')] << regexp.source
@@ -842,6 +851,14 @@ Usage: #{opt.program_name} [options] [names...]
       opt.separator nil
+      opt.on("--[no-]embed-mixins",
+             "Embed mixin methods, attributes, and constants",
+             "into class documentation. (default false)") do |value|
+        @embed_mixins = value
+      end
+      opt.separator nil
       markup_formats = RDoc::Text::MARKUP_FORMAT.keys.sort
       opt.on("--markup=MARKUP", markup_formats,

data/lib/rdoc/parser/c.rb CHANGED Viewed

@@ -440,7 +440,7 @@ class RDoc::Parser::C < RDoc::Parser
   # Scans #content for rb_include_module
   def do_includes
-    @content.scan(/rb_include_module\s*\(\s*(\w+?),\s*(\w+?)\s*\)/) do |c,m|
+    @content.scan(/rb_include_module\s*\(\s*(\w+?),\s*(\w+?)\s*\)/) do |c, m|
       next unless cls = @classes[c]
       m = @known_classes[m] || m

data/lib/rdoc/parser/changelog.rb CHANGED Viewed

@@ -193,7 +193,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
     entries << [entry_name, entry_body] if entry_name
-    entries.reject! do |(entry,_)|
+    entries.reject! do |(entry, _)|
       entry == nil
     end
@@ -221,7 +221,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
   module Git
     ##
-    # Parses auxiliary info.  Currentry `base-url` to expand
+    # Parses auxiliary info.  Currently `base-url` to expand
     # references is effective.
     def parse_info(info)