rdoc 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 868ab7b8ddaf4387e4e3ee196bfec45799d4f7a2
-  data.tar.gz: 6b50f0b61946320a969cc9aacd43f89dcac46080
+  metadata.gz: 8caf92d9ae213ea0a9a9eff7f7433ba487af357f
+  data.tar.gz: 06f1871ad30883d2ce68b5e9392a6988bcce57d5
 SHA512:
-  metadata.gz: 56a35307cad780997ecf4f74dcca155a63e4bef5a60e045703b18f78df2bb64440e65194a6bc24b72707a13bd6d08243437f027077e057081d42a101ba93fab1
-  data.tar.gz: 709d20d6df32039440646b06984c942e79f4509dc61fbf9cfadf858f9bf5af8fa9b7d8afa682b7a585db00b632478f9d1f5a721be96c029224709673221e4ddc
+  metadata.gz: 4013603b560a950d86b326be9826294bf10f6bd5d08039f28fe8424b868d25e1a8d5d9abfba424e97e6a3ab37388c7f4f86948c43de1230d66a2189f140cb26d
+  data.tar.gz: 26e8921920c1de21a5fff069274c82f7fb2e8b333e9cfa48762d58313f2b2ed9e4168ba20ae794763566ec4a06a428e37ce762ec2400403c5f6863b1ff644ab4

data/.autotest

@@ -1,7 +1,9 @@
 require 'autotest/restart'
 
-Autotest.add_hook :run_command do |at|
+Autotest.add_hook :run_command do |_, cmd|
   system "#{Gem.ruby} -rubygems #{Gem.bin_path 'rake', 'rake'} generate"
+  cmd.sub! ' -e ', ' -we '
+  cmd.sub! "'minitest'", "'minitest', '~> 4.7'"
 end
 
 Autotest.add_hook :initialize do |at|

data/History.rdoc

@@ -1,3 +1,72 @@
+=== 4.2.0 / 2014-12-06
+
+* Major enhancements
+  * RDoc can now produce translation files for use with gettext.  See
+    RDoc::Generator::POT for a workflow for creating translations of your
+    documentation.  Pull request #254 by Kouhei Sutou.
+
+* Minor enhancements
+  * RDoc now allows any single-word macro before a C method implementation.
+    Issue #722 by Hanmac.
+  * Now :all is a synonym for :private for RDoc::Options#visibility= to match
+    the --all command line option.  Pull request #276 by Zachary Scott.
+  * Running rake for the first time now installs racc.  Pull request #285 by
+    Kouhei Sutou.
+  * Added <code>-h</code> flag to also display help.  Issue #300 by Ryan Davis
+  * search_index.js is now loaded asynchronously for improved performance.
+  * Allow +X::Y+ as typewriter text.  Issue #319, pull request #322 by Jeremy
+    Evans.
+  * Added RDoc::RI::Task for building ri data easily through rake.  Pull
+    request #332 by Zachary Scott.
+  * A gzipped search index is generated for servers configured to use
+    precompressed files.  Pull request #334 by Zachary Scott.
+  * CSS files now live under /css relative to the document root.  Pull request
+    #335 by Zachary Scott.
+  * Improved detection of valid ruby in verbatim sections.  Pull request #333
+    by Jeremy Evans.
+
+* Bug fixes
+  * Fixed HTML labels for cross-browser compatibility.  This breaks existing
+    links but enables cross-browser compatibility.  Pull request #330 by Jens
+    Wille.
+  * RDoc handles ASCII-incompatible encodings now.  An encoding hint may need
+    to be added to the file for RDoc to produce correct output, though.
+    Issue #288 by Manuel Meurer.
+  * Fixed height recalculation issues when headings are hovered.  Issue #289
+    by Dietmar H. Büto.
+  * RDoc now ignores its own output directories.  Pull Request #306 by
+    Hsing-Hui Hsu, bug #305 by Ryan Davis.
+  * Fixed RDoc::Task no longer uselessly builds documentation when generating
+    non-HTML output.  Bug #307 by Christina Thompson, pull request #308 by
+    Hsing-Hui Hsu
+  * Added pointer to font copyright and license information to LEGAL.rdoc.
+    Issue #290 by Christian Hofstaedtler.
+  * Fixed RDoc::Context#<=> for ruby trunk.  Issue #284 by Hanmac, pull
+    request #287 by Aaron Patterson
+  * Tests no longer create directories inside test/.  Pull request #286 by
+    Kouhei Sutou.
+  * Fixed documentation example in RDoc::Markup.  Pull request #292 by Gregory
+    Brown.
+  * Applied typo fix to RDoc::Markup. Pull request #297 by @montanalow
+  * Fixed pretty_print for RDoc::MethodAttr with an alias.  Pull request #324
+    by Hsing-Hui Hsu.
+  * Fixed lexing of %w"".  Issue #315 by Thierry Lambert, pull request #323 by
+    Jeremy Evans.
+  * RDoc::TokenStream now removes nil tokens.  Pull request #318 by Calle
+    Erlandsson.
+  * Fixed footer links to rubyforge and darkfish.  Pull request #328 by
+    @blackwinter
+  * Fixed page-top link.  Pull request #329 by @blackwinter
+  * Minitest gem activation failures are now ignored during test startup.
+    Issue #313 by Vít Ondruch.
+  * Fixed error when generating documentation from singleton classes.  Issue
+    #311 by Vít Ondruch.
+  * Splat and keyword params can now be detected for documentation
+    completeness.  Issue #321 Tom Kadwill.
+  * Standalone anchors in markdown documents are no longer escaped.  Issue
+    #312 by Scott Thompson.
+  * Fixed RegExp matching stack overflow on Ruby 1.8.7.  Issue #327 by sshao.
+
 === 4.1.2 / 2014-09-05
 
 * Bug fixes
