rdoc 4.1.2 → 4.2.0

data/lib/rdoc/parser.rb

@@ -83,7 +83,7 @@ class RDoc::Parser
       mode = "r"
       s.sub!(/\A#!.*\n/, '')     # assume shebang line isn't longer than 1024.
       encoding = s[/^\s*\#\s*(?:-\*-\s*)?(?:en)?coding:\s*([^\s;]+?)(?:-\*-|[\s;])/, 1]
-      mode = "r:#{encoding}" if encoding
+      mode = "rb:#{encoding}" if encoding
       s = File.open(file, mode) {|f| f.gets(nil, 1024)}
 
       not s.valid_encoding?

data/lib/rdoc/parser/c.rb

@@ -611,7 +611,7 @@ class RDoc::Parser::C < RDoc::Parser
   def find_body class_name, meth_name, meth_obj, file_content, quiet = false
     case file_content
     when %r%((?>/\*.*?\*/\s*)?)
-            ((?:(?:static|SWIGINTERN)\s+)?
+            ((?:(?:\w+)\s+)?
              (?:intern\s+)?VALUE\s+#{meth_name}
              \s*(\([^)]*\))([^;]|$))%xm then
       comment = RDoc::Comment.new $1, @top_level
@@ -745,11 +745,11 @@ class RDoc::Parser::C < RDoc::Parser
     elsif @content =~ %r%Document-(?:class|module):\s+#{class_name}\s*?
                          (?:<\s+[:,\w]+)?\n((?>.*?\*/))%xm then
       comment = "/*\n#{$1}"
-    elsif @content =~ %r%.*((?>/\*.*?\*/\s+))
-                         ([\w\.\s]+\s* = \s+)?rb_define_(class|module).*?"(#{class_name})"%xm then
+    elsif @content =~ %r%((?>/\*.*?\*/\s+))
+                         ([\w\.\s]+\s* = \s+)?rb_define_(class|module)[\t (]*?"(#{class_name})"%xm then
       comment = $1
-    elsif @content =~ %r%.*((?>/\*.*?\*/\s+))
-                         ([\w\.\s]+\s* = \s+)?rb_define_(class|module)_under.*?"(#{class_name.split('::').last})"%xm then
+    elsif @content =~ %r%((?>/\*.*?\*/\s+))
+                         ([\w\. \t]+ = \s+)?rb_define_(class|module)_under[\t\w, (]*?"(#{class_name.split('::').last})"%xm then
       comment = $1
     else
       comment = ''
@@ -1186,7 +1186,6 @@ class RDoc::Parser::C < RDoc::Parser
 
     if hash then
       args << "p#{position} = {}"
-      position += 1
     end
 
     args << '&block' if block

data/lib/rdoc/parser/changelog.rb

@@ -145,10 +145,14 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
           # HACK Ruby 1.8 does not raise ArgumentError for Time.parse "Other"
           entry_name = nil unless entry_name =~ /#{time.year}/
         rescue NoMethodError
-          time, = entry_name.split '  ', 2
-          time = Time.parse time
+          # HACK Ruby 2.1.2 and earlier raises NoMethodError if time part is absent
+          entry_name.split '  ', 2
         rescue ArgumentError
-          entry_name = nil
+          if /out of range/ =~ $!.message
+            Time.parse(entry_name.split('  ', 2)[0]) rescue entry_name = nil
+          else
+            entry_name = nil
+          end
         end
 
         entry_body = []

data/lib/rdoc/parser/ruby.rb

@@ -187,15 +187,16 @@ class RDoc::Parser::Ruby < RDoc::Parser
   end
 
   ##
-  # Extracts the visibility information for the visibility token +tk+.
+  # Extracts the visibility information for the visibility token +tk+
+  # and +single+ class type identifier.
   #
   # Returns the visibility type (a string), the visibility (a symbol) and
   # +singleton+ if the methods following should be converted to singleton
   # methods.
 
-  def get_visibility_information tk # :nodoc:
+  def get_visibility_information tk, single # :nodoc:
     vis_type  = tk.name
-    singleton = false
+    singleton = single == SINGLE
 
     vis =
       case vis_type
@@ -845,7 +846,6 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # true, no found constants will be added to RDoc.
 
   def parse_constant container, tk, comment, ignore_constants = false
-    prev_container = container
     offset  = tk.seek
     line_no = tk.line_no
 
@@ -868,8 +868,6 @@ class RDoc::Parser::Ruby < RDoc::Parser
     end
 
     unless TkASSIGN === eq_tk then
-      suppress_parents container, prev_container
-
       unget_tk eq_tk
       return false
     end
@@ -893,7 +891,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     read_documentation_modifiers con, RDoc::CONSTANT_MODIFIERS
 
     @stats.add_constant con
-    con = container.add_constant con
+    container.add_constant con
 
     true
   end
@@ -1309,7 +1307,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     return unless name
 
     meth = RDoc::AnyMethod.new get_tkread, name
-    meth.singleton = singleton
+    meth.singleton = single == SINGLE ? true : singleton
 
     record_location meth
     meth.offset = offset
@@ -1879,9 +1877,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # Determines the visibility in +container+ from +tk+
 
   def parse_visibility(container, single, tk)
-    singleton = (single == SINGLE)
-
-    vis_type, vis, singleton = get_visibility_information tk
+    vis_type, vis, singleton = get_visibility_information tk, single
 
     skip_tkspace_comment false
 
@@ -2082,7 +2078,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
   def skip_for_variable
     skip_tkspace false
-    tk = get_tk
+    get_tk
     skip_tkspace false
     tk = get_tk
     unget_tk(tk) unless TkIN === tk

data/lib/rdoc/rd/block_parser.rb

@@ -1,6 +1,6 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.11
+# This file is automatically generated by Racc 1.4.12
 # from Racc grammer file "".
 #
 

data/lib/rdoc/rd/inline_parser.rb

@@ -1,6 +1,6 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.11
+# This file is automatically generated by Racc 1.4.12
 # from Racc grammer file "".
 #
 

data/lib/rdoc/rdoc.rb

@@ -305,6 +305,9 @@ option)
       when "directory" then
         next if rel_file_name == "CVS" || rel_file_name == ".svn"
 
+        created_rid = File.join rel_file_name, "created.rid"
+        next if File.file? created_rid
+
         dot_doc = File.join rel_file_name, RDoc::DOT_DOC_FILENAME
 
         if File.file? dot_doc then
@@ -336,7 +339,7 @@ option)
   # Parses +filename+ and returns an RDoc::TopLevel
 
   def parse_file filename
-    if defined?(Encoding) then
+    if Object.const_defined? :Encoding then
       encoding = @options.encoding
       filename = filename.encode encoding
     end
@@ -411,8 +414,6 @@ The internal error was:
 
     return [] if file_list.empty?
 
-    file_info = []
-
     @stats.begin_adding
 
     file_info = file_list.map do |filename|
@@ -565,4 +566,5 @@ end
 # require built-in generators after discovery in case they've been replaced
 require 'rdoc/generator/darkfish'
 require 'rdoc/generator/ri'
+require 'rdoc/generator/pot'
 

data/lib/rdoc/ruby_lex.rb

@@ -434,7 +434,7 @@ class RDoc::RubyLex
       |op, io|
       @ltype = "="
       res = ''
-      nil until (ch = getc) == "\n"
+      nil until getc == "\n"
 
       until ( peek_equal?("=end") && peek(4) =~ /\s/ ) do
         (ch = getc)
@@ -1184,9 +1184,9 @@ class RDoc::RubyLex
     str = if ltype == quoted and %w[" ' /].include? ltype then
             ltype.dup
           elsif RUBY_VERSION > '1.9' then
-            "%#{type or PERCENT_LTYPE.key ltype}#{PERCENT_PAREN_REV[quoted]}"
+            "%#{type or PERCENT_LTYPE.key ltype}#{PERCENT_PAREN_REV[quoted]||quoted}"
           else
-            "%#{type or PERCENT_LTYPE.index ltype}#{PERCENT_PAREN_REV[quoted]}"
+            "%#{type or PERCENT_LTYPE.index ltype}#{PERCENT_PAREN_REV[quoted]||quoted}"
           end
 
     subtype = nil

data/lib/rdoc/ruby_token.rb

@@ -38,9 +38,9 @@ module RDoc::RubyToken
       @text = text
     end
 
-    attr :seek
-    attr :line_no
-    attr :char_no
+    attr_reader :seek
+    attr_reader :line_no
+    attr_reader :char_no
 
     attr_accessor :text
 
@@ -73,7 +73,7 @@ module RDoc::RubyToken
       @node = node
     end
 
-    attr :node
+    attr_reader:node
 
     def ==(other)
       self.class == other.class and
@@ -101,7 +101,7 @@ module RDoc::RubyToken
       super(seek, line_no, char_no)
       @name = name
     end
-    attr :name
+    attr_reader:name
 
     def ==(other)
       self.class == other.class and
@@ -192,7 +192,7 @@ module RDoc::RubyToken
       @text = nil
     end
 
-    attr :op
+    attr_reader:op
 
     def ==(other)
       self.class == other.class and
@@ -217,7 +217,7 @@ module RDoc::RubyToken
       super(seek, line_no, char_no)
       @name = name
     end
-    attr :name
+    attr_reader:name
 
     def ==(other)
       self.class == other.class and

data/lib/rdoc/single_class.rb

@@ -10,6 +10,10 @@ class RDoc::SingleClass < RDoc::ClassModule
     superclass ? super + [superclass] : super
   end
 
+  def aref_prefix # :nodoc:
+    'sclass'
+  end
+
   ##
   # The definition of this singleton class, <tt>class << MyClassName</tt>
 

data/lib/rdoc/stats.rb

@@ -4,6 +4,8 @@
 
 class RDoc::Stats
 
+  include RDoc::Text
+
   ##
   # Output level for the coverage report
 
@@ -438,6 +440,8 @@ class RDoc::Stats
 
     params = method.param_list
 
+    params = params.map { |param| param.gsub(/^\*\*?/, '') }
+
     return 0, [] if params.empty?
 
     document = parse method.comment

data/lib/rdoc/stats/normal.rb

@@ -1,3 +1,8 @@
+begin
+  require 'io/console/size'
+rescue LoadError
+end
+
 ##
 # Stats printer that prints just the files being documented with a progress
 # bar
@@ -5,15 +10,14 @@
 class RDoc::Stats::Normal < RDoc::Stats::Quiet
 
   def begin_adding # :nodoc:
-    puts "Parsing sources..." if $stdout.tty?
+    puts "Parsing sources..."
+    @last_width = 0
   end
 
   ##
   # Prints a file with a progress bar
 
   def print_file files_so_far, filename
-    return unless $stdout.tty?
-
     progress_bar = sprintf("%3d%% [%2d/%2d]  ",
                            100 * files_so_far / @num_files,
                            files_so_far,
@@ -21,7 +25,11 @@ class RDoc::Stats::Normal < RDoc::Stats::Quiet
 
     # Print a progress bar, but make sure it fits on a single line. Filename
     # will be truncated if necessary.
-    terminal_width = (ENV['COLUMNS'] || 80).to_i
+    terminal_width = if defined?(IO) && IO.respond_to?(:console_size)
+                       IO.console_size[1].to_i.nonzero? || 80
+                     else
+                       80
+                     end
     max_filename_size = terminal_width - progress_bar.size
 
     if filename.size > max_filename_size then
@@ -30,18 +38,21 @@ class RDoc::Stats::Normal < RDoc::Stats::Quiet
       filename[0..2] = "..."
     end
 
-    # Pad the line with whitespaces so that leftover output from the
-    # previous line doesn't show up.
     line = "#{progress_bar}#{filename}"
-    padding = terminal_width - line.size
-    line << (" " * padding) if padding > 0
-
-    $stdout.print("#{line}\r")
+    if $stdout.tty?
+      # Clean the line with whitespaces so that leftover output from the
+      # previous line doesn't show up.
+      $stdout.print("\r" << (" " * @last_width) << ("\b" * @last_width) << "\r") if @last_width && @last_width > 0
+      @last_width = line.size
+      $stdout.print("#{line}\r")
+    else
+      $stdout.puts(line)
+    end
     $stdout.flush
   end
 
   def done_adding # :nodoc:
-    puts if $stdout.tty?
+    puts
   end
 
 end

data/lib/rdoc/task.rb

@@ -291,7 +291,7 @@ class RDoc::Task < Rake::TaskLib
   private
 
   def rdoc_target
-    "#{rdoc_dir}/index.html"
+    "#{rdoc_dir}/created.rid"
   end
 
   def rdoc_task_name

data/lib/rdoc/test_case.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 
 begin
   gem 'minitest', '~> 4.0' unless defined?(Test::Unit)
-rescue NoMethodError
+rescue NoMethodError, Gem::LoadError
   # for ruby tests
 end
 

data/lib/rdoc/text.rb

@@ -103,6 +103,15 @@ module RDoc::Text
   # Requires the including class to implement #formatter
 
   def markup text
+    if @store.rdoc.options
+      locale = @store.rdoc.options.locale
+    else
+      locale = nil
+    end
+    if locale
+      i18n_text = RDoc::I18n::Text.new(text)
+      text = i18n_text.translate(locale)
+    end
     parse(text).accept formatter
   end
 

data/lib/rdoc/token_stream.rb

@@ -88,7 +88,7 @@ module RDoc::TokenStream
   # Returns a string representation of the token stream
 
   def tokens_to_s
-    token_stream.map { |token| token.text }.join ''
+    token_stream.compact.map { |token| token.text }.join ''
   end
 
 end

data/test/test_rdoc_context.rb

@@ -621,6 +621,8 @@ class TestRDocContext < XrefTestCase
 
     assert_equal 1,  @c2_c3.<=>(@c2)
     assert_equal(-1, @c2_c3.<=>(@c3))
+
+    assert_nil @c2.<=>(Gem.loaded_specs.values.first)
   end
 
   def test_methods_by_type

data/test/test_rdoc_encoding.rb

@@ -10,6 +10,12 @@ class TestRDocEncoding < RDoc::TestCase
     @tempfile = Tempfile.new 'test_rdoc_encoding'
   end
 
+  def teardown
+    @tempfile.close!
+
+    super
+  end
+
   def test_class_read_file
     @tempfile.write "hi everybody"
     @tempfile.flush
@@ -125,6 +131,23 @@ class TestRDocEncoding < RDoc::TestCase
     assert_equal "hi everybody", content, bug3360
   end
 
+  def test_class_read_file_encoding_iso_2022_jp
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    input = "# coding: ISO-2022-JP\n:\e$B%3%^%s%I\e(B:"
+
+    @tempfile.write input
+    @tempfile.flush
+
+    contents = RDoc::Encoding.read_file @tempfile.path, Encoding::UTF_8
+
+    expected = ":\xe3\x82\xb3\xe3\x83\x9e\xe3\x83\xb3\xe3\x83\x89:"
+    expected.force_encoding Encoding::UTF_8
+
+    assert_equal expected, contents
+    assert_equal Encoding::UTF_8, contents.encoding
+  end
+
   def test_class_set_encoding
     s = "# coding: UTF-8\n"
     RDoc::Encoding.set_encoding s

data/test/test_rdoc_generator_darkfish.rb

@@ -76,8 +76,8 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
     assert_file 'table_of_contents.html'
     assert_file 'js/search_index.js'
 
-    assert_hard_link 'rdoc.css'
-    assert_hard_link 'fonts.css'
+    assert_hard_link 'css/rdoc.css'
+    assert_hard_link 'css/fonts.css'
 
     assert_hard_link 'fonts/SourceCodePro-Bold.ttf'
     assert_hard_link 'fonts/SourceCodePro-Regular.ttf'