rdoc 3.1 → 3.2

data/.autotest

@@ -1,6 +1,7 @@
 # vim: filetype=ruby
 
 require 'autotest/restart'
+require 'autotest/isolate'
 
 Autotest.add_hook :initialize do |at|
   at.testlib = 'minitest/unit' if at.respond_to? :testlib=

data/History.txt

@@ -1,3 +1,13 @@
+=== 3.2 / 2010-12-29
+
+* Minor enhancements
+  * RDoc generator authors may now suppress updating the output dir (creating
+    a created.rid file) by setting RDoc::Options#update_output_dir to false.
+  * RDoc::Task has been refactored to ease creating subclasses.
+* Bug fixes
+  * RDoc's gitignore now ignores .DS_Store files.  Pull Request #3 by Shane
+    Becker.
+
 === 3.1 / 2010-12-28
 
 RDoc has moved to github.  Releases after 3.1 reference github unless
@@ -27,7 +37,7 @@ otherwise noted.
   * RDoc::Markup::ToHtml#gen_url now initializes #from_path to ''.
     Additionally, #from_path is now settable.  RubyForge bug #27838 by Claus
     Folke Brobak.
-  * Comments in the C parser ar enow normalized before being combined.
+  * Comments in the C parser are now normalized before being combined.
     RubyForge patch #28646 by Sven Herzberg.
   * RDoc::Parser::C no longer requires a comment and finds more method bodies.
     RubyForge patch #28643 by Sven Herzberg.

data/Manifest.txt

@@ -111,6 +111,7 @@ lib/rdoc/top_level.rb
 test/README
 test/binary.dat
 test/hidden.zip.txt
+test/test.ja.large.rdoc
 test/test.ja.rdoc
 test/test.ja.txt
 test/test.txt
@@ -151,6 +152,8 @@ test/test_rdoc_require.rb
 test/test_rdoc_ri_driver.rb
 test/test_rdoc_ri_paths.rb
 test/test_rdoc_ri_store.rb
+test/test_rdoc_ruby_lex.rb
+test/test_rdoc_stats.rb
 test/test_rdoc_task.rb
 test/test_rdoc_text.rb
 test/test_rdoc_top_level.rb

data/README.txt

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

data/Rakefile

@@ -17,10 +17,12 @@ Hoe.spec 'rdoc' do
   self.remote_rdoc_dir = ''
   self.rsync_args = '-avz'
   self.testlib = :minitest
-  self.isolate_dir = 'tmp/isolated'
+  self.isolate_dir = 'tmp/isolate'
 
   extra_dev_deps   << ['minitest', '~> 2']
   extra_dev_deps   << ['isolate',  '~> 3']
+  extra_dev_deps   << ['ZenTest',  '~> 4'] # for autotest/isolate
+
   extra_rdoc_files << 'Rakefile'
   spec_extras['required_rubygems_version'] = '>= 1.3'
   spec_extras['homepage'] = 'http://rdoc.rubyforge.org'
@@ -58,7 +60,7 @@ diff_options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
 rsync_options = "-avP --exclude '*svn*' --exclude '*swp' --exclude '*rbc' --exclude '*.rej' --exclude '*.orig'"
 
 rubinius_dir = ENV['RUBINIUS_PATH'] || '../../../git/git.rubini.us/code'
-ruby_dir = ENV['RUBY_PATH'] || '../../ruby/trunk'
+ruby_dir = ENV['RUBY_PATH'] || '../../svn/ruby/trunk'
 
 desc "Updates Ruby HEAD with the currently checked-out copy of RDoc."
 task :update_ruby do

data/lib/rdoc.rb

@@ -95,7 +95,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '3.1'
+  VERSION = '3.2'
 
   ##
   # Method visibilities

data/lib/rdoc/options.rb

@@ -148,6 +148,11 @@ class RDoc::Options
 
   attr_accessor :title
 
+  ##
+  # Should RDoc update the timestamps in the output dir?
+
+  attr_accessor :update_output_dir
+
   ##
   # Verbosity, zero means quiet
 
@@ -188,6 +193,7 @@ class RDoc::Options
     @template = nil
     @template_dir = nil
     @title = nil
+    @update_output_dir = true
     @verbosity = 1
     @visibility = :protected
     @webcvs = nil

data/lib/rdoc/rdoc.rb

@@ -206,7 +206,7 @@ option)
   # Update the flag file in an output directory.
 
   def update_output_dir(op_dir, time, last = {})
-    return if @options.dry_run
+    return if @options.dry_run or not @options.update_output_dir
 
     open output_flag_file(op_dir), "w" do |f|
       f.puts time.rfc2822