@@ -43,7 +112,7 @@
   * Moved old DEVELOPERS file to CONTRIBUTING to match github conventions.
   * TomDoc output now has a "Returns" heading.  Issue #234 by Brian Henderson
   * Metaprogrammed methods can now use the :args: directive in addition to the
-    :call-seq: durective.  Issue #236 by Mike Moore.
+    :call-seq: directive.  Issue #236 by Mike Moore.
   * Sections can be linked to using "@" like labels.  If a section and a label
     have the same name the section will be preferred.  Issue #233 by Brian
     Henderson.
@@ -71,8 +140,6 @@
     Bug #214 by Ryan Davis.
   * Fixed documented? check for classes which indicated incorrect 100%
     coverage.  Bug #211 by Ryan Davis.
-  * RDoc ignores constants discovered in passing in class and method bodies.
-    Bug #209 by Ryan Davis.
   * An :enddoc: at the top level stops all further parsing.  Bug #213 by Ryan
     Davis.
   * Improved handling of multiline call-seq.  Bug #207 by Erik Hollensbe.

data/LEGAL.rdoc

@@ -37,3 +37,14 @@ MarkdownTest::
 
   See http://dev.perl.org/licenses/ for the terms of the Perl license.
 
+Fonts::
+  Source Code Pro is (c) 2010, 2012 Adobe Systems Incorporated.
+
+  Lato is (c) 2010 Łukasz Dziedzic.
+
+  Both fonts are used under the SIL Open Font License, Version 1.1.  The
+  license is available at http://scripts.sil.org/OFL
+
+  See lib/rdoc/generator/template/darkfish/fonts.css for complete copyright
+  and license information, including a copy of the OFL.
+

data/Manifest.txt

@@ -37,6 +37,7 @@ lib/rdoc/generator/darkfish.rb
 lib/rdoc/generator/json_index.rb
 lib/rdoc/generator/markup.rb
 lib/rdoc/generator/ri.rb
+lib/rdoc/generator/pot.rb
 lib/rdoc/generator/template/darkfish/.document
 lib/rdoc/generator/template/darkfish/_footer.rhtml
 lib/rdoc/generator/template/darkfish/_head.rhtml
@@ -54,7 +55,7 @@ lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
 lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
 lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml
 lib/rdoc/generator/template/darkfish/class.rhtml
-lib/rdoc/generator/template/darkfish/fonts.css
+lib/rdoc/generator/template/darkfish/css/fonts.css
 lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf
 lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf
 lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf
