rdoc 3.5.3 → 3.6

data/lib/rdoc/ri/store.rb

@@ -7,6 +7,18 @@ require 'fileutils'
 # The store manages reading and writing ri data for a project (gem, path,
 # etc.) and maintains a cache of methods, classes and ancestors in the
 # store.
+#
+# The store maintains a #cache of its contents for faster lookup.  After
+# adding items to the store it must be flushed using #save_cache.  The cache
+# contains the following structures:
+#
+#    @cache = {
+#      :class_methods    => {}, # class name => class methods
+#      :instance_methods => {}, # class name => instance methods
+#      :attributes       => {}, # class name => attributes
+#      :modules          => [], # classes and modules in this store
+#      :ancestors        => {}, # class name => ancestor names
+#    }
 
 class RDoc::RI::Store
 

data/lib/rdoc/ruby_lex.rb

@@ -403,9 +403,11 @@ class RDoc::RubyLex
       res = ''
       nil until (ch = getc) == "\n"
 
-      until peek_equal?("=end") && peek(4) =~ /\s/ do
-        until (ch = getc) == "\n" do res << ch end
+      until ( peek_equal?("=end") && peek(4) =~ /\s/ ) do
+        (ch = getc)
+        res << ch
       end
+  
       gets # consume =end
 
       @ltype = nil

data/lib/rdoc/stats.rb

@@ -31,7 +31,7 @@ class RDoc::Stats
 
     @coverage_level = 0
     @doc_items = nil
-    @fully_documented = nil
+    @fully_documented = false
     @num_params = 0
     @percent_doc = nil
     @start = Time.now

data/lib/rdoc/stats/normal.rb

@@ -5,46 +5,43 @@
 class RDoc::Stats::Normal < RDoc::Stats::Quiet
 
   def begin_adding # :nodoc:
-    puts "Parsing sources..."
+    puts "Parsing sources..." if $stdout.tty?
   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,
                            @num_files)
 
-    if $stdout.tty? then
-      # 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
-      max_filename_size = terminal_width - progress_bar.size
-
-      if filename.size > max_filename_size then
-        # Turn "some_long_filename.rb" to "...ong_filename.rb"
-        filename = filename[(filename.size - max_filename_size) .. -1]
-        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")
-    else
-      $stdout.puts "#{progress_bar} #{filename}"
+    # 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
+    max_filename_size = terminal_width - progress_bar.size
+
+    if filename.size > max_filename_size then
+      # Turn "some_long_filename.rb" to "...ong_filename.rb"
+      filename = filename[(filename.size - max_filename_size) .. -1]
+      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")
     $stdout.flush
   end
 
   def done_adding # :nodoc:
-    puts
+    puts if $stdout.tty?
   end
 
 end

data/lib/rdoc/task.rb

@@ -37,9 +37,8 @@ require 'rake'
 require 'rake/tasklib'
 
 ##
-# Create a documentation task that will generate the RDoc files for a project.
-#
-# The RDoc::Task will create the following targets:
+# RDoc::Task creates the following rake tasks to generate and clean up RDoc
+# output:
 #
 # [rdoc]
 #   Main task for this RDoc task.
@@ -56,12 +55,12 @@ require 'rake/tasklib'
 #   gem 'rdoc'
 #   require 'rdoc/task'
 #
-#   RDoc::Task.new do |rd|
-#     rd.main = "README.rdoc"
-#     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+#   RDoc::Task.new do |rdoc|
+#     rdoc.main = "README.rdoc"
+#     rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
 #   end
 #
-# The +rd+ object passed to the block is an RDoc::Task object. See the
+# The +rdoc+ object passed to the block is an RDoc::Task object. See the
 # attributes list for the RDoc::Task class for available customization options.
 #
 # == Specifying different task names
@@ -73,10 +72,10 @@ require 'rake/tasklib'
 #   gem 'rdoc'
 #   require 'rdoc/task'
 #
-#   RDoc::Task.new :rdoc_dev do |rd|
-#     rd.main = "README.doc"
-#     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
-#     rd.options << "--all"
+#   RDoc::Task.new :rdoc_dev do |rdoc|
+#     rdoc.main = "README.doc"
+#     rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+#     rdoc.options << "--all"
 #   end
 #
 # The tasks would then be named :<em>rdoc_dev</em>,

data/lib/rdoc/text.rb

@@ -61,25 +61,17 @@ module RDoc::Text
   # Flush +text+ left based on the shortest line
 
   def flush_left text
-    indents = []
+    indent = 9999
 
     text.each_line do |line|
-      indents << (line =~ /[^\s]/ || 9999)
+      line_indent = line =~ /\S/ || 9999
+      indent = line_indent if indent > line_indent
     end
 
-    indent = indents.min
-
-    flush = []
-
     empty = ''
     empty.force_encoding text.encoding if Object.const_defined? :Encoding
 
