rdoc 6.0.1.1 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec933eeb581c303748038cb9f82de18570dde50a582ac6915609294babc1104a
-  data.tar.gz: aec53034d96ef156fa85b730d9d25802f47ed4a3e75216923005e66cea41054d
+  metadata.gz: 136b786cd5e93311d3c19248fb763401cad84e1c9b60f898c37d4a7aadea2cd5
+  data.tar.gz: d8eecce4cd75284596fb7680c58de2fe7277a4202a5b1dcef4c311906288209f
 SHA512:
-  metadata.gz: c57a88f571a332485e19aac2c2fed33640484e4c139ce0692647cab8db296cfdc1a85cf9fccdfc1efb549f0849bdcd6715353ce1a23f4b586ccb7f0b36803bf9
-  data.tar.gz: 1a0c790d84aca6c8813ae0054168905555c028f8acb10f47761f9b4e05d1e73ee79e7439444d69c82aca4148579be5c1e54f837a22b54a8ba62368cfe0b7ed04
+  metadata.gz: a87e8abc462df4ef4bf50932aba214bad8b1d0dc3d76699ecb49ef47a086e6fd6b44fa24ccb95f74313c0a2f6e0f8ac2c106a4e32b10cae7f7aa58365cb97e6b
+  data.tar.gz: f9f294853cf260b35482a717fb9cff10203c25fa9c31c62bf8c65f5cc0cf2fcb91d4e321ca9f4e61d50af9f999094f95eea8f47256991ca1ae0a0e7d62e984ff

data/.travis.yml

@@ -1,14 +1,16 @@
 ---
 before_install:
-  - gem install bundler --no-document
+  - gem update --system
+  - gem update bundler
 language: ruby
 rvm:
-  - 2.2.8
-  - 2.3.5
-  - 2.4.2
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
   - ruby-head
-  - jruby-9.1.15.0
+  - jruby-9.1.16.0
 env:
   global:
     NOBENCHMARK=1
-script: bundle exec rake
+script: rake

data/Rakefile

@@ -79,58 +79,8 @@ parsed_files = PARSER_FILES.map do |parser_file|
 end
 
 task "#{path}.gem" => package_parser_files
-task :check_manifest => :generate
 
 desc "Genrate all files used racc and kpeg"
 task :generate => parsed_files
 
-# These tasks expect to have the following directory structure:
-#
-#   git/git.rubini.us/code # Rubinius git HEAD checkout
-#   svn/ruby/trunk         # ruby subversion HEAD checkout
-#   svn/rdoc/trunk         # RDoc subversion HEAD checkout
-#
-# If you don't have this directory structure, set RUBY_PATH and/or
-# RUBINIUS_PATH.
-
-diff_options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
-rsync_options = "-avP --exclude '*svn*' --exclude '*swp' --exclude '*rbc' --exclude '*.rej' --exclude '*.orig' --exclude '*.kpeg' --exclude '*.ry' --exclude 'literals_1_8.rb' --exclude 'gauntlet_rdoc.rb'"
-
-rubinius_dir = ENV['RUBINIUS_PATH'] || '../../../git/git.rubini.us/code'
-ruby_dir = ENV['RUBY_PATH'] || '../../svn/ruby/trunk'
-
-desc "Updates Ruby HEAD with the currently checked-out copy of RDoc."
-task :update_ruby do
-  sh "rsync #{rsync_options} bin/rdoc #{ruby_dir}/bin/rdoc"
-  sh "rsync #{rsync_options} bin/ri #{ruby_dir}/bin/ri"
-  sh "rsync #{rsync_options} lib/ #{ruby_dir}/lib"
-  sh "rsync #{rsync_options} test/ #{ruby_dir}/test/rdoc"
-end
-
-desc "Diffs Ruby HEAD with the currently checked-out copy of RDoc."
-task :diff_ruby do
-  sh "diff #{diff_options} bin/rdoc #{ruby_dir}/bin/rdoc; true"
-  sh "diff #{diff_options} bin/ri #{ruby_dir}/bin/ri; true"
-  sh "diff #{diff_options} lib/rdoc.rb #{ruby_dir}/lib/rdoc.rb; true"
-  sh "diff #{diff_options} lib/rdoc #{ruby_dir}/lib/rdoc; true"
-  sh "diff #{diff_options} test #{ruby_dir}/test/rdoc; true"
-end
-
-desc "Updates Rubinius HEAD with the currently checked-out copy of RDoc."
-task :update_rubinius do
-  sh "rsync #{rsync_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb"
-  sh "rsync #{rsync_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb"
-  sh "rsync #{rsync_options} lib/ #{rubinius_dir}/lib"
-  sh "rsync #{rsync_options} test/ #{rubinius_dir}/test/rdoc"
-end
-
-desc "Diffs Rubinius HEAD with the currently checked-out copy of RDoc."
-task :diff_rubinius do
-  sh "diff #{diff_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb; true"
-  sh "diff #{diff_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb; true"
-  sh "diff #{diff_options} lib/rdoc.rb #{rubinius_dir}/lib/rdoc.rb; true"
-  sh "diff #{diff_options} lib/rdoc #{rubinius_dir}/lib/rdoc; true"
-  sh "diff #{diff_options} test #{rubinius_dir}/test/rdoc; true"
-end
-
 task :build => [:generate]