@@ -91,7 +92,7 @@ lib/rdoc/generator/template/darkfish/js/darkfish.js
 lib/rdoc/generator/template/darkfish/js/jquery.js
 lib/rdoc/generator/template/darkfish/js/search.js
 lib/rdoc/generator/template/darkfish/page.rhtml
-lib/rdoc/generator/template/darkfish/rdoc.css
+lib/rdoc/generator/template/darkfish/css/rdoc.css
 lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
 lib/rdoc/generator/template/darkfish/servlet_root.rhtml
 lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
@@ -234,6 +235,9 @@ test/test_rdoc_generator_darkfish.rb
 test/test_rdoc_generator_json_index.rb
 test/test_rdoc_generator_markup.rb
 test/test_rdoc_generator_ri.rb
+test/test_rdoc_generator_pot.rb
+test/test_rdoc_generator_pot_po.rb
+test/test_rdoc_generator_pot_po_entry.rb
 test/test_rdoc_include.rb
 test/test_rdoc_markdown.rb
 test/test_rdoc_markdown_test.rb

data/Rakefile

@@ -77,9 +77,16 @@ def rake(*args)
   sh $0, *args
 end
 
-if PARSER_FILES.any? {|file| not File.exist?(file)}
+need_racc = PARSER_FILES.any? do |rb_file|
+  ry_file = rb_file.gsub(/\.rb\z/, ".ry")
+  not File.exist?(rb_file) or
+    (File.exist?(ry_file) and File.mtime(rb_file) < File.mtime(ry_file))
+end
+
+if need_racc
   Rake::Task["default"].prerequisites.clear
   task :default do
+    rake "check_extra_deps"
     rake "install_plugins"
     rake "newb"
   end

data/lib/rdoc.rb

@@ -64,7 +64,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '4.1.2'
+  VERSION = '4.2.0'
 
   ##
   # Method visibilities
@@ -151,6 +151,8 @@ module RDoc
 
   autoload :Comment,        'rdoc/comment'
 
+  autoload :I18n,           'rdoc/i18n'
+
   # code objects
   #
   # We represent the various high-level code constructs that appear in Ruby

data/lib/rdoc/context.rb

@@ -164,6 +164,8 @@ class RDoc::Context < RDoc::CodeObject
   # Contexts are sorted by full_name
 
   def <=>(other)
+    return nil unless RDoc::CodeObject === other
+
     full_name <=> other.full_name
   end
 

data/lib/rdoc/encoding.rb

@@ -29,7 +29,9 @@ module RDoc::Encoding
         encoding ||= Encoding.default_external
         orig_encoding = content.encoding
 
-        if utf8 then
+        if not orig_encoding.ascii_compatible? then
+          content.encode! encoding
+        elsif utf8 then
           content.force_encoding Encoding::UTF_8
           content.encode! encoding
         else

data/lib/rdoc/generator.rb

@@ -45,6 +45,7 @@ module RDoc::Generator
   autoload :Darkfish,  'rdoc/generator/darkfish'
   autoload :JsonIndex, 'rdoc/generator/json_index'
   autoload :RI,        'rdoc/generator/ri'
+  autoload :POT,       'rdoc/generator/pot'
 
 end
 

data/lib/rdoc/generator/darkfish.rb

@@ -62,14 +62,14 @@ class RDoc::Generator::Darkfish
 
   BUILTIN_STYLE_ITEMS = # :nodoc:
     %w[
-      fonts.css
+      css/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
+      css/rdoc.css
   ]
 
   ##
@@ -246,6 +246,7 @@ class RDoc::Generator::Darkfish
     generate_file_files
     generate_table_of_contents
     @json_index.generate
+    @json_index.generate_gzipped
 
     copy_static
 

data/lib/rdoc/generator/json_index.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'zlib'
 
 ##
 # The JsonIndex generator is designed to complement an HTML generator and
@@ -152,6 +153,49 @@ class RDoc::Generator::JsonIndex
     end
   end
 
