rdoc 2.5 → 2.5.1

data/lib/rdoc/rdoc.rb

@@ -78,7 +78,7 @@ class RDoc::RDoc
     @current      = nil
     @exclude      = nil
     @generator    = nil
-    @last_created = nil
+    @last_created = {}
     @old_siginfo  = nil
     @options      = nil
     @stats        = nil
@@ -135,20 +135,29 @@ class RDoc::RDoc
   def setup_output_dir(op_dir, force)
     flag_file = output_flag_file op_dir
 
+    last = {}
+
     if File.exist? op_dir then
       unless File.directory? op_dir then
         error "'#{op_dir}' exists, and is not a directory"
       end
       begin
-        created = File.read(flag_file)
-      rescue SystemCallError
+        open flag_file do |io|
+          unless force
+            Time.parse f.gets
+            io.each do |line|
+              file, time = line.split(/\t/, 2)
+              time = Time.parse(time) rescue next
+              last[file] = time
+            end
+          end
+        end
+      rescue
         error "\nDirectory #{op_dir} already exists, but it looks like it\n" +
           "isn't an RDoc directory. Because RDoc doesn't want to risk\n" +
           "destroying any of your existing files, you'll need to\n" +
           "specify a different output directory name (using the\n" +
           "--op <dir> option).\n\n"
-      else
-        last = (Time.parse(created) unless force rescue nil)
       end
     else
       FileUtils.mkdir_p(op_dir)
@@ -160,8 +169,13 @@ class RDoc::RDoc
   ##
   # Update the flag file in an output directory.
 
-  def update_output_dir(op_dir, time)
-    File.open(output_flag_file(op_dir), "w") { |f| f.puts time.rfc2822 }
+  def update_output_dir(op_dir, time, last = {})
+    File.open(output_flag_file(op_dir), "w") do |f|
+      f.puts time.rfc2822
+      last.each do |n, t|
+        f.puts "#{n}\t#{t.rfc2822}"
+      end
+    end
   end
 
   ##
@@ -211,18 +225,20 @@ class RDoc::RDoc
       stat = File.stat rel_file_name rescue next
 
       case type = stat.ftype
