rdoc 2.2.1 → 2.3.0

data/lib/rdoc/parser/ruby.rb

@@ -1683,7 +1683,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     if TkSYMBEG === tk then
       set_token_position(tk.line_no, tk.char_no)
       tk1 = get_tk
-      if TkId === tk1 or TkOp === tk1 or TkSTRING === tk1 then
+      if TkId === tk1 or TkOp === tk1 or TkSTRING === tk1 or TkDSTRING === tk1 then
         if tk1.respond_to?(:name)
           tk = Token(TkSYMBOL).set_text(":" + tk1.name)
         else
@@ -2045,8 +2045,11 @@ class RDoc::Parser::Ruby < RDoc::Parser
         name = name_t.text[1..-1]
       when TkSTRING then
         name = name_t.text[1..-2]
+      when TkASSIGN then # ignore
+        remove_token_listener self
+        return
       else
-        warn "#{container.top_level.file_relative_name}:#{name_t.line_no} unknown name token #{name_t.inspect} for meta-method"
+        warn "#{container.toplevel.file_relative_name}:#{name_t.line_no} unknown name token #{name_t.inspect} for meta-method '#{tk.name}'"
         name = 'unknown'
       end
     end

data/lib/rdoc/parser/simple.rb

@@ -27,6 +27,7 @@ class RDoc::Parser::Simple < RDoc::Parser
 
   def scan
     @top_level.comment = remove_private_comments(@content)
+    @top_level.parser = self.class
     @top_level
   end
 

data/lib/rdoc/rdoc.rb

@@ -17,6 +17,7 @@ require 'rdoc/diagram'
 require 'find'
 require 'fileutils'
 require 'time'
+require 'thread'
 
 module RDoc
 
@@ -32,32 +33,22 @@ module RDoc
 
   class RDoc
 
-    Generator = Struct.new(:file_name, :class_name, :key)
-
     ##
     # Accessor for statistics.  Available after each call to parse_files
 
     attr_reader :stats
 
     ##
-    # This is the list of output generator that we support
+    # This is the list of supported output generators
 
     GENERATORS = {}
 
-    $LOAD_PATH.collect do |d|
-      File.expand_path d
-    end.find_all do |d|
-      File.directory? "#{d}/rdoc/generator"
-    end.each do |dir|
-      Dir.entries("#{dir}/rdoc/generator").each do |gen|
-        next unless /(\w+)\.rb$/ =~ gen
-        type = $1
-        unless GENERATORS.has_key? type
-          GENERATORS[type] = Generator.new("rdoc/generator/#{gen}",
-                                           "#{type.upcase}".intern,
-                                           type)
-        end
-      end
+    ##
+    # Add +klass+ that can generate output after parsing
+
+    def self.add_generator(klass)
+      name = klass.name.sub(/^RDoc::Generator::/, '').downcase
+      GENERATORS[name] = klass
     end
 
     def initialize
@@ -149,7 +140,8 @@ module RDoc
 
       relative_files.each do |rel_file_name|
         next if exclude_pattern && exclude_pattern =~ rel_file_name
-        stat = File.stat(rel_file_name)
+        stat = File.stat rel_file_name rescue next
+
         case type = stat.ftype
         when "file"
           next if @last_created and stat.mtime < @last_created
@@ -189,8 +181,6 @@ module RDoc
     # Parse each file on the command line, recursively entering directories.
 
     def parse_files(options)
-      @stats = Stats.new options.verbosity
-
       files = options.files
       files = ["."] if files.empty?
 
@@ -198,33 +188,50 @@ module RDoc
 
       return [] if file_list.empty?
 
+      jobs = SizedQueue.new(number_of_threads * 3)
+      workers = []
       file_info = []
-
-      file_list.each do |filename|
-        @stats.add_file filename
-
-        content = if RUBY_VERSION >= '1.9' then
-                    File.open(filename, "r:ascii-8bit") { |f| f.read }
-                  else
-                    File.read filename
-                  end
-
-        if defined? Encoding then
-          if /coding:\s*(\S+)/ =~ content[/\A(?:.*\n){0,2}/]
-            if enc = ::Encoding.find($1)
-              content.force_encoding(enc)
+      file_info_lock = Mutex.new
+
+      Thread.abort_on_exception = true
+      @stats = Stats.new(file_list.size, options.verbosity)
+      @stats.begin_adding(number_of_threads)
+
+      # Create worker threads.
+      number_of_threads.times do
+        thread = Thread.new do
+          while (filename = jobs.pop)
+            @stats.add_file(filename)
+            content = read_file_contents(filename)
+            top_level = ::RDoc::TopLevel.new filename
+
+            parser = ::RDoc::Parser.for(top_level, filename, content, options,
+                                        @stats)
+            result = parser.scan
+
+            file_info_lock.synchronize do
+              file_info << result
             end
           end
         end
