Add LEGAL.rdoc with references to licenses in other files. Issue #78

RDoc::CrossReference now ignores non-text RDoc::TopLevels when generating links.

Author: drbrain

History.rdoc

@@ -2,7 +2,8 @@
 
 * Major enhancements
   * RDoc HTML output has been improved:
-    * The search from Володя Колесников's sdoc has been integrated.
+    * The search from Володя Колесников's (Vladimir Kolesnikov) Sdoc has been
+      integrated.
 
       The search index generation is a reusable component through
       RDoc::Generator::JsonIndex
@@ -87,6 +88,8 @@
     +rb_struct_define_without_accessor+ (like Range).  Pull Request #73 by Dan
     Bernier
   * Fixed lexing of <code>a b <<-HEREDOC</code>.  Issue #75 by John Mair.
+  * Added LEGAL.rdoc with references to licenses in other files.  Issue #78 by
+    Dmitry Jemerov.
 
 === 3.9.2 / 2011-08-11
 

LEGAL.rdoc

@@ -0,0 +1,27 @@
+# coding: UTF-8
+
+= Legal Notice Information
+
+The files in this distribution are covered by the Ruby license (see LICENSE) except the features mentioned below:
+
+Darkfish::
+  Darkfish was written by Michael Granger and is included under the MIT
+  license.  Darkfish contains images from the Silk Icons set by Mark James.
+
+  See lib/rdoc/generator/darkfish.rb for license information.
+
+  * lib/rdoc/generator/darkfish.rb
+  * lib/rdoc/generator/template/darkfish/*
+  * lib/rdoc/generator/template/darkfish/images
+
+Sdoc::
+  Portions of SDoc by (Володя Колесников) Vladimir Kolesnikov are included
+  under the MIT license as RDoc::Generator::JsonIndex.  See
+  lib/rdoc/generator/json_index.rb for license information.
+
+  * lib/rdoc/generator/json_index.rb
+  * lib/rdoc/generator/template/json_index/*
+  * The +#search_index+ methods on RDoc::CodeObject subclasses were derived
+    from sdoc.
+  * RDoc::ClassModule#document_self_or_methods comes from Sdoc.
+

Manifest.txt

@@ -1,6 +1,7 @@
 .autotest
 .document
 History.rdoc
+LEGAL.rdoc
 LICENSE.rdoc
 Manifest.txt
 README.rdoc

Rakefile

@@ -41,6 +41,7 @@ Depending on your version of ruby, you may need to install ruby rdoc/ri data:
   self.extra_rdoc_files += %w[
     History.rdoc
     LICENSE.rdoc
+    LEGAL.rdoc
     README.rdoc
     RI.rdoc
     TODO.rdoc
@@ -128,3 +129,4 @@ task :diff_rubinius do
   sh "diff #{diff_options} test #{rubinius_dir}/test/rdoc; true"
 end
 
+

lib/rdoc/top_level.rb

@@ -378,6 +378,14 @@ def base_name
 
   alias name base_name
 
+  ##
+  # Only a TopLevel that contains text file) will be displayed.  See also
+  # RDoc::CodeObject#display?
+
+  def display?
+    text? and super
+  end
+
   ##
   # See RDoc::TopLevel::find_class_or_module
   #--

test/test_rdoc_cross_reference.rb

@@ -16,13 +16,6 @@ def refute_ref name
     assert_equal name, @xref.resolve(name, name)
   end
 
-  def test_resolve_page
-    page = RDoc::TopLevel.new 'README.txt'
-    page.parser = RDoc::Parser::Simple
-
-    assert_ref page, 'README'
-  end
-
   def test_resolve_C2
     @xref = RDoc::CrossReference.new @c2
 
@@ -100,7 +93,7 @@ def test_resolve_class
   end
 
   def test_resolve_file
-    assert_ref @xref_data, 'xref_data.rb'
+    refute_ref 'xref_data.rb'
   end
 
   def test_resolve_method
@@ -136,6 +129,13 @@ def test_resolve_method
     assert_ref @c2_c3_m, '::C2::C3#m(*)'
   end
 
+  def test_resolve_page
+    page = RDoc::TopLevel.new 'README.txt'
+    page.parser = RDoc::Parser::Simple
+
+    assert_ref page, 'README'
+  end
+
   def test_resolve_percent
     i_percent = RDoc::AnyMethod.new nil, '%'
     i_percent.singleton = false

test/test_rdoc_markup_to_html_crossref.rb

@@ -118,7 +118,9 @@ def test_handle_special_CROSSREF_show_hash_false
   end
 
   def test_handle_special_HYPERLINK_rdoc
-    RDoc::TopLevel.new 'README.txt'
+    readme = RDoc::TopLevel.new 'README.txt'
+    readme.parser = RDoc::Parser::Simple
+
     @to = RDoc::Markup::ToHtmlCrossref.new 'C2.html', @c2, true
 
     link = @to.handle_special_HYPERLINK hyper 'C2::C3'
@@ -135,7 +137,9 @@ def test_handle_special_HYPERLINK_rdoc
   end
 
   def test_handle_special_TIDYLINK_rdoc
-    RDoc::TopLevel.new 'README.txt'
+    readme = RDoc::TopLevel.new 'README.txt'
+    readme.parser = RDoc::Parser::Simple
+
     @to = RDoc::Markup::ToHtmlCrossref.new 'C2.html', @c2, true
 
     link = @to.handle_special_TIDYLINK tidy 'C2::C3'

test/test_rdoc_top_level.rb

@@ -191,6 +191,15 @@ def test_base_name
     assert_equal 'top_level.rb', @top_level.base_name
   end
 
+  def test_display_eh
+    refute @top_level.display?
+
+    page = RDoc::TopLevel.new 'README.txt'
+    page.parser = RDoc::Parser::Simple
+
+    assert page.display?
+  end
+
   def test_eql_eh
     top_level2 = RDoc::TopLevel.new 'path/top_level.rb'
     other_level = RDoc::TopLevel.new 'path/other_level.rb'