data/lib/rdoc/task.rb

@@ -149,17 +149,45 @@ class RDoc::Task < Rake::TaskLib
   # Create an RDoc task with the given name. See the RDoc::Task class overview
   # for documentation.
 
-  def initialize(name = :rdoc)  # :yield: self
-    if name.is_a? Hash then
-      invalid_options = name.keys.map { |k| k.to_sym } -
-        [:rdoc, :clobber_rdoc, :rerdoc]
-
-      unless invalid_options.empty? then
-        raise ArgumentError, "invalid options: #{invalid_options.join(", ")}"
-      end
-    end
+  def initialize name = :rdoc # :yield: self
+    defaults
+
+    check_names name
 
     @name = name
+
+    yield self if block_given?
+
+    define
+  end
+
+  ##
+  # Ensures that +names+ only includes names for the :rdoc, :clobber_rdoc and
+  # :rerdoc.  If other names are given an ArgumentError is raised.
+
+  def check_names names
+    return unless Hash === names
+
+    invalid_options =
+      names.keys.map { |k| k.to_sym } - [:rdoc, :clobber_rdoc, :rerdoc]
+
+    unless invalid_options.empty? then
+      raise ArgumentError, "invalid options: #{invalid_options.join ', '}"
+    end
+  end
+
+  ##
+  # Task description for the clobber rdoc task or its renamed equivalent
+
+  def clobber_task_description
+    "Remove RDoc HTML files"
+  end
+
+  ##
+  # Sets default task values
+
+  def defaults
+    @name = :rdoc
     @rdoc_files = Rake::FileList.new
     @rdoc_dir = 'html'
     @main = nil
@@ -167,14 +195,12 @@ class RDoc::Task < Rake::TaskLib
     @template = nil
     @generator = nil
     @options = []
-    yield self if block_given?
-    define
   end
 
   ##
   # All source is inline now.  This method is deprecated
 
-  def inline_source() # :nodoc:
+  def inline_source # :nodoc:
     warn "RDoc::Task#inline_source is deprecated"
     true
   end
@@ -190,13 +216,13 @@ class RDoc::Task < Rake::TaskLib
   # Create the tasks defined by this task lib.
 
   def define
-    desc "Build RDoc HTML files"
+    desc rdoc_task_description
     task rdoc_task_name
 
-    desc "Rebuild RDoc HTML files"
+    desc rerdoc_task_description
     task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
 
-    desc "Remove RDoc HTML files"
+    desc clobber_task_description
     task clobber_task_name do
       rm_r @rdoc_dir rescue nil
     end
@@ -215,11 +241,9 @@ class RDoc::Task < Rake::TaskLib
       @before_running_rdoc.call if @before_running_rdoc
       args = option_list + @rdoc_files
 
-      if Rake.application.options.trace then
-        $stderr.puts "rdoc #{args.join ' '}"
-      end
+      $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
       require 'rdoc/rdoc'
-      RDoc::RDoc.new.document(args)
+      RDoc::RDoc.new.document args
     end
 
     self
@@ -247,6 +271,20 @@ class RDoc::Task < Rake::TaskLib
     @before_running_rdoc = block
   end
 
+  ##
+  # Task description for the rdoc task or its renamed equivalent
+
+  def rdoc_task_description
+    'Build RDoc HTML files'
+  end
+
+  ##
+  # Task description for the rerdoc task or its renamed description
+
+  def rerdoc_task_description
+    "Rebuild RDoc HTML files"
+  end
+
   private
 
   def rdoc_target

data/test/test.ja.large.rdoc

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+ 吾輩（わがはい）は猫である。名前はまだ無い。
+ どこで生れたかとんと見当（けんとう）がつかぬ。何でも薄暗いじめじめした所でニャーニャー泣いていた事だけは記憶している。吾輩はここで始めて人間というものを見た。しかもあとで聞くとそれは書生という人間中で一番獰悪（どうあく）な種族であったそうだ。この書生というのは時々我々を捕（つかま）えて煮（に）て食うという話である。しかしその当時は何という考もなかったから別段恐しいとも思わなかった。ただ彼の掌（てのひら）に載せられてスーと持ち上げられた時何だかフワフワした感じがあったばかりである。掌の上で少し落ちついて書生の顔を見たのがいわゆる人間というものの見始（みはじめ）であろう。この時妙なものだと思った感じが今でも残っている。第一毛をもって装飾されべきはずの顔がつるつるしてまるで薬缶（やかん）だ。その後（ご）猫にもだいぶ逢（あ）ったがこんな片輪（かたわ）には一度も出会（でく）わした事がない。のみならず顔の真中があまりに突起している。そうしてその穴の中から時々ぷうぷうと煙（けむり）を吹く。どうも咽（む）せぽくて実に弱った。これが人間の飲む煙草（たばこ）というものである事はようやくこの頃知った。

