rdoc 4.3.0 → 5.0.0.beta1

data/lib/rdoc/erb_partial.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Allows an ERB template to be rendered in the context (binding) of an
 # existing ERB template evaluation.

data/lib/rdoc/erbio.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'erb'
 
 ##

data/lib/rdoc/extend.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A Module extension to a class with \#extend
 #

data/lib/rdoc/generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # RDoc uses generators to turn parsed source code in the form of an
 # RDoc::CodeObject tree into some form of output.  RDoc comes with the HTML

data/lib/rdoc/generator/darkfish.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 # -*- mode: ruby; ruby-indent-level: 2; tab-width: 2 -*-
 
 require 'erb'

data/lib/rdoc/generator/json_index.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'json'
 begin
   require 'zlib'

data/lib/rdoc/generator/markup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Handle common RDoc::Markup tasks for various CodeObjects
 #

data/lib/rdoc/generator/pot.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Generates a POT file.
 #

data/lib/rdoc/generator/pot/message_extractor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Extracts message from RDoc::Store
 

data/lib/rdoc/generator/pot/po.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Generates a PO format text
 

data/lib/rdoc/generator/pot/po_entry.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A PO entry in PO
 

data/lib/rdoc/generator/ri.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Generates ri data files
 

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

@@ -3,7 +3,8 @@
 <title><%= h @title %></title>
 
 <script type="text/javascript">
-  var rdoc_rel_prefix = "<%= rel_prefix %>/";
+  var rdoc_rel_prefix = "<%= asset_rel_prefix %>/";
+  var index_rel_prefix = "<%= rel_prefix %>/";
 </script>
 
 <script src="<%= asset_rel_prefix %>/js/jquery.js"></script>

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

@@ -17,7 +17,7 @@
   font-weight: 400;
   src: local("Source Code Pro"),
        local("SourceCodePro-Regular"),
