rdoc 2.4.0 → 2.4.1

data/History.txt

@@ -1,6 +1,17 @@
-=== 2.3.1 / ??
+=== 2.4.1 / 2009-02-26
 
-* N Minor Enhancements
+* 1 Minor Enhancements
+  * Added :attr:, :attr_reader:, :attr_writer:, :attr_accessor: directives.
+    Replaces --accessor.  See RDoc::Parser::Ruby for details.
+
+* 3 Bug Fixes
+  * Don't complain when exiting normally.  Bug by Matt Neuburg.
+  * Restore --inline-source that warns
+  * Fixed links to files in Darkfish output
+
+=== 2.4.0 / 2009-02-24
+
+* 9 Minor Enhancements
   * `ri -f html` is now XHTML-happy
   * Clarified RDoc::Markup link syntax.  Bug #23517 by Eric Armstrong.
   * Number of threads to parse with is now configurable
@@ -15,7 +26,7 @@
   * Removed --ri-system as it is unused by Ruby's makefiles
   * Added method list to index.html
 
-* N Bug Fixes
+* 6 Bug Fixes
   * nodoc'd classes no longer appear in the index.  Bug #23751 by Clifford
     Heath.
   * Fix 1.9 compatibility issues.  Bug #23815 by paddor.

data/README.txt

@@ -1,7 +1,8 @@
 = \RDoc
 
