rdoc 2.2.1 → 2.3.0

data/lib/rdoc/generator/texinfo.rb

@@ -1,81 +0,0 @@
-require 'rdoc/rdoc'
-require 'rdoc/generator'
-require 'rdoc/markup/to_texinfo'
-
-module RDoc
-  module Generator
-    # This generates Texinfo files for viewing with GNU Info or Emacs
-    # from RDoc extracted from Ruby source files.
-    class TEXINFO
-      # What should the .info file be named by default?
-      DEFAULT_INFO_FILENAME = 'rdoc.info'
-
-      include Generator::MarkUp
-
-      # Accept some options
-      def initialize(options)
-        @options = options
-        @options.inline_source = true
-        @options.op_name ||= 'rdoc.texinfo'
-        @options.formatter = ::RDoc::Markup::ToTexInfo.new
-      end
-
-      # Generate the +texinfo+ files
-      def generate(toplevels)
-        @toplevels = toplevels
-        @files, @classes = ::RDoc::Generator::Context.build_indices(@toplevels,
-                                                                    @options)
-
-        (@files + @classes).each { |x| x.value_hash }
-
-        open(@options.op_name, 'w') do |f|
-          f.puts TexinfoTemplate.new('files' => @files,
-                                     'classes' => @classes,
-                                     'filename' => @options.op_name.gsub(/texinfo/, 'info'),
-                                     'title' => @options.title).render
-        end
-        # TODO: create info files and install?
-      end
-
-      class << self
-        # Factory? We don't need no stinkin' factory!
-        alias_method :for, :new
-      end
-    end
-
-    # Basically just a wrapper around ERB.
-    # Should probably use RDoc::TemplatePage instead
-    class TexinfoTemplate
-      BASE_DIR = ::File.expand_path(::File.dirname(__FILE__)) # have to calculate this when the file's loaded.
-
-      def initialize(values, file = 'texinfo.erb')
-        @v, @file = [values, file]
-      end
-     
-      def template
-        ::File.read(::File.join(BASE_DIR, 'texinfo', @file))
-      end
-
-      # Go!
-      def render
-        ERB.new(template).result binding
-      end
-
-      def href(location, text)
-        text # TODO: how does texinfo do hyperlinks?
-      end
-
-      def target(name, text)
-        text # TODO: how do hyperlink targets work?
-      end
-
-      # TODO: this is probably implemented elsewhere?
-      def method_prefix(section)
-        { 'Class' => '.',
-          'Module' => '::',
-          'Instance' => '#',
-        }[section['category']]
-      end
-    end
-  end
-end

data/lib/rdoc/generator/texinfo/class.texinfo.erb

@@ -1,44 +0,0 @@
-@node <%= @v['class']['full_name'].gsub(/::/, '-') %>
-@chapter <%= @v['class']["classmod"] %> <%= @v['class']['full_name'] %>
-
-<% if @v['class']["parent"] and @v['class']['par_url'] %>
-Inherits <%= href @v['class']["par_url"], @v['class']["parent"] %><% end %>
-
-<%= @v['class']["description"] %>
-
-<% if @v['class']["includes"] %>
-Includes
-<%   @v['class']["includes"].each do |include| %>
-* <%=  href include["aref"], include["name"] %>
-<%   end # @v['class']["includes"] %>
-<% end %>
-
-<% if @v['class']["sections"] %>
-<%   @v['class']["sections"].each do |section| %>
-<%     if section["attributes"] %>
-Attributes
-<%       section["attributes"].each do |attributes| %>
-* <%=      attributes["name"] %> <%= attributes["rw"] %> <%= attributes["a_desc"] %>
-<%       end # section["attributes"] %>
-<%     end %>
-<%   end %>
-
-<%   @v['class']["sections"].each do |section| %>
-<%     if section["method_list"] %>
-Methods
-@menu
-<%     section["method_list"].each_with_index do |method_list, i| %>
-<%= i %>
-<%       (method_list["methods"] || []).each do |method| %>
-* <%= @v['class']['full_name'].gsub(/::/, '-') %><%= method_prefix method_list %><%= method['name'] %>::<% end %>
-<% end %>
-@end menu
-
-<%     section["method_list"].each do |method_list| %>
-<%       (method_list["methods"] || []).uniq.each do |method| %>
-<%=        TexinfoTemplate.new(@v.merge({'method' => method, 'list' => method_list}),
-                               'method.texinfo.erb').render %><% end %>
-<%       end %>
-<%     end # if section["method_list"] %>
-<% end # @v['class']["sections"] %>
-<% end %>