-       url("fonts/SourceCodePro-Regular.ttf") format("truetype");
+       url("../fonts/SourceCodePro-Regular.ttf") format("truetype");
 }
 
 @font-face {
@@ -26,7 +26,7 @@
   font-weight: 700;
   src: local("Source Code Pro Bold"),
        local("SourceCodePro-Bold"),
-       url("fonts/SourceCodePro-Bold.ttf") format("truetype");
+       url("../fonts/SourceCodePro-Bold.ttf") format("truetype");
 }
 
 /*
@@ -46,7 +46,7 @@
   font-weight: 300;
   src: local("Lato Light"),
        local("Lato-Light"),
-       url("fonts/Lato-Light.ttf") format("truetype");
+       url("../fonts/Lato-Light.ttf") format("truetype");
 }
 
 @font-face {
@@ -55,7 +55,7 @@
   font-weight: 300;
   src: local("Lato Light Italic"),
        local("Lato-LightItalic"),
-       url("fonts/Lato-LightItalic.ttf") format("truetype");
+       url("../fonts/Lato-LightItalic.ttf") format("truetype");
 }
 
 @font-face {
@@ -64,7 +64,7 @@
   font-weight: 700;
   src: local("Lato Regular"),
        local("Lato-Regular"),
-       url("fonts/Lato-Regular.ttf") format("truetype");
+       url("../fonts/Lato-Regular.ttf") format("truetype");
 }
 
 @font-face {
@@ -73,7 +73,7 @@
   font-weight: 700;
   src: local("Lato Italic"),
        local("Lato-Italic"),
-       url("fonts/Lato-RegularItalic.ttf") format("truetype");
+       url("../fonts/Lato-RegularItalic.ttf") format("truetype");
 }
 
 /*

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

@@ -59,7 +59,7 @@ function hookSearch() {
     var html = '';
 
     // TODO add relative path to <script> per-page
-    html += '<p class="search-match"><a href="' + rdoc_rel_prefix + result.path + '">' + this.hlt(result.title);
+    html += '<p class="search-match"><a href="' + index_rel_prefix + result.path + '">' + this.hlt(result.title);
     if (result.params)
       html += '<span class="params">' + result.params + '</span>';
     html += '</a>';
@@ -121,9 +121,9 @@ function highlightClickTarget( event ) {
   };
 };
 
-function loadAsync(path, success) {
+function loadAsync(path, success, prefix) {
   $.ajax({
-    url: rdoc_rel_prefix + path,
+    url: prefix + path,
     dataType: 'script',
     success: success,
     cache: true
@@ -154,8 +154,8 @@ $(document).ready( function() {
     });
   }
 
-  loadAsync('js/navigation.js',   search_success_function('navigation_loaded'));
-  loadAsync('js/search.js',       search_success_function('search_loaded'));
-  loadAsync('js/search_index.js', search_success_function('search_index_loaded'));
-  loadAsync('js/searcher.js',     search_success_function('searcher_loaded'));
+  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);
 });

data/lib/rdoc/generator/template/json_index/js/searcher.js

@@ -172,6 +172,7 @@ Searcher.prototype = new function() {
     result.path = info[2];
     result.params = info[3];
     result.snippet = info[4];
+    result.badge = info[6];
     return result;
   }
 

data/lib/rdoc/ghost_method.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # GhostMethod represents a method referenced only by a comment
 

data/lib/rdoc/i18n.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # This module provides i18n realated features.
 

data/lib/rdoc/i18n/locale.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A message container for a locale.
 #

data/lib/rdoc/i18n/text.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # An i18n supported text.
 #

data/lib/rdoc/include.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A Module included in a class with \#include
 #

data/lib/rdoc/known_classes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 module RDoc
 
   ##

data/lib/rdoc/markdown.kpeg

@@ -17,7 +17,7 @@
 #
 #     data = File.read("README.md")
 #     formatter = RDoc::Markup::ToHtml.new(RDoc::Options.new, nil)
-#     html = RDoc::Markdown.parse(data).accept(@formatter)
+#     html = RDoc::Markdown.parse(data).accept(formatter)
 #
 #     # do something with html
 #
@@ -179,11 +179,7 @@
   require 'rdoc/markup/to_joined_paragraph'
   require 'rdoc/markdown/entities'
 
-  if RUBY_VERSION > '1.9' then
-    require 'rdoc/markdown/literals_1_9'
-  else
-    require 'rdoc/markdown/literals_1_8'
-  end
+  require 'rdoc/markdown/literals'
 
   ##
   # Supported extensions

data/lib/rdoc/markdown.rb

@@ -14,7 +14,7 @@
 #
 #     data = File.read("README.md")
 #     formatter = RDoc::Markup::ToHtml.new(RDoc::Options.new, nil)
-#     html = RDoc::Markdown.parse(data).accept(@formatter)
+#     html = RDoc::Markdown.parse(data).accept(formatter)
 #
 #     # do something with html
 #
@@ -526,11 +526,7 @@ class RDoc::Markdown
   require 'rdoc/markup/to_joined_paragraph'
   require 'rdoc/markdown/entities'
 
-  if RUBY_VERSION > '1.9' then
-    require 'rdoc/markdown/literals_1_9'
-  else
-    require 'rdoc/markdown/literals_1_8'
-  end
+  require 'rdoc/markdown/literals'
 
   ##
   # Supported extensions

data/lib/rdoc/markdown/entities.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # HTML entity name map for RDoc::Markdown
 

data/lib/rdoc/markdown/{literals_1_9.rb → literals.rb}

@@ -1,4 +1,5 @@
 # coding: UTF-8
+# frozen_string_literal: false
 # :markup: markdown
 
 ##
@@ -288,8 +289,6 @@ class RDoc::Markdown::Literals
         else
           return ans
         end
-
-        return ans
       end
     end
 
@@ -322,8 +321,6 @@ class RDoc::Markdown::Literals
         else
           return ans
         end
-
-        return ans
       end
     end
 

data/lib/rdoc/markup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # RDoc::Markup parses plain text documents and attempts to decompose them into
 # their constituent parts.  Some of these parts are high-level: paragraphs,

data/lib/rdoc/markup/attr_changer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 class RDoc::Markup
 
   AttrChanger = Struct.new :turn_on, :turn_off # :nodoc:

data/lib/rdoc/markup/attr_span.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # An array of attributes which parallels the characters in a string.
 

data/lib/rdoc/markup/attribute_manager.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Manages changes of attributes in a block of text
 

data/lib/rdoc/markup/attributes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # We manage a set of attributes.  Each attribute has a symbol name and a bit
 # value.

data/lib/rdoc/markup/blank_line.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # An empty line.  This class is a singleton.
 

data/lib/rdoc/markup/block_quote.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A quoted section which contains markup items.
 

data/lib/rdoc/markup/document.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A Document containing lists, headings, paragraphs, etc.
 

data/lib/rdoc/markup/formatter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Base class for RDoc markup formatters
 #

data/lib/rdoc/markup/formatter_test_case.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'minitest/unit'
 
 ##
@@ -176,9 +177,6 @@ class RDoc::Markup::FormatterTestCase < RDoc::TestCase
       # Calls accept_heading_3 with a level 3 RDoc::Markup::Heading
 
       def test_accept_heading_3
-        # HACK this doesn't belong here
-        skip "No String#chars, upgrade your ruby" unless ''.respond_to? :chars
-
         @to.start_accepting
 
         @to.accept_heading @RM::Heading.new(3, 'Hello')
@@ -764,4 +762,3 @@ class RDoc::Markup::FormatterTestCase < RDoc::TestCase
   end
 
 end
-

data/lib/rdoc/markup/hard_break.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A hard-break in the middle of a paragraph.
 

data/lib/rdoc/markup/heading.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A heading with a level (1-6) and text
 

data/lib/rdoc/markup/include.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A file included at generation time.  Objects of this class are created by
 # RDoc::RD for an extension-less include.

data/lib/rdoc/markup/indented_paragraph.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # An Indented Paragraph of text
 

data/lib/rdoc/markup/inline.rb

@@ -1 +1,2 @@
+# frozen_string_literal: false
 warn "requiring rdoc/markup/inline is deprecated and will be removed in RDoc 4." if $-w

data/lib/rdoc/markup/list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A List is a homogeneous set of ListItems.
 #

data/lib/rdoc/markup/list_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # An item within a List that contains paragraphs, headings, etc.
 #

data/lib/rdoc/markup/paragraph.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A Paragraph of text
 

data/lib/rdoc/markup/parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 require 'strscan'
 
 ##

data/lib/rdoc/markup/pre_process.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Handle common directives that can occur in a block of text:
 #

data/lib/rdoc/markup/raw.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A section of text that is added to the output document as-is
 

data/lib/rdoc/markup/rule.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # A horizontal rule with a weight
 

data/lib/rdoc/markup/special.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Hold details of a special sequence
 

data/lib/rdoc/markup/text_formatter_test_case.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Test case for creating new plain-text RDoc::Markup formatters.  See also
 # RDoc::Markup::FormatterTestCase

data/lib/rdoc/markup/to_ansi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 ##
 # Outputs RDoc markup with vibrant ANSI color!