+        workers << thread
+      end
 
-        top_level = ::RDoc::TopLevel.new filename
-
-        parser = ::RDoc::Parser.for top_level, filename, content, options,
-                                    @stats
+      # Feed filenames to the parser worker threads...
+      file_list.each do |filename|
+        jobs << filename
+      end
+      workers.size.times do
+        jobs << nil
+      end
 
-        file_info << parser.scan
+      # ...and wait until they're done.
+      workers.each do |thread|
+        thread.join
       end
 
+      @stats.done_adding
+
       file_info
     end
 
@@ -243,7 +250,7 @@ module RDoc
     def document(argv)
       TopLevel::reset
 
-      @options = Options.new GENERATORS
+      @options = Options.new
       @options.parse argv
 
       @last_created = nil
@@ -261,14 +268,12 @@ module RDoc
       if file_info.empty?
         $stderr.puts "\nNo newer files." unless @options.quiet
       else
-        @gen = @options.generator
+        generator = @options.generator
 
-        $stderr.puts "\nGenerating #{@gen.key.upcase}..." unless @options.quiet
+        $stderr.puts "\nGenerating #{generator.name.sub(/^.*::/, '')}..." unless
+          @options.quiet
 
-        require @gen.file_name
-
-        gen_class = ::RDoc::Generator.const_get @gen.class_name
-        @gen = gen_class.for @options
+        @gen = generator.for @options
 
         pwd = Dir.pwd
 
@@ -283,11 +288,58 @@ module RDoc
         end
       end
 
-      unless @options.quiet
+      unless @options.quiet or not @stats then
         puts
         @stats.print
       end
     end
+
+    private
+
+    def number_of_threads
+      @@number_of_threads ||=
+        if RUBY_PLATFORM == "java"
+          Java::java::lang::Runtime.getRuntime.availableProcessors * 2
+        else
+          2
+        end
+    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
+
+      if defined? Encoding then
+        if /coding:\s*(\S+)/ =~ content[/\A(?:.*\n){0,2}/]
+          if enc = ::Encoding.find($1)
+            content.force_encoding(enc)
+          end
+        end
+      end
+
+      content
+    end
+  end
+end
+
+if Gem.respond_to? :find_files then
+  rdoc_extensions = Gem.find_files 'rdoc/discover'
+
+  rdoc_extensions.each do |extension|
+    begin
+      load extension
+    rescue => e
+      warn "error loading #{extension.inspect}: #{e.message} (#{e.class})"
+    end
   end
 end
 
+# require built-in generators after discovery in case they've been replaced
+require 'rdoc/generator/darkfish'
+require 'rdoc/generator/html'
+require 'rdoc/generator/ri'
+require 'rdoc/generator/xml'
+

data/lib/rdoc/ri/cache.rb

@@ -20,14 +20,14 @@ class RDoc::RI::ClassEntry
     @path_names << path
   end
 
-  # read in our methods and any classes
-  # and modules in our namespace. Methods are
-  # stored in files called name-c|i.yaml,
-  # where the 'name' portion is the external
-  # form of the method name and the c|i is a class|instance
-  # flag
+  ##
+  # read in our methods and any classes and modules in our namespace. Methods
+  # are stored in files called name-c|i.yaml, where the 'name' portion is the
+  # external form of the method name and the c|i is a class|instance flag
 
   def load_from(dir)
+    return unless File.exist? dir
+
     Dir.foreach(dir) do |name|
       next if name =~ /^\./
 

data/lib/rdoc/ri/display.rb

@@ -1,15 +1,5 @@
 require 'rdoc/ri'
 
-# readline support might not be present, so be careful
-# when requiring it.
-begin
-  require('readline')
-  require('abbrev')
-  CAN_USE_READLINE = true
-rescue
-  CAN_USE_READLINE = false
-end
-
 ##
 # This is a kind of 'flag' module. If you want to write your own 'ri' display
 # module (perhaps because you're writing an IDE), you write a class which
@@ -42,6 +32,8 @@ class RDoc::RI::DefaultDisplay
 
   include RDoc::RI::Display
 
+  attr_reader :formatter
+
   def initialize(formatter, width, use_stdout, output = $stdout)
     @use_stdout = use_stdout
     @formatter = formatter.new output, width, "     "
@@ -53,7 +45,7 @@ class RDoc::RI::DefaultDisplay
 
   def display_class_info(klass)
     page do
