rdoc 2.5.2 → 2.5.3

data/History.txt

@@ -1,4 +1,4 @@
-=== 2.5.2 / 2010-04-09
+=== 2.5.3 / 2010-04
 
 *NOTE*:
 
@@ -19,7 +19,17 @@ To have ri data for you gems you'll also need to run:
 
 If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
 
-* 1 Minor Enhancements
+* 1 Minor Enhancement
+  * RDoc::Parser::Simple and the include directive remove coding: comment from
+    first line
+* 2 Bug Fixe
+  * Fixed loading of created.rid when regenerating documentation.  Ruby bug
+    #3121 by Yusuke Endoh.
+  * Compare times as Integers as created.rid doesn't store fractional times.
+
+=== 2.5.2 / 2010-04-09
+
+* 1 Minor Enhancement
   * Imported various changes by Nobu from ruby trunk.
 * 2 Bug Fixes
   * RDoc parses files without extensions as text files again.

data/Manifest.txt

@@ -121,6 +121,7 @@ test/test_rdoc_markup_attribute_manager.rb
 test/test_rdoc_markup_document.rb
 test/test_rdoc_markup_paragraph.rb
 test/test_rdoc_markup_parser.rb
+test/test_rdoc_markup_pre_process.rb
 test/test_rdoc_markup_to_ansi.rb
 test/test_rdoc_markup_to_bs.rb
 test/test_rdoc_markup_to_html.rb

data/lib/rdoc.rb

@@ -383,7 +383,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '2.5.2'
+  VERSION = '2.5.3'
 
   ##
   # Name of the dotfile that contains the description of files to be processed

data/lib/rdoc/markup/preprocess.rb

@@ -41,14 +41,13 @@ class RDoc::Markup::PreProcess
     end
   end
 
-  private
-
   ##
   # Include a file, indenting it correctly.
 
   def include_file(name, indent)
     if full_name = find_include_file(name) then
       content = File.read full_name