+  ##
+  # Compress the search_index.js file using gzip
+
+  def generate_gzipped
+    debug_msg "Compressing generated JSON index"
+    out_dir = @base_dir + @options.op_dir
+
+    search_index_file = out_dir + SEARCH_INDEX_FILE
+    outfile           = out_dir + "#{search_index_file}.gz"
+
+    debug_msg "Reading the JSON index file from %s" % search_index_file
+    search_index = search_index_file.read
+
+    debug_msg "Writing gzipped search index to %s" % outfile
+
+    Zlib::GzipWriter.open(outfile) do |gz|
+      gz.mtime = File.mtime(search_index_file)
+      gz.orig_name = search_index_file.to_s
+      gz.write search_index
+      gz.close
+    end
+
+    # GZip the rest of the js files
+    Dir.chdir @template_dir do
+      Dir['**/*.js'].each do |source|
+        dest = out_dir + source
+        outfile = out_dir + "#{dest}.gz"
+
+        debug_msg "Reading the original js file from %s" % dest
+        data = dest.read
+
+        debug_msg "Writing gzipped file to %s" % outfile
+
+        Zlib::GzipWriter.open(outfile) do |gz|
+          gz.mtime = File.mtime(dest)
+          gz.orig_name = dest.to_s
+          gz.write data
+          gz.close
+        end
+      end
+    end
+  end
+
   ##
   # Adds classes and modules to the index
 

data/lib/rdoc/generator/pot.rb

@@ -0,0 +1,97 @@
+##
+# Generates a POT file.
+#
+# Here is a translator work flow with the generator.
+#
+# == Create .pot
+#
+# You create .pot file by pot formatter:
+#
+#   % rdoc --format pot
+#
+# It generates doc/rdoc.pot.
+#
+# == Create .po
+#
+# You create .po file from doc/rdoc.pot. This operation is needed only
+# the first time. This work flow assumes that you are a translator
+# for Japanese.
+#
+# You create locale/ja/rdoc.po from doc/rdoc.pot. You can use msginit
+# provided by GNU gettext or rmsginit provided by gettext gem. This
+# work flow uses gettext gem because it is more portable than GNU
+# gettext for Rubyists. Gettext gem is implemented by pure Ruby.
+#
+#   % gem install gettext
+#   % mkdir -p locale/ja
+#   % rmsginit --input doc/rdoc.pot --output locale/ja/rdoc.po --locale ja
+#
+# Translate messages in .po
+#
+# You translate messages in .po by a PO file editor. po-mode.el exists
+# for Emacs users. There are some GUI tools such as GTranslator.
+# There are some Web services such as POEditor and Tansifex. You can
+# edit by your favorite text editor because .po is a text file.
+# Generate localized documentation
+#
+# You can generate localized documentation with locale/ja/rdoc.po:
+#
+#   % rdoc --locale ja
+#
+# You can find documentation in Japanese in doc/. Yay!
+#
+# == Update translation
+#
+# You need to update translation when your application is added or
+# modified messages.
+#
+# You can update .po by the following command lines:
+#
+#   % rdoc --format pot
+#   % rmsgmerge --update locale/ja/rdoc.po doc/rdoc.pot
+#
+# You edit locale/ja/rdoc.po to translate new messages.
+
+class RDoc::Generator::POT
+
+  RDoc::RDoc.add_generator self
+
+  ##
+  # Description of this generator
+
+  DESCRIPTION = 'creates .pot file'
+
+  ##
+  # Set up a new .pot generator
+
+  def initialize store, options #:not-new:
+    @options    = options
+    @store      = store
+  end
+
+  ##
+  # Writes .pot to disk.
+
+  def generate
+    po = extract_messages
+    pot_path = 'rdoc.pot'
+    File.open(pot_path, "w") do |pot|
+      pot.print(po.to_s)
+    end
+  end
+
+  def class_dir
+    nil
+  end
+
+  private
+  def extract_messages
+    extractor = MessageExtractor.new(@store)
+    extractor.extract
+  end
+
+  autoload :MessageExtractor, 'rdoc/generator/pot/message_extractor'
+  autoload :PO,               'rdoc/generator/pot/po'
+  autoload :POEntry,          'rdoc/generator/pot/po_entry'
+
+end

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

@@ -1,5 +1,5 @@
 <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>.
+  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">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

@@ -2,21 +2,18 @@
 
 <title><%= h @title %></title>
 
-<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 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>
+
+<link href="<%= asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
+<link href="<%= asset_rel_prefix %>/css/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 %>
+