-      when "file"
-        next if @last_created and stat.mtime < @last_created
+      when "file" then
+        next if last_created = @last_created[rel_file_name] and
+                stat.mtime <= last_created
 
         if force_doc or RDoc::Parser.can_parse(rel_file_name) then
           file_list << rel_file_name.sub(/^\.\//, '')
+          @last_created[rel_file_name] = stat.mtime
         end
-      when "directory"
+      when "directory" then
         next if rel_file_name == "CVS" || rel_file_name == ".svn"
 
         dot_doc = File.join rel_file_name, RDoc::DOT_DOC_FILENAME
 
-        if File.file?(dot_doc) then
+        if File.file? dot_doc then
           file_list << parse_dot_doc_file(rel_file_name, dot_doc)
         else
           file_list << list_files_in_directory(rel_file_name)
@@ -366,7 +382,7 @@ The internal error was:
           self.class.current = self
 
           @generator.generate file_info
-          update_output_dir ".", start_time
+          update_output_dir ".", start_time, @last_created
         ensure
           self.class.current = nil
         end
@@ -380,14 +396,10 @@ The internal error was:
   end
 
   def read_file_contents(filename)
-    content = if RUBY_VERSION >= '1.9' then
-                File.open(filename, "r:ascii-8bit") { |f| f.read }
-              else
-                File.read filename
-              end
+    content = File.open(filename, "rb") { |f| f.read }
 
     if defined? Encoding then
-      if /coding:\s*([\w-]+)/i =~ content[/\A(?:.*\n){0,2}/]
+      if /coding[=:]\s*([^\s;]+)/i =~ content[%r"\A(?:#!.*\n)?.*\n"]
         if enc = ::Encoding.find($1)
           content.force_encoding(enc)
         end

data/lib/rdoc/ri/driver.rb

@@ -532,7 +532,7 @@ Options may also be set in the 'RI' environment variable.
       elsif selector then
         # replace Foo with Foo:: as given
         completions.delete klass
-        completions << "#{klass}#{selector}" 
+        completions << "#{klass}#{selector}"
       end
 
       completions.push(*methods)
@@ -657,21 +657,13 @@ Options may also be set in the 'RI' environment variable.
         end
         out << RDoc::Markup::Rule.new(1)
 
-        if method.call_seq then
-          call_seq = method.call_seq.chomp.split "\n"
-          call_seq = call_seq.map { |line| ['  ', line, "\n"] }
-          out << RDoc::Markup::Verbatim.new(*call_seq.flatten)
+        if method.arglists then
+          arglists = method.arglists.chomp.split "\n"
+          arglists = arglists.map { |line| ['  ', line, "\n"] }
+          out << RDoc::Markup::Verbatim.new(*arglists.flatten)
+          out << RDoc::Markup::Rule.new(1)
         end
 
-        if method.block_params then
-          out << RDoc::Markup::BlankLine.new if method.call_seq
-          params = "yields: #{method.block_params}"
-          out << RDoc::Markup::Verbatim.new('  ', params, "\n")
-        end
-
-        out << RDoc::Markup::Rule.new(1) if
-          method.call_seq or method.block_params
-
         out << RDoc::Markup::BlankLine.new
         out << method.comment
         out << RDoc::Markup::BlankLine.new
@@ -793,7 +785,7 @@ Options may also be set in the 'RI' environment variable.
     end
 
     methods.each do |item|
-      yield(*item)
+      yield(*item) # :yields: store, klass, ancestor, types, method
     end
 
     self

data/lib/rdoc/ri/paths.rb

@@ -58,8 +58,7 @@ module RDoc::RI::Paths
   def self.gemdirs
     return @gemdirs if @gemdirs
 
-    require 'rubygems' unless defined?(Gem) and defined?(Gem::Enable) and
-                              Gem::Enable
+    require 'rubygems' unless defined?(Gem)
 
     # HACK dup'd from Gem.latest_partials and friends
     all_paths = []

data/lib/rdoc/ruby_lex.rb

@@ -144,7 +144,7 @@ class RDoc::RubyLex
     end
     @seek += 1
     if c == "\n"
-      @line_no += 1 
+      @line_no += 1
       @char_no = 0
     else
       @char_no += 1
@@ -181,10 +181,10 @@ class RDoc::RubyLex
       c2 = @here_readed.pop
     end
     c = c2 unless c
-    @rests.unshift c #c = 
+    @rests.unshift c #c =
     @seek -= 1
     if c == "\n"
-      @line_no -= 1 
+      @line_no -= 1
       if idx = @readed.reverse.index("\n")
         @char_no = @readed.size - idx
       else
@@ -394,7 +394,7 @@ class RDoc::RubyLex
     end
 
     @OP.def_rule("=begin",
-                 proc{|op, io| @prev_char_no == 0 && peek(0) =~ /\s/}) do 
+                 proc{|op, io| @prev_char_no == 0 && peek(0) =~ /\s/}) do
       |op, io|
       @ltype = "="
       res = ''
@@ -415,8 +415,8 @@ class RDoc::RubyLex
       else
         @continue = false
         @lex_state = EXPR_BEG
