rdoc 3.9.2 → 3.9.3

data/History.txt

@@ -1,3 +1,13 @@
+=== 3.9.3 / 2011-08-23
+
+* Bug fixes
+  * Add US-ASCII magic comments to work with <tt>ruby -Ku</tt>.  Issue #63 by
+    Travis D. Warlick, Jr.
+  * Image paths at HTTPS URLs are now turned into +<img>+ tags.  Pull
+    Request #60 by James Mead
+  * Markup defined by RDoc::Markup#add_special inside a <tt><tt></tt> is no
+    longer converted.
+
 === 3.9.2 / 2011-08-11
 
 * Bug fix

data/Manifest.txt

@@ -136,6 +136,7 @@ test/test_rdoc_include.rb
 test/test_rdoc_markup.rb
 test/test_rdoc_markup_attribute_manager.rb
 test/test_rdoc_markup_document.rb
+test/test_rdoc_markup_formatter.rb
 test/test_rdoc_markup_indented_paragraph.rb
 test/test_rdoc_markup_paragraph.rb
 test/test_rdoc_markup_parser.rb

data/lib/rdoc.rb

@@ -104,7 +104,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '3.9.2'
+  VERSION = '3.9.3'
 
   ##
   # Method visibilities

data/lib/rdoc/encoding.rb

@@ -1,3 +1,5 @@
+# coding: US-ASCII
+
 require 'rdoc'
 
 ##

data/lib/rdoc/markup.rb

@@ -284,7 +284,19 @@ require 'rdoc'
 #
 # Links can also be of the form <tt>label[url]</tt>, in which case +label+ is
 # used in the displayed text, and +url+ is used as the target.  If +label+
-# contains multiple words, put it in braces: <tt>{multi word label}[url]<tt>.
+# contains multiple words, put it in braces: <tt>{multi word label}[url]</tt>.
+# The +url+ may be an +http:+-type link or a cross-reference to a class,
+# module or method with a label.
+#
+# Links with the <tt>rdoc-ref:</tt> scheme will link to the referenced class,
+# module, method, file, etc.  If the referenced item is does not exist
+# no link will be generated and <tt>rdoc-ref:</tt> will be removed from the
+# resulting text.
+#
+# Links starting with +link:+ refer to local files whose path is relative to
+# the <tt>--op</tt> directory.  Use <tt>rdoc-ref:</tt> instead of
+# <tt>link:</tt> to link to files generated by RDoc as the link target may
+# be different across RDoc generators.
 #
 # Example links:
 #

data/lib/rdoc/markup/formatter.rb

@@ -88,7 +88,9 @@ class RDoc::Markup::Formatter
   ##
   # Converts added specials.  See RDoc::Markup#add_special
 
-  def convert_special(special)
+  def convert_special special
+    return special.text if in_tt?
+
     handled = false
 
     RDoc::Markup::Attribute.each_name_of special.type do |name|

data/lib/rdoc/markup/to_html.rb

@@ -254,7 +254,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
             end
     end
 
-    if (type == "http" or type == "link") and
+    if (type == "http" or type == "https" or type == "link") and
        url =~ /\.(gif|png|jpg|jpeg|bmp)$/ then
       "<img src=\"#{url}\" />"
     else

data/lib/rdoc/ruby_lex.rb

@@ -1,3 +1,5 @@
+# coding: US-ASCII
+
 #--
 #   irb/ruby-lex.rb - ruby lexcal analyzer
 #   	$Release Version: 0.9.5$

data/test/test_rdoc_code_object.rb

@@ -1,3 +1,5 @@
+# coding: US-ASCII
+
 require 'rubygems'
 require 'minitest/autorun'
 require File.expand_path '../xref_test_case', __FILE__

data/test/test_rdoc_encoding.rb

@@ -1,3 +1,5 @@
+# coding: US-ASCII
+
 require 'rubygems'
 require 'minitest/autorun'
 require 'rdoc'