data/test/test_rdoc_options.rb

@@ -338,5 +338,13 @@ file 'unreadable' not readable
     RDoc::RDoc::GENERATORS.delete 'TestGenerator'
   end
 
+  def test_update_output_dir
+    assert @options.update_output_dir
+
+    @options.update_output_dir = false
+
+    refute @options.update_output_dir
+  end
+
 end
 

data/test/test_rdoc_rdoc.rb

@@ -149,6 +149,17 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
     end
   end
 
+  def test_update_output_dir_dont
+    skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
+
+    Dir.mktmpdir do |d|
+      @rdoc.options.update_output_dir = false
+      @rdoc.update_output_dir d, Time.now, {}
+
+      refute File.exist? "#{d}/created.rid"
+    end
+  end
+
   def test_update_output_dir_dry_run
     skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir
 

data/test/test_rdoc_task.rb

@@ -6,25 +6,29 @@ class TestRDocTask < MiniTest::Unit::TestCase
 
   def setup
     Rake::Task.clear
+
+    @t = RDoc::Task.new
   end
 
-  def test_inline_source
-    t = RDoc::Task.new
+  def test_clobber_task_description
+    assert_equal 'Remove RDoc HTML files', @t.clobber_task_description
+  end
 
+  def test_inline_source
     _, err = capture_io do
-      assert t.inline_source
+      assert @t.inline_source
     end
 
     assert_equal "RDoc::Task#inline_source is deprecated\n", err
 
     _, err = capture_io do
-      t.inline_source = false
+      @t.inline_source = false
     end
 
     assert_equal "RDoc::Task#inline_source is deprecated\n", err
 
     capture_io do
-      assert t.inline_source
+      assert @t.inline_source
     end
   end
 
@@ -51,6 +55,14 @@ class TestRDocTask < MiniTest::Unit::TestCase
     assert_equal %w[-o html -f ri], rdoc_task.option_list
   end
 
+  def test_rdoc_task_description
+    assert_equal 'Build RDoc HTML files', @t.rdoc_task_description
+  end
+
+  def test_rerdoc_task_description
+    assert_equal 'Rebuild RDoc HTML files', @t.rerdoc_task_description
+  end
+
   def test_tasks_creation_with_custom_name_string
     rd = RDoc::Task.new("rdoc_dev")
     assert Rake::Task[:rdoc_dev]
@@ -60,7 +72,14 @@ class TestRDocTask < MiniTest::Unit::TestCase
   end
 
   def test_tasks_creation_with_custom_name_hash
-    options = { :rdoc => "rdoc", :clobber_rdoc => "rdoc:clean", :rerdoc => "rdoc:force" }
+    options = {
+      :rdoc => "rdoc",
+      :clobber_rdoc => "rdoc:clean",
+      :rerdoc => "rdoc:force"
+    }
+
+    Rake::Task.clear
+
     rd = RDoc::Task.new(options)
     assert Rake::Task[:"rdoc"]
     assert Rake::Task[:"rdoc:clean"]

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 3
-  - 1
-  version: "3.1"
+  - 2
+  version: "3.2"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -38,7 +38,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2010-12-28 00:00:00 -08:00
+date: 2010-12-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,9 +102,23 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: ZenTest
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 4
+        version: "4"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -116,7 +130,7 @@ dependencies:
         - 0
         version: 2.7.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: |-
   RDoc produces HTML and command-line documentation for Ruby projects.  RDoc
   includes the +rdoc+ and +ri+ tools for generating and displaying online
@@ -254,6 +268,7 @@ files:
 - test/README
 - test/binary.dat
 - test/hidden.zip.txt
+- test/test.ja.large.rdoc
 - test/test.ja.rdoc
 - test/test.ja.txt
 - test/test.txt
@@ -294,13 +309,13 @@ files:
 - test/test_rdoc_ri_driver.rb
 - test/test_rdoc_ri_paths.rb
 - test/test_rdoc_ri_store.rb
+- test/test_rdoc_ruby_lex.rb
+- test/test_rdoc_stats.rb
 - test/test_rdoc_task.rb
 - test/test_rdoc_text.rb
 - test/test_rdoc_top_level.rb
 - test/xref_data.rb
 - test/xref_test_case.rb
-- test/test_rdoc_ruby_lex.rb
-- test/test_rdoc_stats.rb
 has_rdoc: true
 homepage: http://rdoc.rubyforge.org
 licenses: []