-        until (@indent_stack.empty? || 
-               [TkLPAREN, TkLBRACK, TkLBRACE, 
+        until (@indent_stack.empty? ||
+               [TkLPAREN, TkLBRACK, TkLBRACE,
                  TkfLPAREN, TkfLBRACK, TkfLBRACE].include?(@indent_stack.last))
           @indent_stack.pop
         end
@@ -427,7 +427,7 @@ class RDoc::RubyLex
     end
 
     @OP.def_rules("*", "**",
-                  "=", "==", "===", 
+                  "=", "==", "===",
                   "=~", "<=>",
                   "<", "<=",
                   ">", ">=", ">>") do
@@ -641,8 +641,8 @@ class RDoc::RubyLex
     @OP.def_rules(";") do
       |op, io|
       @lex_state = EXPR_BEG
-      until (@indent_stack.empty? || 
-             [TkLPAREN, TkLBRACK, TkLBRACE, 
+      until (@indent_stack.empty? ||
+             [TkLPAREN, TkLBRACK, TkLBRACE,
                TkfLPAREN, TkfLBRACK, TkfLBRACE].include?(@indent_stack.last))
         @indent_stack.pop
       end
@@ -761,7 +761,7 @@ class RDoc::RubyLex
       end
     end
 
-    #       @OP.def_rule("def", proc{|op, io| /\s/ =~ io.peek(0)}) do 
+    #       @OP.def_rule("def", proc{|op, io| /\s/ =~ io.peek(0)}) do
     # 	|op, io|
     # 	@indent += 1
     # 	@lex_state = EXPR_FNAME
@@ -1149,7 +1149,7 @@ class RDoc::RubyLex
           str << read_escape
         end
 
-        if PERCENT_PAREN.values.include?(@quoted) 
+        if PERCENT_PAREN.values.include?(@quoted)
           if PERCENT_PAREN[ch] == @quoted
             nest += 1
           elsif ch == @quoted
@@ -1270,7 +1270,7 @@ class RDoc::RubyLex
         escape << ch << read_escape
       end
     else
-      # other characters 
+      # other characters
     end
 
     escape

data/lib/rdoc/ruby_token.rb

@@ -1,5 +1,5 @@
 #--
-#   irb/ruby-token.rb - ruby tokens 
+#   irb/ruby-token.rb - ruby tokens
 #   	$Release Version: 0.9.5$
 #   	$Revision: 11708 $
 #   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
@@ -211,7 +211,7 @@ module RDoc::RubyToken
         IRB.fail TkReading2TokenNoKey, token
       end
 
-      tk = Token(tk[0], value) 
+      tk = Token(tk[0], value)
 
       if tk.kind_of?(TkOp) then
         tk.name = token
@@ -221,8 +221,8 @@ module RDoc::RubyToken
         IRB.fail TkSymbol2TokenNoKey, token
       end
 
-      tk = Token(tk[0], value) 
-    else 
+      tk = Token(tk[0], value)
+    else
       if token.instance_method(:initialize).arity == 3 then
         tk = token.new(@prev_seek, @prev_line_no, @prev_char_no)
         tk.set_text value

data/lib/rdoc/stats.rb

@@ -190,10 +190,10 @@ class RDoc::Stats
         line << (" " * padding) if padding > 0
 
         $stdout.print("#{line}\r")
-        $stdout.flush
       else
-        puts "#{progress_bar} #{filename}"
+        $stdout.puts "#{progress_bar} #{filename}"
       end
+      $stdout.flush
     end
 
     def done_adding # :nodoc:

data/lib/rdoc/task.rb

@@ -160,24 +160,28 @@ class RDoc::Task < Rake::TaskLib
   # Create the tasks defined by this task lib.
 
   def define
-    desc "Build the RDoc HTML files"
+    desc "Build RDoc HTML files"
     task rdoc_task_name
 
-    desc "Force rebuild RDoc HTML files"
+    desc "Rebuild RDoc HTML files"
     task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
 
     desc "Remove RDoc HTML files"
     task clobber_task_name do
-      rm_r rdoc_dir rescue nil
+      rm_r @rdoc_dir rescue nil
     end
 
     task :clobber => [clobber_task_name]
 
     directory @rdoc_dir
 
+    rdoc_target_deps = [
+      @rdoc_files,
+      Rake.application.rakefile
+    ].flatten.compact
+
     task rdoc_task_name => [rdoc_target]
-    file rdoc_target => @rdoc_files + [Rake.application.rakefile] do
-      rm_r @rdoc_dir rescue nil
+    file rdoc_target => rdoc_target_deps do
       @before_running_rdoc.call if @before_running_rdoc
       args = option_list + @rdoc_files
 

data/test/test.txt

@@ -0,0 +1 @@
+test file

data/test/test_rdoc_any_method.rb

@@ -1,26 +1,43 @@
-require 'test/xref_test_case'
+require File.expand_path '../xref_test_case', __FILE__
 
 class RDocAnyMethodTest < XrefTestCase
 
-  def test_full_name
-    assert_equal 'C1::m', @c1.method_list.first.full_name
+  def test_arglists
+    m = RDoc::AnyMethod.new nil, 'method'
+
+    assert_nil m.arglists
+
+    m.params = "(a, b)"
+    m.block_params = "c, d"
+
+    assert_equal "method(a, b) { |c, d| ... }", m.arglists
+
+    call_seq = <<-SEQ
+method(a) { |c| ... }
+method(a, b) { |c, d| ... }
+    SEQ
+
+    m.call_seq = call_seq.dup
+
+    assert_equal call_seq, m.arglists
   end
 
-  def test_parent_name
-    assert_equal 'C1', @c1.method_list.first.parent_name
-    assert_equal 'C1', @c1.method_list.last.parent_name
+  def test_full_name
+    assert_equal 'C1::m', @c1.method_list.first.full_name
   end
 
   def test_marshal_load
     instance_method = Marshal.load Marshal.dump(@c1.method_list.last)
 
-    assert_equal 'C1#m', instance_method.full_name
-    assert_equal 'C1',   instance_method.parent_name
+    assert_equal 'C1#m',  instance_method.full_name
+    assert_equal 'C1',    instance_method.parent_name
+    assert_equal '(foo)', instance_method.params
 
     class_method = Marshal.load Marshal.dump(@c1.method_list.first)
 
     assert_equal 'C1::m', class_method.full_name
     assert_equal 'C1',    class_method.parent_name
+    assert_equal '()',    class_method.params
   end
 
   def test_name
@@ -29,5 +46,30 @@ class RDocAnyMethodTest < XrefTestCase
     assert_nil m.name
   end
 
+  def test_param_seq
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.parent = @c1
+    m.params = 'a'
+
+    assert_equal '(a)', m.param_seq
+
+    m.params = '(a)'
+
+    assert_equal '(a)', m.param_seq
+
+    m.params = "(a,\n  b)"
+
+    assert_equal '(a, b)', m.param_seq
+
+    m.block_params = "c,\n  d"
+
+    assert_equal '(a, b) { |c, d| ... }', m.param_seq
+  end
+
+  def test_parent_name
+    assert_equal 'C1', @c1.method_list.first.parent_name
+    assert_equal 'C1', @c1.method_list.last.parent_name
+  end
+
 end
 

data/test/test_rdoc_attr.rb

@@ -8,6 +8,10 @@ class TestRDocAttr < MiniTest::Unit::TestCase
     @a = RDoc::Attr.new nil, 'attr', 'RW', ''
   end
 
+  def test_arglists
+    assert_nil @a.arglists
+  end
+
   def test_block_params
     assert_nil @a.block_params
   end
@@ -20,6 +24,10 @@ class TestRDocAttr < MiniTest::Unit::TestCase
     assert_equal '(unknown)#attr', @a.full_name
   end
 
+  def test_params
+    assert_nil @a.params
+  end
+
   def test_singleton
     refute @a.singleton
   end

data/test/test_rdoc_class_module.rb

@@ -1,4 +1,4 @@
-require 'test/xref_test_case'
+require File.expand_path '../xref_test_case', __FILE__
 
 class TestRDocClassModule < XrefTestCase
 

data/test/test_rdoc_code_object.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
-require 'minitest/unit'
-require 'test/xref_test_case'
+require 'minitest/autorun'
+require File.expand_path '../xref_test_case', __FILE__
 require 'rdoc/code_object'
 
 class TestRDocCodeObject < XrefTestCase

data/test/test_rdoc_constant.rb

@@ -1,4 +1,4 @@
-require 'test/xref_test_case'
+require File.expand_path '../xref_test_case', __FILE__
 
 class TestRDocConstant < XrefTestCase