data/lib/rdoc.rb

@@ -65,7 +65,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '6.0.1.1'
+  VERSION = '6.0.2'
 
   ##
   # Method visibilities
@@ -153,7 +153,7 @@ module RDoc
 
   autoload :Comment,        'rdoc/comment'
 
-  autoload :I18n,           'rdoc/i18n'
+  require 'rdoc/i18n'
 
   # code objects
   #

data/lib/rdoc/context.rb

@@ -407,6 +407,7 @@ class RDoc::Context < RDoc::CodeObject
     mod.section = current_section # TODO declaring context? something is
                                   # wrong here...
     mod.parent = self
+    mod.full_name = nil
     mod.store = @store
 
     unless @done_documenting then
@@ -414,6 +415,10 @@ class RDoc::Context < RDoc::CodeObject
       # this must be done AFTER adding mod to its parent, so that the full
       # name is correct:
       all_hash[mod.full_name] = mod
+      if @store.unmatched_constant_alias[mod.full_name] then
+        to, file = @store.unmatched_constant_alias[mod.full_name]
+        add_module_alias mod, mod.name, to, file
+      end
     end
 
     mod
@@ -510,41 +515,53 @@ class RDoc::Context < RDoc::CodeObject
     add_class_or_module mod, @modules, @store.modules_hash
   end
 
+  ##
+  # Adds a module by +RDoc::NormalModule+ instance. See also #add_module.
+
+  def add_module_by_normal_module(mod)
+    add_class_or_module mod, @modules, @store.modules_hash
+  end
+
   ##
   # Adds an alias from +from+ (a class or module) to +name+ which was defined
   # in +file+.
 
-  def add_module_alias from, name, file
+  def add_module_alias from, from_name, to, file
     return from if @done_documenting
 
-    to_name = child_name name
+    to_full_name = child_name to.name
 
     # if we already know this name, don't register an alias:
     # see the metaprogramming in lib/active_support/basic_object.rb,
     # where we already know BasicObject is a class when we find
     # BasicObject = BlankSlate
-    return from if @store.find_class_or_module to_name
+    return from if @store.find_class_or_module to_full_name
+
+    unless from
+      @store.unmatched_constant_alias[child_name(from_name)] = [to, file]
+      return to
+    end
 
-    to = from.dup
-    to.name = name
-    to.full_name = nil
+    new_to = from.dup
+    new_to.name = to.name
+    new_to.full_name = nil
 
-    if to.module? then
-      @store.modules_hash[to_name] = to
-      @modules[name] = to
+    if new_to.module? then
+      @store.modules_hash[to_full_name] = new_to
+      @modules[to.name] = new_to
     else