+      content = content.sub(/\A# .*coding[=:].*$/, '').lstrip
 
       # strip leading '#'s, but only if all lines start with them
       if content =~ /^[^#]/ then
@@ -57,7 +56,7 @@ class RDoc::Markup::PreProcess
         content.gsub(/^#?/, indent)
       end
     else
-      $stderr.puts "Couldn't find file to include '#{name}' from #{@input_file_name}"
+      warn "Couldn't find file to include '#{name}' from #{@input_file_name}"
       ''
     end
   end

data/lib/rdoc/parser/simple.rb

@@ -24,7 +24,10 @@ class RDoc::Parser::Simple < RDoc::Parser
   # Extract the file contents and attach them to the TopLevel as a comment
 
   def scan
-    @top_level.comment = remove_private_comments(@content)
+    comment = remove_coding_comment @content
+    comment = remove_private_comments comment
+
+    @top_level.comment = comment
     @top_level.parser = self.class
     @top_level
   end
@@ -33,5 +36,9 @@ class RDoc::Parser::Simple < RDoc::Parser
     comment.gsub(/^--\n.*?^\+\+/m, '').sub(/^--\n.*/m, '')
   end
 
+  def remove_coding_comment text
+    text.sub(/\A# .*coding[=:].*$/, '')
+  end
+
 end
 

data/lib/rdoc/rdoc.rb

@@ -37,6 +37,11 @@ class RDoc::RDoc
 
   attr_accessor :generator
 
+  ##
+  # Hash of files and their last modified times.
+
+  attr_reader :last_modified
+
   ##
   # RDoc options
 
@@ -75,13 +80,13 @@ class RDoc::RDoc
   end
 
   def initialize
-    @current      = nil
-    @exclude      = nil
-    @generator    = nil
-    @last_created = {}
-    @old_siginfo  = nil
-    @options      = nil
-    @stats        = nil
+    @current       = nil
+    @exclude       = nil
+    @generator     = nil
+    @last_modified = {}
+    @old_siginfo   = nil
+    @options       = nil
+    @stats         = nil
   end
 
   ##
@@ -132,35 +137,39 @@ class RDoc::RDoc
   # contain the flag file <tt>created.rid</tt> then we refuse to use it, as
   # we may clobber some manually generated documentation
 
-  def setup_output_dir(op_dir, force)
-    flag_file = output_flag_file op_dir
+  def setup_output_dir(dir, force)
+    flag_file = output_flag_file dir
 
     last = {}
 
-    if File.exist? op_dir then
-      unless File.directory? op_dir then
-        error "'#{op_dir}' exists, and is not a directory"
-      end
+    if File.exist? dir then
+      error "#{dir} exists and is not a directory" unless File.directory? dir
+
       begin
         open flag_file do |io|
-          unless force
-            Time.parse f.gets
+          unless force then
+            Time.parse io.gets
+
             io.each do |line|
-              file, time = line.split(/\t/, 2)
+              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"
+      rescue SystemCallError, TypeError
+        error <<-ERROR
+
+Directory #{dir} already exists, but it looks like it isn't an RDoc directory.
+
+Because RDoc doesn't want to risk destroying any of your existing files,
+you'll need to specify a different output directory name (using the --op <dir>
+option)
+
+        ERROR
       end
     else
-      FileUtils.mkdir_p(op_dir)
+      FileUtils.mkdir_p dir
     end
 
     last
@@ -170,7 +179,7 @@ class RDoc::RDoc
   # Update the flag file in an output directory.
 
   def update_output_dir(op_dir, time, last = {})
-    File.open(output_flag_file(op_dir), "w") do |f|
+    open output_flag_file(op_dir), "w" do |f|
       f.puts time.rfc2822
       last.each do |n, t|
         f.puts "#{n}\t#{t.rfc2822}"
@@ -226,12 +235,12 @@ class RDoc::RDoc
 
       case type = stat.ftype
       when "file" then
-        next if last_created = @last_created[rel_file_name] and
-                stat.mtime <= last_created
+        next if last_modified = @last_modified[rel_file_name] and
+                stat.mtime.to_i <= last_modified.to_i
 
         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
+          @last_modified[rel_file_name] = stat.mtime
         end
       when "directory" then
         next if rel_file_name == "CVS" || rel_file_name == ".svn"
@@ -356,7 +365,7 @@ The internal error was:
 
     @exclude = @options.exclude
 
-    @last_created = setup_output_dir @options.op_dir, @options.force_update
+    @last_modified = setup_output_dir @options.op_dir, @options.force_update
 
     start_time = Time.now
 
@@ -382,7 +391,7 @@ The internal error was:
           self.class.current = self
 
           @generator.generate file_info
-          update_output_dir ".", start_time, @last_created
+          update_output_dir ".", start_time, @last_modified
         ensure
           self.class.current = nil
         end
@@ -396,7 +405,7 @@ The internal error was:
   end
 
   def read_file_contents(filename)
-    content = File.open(filename, "rb") { |f| f.read }
+    content = open filename, "rb" do |f| f.read end
 
     if defined? Encoding then
       if /coding[=:]\s*([^\s;]+)/i =~ content[%r"\A(?:#!.*\n)?.*\n"]

data/test/test_rdoc_markup_pre_process.rb

@@ -0,0 +1,42 @@
+require 'tempfile'
+require 'rubygems'
+require 'minitest/autorun'
+require 'rdoc/markup/preprocess'
+
+class TestRDocMarkupPreProcess < MiniTest::Unit::TestCase
+
+  def setup
+    @tempfile = Tempfile.new 'test_rdoc_markup_pre_process'
+    @name = File.basename @tempfile.path
+    @dir  = File.dirname @tempfile.path
+
+    @pp = RDoc::Markup::PreProcess.new __FILE__, [@dir]
+  end
+
+  def teardown
+    @tempfile.close
+  end
+
+  def test_include_file
+    @tempfile.write <<-INCLUDE
+# -*- mode: rdoc; coding: utf-8; fill-column: 74; -*-
+
+Regular expressions (<i>regexp</i>s) are patterns which describe the
+contents of a string.
+    INCLUDE
+
+    @tempfile.flush
+    @tempfile.rewind
+
+    content = @pp.include_file @name, ''
+
+    expected = <<-EXPECTED
+Regular expressions (<i>regexp</i>s) are patterns which describe the
+contents of a string.
+    EXPECTED
+
+    assert_equal expected, content
+  end
+
+end
+

data/test/test_rdoc_parser_simple.rb

@@ -22,6 +22,25 @@ class TestRDocParserSimple < MiniTest::Unit::TestCase
     @tempfile.close
   end
 
+  def test_remove_coding_comment
+    parser = util_parser <<-TEXT
+# -*- mode: rdoc; coding: utf-8; fill-column: 74; -*-
+
+Regular expressions (<i>regexp</i>s) are patterns which describe the
+contents of a string.
+    TEXT
+
+    parser.scan
+
+    expected = <<-TEXT.strip
+
+Regular expressions (<i>regexp</i>s) are patterns which describe the
+contents of a string.
+    TEXT
+
+    assert_equal expected, @top_level.comment
+  end
+
   def test_remove_private_comments
     parser = util_parser ''
     text = "foo\n\n--\nbar\n++\n\nbaz\n"

data/test/test_rdoc_rdoc.rb

@@ -1,4 +1,5 @@
 require 'tempfile'
+require 'tmpdir'
 require 'rubygems'
 require 'minitest/autorun'
 require 'rdoc/rdoc'
@@ -11,7 +12,7 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
   end
 
   def teardown
-    @tempfile.close
+    @tempfile.close rescue nil # HACK for 1.8.6
   end
 
   def test_gather_files
@@ -19,6 +20,24 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
     assert_equal [file], @rdoc.gather_files([file, file])
   end
 
+  def test_normalized_file_list
+    files = @rdoc.normalized_file_list [__FILE__]
+
+    files = files.map { |file| File.expand_path file }
+
+    assert_equal [File.expand_path(__FILE__)], files
+  end
+
+  def test_normalized_file_list_not_modified
+    files = [__FILE__]
+
+    @rdoc.last_modified[__FILE__] = File.stat(__FILE__).mtime
+
+    files = @rdoc.normalized_file_list [__FILE__]
+
+    assert_empty files
+  end
+
   def test_read_file_contents
     @tempfile.write "hi everybody"
     @tempfile.flush
@@ -62,5 +81,75 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
     assert_empty @rdoc.remove_unparseable file_list
   end
 
+  def test_setup_output_dir
+    path = @tempfile.path
+    @tempfile.unlink
+
+    last = @rdoc.setup_output_dir path, false
+
+    assert_empty last
+
+    assert File.directory? path
+  ensure
+    FileUtils.rm_f path
+  end
+
+  def test_setup_output_dir_exists
+    path = @tempfile.path
+    @tempfile.unlink
+    FileUtils.mkdir_p path
+
+    open @rdoc.output_flag_file(path), 'w' do |io|
+      io.puts Time.at 0
+      io.puts "./lib/rdoc.rb\t#{Time.at 86400}"
+    end
+
+    last = @rdoc.setup_output_dir path, false
+
+    assert_equal 1, last.size
+    assert_equal Time.at(86400), last['./lib/rdoc.rb']
+  ensure
+    FileUtils.rm_f path
+  end
+
+  def test_setup_output_dir_exists_empty_created_rid
+    path = @tempfile.path
+    @tempfile.unlink
+    FileUtils.mkdir_p path
+
+    open @rdoc.output_flag_file(path), 'w' do end
+
+    e = assert_raises RDoc::Error do
+      @rdoc.setup_output_dir path, false
+    end
+
+    assert_match %r%Directory #{Regexp.escape path} already exists%, e.message
+  ensure
+    FileUtils.rm_f path
+  end
+
+  def test_setup_output_dir_exists_file
+    path = @tempfile.path
+
+    e = assert_raises RDoc::Error do
+      @rdoc.setup_output_dir path, false
+    end
+
+    assert_match(%r%#{Regexp.escape path} exists and is not a directory%,
+                 e.message)
+  end
+
+  def test_setup_output_dir_exists_not_rdoc
+    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
+
+    Dir.mktmpdir do |dir|
+      e = assert_raises RDoc::Error do
+        @rdoc.setup_output_dir dir, false
+      end
+
+      assert_match %r%Directory #{Regexp.escape dir} already exists%, e.message
+    end
+  end
+
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 5
-  - 2
-  version: 2.5.2
+  - 3
+  version: 2.5.3
 platform: ruby
 authors: 
 - Eric Hodel
@@ -38,7 +38,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2010-04-09 00:00:00 -07:00
+date: 2010-04-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -246,6 +246,7 @@ files:
 - test/test_rdoc_markup_document.rb
 - test/test_rdoc_markup_paragraph.rb
 - test/test_rdoc_markup_parser.rb
+- test/test_rdoc_markup_pre_process.rb
 - test/test_rdoc_markup_to_ansi.rb
 - test/test_rdoc_markup_to_bs.rb
 - test/test_rdoc_markup_to_html.rb
@@ -316,6 +317,7 @@ test_files:
 - test/test_rdoc_markup_document.rb
 - test/test_rdoc_markup_paragraph.rb
 - test/test_rdoc_markup_parser.rb
+- test/test_rdoc_markup_pre_process.rb
 - test/test_rdoc_markup_to_ansi.rb
 - test/test_rdoc_markup_to_bs.rb
 - test/test_rdoc_markup_to_html.rb

metadata.gz.sig

@@ -1 +1,3 @@
-:�T׺�pT;aY�����좟c��"*��<J�&7u�ss9f�$��Ԋ/|81bv���.����]���T��H��������ܩBHi!^L�͎eZ7�|������v��c���U*��'�"�e������u��8�Wi2�����u�zB�3�7�I� �<�a
�0m��HsŰ�Db�䵣��
+g\x��z�jy`ӣ"��$���T�"�)QyP�]����e$fC�����:_��������I
ʈ���)E�nWS8���,(�:�+i�(=�ک��:�E+)�
+��ܿNj�
+]