data/test/test_rdoc_markup_formatter.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'rdoc'
+require 'rdoc/markup'
+require 'rdoc/markup/formatter'
+
+class TestRDocMarkupFormatter < MiniTest::Unit::TestCase
+
+  class ToTest < RDoc::Markup::Formatter
+
+    def initialize markup
+      super
+
+      add_tag :TT, '<tt>', '</tt>'
+    end
+
+    def accept_paragraph paragraph
+      @res << attributes(paragraph.text)
+    end
+
+    def attributes text
+      convert_flow @am.flow text.dup
+    end
+
+    def handle_special_CAPS special
+      "handled #{special.text}"
+    end
+
+    def start_accepting
+      @res = ""
+    end
+
+    def end_accepting
+      @res
+    end
+
+  end
+
+  def setup
+    @markup = RDoc::Markup.new
+    @markup.add_special(/[A-Z]+/, :CAPS)
+
+    @to = ToTest.new @markup
+
+    @caps    = RDoc::Markup::Attribute.bitmap_for :CAPS
+    @special = RDoc::Markup::Attribute.bitmap_for :_SPECIAL_
+    @tt      = RDoc::Markup::Attribute.bitmap_for :TT
+  end
+
+  def test_convert_tt_special
+    converted = @to.convert '<tt>AAA</tt>'
+
+    assert_equal '<tt>AAA</tt>', converted
+  end
+
+end
+

data/test/test_rdoc_markup_to_html.rb

@@ -306,6 +306,14 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
                  @to.gen_url('link:example', 'example')
   end
 
+  def test_gem_url_image_url
+    assert_equal '<img src="http://example.com/image.png" />', @to.gen_url('http://example.com/image.png', 'ignored')
+  end
+
+  def test_gem_url_ssl_image_url
+    assert_equal '<img src="https://example.com/image.png" />', @to.gen_url('https://example.com/image.png', 'ignored')
+  end
+
   def test_handle_special_HYPERLINK_link
     special = RDoc::Markup::Special.new 0, 'link:README.txt'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 39
+  hash: 37
   prerelease: 
   segments: 
   - 3
   - 9
-  - 2
-  version: 3.9.2
+  - 3
+  version: 3.9.3
 platform: ruby
 authors: 
 - Eric Hodel
@@ -39,7 +39,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2011-08-11 00:00:00 Z
+date: 2011-08-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest
@@ -107,11 +107,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 17
+        hash: 27
         segments: 
         - 2
-        - 9
-        version: "2.9"
+        - 12
+        version: "2.12"
   type: :development
   version_requirements: *id005
 description: |-
@@ -276,6 +276,7 @@ files:
 - test/test_rdoc_markup.rb
 - test/test_rdoc_markup_attribute_manager.rb
 - test/test_rdoc_markup_document.rb
+- test/test_rdoc_markup_formatter.rb
 - test/test_rdoc_markup_indented_paragraph.rb
 - test/test_rdoc_markup_paragraph.rb
 - test/test_rdoc_markup_parser.rb
@@ -313,8 +314,6 @@ files:
 homepage: http://docs.seattlerb.org/rdoc
 licenses: []
 
-metadata: {}
-
 post_install_message: |
   Depending on your version of ruby, you may need to install ruby rdoc/ri data:
   
@@ -352,9 +351,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rdoc
-rubygems_version: 1.8.6
+rubygems_version: 1.8.8
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: RDoc produces HTML and command-line documentation for Ruby projects
 test_files: 
 - test/test_attribute_manager.rb
@@ -374,6 +373,7 @@ test_files:
 - test/test_rdoc_markup.rb
 - test/test_rdoc_markup_attribute_manager.rb
 - test/test_rdoc_markup_document.rb
+- test/test_rdoc_markup_formatter.rb
 - test/test_rdoc_markup_indented_paragraph.rb
 - test/test_rdoc_markup_paragraph.rb
 - test/test_rdoc_markup_parser.rb