-      superclass = klass.superclass_string
+      superclass = klass.superclass
 
       if superclass
         superclass = " < " + superclass
@@ -119,64 +111,18 @@ class RDoc::RI::DefaultDisplay
       return display_class_method_list(klass)
     end
   end
-  
+
   ##
   # Given a Hash mapping a class' methods to method types (returned by
-  # display_class_method_list), this method allows the user to
-  # choose one of the methods.
-  
-  def get_class_method_choice(method_map)
-    if CAN_USE_READLINE
-      # prepare abbreviations for tab completion
-      abbreviations = method_map.keys.abbrev
-      Readline.completion_proc = proc do |string| 
-        abbreviations.values.uniq.grep(/^#{string}/)
-      end
-    end
-    
-    @formatter.raw_print_line "\nEnter the method name you want.\n"
-    @formatter.raw_print_line "Class methods can be preceeded by '::' and instance methods by '#'.\n"
-
-    if CAN_USE_READLINE
-      @formatter.raw_print_line "You can use tab to autocomplete.\n"
-      @formatter.raw_print_line "Enter a blank line to exit.\n"
-      
-      choice_string = Readline.readline(">> ").strip
-    else
-      @formatter.raw_print_line "Enter a blank line to exit.\n"
-      @formatter.raw_print_line ">> "
-      choice_string = $stdin.gets.strip
-    end
-    
-    if choice_string == ''
-      return nil
-    else
-      class_or_instance = method_map[choice_string]
-
-      if class_or_instance
-        # If the user's choice is not preceeded by a '::' or a '#', figure
-        # out whether they want a class or an instance method and decorate
-        # the choice appropriately.
-        if(choice_string =~ /^[a-zA-Z]/)
-          if(class_or_instance == :class)
-            choice_string = "::#{choice_string}"
-          else
-            choice_string = "##{choice_string}"
-          end
-        end
+  # display_class_method_list), this method allows the user to choose one of
+  # the methods.
 
-        return choice_string
-      else
-        @formatter.raw_print_line "No method matched '#{choice_string}'.\n"
-        return nil
-      end
-    end
+  def get_class_method_choice(method_map)
   end
-  
 
   ##
-  # Display methods on +klass+
-  # Returns a hash mapping method name to method contents (HACK?)
+  # Display methods on +klass+.  Returns a hash mapping method name to method
+  # contents
 
   def display_class_method_list(klass)
     method_map = {}
@@ -187,16 +133,16 @@ class RDoc::RI::DefaultDisplay
                   :instance_methods,
                   :instance_method_extensions,
                  ]
-    
+
     class_data.each do |data_type|
       data = klass.send data_type
-      
+
       unless data.nil? or data.empty? then
         @formatter.blankline
-        
+
         heading = data_type.to_s.split('_').join(' ').capitalize << ':'
         @formatter.display_heading heading, 2, ''
-        
+
         method_names = []
         data.each do |item|
           method_names << item.name
@@ -217,7 +163,7 @@ class RDoc::RI::DefaultDisplay
         end
         method_names.sort!
 
-        @formatter.wrap method_names.join(',')
+        @formatter.wrap method_names.join(', ')
       end
     end
 
@@ -268,7 +214,7 @@ class RDoc::RI::DefaultDisplay
       end
     end
   end
-  
+
   ##
   # Display a list of +methods+ and allow the user to select one of them.
 
@@ -280,9 +226,9 @@ class RDoc::RI::DefaultDisplay
       methods.each_with_index do |method, index|
         @formatter.raw_print_line "%3d %s [%s]\n" % [index + 1, method.full_name, method.source_path]
       end
-      
+
       @formatter.raw_print_line ">> "
-      
+
       choice = $stdin.gets.strip!
 
       if(choice == '')
@@ -294,7 +240,7 @@ class RDoc::RI::DefaultDisplay
       if ((choice == 0) || (choice > methods.size)) then
         @formatter.raw_print_line "Invalid choice!\n"
       else
-        method = methods[choice - 1] 
+        method = methods[choice - 1]
         display_method_info(method)
       end
     end
@@ -327,14 +273,16 @@ class RDoc::RI::DefaultDisplay
   # List the classes in +classes+.
 
   def list_known_classes(classes)
-    if classes.empty?
+    if classes.empty? then
       warn_no_database
     else
       page do
         @formatter.draw_line "Known classes and modules"
         @formatter.blankline
 
-        @formatter.wrap classes.sort.join(', ')
+        classes.sort.each do |klass|
+          @formatter.wrap klass
+        end
       end
     end
   end
@@ -390,4 +338,3 @@ class RDoc::RI::DefaultDisplay
   end
 
 end
-