-    text.each_line do |line|
-      line[/^ {0,#{indent}}/] = empty
-      flush << line
-    end
-
-    flush.join
+    text.gsub(/^ {0,#{indent}}/, empty)
   end
 
   ##

data/test/test_rdoc_class_module.rb

@@ -8,6 +8,10 @@ class TestRDocClassModule < XrefTestCase
     @RM = RDoc::Markup
   end
 
+  def test_ancestors
+    assert_equal [@parent], @child.ancestors
+  end
+
   def test_comment_equals
     cm = RDoc::ClassModule.new 'Klass'
     cm.comment = '# comment 1'
@@ -23,6 +27,16 @@ class TestRDocClassModule < XrefTestCase
     assert_equal "comment 1\n---\ncomment 2\n---\n* comment 3", cm.comment
   end
 
+  def test_each_ancestor
+    ancestors = []
+
+    @child.each_ancestor do |mod|
+      ancestors << mod
+    end
+
+    assert_equal [@parent], ancestors
+  end
+
   # handle making a short module alias of yourself
 
   def test_find_class_named
@@ -36,6 +50,7 @@ class TestRDocClassModule < XrefTestCase
     cm1.comment = 'klass 1'
     cm1.add_attribute RDoc::Attr.new(nil, 'a1', 'RW', '')
     cm1.add_attribute RDoc::Attr.new(nil, 'a3', 'R', '')
+    cm1.add_attribute RDoc::Attr.new(nil, 'a4', 'R', '')
     cm1.add_constant RDoc::Constant.new('C1', nil, '')
     cm1.add_include RDoc::Include.new('I1', '')
     cm1.add_method RDoc::AnyMethod.new(nil, 'm1')
@@ -46,6 +61,7 @@ class TestRDocClassModule < XrefTestCase
                                 @RM::Paragraph.new('klass 2')))
     cm2.add_attribute RDoc::Attr.new(nil, 'a2', 'RW', '')
     cm2.add_attribute RDoc::Attr.new(nil, 'a3', 'W', '')
+    cm2.add_attribute RDoc::Attr.new(nil, 'a4', 'R', '')
     cm2.add_constant RDoc::Constant.new('C2', nil, '')
     cm2.add_include RDoc::Include.new('I2', '')
     cm2.add_method RDoc::AnyMethod.new(nil, 'm2')
@@ -62,6 +78,7 @@ class TestRDocClassModule < XrefTestCase
       RDoc::Attr.new(nil, 'a1', 'RW', ''),
       RDoc::Attr.new(nil, 'a2', 'RW', ''),
       RDoc::Attr.new(nil, 'a3', 'RW', ''),
+      RDoc::Attr.new(nil, 'a4', 'R',  ''),
     ]
 
     expected.each do |a| a.parent = cm1 end

data/test/test_rdoc_code_object.rb

@@ -119,6 +119,16 @@ class TestRDocCodeObject < XrefTestCase
     assert @co.document_children
   end
 
+  def test_each_parent
+    parents = []
+
+    @parent_m.each_parent do |code_object|
+      parents << code_object
+    end
+
+    assert_equal [@parent, @xref_data], parents
+  end
+
   def test_full_name_equals
     @co.full_name = 'hi'
 

data/test/test_rdoc_context.rb

@@ -143,6 +143,16 @@ class TestRDocContext < XrefTestCase
     assert_equal [incl], @context.includes
   end
 
+  def test_add_include_twice
+    incl1 = RDoc::Include.new 'Name', 'comment'
+    @context.add_include incl1
+
+    incl2 = RDoc::Include.new 'Name', 'comment'
+    @context.add_include incl2
+
+    assert_equal [incl1], @context.includes
+  end
+
   def test_add_method
     meth = RDoc::AnyMethod.new nil, 'old_name'
     meth.visibility = nil
@@ -438,5 +448,146 @@ class TestRDocContext < XrefTestCase
     assert_equal expected, @c1.methods_by_type(separate)
   end
 
+  def test_methods_matching
+    methods = []
+
+    @parent.methods_matching 'm' do |m|
+      methods << m
+    end
+
+    assert_equal [@parent_m], methods
+  end
+
+  def test_methods_matching_singleton
+    methods = []
+
+    @parent.methods_matching 'm', true do |m|
+      methods << m
+    end
+
+    assert_equal [@parent__m], methods
+  end
+
+  def test_methods_matching_inherit
+    methods = []
+
+    @child.methods_matching 'm' do |m|
+      methods << m
+    end
+
+    assert_equal [@parent_m], methods
+  end
+
+  def test_remove_invisible_private
+    util_visibilities
+
+    @vis.remove_invisible :private
+
+    assert_equal [@pub, @prot, @priv], @vis.method_list
+    assert_equal [@apub, @aprot, @apriv], @vis.attributes
+  end
+
+  def test_remove_invisible_protected
+    util_visibilities
+
+    @vis.remove_invisible :protected
+
+    assert_equal [@pub, @prot], @vis.method_list
+    assert_equal [@apub, @aprot], @vis.attributes
+  end
+
+  def test_remove_invisible_public
+    util_visibilities
+
+    @vis.remove_invisible :public
+
+    assert_equal [@pub], @vis.method_list
+    assert_equal [@apub], @vis.attributes
+  end
+
+  def test_remove_invisible_public_force
+    util_visibilities
+
+    @priv.force_documentation = true
+    @prot.force_documentation = true
+    @apriv.force_documentation = true
+    @aprot.force_documentation = true
+
+    @vis.remove_invisible :public
+
+    assert_equal [@pub, @prot, @priv], @vis.method_list
+    assert_equal [@apub, @aprot, @apriv], @vis.attributes
+  end
+
+  def test_remove_invisible_in_protected
+    util_visibilities
+
+    methods = [@pub, @prot, @priv]
+
+    @c1.remove_invisible_in methods, :protected
+
+    assert_equal [@pub, @prot], methods
+  end
+
+  def test_remove_invisible_in_protected_force
+    util_visibilities
+
+    @priv.force_documentation = true
+
+    methods = [@pub, @prot, @priv]
+
+    @c1.remove_invisible_in methods, :protected
+
+    assert_equal [@pub, @prot, @priv], methods
+  end
+
+  def test_remove_invisible_in_public
+    util_visibilities
+
+    methods = [@pub, @prot, @priv]
+
+    @c1.remove_invisible_in methods, :public
+
+    assert_equal [@pub], methods
+  end
+
+  def test_remove_invisible_in_public_force
+    util_visibilities
+
+    @prot.force_documentation = true
+    @priv.force_documentation = true
+
+    methods = [@pub, @prot, @priv]
+
+    @c1.remove_invisible_in methods, :public
+
+    assert_equal [@pub, @prot, @priv], methods
+  end
+
+  def util_visibilities
+    @pub  = RDoc::AnyMethod.new nil, 'pub'
+    @prot = RDoc::AnyMethod.new nil, 'prot'
+    @priv = RDoc::AnyMethod.new nil, 'priv'
+
+    @apub  = RDoc::Attr.new nil, 'pub',  'RW', nil
+    @aprot = RDoc::Attr.new nil, 'prot', 'RW', nil
+    @apriv = RDoc::Attr.new nil, 'priv', 'RW', nil
+
+    @vis = RDoc::NormalClass.new 'Vis'
+    @vis.add_method @pub
+    @vis.add_method @prot
+    @vis.add_method @priv
+
+    @vis.add_attribute @apub
+    @vis.add_attribute @aprot
+    @vis.add_attribute @apriv
+
+    @prot.visibility = :protected
+    @priv.visibility = :private
+
+    @aprot.visibility = :protected
+    @apriv.visibility = :private
+  end
+
 end
 

data/test/test_rdoc_encoding.rb

@@ -26,9 +26,6 @@ class TestRDocEncoding < MiniTest::Unit::TestCase
     @tempfile.write expected
     @tempfile.flush
 
-    # FIXME 1.9 fix on windoze
-    expected.gsub!("\n", "\r\n") if RUBY_VERSION =~ /^1.9/ && RUBY_PLATFORM =~ /mswin|mingw/
-
     contents = RDoc::Encoding.read_file @tempfile.path, Encoding::UTF_8
     assert_equal "hi everybody", contents
     assert_equal Encoding::UTF_8, contents.encoding
@@ -55,9 +52,6 @@ class TestRDocEncoding < MiniTest::Unit::TestCase
     @tempfile.write "# coding: utf-8\n\317\200" # pi
     @tempfile.flush
 
-    # FIXME 1.9 fix on windoze
-    expected.gsub!("\n", "\r\n") if RUBY_VERSION =~ /^1.9/ && RUBY_PLATFORM =~ /mswin|mingw/
-
     contents = :junk
 
     _, err = capture_io do
@@ -78,9 +72,6 @@ class TestRDocEncoding < MiniTest::Unit::TestCase
     @tempfile.write expected
     @tempfile.flush
 
-    # FIXME 1.9 fix on windoze
-    expected.gsub!("\n", "\r\n") if RUBY_VERSION =~ /^1.9/ && RUBY_PLATFORM =~ /win32|mingw32/
-
     contents = RDoc::Encoding.read_file @tempfile.path, Encoding::UTF_8
     assert_equal "hi everybody", contents
     assert_equal Encoding::UTF_8, contents.encoding
@@ -92,9 +83,6 @@ class TestRDocEncoding < MiniTest::Unit::TestCase
     @tempfile.write "# coding: utf-8\n\317\200" # pi
     @tempfile.flush
 
-    # FIXME 1.9 fix on windoze
-    expected.gsub!("\n", "\r\n") if RUBY_VERSION =~ /^1.9/ && RUBY_PLATFORM =~ /mswin|mingw/
-
     contents = RDoc::Encoding.read_file @tempfile.path, Encoding::US_ASCII, true
 
     assert_equal '?', contents