-* Project Page: http://rubyforge.org/projects/rdoc/
-* Documentation: http://rdoc.rubyforge.org/
+* {RDoc Project Page}[http://rubyforge.org/projects/rdoc/]
+* {RDoc Documentation}[http://rdoc.rubyforge.org/]
+* {RDoc Bug Tracker}[http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse]
 
 == DESCRIPTION:
 

data/bin/rdoc

@@ -17,6 +17,8 @@ rescue Interrupt
   $stderr.puts
   $stderr.puts "Interrupted"
   exit 1
+rescue SystemExit
+  raise
 rescue Exception => e
   if $DEBUG_RDOC then
     $stderr.puts e.message

data/lib/rdoc.rb

@@ -1,5 +1,7 @@
 $DEBUG_RDOC = nil
 
+# :main: README.txt
+
 ##
 # = \RDoc - Ruby Documentation System
 #
@@ -380,7 +382,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = "2.4.0"
+  VERSION = "2.4.1"
 
   ##
   # Name of the dotfile that contains the description of files to be processed

data/lib/rdoc/generator/darkfish.rb

@@ -147,17 +147,27 @@ class RDoc::Generator::Darkfish
 		@outputdir.mkpath
 	end
 
-	### Copy over the stylesheet into the appropriate place in the
-	### output directory.
+	### Copy over the stylesheet into the appropriate place in the output
+	### directory.
 	def write_style_sheet
-		debug_msg "Copying over static files"
-		staticfiles = %w[rdoc.css js images]
-		staticfiles.each do |path|
-			FileUtils.cp_r( @template_dir + path, '.', :verbose => $DEBUG, :noop => $dryrun )
-		end
-	end
+		debug_msg "Copying static files"
+		options = { :verbose => $DEBUG_RDOC, :noop => $dryrun }
+
+		FileUtils.cp @template_dir + 'rdoc.css', '.', options
+
+		Dir[@template_dir + "{js,images}/**/*"].each do |path|
+			next if File.directory? path
+			next if path =~ /#{File::SEPARATOR}\./
 
+			dst = Pathname.new(path).relative_path_from @template_dir
 
+			# I suck at glob
+			dst_dir = dst.dirname
+			FileUtils.mkdir_p dst_dir, options unless File.exist? dst_dir
+
+			FileUtils.cp @template_dir + path, dst, options
+		end
+	end
 
 	### Build the initial indices and output objects
 	### based on an array of TopLevel objects containing

data/lib/rdoc/generator/template/darkfish/classpage.rhtml

@@ -117,7 +117,7 @@
 				<h3 class="section-header">Files</h3>
 				<ul>
 				<% simple_files.each do |file| %>
-					<li class="file"><a href="<%= rel_prefix %>/<%= file.base_name %>.html"><%= h file.base_name %></a></li>
+					<li class="file"><a href="<%= rel_prefix %>/<%= file.path %>"><%= h file.base_name %></a></li>
 				<% end %>
 				</ul>
 			</div>

data/lib/rdoc/generator/template/darkfish/filepage.rhtml

@@ -30,7 +30,7 @@
 				<h3 class="section-header">Files</h3>
 				<ul>
 				<% simple_files.each do |f| %>
-					<li class="file"><a href="<%= rel_prefix %>/<%= f.base_name %>.html"><%= h f.base_name %></a></li>
+					<li class="file"><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.base_name %></a></li>
 				<% end %>
 				</ul>
 			</div>

data/lib/rdoc/generator/template/darkfish/index.rhtml

@@ -34,7 +34,7 @@
 	<h2>Files</h2>
 	<ul>
 		<% simple_files.sort.each do |file| %>
-			<li class="file"><a href="<%= file.base_name %>.html"><%= h file.base_name %></a></li>
+			<li class="file"><a href="<%= file.path %>"><%= h file.base_name %></a></li>
 		<% end %>
 	</ul>
 	<% end %>

data/lib/rdoc/options.rb

@@ -403,6 +403,16 @@ Usage: #{opt.program_name} [options] [names...]
              "'\%s', the filename will be appended to it.") do |value|
         @webcvs = value
       end
+
+      opt.separator nil
+
+      opt.separator 'Deprecated options - these warn when set'
+
+      opt.separator nil
+
+      opt.on("--inline-source", "-S") do |value|
+        warn "--inline-source will be removed from RDoc on or after August 2009"
+      end
     end
 
     argv.insert(0, *ENV['RDOCOPT'].split) if ENV['RDOCOPT']

data/lib/rdoc/parser/ruby.rb

@@ -1439,12 +1439,23 @@ end
 #   ##
 #   # :singleton-method: woo_hoo!
 #
-# == Hidden methods
+# Additionally you can mark a method as an attribute by
+# using :attr:, :attr_reader:, :attr_writer: or :attr_accessor:.  Just like
+# for :method:, the name is optional.
+#
+#   ##
+#   # :attr_reader: my_attr_name
+#
+# == Hidden methods and attributes
 #
 # You can provide documentation for methods that don't appear using
-# the :method: and :singleton-method: directives:
+# the :method:, :singleton-method: and :attr: directives:
 #
 #   ##
+#   # :attr_writer: ghost_writer
+#   # There is an attribute here, but you can't see it!
+#   
+#   ##
 #   # :method: ghost_method
 #   # There is a method here, but you can't see it!
 #   
@@ -1765,8 +1776,12 @@ class RDoc::Parser::Ruby < RDoc::Parser
     return prefix + msg
   end
 
+  ##
+  # Creates an RDoc::Attr for the name following +tk+, setting the comment to
+  # +comment+.
+
   def parse_attr(context, single, tk, comment)
-    args = parse_symbol_arg(1)
+    args = parse_symbol_arg 1
     if args.size > 0
       name = args[0]
       rw = "R"
@@ -1787,12 +1802,16 @@ class RDoc::Parser::Ruby < RDoc::Parser
     end
   end
 
+  ##
+  # Creates an RDoc::Attr for each attribute listed after +tk+, setting the
+  # comment for each to +comment+.
+
   def parse_attr_accessor(context, single, tk, comment)
     args = parse_symbol_arg
     read = get_tkread
     rw = "?"
 
-    # If nodoc is given, don't document any of them
+    # TODO If nodoc is given, don't document any of them
 
     tmp = RDoc::CodeObject.new
     read_documentation_modifiers tmp, RDoc::ATTR_MODIFIERS
@@ -1973,37 +1992,51 @@ class RDoc::Parser::Ruby < RDoc::Parser
     end
   end
 
+  ##
+  # Generates an RDoc::Method or RDoc::Attr from +comment+ by looking for
+  # :method: or :attr: directives in +comment+.
+
   def parse_comment(container, tk, comment)
     line_no = tk.line_no
     column  = tk.char_no
 
     singleton = !!comment.sub!(/(^# +:?)(singleton-)(method:)/, '\1\3')
 
+    # REFACTOR
     if comment.sub!(/^# +:?method: *(\S*).*?\n/i, '') then
       name = $1 unless $1.empty?
-    else
-      return nil
-    end
 
-    meth = RDoc::GhostMethod.new get_tkread, name
-    meth.singleton = singleton
+      meth = RDoc::GhostMethod.new get_tkread, name
+      meth.singleton = singleton
 
-    @stats.add_method meth
+      @stats.add_method meth
 
-    meth.start_collecting_tokens
-    indent = TkSPACE.new 1, 1
-    indent.set_text " " * column
+      meth.start_collecting_tokens
+      indent = TkSPACE.new 1, 1
+      indent.set_text " " * column
 
-    position_comment = TkCOMMENT.new(line_no, 1, "# File #{@top_level.absolute_name}, line #{line_no}")
-    meth.add_tokens [position_comment, NEWLINE_TOKEN, indent]
+      position_comment = TkCOMMENT.new(line_no, 1, "# File #{@top_level.absolute_name}, line #{line_no}")
+      meth.add_tokens [position_comment, NEWLINE_TOKEN, indent]
 
-    meth.params = ''
+      meth.params = ''
 
-    extract_call_seq comment, meth
+      extract_call_seq comment, meth
 
-    container.add_method meth if meth.document_self
+      container.add_method meth if meth.document_self
 
-    meth.comment = comment
+      meth.comment = comment
+    elsif comment.sub!(/# +:?(attr(_reader|_writer|_accessor)?:) *(\S*).*?\n/i, '') then
+      rw = case $1
+           when 'attr_reader' then 'R'
+           when 'attr_writer' then 'W'
+           else 'RW'
+           end
+
+      name = $3 unless $3.empty?
+
+      att = RDoc::Attr.new get_tkread, name, rw, comment
+      container.add_attribute att
+    end
   end
 
   def parse_include(context, comment)
@@ -2018,6 +2051,32 @@ class RDoc::Parser::Ruby < RDoc::Parser
     end
   end
 
+  def parse_meta_attr(context, single, tk, comment)
+    args = parse_symbol_arg
+    read = get_tkread
+    rw = "?"
+
+    # If nodoc is given, don't document any of them
+
+    tmp = RDoc::CodeObject.new
+    read_documentation_modifiers tmp, RDoc::ATTR_MODIFIERS
+    return unless tmp.document_self
+
+    if comment.sub!(/^# +:?(attr(_reader|_writer|_accessor)?): *(\S*).*?\n/i, '') then
+      rw = case $1
+           when 'attr_reader' then 'R'
+           when 'attr_writer' then 'W'
+           else 'RW'
+           end
+      name = $3 unless $3.empty?
+    end
+
+    for name in args
+      att = RDoc::Attr.new get_tkread, name, rw, comment
+      context.add_attribute att
+    end
+  end
+
   ##
   # Parses a meta-programmed method
 

data/test/test_rdoc_parser_ruby.rb

@@ -28,6 +28,28 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     @tempfile2.close
   end
 
+  def test_look_for_directives_in_attr
+    util_parser ""
+
+    comment = "# :attr: my_attr\n"
+
+    @parser.look_for_directives_in @top_level, comment
+
+    assert_equal "# :attr: my_attr\n", comment
+
+    comment = "# :attr_reader: my_method\n"
+
+    @parser.look_for_directives_in @top_level, comment
+
+    assert_equal "# :attr_reader: my_method\n", comment
+
+    comment = "# :attr_writer: my_method\n"
+
+    @parser.look_for_directives_in @top_level, comment
+
+    assert_equal "# :attr_writer: my_method\n", comment
+  end
+
   def test_look_for_directives_in_commented
     util_parser ""
 
@@ -136,6 +158,147 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     assert_equal 'hi', @options.title
   end
 
+  def test_parse_attr
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# my attr\n"
+
+    util_parser "attr :foo, :bar"
+
+    tk = @parser.get_tk
+
+    @parser.parse_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    assert_equal 1, klass.attributes.length
+
+    foo = klass.attributes.first
+    assert_equal 'foo', foo.name
+    assert_equal "##\n# my attr\n", foo.comment
+  end
+
+  def test_parse_attr_accessor
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# my attr\n"
+
+    util_parser "attr_accessor :foo, :bar"
+
+    tk = @parser.get_tk
+
+    @parser.parse_attr_accessor klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    assert_equal 2, klass.attributes.length
+
+    foo = klass.attributes.first
+    assert_equal 'foo', foo.name
+    assert_equal 'RW', foo.rw
+    assert_equal "##\n# my attr\n", foo.comment
+
+    bar = klass.attributes.last
+    assert_equal 'bar', bar.name
+    assert_equal 'RW', bar.rw
+    assert_equal "##\n# my attr\n", bar.comment
+  end
+
+  def test_parse_attr_accessor_writer
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# my attr\n"
+
+    util_parser "attr_writer :foo, :bar"
+
+    tk = @parser.get_tk
+
+    @parser.parse_attr_accessor klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    assert_equal 2, klass.attributes.length
+
+    foo = klass.attributes.first
+    assert_equal 'foo', foo.name
+    assert_equal 'W', foo.rw
+    assert_equal "##\n# my attr\n", foo.comment
+
+    bar = klass.attributes.last
+    assert_equal 'bar', bar.name
+    assert_equal 'W', bar.rw
+    assert_equal "##\n# my attr\n", bar.comment
+  end
+
+  def test_parse_meta_attr
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# :attr: \n# my method\n"
+
+    util_parser "add_my_method :foo, :bar"
+
+    tk = @parser.get_tk
+
+    @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    foo = klass.attributes.first
+    assert_equal 'foo', foo.name
+    assert_equal 'RW', foo.rw
+    assert_equal "##\n# my method\n", foo.comment
+  end
+
+  def test_parse_meta_attr_accessor
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# :attr_accessor: \n# my method\n"
+
+    util_parser "add_my_method :foo, :bar"
+
+    tk = @parser.get_tk
+
+    @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    foo = klass.attributes.first
+    assert_equal 'foo', foo.name
+    assert_equal 'RW', foo.rw
+    assert_equal "##\n# my method\n", foo.comment
+  end
+
+  def test_parse_meta_attr_reader
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# :attr_reader: \n# my method\n"
+
+    util_parser "add_my_method :foo, :bar"
+
+    tk = @parser.get_tk
+
+    @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    foo = klass.attributes.first
+    assert_equal 'foo', foo.name
+    assert_equal 'R', foo.rw
+    assert_equal "##\n# my method\n", foo.comment
+  end
+
+  def test_parse_meta_attr_writer
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# :attr_writer: \n# my method\n"
+
+    util_parser "add_my_method :foo, :bar"
+
+    tk = @parser.get_tk
+
+    @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    foo = klass.attributes.first
+    assert_equal 'foo', foo.name
+    assert_equal 'W', foo.rw
+    assert_equal "##\n# my method\n", foo.comment
+  end
+
   def test_parse_class
     comment = "##\n# my method\n"
 
@@ -265,15 +428,35 @@ EOF
     assert_equal 'Foo::Helper', helper.full_name
   end
 
-  def test_parse_comment
-    content = <<-EOF
-class Foo
-  ##
-  # :method: my_method
-  # my method comment
+  def test_parse_comment_attr
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
 
-end
-    EOF
+    comment = "##\n# :attr: foo\n# my attr\n"
+
+    util_parser "\n"
+
+    tk = @parser.get_tk
+
+    @parser.parse_comment klass, tk, comment
+
+    foo = klass.attributes.first
+    assert_equal 'foo',     foo.name
+    assert_equal 'RW',      foo.rw
+    assert_equal comment,   foo.comment
+
+    assert_equal nil,       foo.viewer
+    assert_equal true,      foo.document_children
+    assert_equal true,      foo.document_self
+    assert_equal false,     foo.done_documenting
+    assert_equal false,     foo.force_documentation
+    assert_equal klass,     foo.parent
+    assert_equal :public,   foo.visibility
+    assert_equal "\n",      foo.text
+    assert_equal klass.current_section, foo.section
+  end
+
+  def test_parse_comment_method
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors: 
 - Eric Hodel
@@ -33,7 +33,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2009-02-24 00:00:00 -08:00
+date: 2009-02-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,7 +54,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.3
+        version: 1.9.0
     version: 
 description: RDoc is an application that produces documentation for one or more Ruby source files.  RDoc includes the +rdoc+ and +ri+ tools for generating and displaying online documentation.  At this point in time, RDoc 2.x is a work in progress and may incur further API changes beyond what has been made to RDoc 1.0.1.  Command-line tools are largely unaffected, but internal APIs may shift rapidly.  See RDoc for a description of RDoc's markup and basic use.
 email: 
@@ -72,7 +72,6 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 - RI.txt
-- test/test.ja.txt
 files: 
 - .autotest
 - .document
@@ -199,7 +198,7 @@ files:
 - test/xref_data.rb
 - test/xref_test_case.rb
 has_rdoc: true
-homepage: "Project Page: http://rubyforge.org/projects/rdoc/"
+homepage: "{RDoc Project Page}[http://rubyforge.org/projects/rdoc/]"
 post_install_message: 
 rdoc_options: 
 - --main