data/lib/rdoc/generator/texinfo/file.texinfo.erb

@@ -1,6 +0,0 @@
-<% if false %>
-<h2>File: <%= @v['file']["short_name"] %></h2>
-Path: <%= @v['file']["full_path"] %>
-
-<%= TexinfoTemplate.new(@v, 'content.texinfo.erb').render %>
-<% end %>

data/lib/rdoc/generator/texinfo/method.texinfo.erb

@@ -1,6 +0,0 @@
-@node <%= @v['class']['full_name'].gsub(/::/, '-') %><%= method_prefix @v['list'] %><%= @v['method']['name'] %>
-@section <%= @v['class']["classmod"] %> <%= @v['class']['full_name'] %><%= method_prefix @v['list'] %><%= @v['method']['name'] %>
-<%= @v['method']["type"] %> <%= @v['method']["category"] %> method:
-<%= target @v['method']["aref"], @v['method']['callseq'] ||
-                                 @v['method']["name"] + @v['method']["params"] %>
-<%= @v['method']["m_desc"] %>

data/lib/rdoc/generator/texinfo/texinfo.erb

@@ -1,28 +0,0 @@
-\input texinfo   @c -*-texinfo-*-
-@c %**start of header
-@setfilename <%= @v['filename'] %>
-@settitle <%= @v['title'] %>
-@c %**end of header
-
-@contents @c TODO: whitespace is a mess... =\
-
-@ifnottex
-@node Top
-
-@top <%= @v['title'] %>
-@end ifnottex
-
-<% if @f = @v['files'].detect { |f| f.name =~ /Readme/i }  %>
-<%= @f.values['description'] %><% end %>
-
-@menu
-<% @v['classes'].each do |klass| %>
-* <%= klass.name.gsub(/::/, '-') %>::<% end %>
-@c TODO: add files
-@end menu
-
-<% (@v['classes'] || []).each_with_index do |klass, i| %>
-<%= TexinfoTemplate.new(@v.merge('class' => klass.values), 
-                        'class.texinfo.erb').render %><% end %>
-
-@bye

data/test/rdoc_markup_to_html_crossref_reference.rb

@@ -1,31 +0,0 @@
-#
-# This file is parsed by test_rdoc_markup_to_html_crossref.rb
-# during its tests.
-#
-class Ref_Class1
-end
-
-class Ref_Class2
-  class Ref_Class3
-    def method
-    end
-
-    class Helper1
-      def method?
-      end
-    end
-  end
-end
-
-class Ref_Class3
-  class Helper1
-  end
-
-  class Helper2
-  end
-end
-
-class Ref_Class4
-  class Ref_Class4
-  end
-end

data/test/test_rdoc_info_formatting.rb