-      @store.classes_hash[to_name] = to
-      @classes[name] = to
+      @store.classes_hash[to_full_name] = new_to
+      @classes[to.name] = new_to
     end
 
     # Registers a constant for this alias.  The constant value and comment
     # will be updated later, when the Ruby parser adds the constant
-    const = RDoc::Constant.new name, nil, to.comment
+    const = RDoc::Constant.new to.name, nil, new_to.comment
     const.record_location file
     const.is_alias_for = from
     add_constant const
 
-    to
+    new_to
   end
 
   ##
@@ -863,7 +880,13 @@ class RDoc::Context < RDoc::CodeObject
   # Finds a method named +name+ with singleton value +singleton+.
 
   def find_method(name, singleton)
-    @method_list.find { |m| m.name == name && m.singleton == singleton }
+    @method_list.find { |m|
+      if m.singleton
+        m.name == name && m.singleton == singleton
+      else
+        m.name == name && !m.singleton && !singleton
+      end
+    }
   end
 
   ##

data/lib/rdoc/encoding.rb

@@ -7,6 +7,18 @@
 
 module RDoc::Encoding
 
+  HEADER_REGEXP = /^
+    (?:
+      \A\#!.*\n
+      |
+      ^\#\s+frozen[-_]string[-_]literal[=:].+\n
+      |
+      ^\#[^\n]+\b(?:en)?coding[=:]\s*(?<name>[^\s;]+).*\n
+      |
+      <\?xml[^?]*encoding=(?<quote>["'])(?<name>.*?)\k<quote>.*\n
+    )+
+  /xi # :nodoc:
+
   ##
   # Reads the contents of +filename+ and handles any encoding directives in
   # the file.
@@ -18,12 +30,13 @@ module RDoc::Encoding
   # unknown character in the target encoding will be replaced with '?'
 
   def self.read_file filename, encoding, force_transcode = false
-    content = open filename, "rb" do |f| f.read end
+    content = File.open filename, "rb" do |f| f.read end
     content.gsub!("\r\n", "\n") if RUBY_PLATFORM =~ /mswin|mingw/
 
     utf8 = content.sub!(/\A\xef\xbb\xbf/, '')
 
-    content = RDoc::Encoding.set_encoding content
+    enc = RDoc::Encoding.detect_encoding content
+    content = RDoc::Encoding.change_encoding content, enc if enc
 
     begin
       encoding ||= Encoding.default_external
@@ -85,29 +98,22 @@ module RDoc::Encoding
   end
 
   ##
-  # Sets the encoding of +string+ based on the magic comment
-
-  def self.set_encoding string
-    string = remove_frozen_string_literal string
-
-    string =~ /\A(?:#!.*\n)?(.*\n)/
-
-    first_line = $1
+  # Detects the encoding of +string+ based on the magic comment
 
-    name = case first_line
-           when /^<\?xml[^?]*encoding=(["'])(.*?)\1/ then $2
-           when /\b(?:en)?coding[=:]\s*([^\s;]+)/i   then $1
-           else                                           return string
-           end
+  def self.detect_encoding string
+    result = HEADER_REGEXP.match string
+    name = result && result[:name]
 
-    string = string.sub first_line, ''
-
-    string = remove_frozen_string_literal string
+    name ? Encoding.find(name) : nil
+  end
 
-    enc = Encoding.find name
-    string = RDoc::Encoding.change_encoding string, enc if enc
+  ##
+  # Removes magic comments and shebang
 
-    string
+  def self.remove_magic_comment string
+    string.sub HEADER_REGEXP do |s|
+      s.gsub(/[^\n]/, '')
+    end
   end
 
   ##

data/lib/rdoc/erbio.rb

@@ -9,7 +9,7 @@ require 'erb'
 #
 #   erbio = RDoc::ERBIO.new '<%= "hello world" %>', nil, nil
 #
-#   open 'hello.txt', 'w' do |io|
+#   File.open 'hello.txt', 'w' do |io|
 #     erbio.result binding
 #   end
 #

data/lib/rdoc/generator/json_index.rb

@@ -147,12 +147,15 @@ class RDoc::Generator::JsonIndex
 
       JSON.dump data, io, 0
     end
+    unless ENV['SOURCE_DATE_EPOCH'].nil?
+      index_file.utime index_file.atime, Time.at(ENV['SOURCE_DATE_EPOCH'].to_i).gmtime
+    end
 
     Dir.chdir @template_dir do
       Dir['**/*.js'].each do |source|
         dest = File.join out_dir, source
 
-        FileUtils.install source, dest, :mode => 0644, :verbose => $DEBUG_RDOC
+        FileUtils.install source, dest, :mode => 0644, :preserve => true, :verbose => $DEBUG_RDOC
       end
     end
   end

data/lib/rdoc/generator/pot.rb

@@ -91,8 +91,8 @@ class RDoc::Generator::POT
     extractor.extract
   end
 
-  autoload :MessageExtractor, 'rdoc/generator/pot/message_extractor'
-  autoload :PO,               'rdoc/generator/pot/po'
-  autoload :POEntry,          'rdoc/generator/pot/po_entry'
+  require 'rdoc/generator/pot/message_extractor'
+  require 'rdoc/generator/pot/po'
+  require 'rdoc/generator/pot/po_entry'
 
 end

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

@@ -7,11 +7,8 @@
   var index_rel_prefix = "<%= rel_prefix %>/";
 </script>
 
-<script src="<%= asset_rel_prefix %>/js/navigation.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/search.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/search_index.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/searcher.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/darkfish.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/jquery.js"></script>
+<script src="<%= asset_rel_prefix %>/js/darkfish.js"></script>
 
 <link href="<%= asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
 <link href="<%= asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">

data/lib/rdoc/generator/template/darkfish/css/rdoc.css

@@ -9,8 +9,6 @@
 /* vim: ft=css et sw=2 ts=2 sts=2 */
 /* Base Green is: #6C8C22 */
 
-.hide { display: none !important; }
-
 * { padding: 0; margin: 0; }
 
 body {
@@ -50,16 +48,6 @@ h6:hover span {
   display: inline;
 }
 
-h1:target,
-h2:target,
-h3:target,
-h4:target,
-h5:target,
-h6:target {
-  margin-left: -10px;
-  border-left: 10px solid #f1edba;
-}
-
 :link,
 :visited {
   color: #6C8C22;
@@ -453,16 +441,7 @@ main header h3 {
 /* @group Method Details */
 
 main .method-source-code {
-  max-height: 0;
-  overflow: hidden;
-  transition-duration: 200ms;
-  transition-delay: 0ms;
-  transition-property: all;
-  transition-timing-function: ease-in-out;
-}
-
-main .method-source-code.active-menu {
-  max-height: 100vh;
+  display: none;
 }
 
 main .method-description .method-calls-super {

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

@@ -8,7 +8,6 @@
  */
 
 /* Provide console simulation for firebug-less environments */
-/*
 if (!("console" in window) || !("firebug" in console)) {
   var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
     "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
@@ -17,35 +16,41 @@ if (!("console" in window) || !("firebug" in console)) {
   for (var i = 0; i < names.length; ++i)
     window.console[names[i]] = function() {};
 };
+
+
+/**
+ * Unwrap the first element that matches the given @expr@ from the targets and return them.
  */
+$.fn.unwrap = function( expr ) {
+  return this.each( function() {
+    $(this).parents( expr ).eq( 0 ).after( this ).remove();
+  });
+};
 
 
 function showSource( e ) {
   var target = e.target;
-  while (!target.classList.contains('method-detail')) {
-    target = target.parentNode;
-  }
-  if (typeof target !== "undefined" && target !== null) {
-    target = target.querySelector('.method-source-code');
-  }
-  if (typeof target !== "undefined" && target !== null) {
-    target.classList.toggle('active-menu')
-  }
+  var codeSections = $(target).
+    parents('.method-detail').
+    find('.method-source-code');
+
+  $(target).
+    parents('.method-detail').
+    find('.method-source-code').
+    slideToggle();
 };
 
 function hookSourceViews() {
-  document.querySelectorAll('.method-heading').forEach(function (codeObject) {
-    codeObject.addEventListener('click', showSource);
-  });
+  $('.method-heading').click( showSource );
 };
 
 function hookSearch() {
-  var input  = document.querySelector('#search-field');
-  var result = document.querySelector('#search-results');
-  result.classList.remove("initially-hidden");
+  var input  = $('#search-field').eq(0);
+  var result = $('#search-results').eq(0);
+  $(result).show();
 
-  var search_section = document.querySelector('#search-section');
-  search_section.classList.remove("initially-hidden");
+  var search_section = $('#search-section').get(0);
+  $(search_section).show();
 
   var search = new Search(search_data, input, result);
 
@@ -72,14 +77,85 @@ function hookSearch() {
   }
 
   search.select = function(result) {
-      console.log(result);
-    window.location.href = result.firstChild.firstChild.href;
+    var result_element = result.get(0);
+    window.location.href = result_element.firstChild.firstChild.href;
   }
 
   search.scrollIntoView = search.scrollInWindow;
 };
 
-document.addEventListener('DOMContentLoaded', function() {
+function highlightTarget( anchor ) {
+  console.debug( "Highlighting target '%s'.", anchor );
+
+  $("a[name]").each( function() {
+    if ( $(this).attr("name") == anchor ) {
+      if ( !$(this).parent().parent().hasClass('target-section') ) {
+        console.debug( "Wrapping the target-section" );
+        $('div.method-detail').unwrap( 'div.target-section' );
+        $(this).parent().wrap( '<div class="target-section"></div>' );
+      } else {
+        console.debug( "Already wrapped." );
+      }
+    }
+  });
+};
+
+function highlightLocationTarget() {
+  console.debug( "Location hash: %s", window.location.hash );
+  if ( ! window.location.hash || window.location.hash.length == 0 ) return;
+
+  var anchor = window.location.hash.substring(1);
+  console.debug( "Found anchor: %s; matching %s", anchor, "a[name=" + anchor + "]" );
+
+  highlightTarget( anchor );
+};
+
+function highlightClickTarget( event ) {
+  console.debug( "Highlighting click target for event %o", event.target );
+  try {
+    var anchor = $(event.target).attr( 'href' ).substring(1);
+    console.debug( "Found target anchor: %s", anchor );
+    highlightTarget( anchor );
+  } catch ( err ) {
+    console.error( "Exception while highlighting: %o", err );
+  };
+};
+
+function loadAsync(path, success, prefix) {
+  $.ajax({
+    url: prefix + path,
+    dataType: 'script',
+    success: success,
+    cache: true
+  });
+};
+
+$(document).ready( function() {
   hookSourceViews();
+  highlightLocationTarget();
+  $('ul.link-list a').bind( "click", highlightClickTarget );
+
+  var search_scripts_loaded = {
+    navigation_loaded:   false,
+    search_loaded:       false,
+    search_index_loaded: false,
+    searcher_loaded:     false,
+  }
+
+  var search_success_function = function(variable) {
+    return (function (data, status, xhr) {
+      search_scripts_loaded[variable] = true;
+
+      if (search_scripts_loaded['navigation_loaded']   == true &&
+          search_scripts_loaded['search_loaded']       == true &&
+          search_scripts_loaded['search_index_loaded'] == true &&
+          search_scripts_loaded['searcher_loaded']     == true)
         hookSearch();
     });
+  }
+
+  loadAsync('js/navigation.js',   search_success_function('navigation_loaded'), rdoc_rel_prefix);
+  loadAsync('js/search.js',       search_success_function('search_loaded'), rdoc_rel_prefix);
+  loadAsync('js/search_index.js', search_success_function('search_index_loaded'), index_rel_prefix);
+  loadAsync('js/searcher.js',     search_success_function('searcher_loaded'), rdoc_rel_prefix);
+});