@@ -1,175 +0,0 @@
-require 'fileutils'
-require 'tmpdir'
-require 'test/unit'
-
-require 'rdoc/generator/texinfo'
-
-# From chapter 18 of the Pickaxe 3rd ed. and the TexInfo manual.
-class TestRDocInfoFormatting < Test::Unit::TestCase
-  def setup
-    @output_dir = File.join Dir.tmpdir, "test_rdoc_info_formatting_#{$$}"
-    @output_file = File.join @output_dir, 'rdoc.texinfo'
-
-    RDoc::RDoc.new.document(['--fmt=texinfo', '--quiet',
-                             File.expand_path(__FILE__),
-                             "--op=#{@output_dir}"])
-    @text = File.read @output_file
-
-    # File.open('rdoc.texinfo', 'w') { |f| f.puts @text }
-  end
-
-  def teardown
-    # FileUtils.rm_rf @output_dir
-  end
-
-  # Make sure tags like *this* do not make HTML
-  def test_descriptions_are_not_html
-    assert_no_match Regexp.new("\<b\>this\<\/b\>"), @text, "We had some HTML; icky!"
-  end
-
-  # Ensure we get a reasonable amount
-  #
-  # of space in between paragraphs.
-  def test_paragraphs_are_spaced
-    assert_match(/amount\n\n\nof space/, @text)
-  end
-
-  # @ and {} should be at-sign-prefixed
-  def test_escaping
-    assert_match(/@@ and @\{@\} should be at-sign-prefixed/)
-  end
-  
-  # This tests that *bold* and <b>bold me</b> become @strong{bolded}
-  def test_bold
-    # Seems like a limitation of the Info format: @strong{bold}
-    # becomes *bold* when read in Info or M-x info. highly lame!
-    assert_match(/@strong\{bold\}/)
-    assert_match(/@strong\{bold me\}/)
-  end
-
-  # Test that _italics_ and <em>italicize me</em> becomes @emph{italicized}
-  def test_italics
-    assert_match(/@emph\{italics\}/)
-    assert_match(/@emph\{italicize me\}/)
-  end
-
-  # And that typewriter +text+ and <tt>typewriter me</tt> becomes @code{typewriter}
-  def test_tt
-    assert_match(/@code\{text\}/)
-    assert_match(/@code\{typewriter me\}/)
-  end
-
-  # Check that
-  #   anything indented is
-  #   verbatim @verb{|foo bar baz|}
-  def test_literal_code
-    assert_match("@verb{|  anything indented is
-  verbatim @@verb@{|foo bar baz|@}
-|}")
-  end
-
-  # = Huge heading should be a @majorheading
-  # == There is also @chapheading
-  # === Everything deeper becomes a regular @heading
-  # ====== Regardless of its nesting level
-  def test_headings
-    assert_match(/@majorheading Huge heading should be a @@majorheading/)
-    assert_match(/@chapheading There is also @@chapheading/)
-    assert_match(/@heading Everything deeper becomes a regular @@heading/)
-    assert_match(/@heading Regardless of its nesting level/)
-  end
-
-  # * list item
-  # * list item2
-  #
-  # with a paragraph in between
-  #
-  # - hyphen lists
-  # - are also allowed
-  #   and items may flow over lines
-  def test_bullet_lists
-    assert_match("@itemize @bullet
-@item
-list item
-@item
-list item2
-@end itemize")
-    assert_match("@itemize @bullet
-@item
-hyphen lists
-@item
-are also allowed and items may flow over lines
-@end itemize")
-  end
-
-  # 2. numbered lists
-  # 8. are made by
-  # 9. a digit followed by a period
-  def test_numbered_lists
-  end
-
-  # a. alpha lists
-  # b. should be parsed too
-  def test_alpha_lists
-  end
-
-  # [cat]   small domestic animal
-  # [+cat+] command to copy standard input
-  #         to standard output
-  def test_labelled_lists
-  end
-
-  # * First item.
-  #   * Inner item.
-  #   * Second inner item.
-  # * Second outer item.
-  def test_nested_lists
-    assert_match("@itemize @bullet
-@item
-First item.
-@itemize @bullet
-@item
-Inner item.
-@item
-Second inner item.
-@end itemize
-@item
-Second outer item.
-@end itemize")
-  end
-  
-  def test_internal_hyperlinks
-    # be sure to test multi-word hyperlinks as well.
-  end
-
-  def test_hyperlink_targets
-  end
-
-  def test_web_links
-    # An example of the two-argument form: The official
-    # @uref{ftp://ftp.gnu.org/gnu, GNU ftp site} holds programs and texts.
-
-    # produces:
-    #      The official GNU ftp site (ftp://ftp.gnu.org/gnu)
-    #      holds programs and texts.
-    # and the HTML output is this:
-    #      The official <a href="ftp://ftp.gnu.org/gnu">GNU ftp site</a>
-    #      holds programs and texts.
-  end
-
-  # three or more hyphens
-  # ----
-  # should produce a horizontal rule
-  def test_horizontal_rule
-    # gah; not sure texinfo supports horizontal rules
-  end
-
-  private
-
-  # We don't want the whole string inspected if we pass our own
-  # message in.
-  def assert_match(regex, string = @text,
-                   message = "Didn't find #{regex.inspect} in #{string}.")
-    assert string[regex] #, message
-  end
-end

data/test/test_rdoc_info_sections.rb

@@ -1,136 +0,0 @@
-require 'fileutils'
-require 'tempfile'
-require 'test/unit'
-require 'tmpdir'
-
-require 'rdoc/generator/texinfo'
-
-# give us access to check this stuff before it's rendered
-class RDoc::Generator::TEXINFO; attr_reader :files, :classes; end
-class RDoc::RDoc; attr_reader :options; attr_reader :gen; end
-
-class TestRDocInfoSections < Test::Unit::TestCase
-
-  def setup
-    @output_dir = File.join Dir.tmpdir, "test_rdoc_info_sections_#{$$}"
-    @output_file = File.join @output_dir, 'rdoc.texinfo'
-
-    @input_file = Tempfile.new 'my_file.rb'
-
-    open @input_file.path, 'w' do |io|
-      io.write TEST_DOC
-    end
-
-    RDoc::Parser.alias_extension '.rb', File.extname(@input_file.path)
-
-    @rdoc = RDoc::RDoc.new
-    @rdoc.document(['--fmt=texinfo', '--quiet', @input_file.path,
-                    "--op=#{@output_dir}"])
-
-    @text = File.read @output_file
-  end
-
-  def teardown
-    @input_file.close
-    FileUtils.rm_rf @output_dir
-  end
-
-  def test_output_exists
-    assert ! @text.empty?
-  end
-
-  def test_each_class_has_a_chapter
-    assert_section "Class MyClass", '@chapter'
-  end
-
-  def test_class_descriptions_are_given
-    assert_match(/Documentation for my class/, @text.gsub("\n", ' '))
-  end
-
-  def test_included_modules_are_given
-    assert_match(/Includes.* MyModule/m, @text)
-  end
-
-  def test_class_methods_are_given
-    assert_match(/my_class_method\(my_first_argument\)/, @text)
-  end
-
-  def test_classes_instance_methods_are_given
-    assert_section 'Class MyClass#my_method'
-    assert_match(/my_method\(my_first_argument\)/, @text)
-  end
-
-  def test_each_module_has_a_chapter
-    assert_section 'MyModule', '@chapter'
-  end
-
-  def test_methods_are_shown_only_once
-    methods = @rdoc.gen.classes.map do |c|
-      c.methods.map do |m|
-        c.name + '#' + m.name
-      end
-    end.flatten
-
-    assert_equal methods, methods.uniq
-  end
-
-#   if system "makeinfo --version > /dev/null"
-#     def test_compiles_to_info
-#       makeinfo_output = `cd #{@output_dir} && makeinfo rdoc.texinfo`
-#       assert(File.exist?(File.join(@output_dir, 'rdoc.info')),
-#              "Info file was not compiled: #{makeinfo_output}")
-#     end
-#   end
-
-#   def test_constants_are_documented_somehow
-#     assert_section 'DEFAULT_FILENAME' # what kind of section?
-#     assert_section 'DEFAULT_INFO_FILENAME'
-#   end
-
-#   def test_oh_yeah_dont_forget_files
-#   end
-
-  def assert_section(name, command = '@section')
-    assert_match Regexp.new("^#{command}.*#{Regexp.escape name}"), @text, "Could not find a #{command} #{name}"
-  end
-
-  TEST_DOC = <<-DOC
-##
-# Documentation for my module
-
-module MyModule
-
-  ##
-  # Documentation for my included method
-
-  def my_included_method() end
-
-end
-
-##
-# Documentation for my class
-
-class MyClass
-
-  include MyModule
-
-  ##
-  # Documentation for my constant
-
-  MY_CONSTANT = 'my value'
-
-  ##
-  # Documentation for my class method
-
-  def self.my_class_method(my_first_argument) end
-
-  ##
-  # Documentation for my method
-
-  def my_method(my_first_argument) end
-
-end
-
-  DOC
-
-end