rdoc 4.2.1 → 6.3.1

data/test/test_rdoc_generator_darkfish.rb

@@ -1,229 +0,0 @@
-require 'rdoc/test_case'
-
-class TestRDocGeneratorDarkfish < RDoc::TestCase
-
-  def setup
-    super
-
-    @lib_dir = "#{@pwd}/lib"
-    $LOAD_PATH.unshift @lib_dir # ensure we load from this RDoc
-
-    @options = RDoc::Options.new
-    @options.option_parser = OptionParser.new
-
-    @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_darkfish_#{$$}"
-    FileUtils.mkdir_p @tmpdir
-    Dir.chdir @tmpdir
-    @options.op_dir = @tmpdir
-    @options.generator = RDoc::Generator::Darkfish
-
-    $LOAD_PATH.each do |path|
-      darkfish_dir = File.join path, 'rdoc/generator/template/darkfish/'
-      next unless File.directory? darkfish_dir
-      @options.template_dir = darkfish_dir
-      break
-    end
-
-    @rdoc.options = @options
-
-    @g = @options.generator.new @store, @options
-    @rdoc.generator = @g
-
-    @top_level = @store.add_file 'file.rb'
-    @top_level.parser = RDoc::Parser::Ruby
-    @klass = @top_level.add_class RDoc::NormalClass, 'Klass'
-
-    @alias_constant = RDoc::Constant.new 'A', nil, ''
-    @alias_constant.record_location @top_level
-
-    @top_level.add_constant @alias_constant
-
-    @klass.add_module_alias @klass, 'A', @top_level
-
-    @meth = RDoc::AnyMethod.new nil, 'method'
-    @meth_bang = RDoc::AnyMethod.new nil, 'method!'
-    @attr = RDoc::Attr.new nil, 'attr', 'RW', ''
-
-    @klass.add_method @meth
-    @klass.add_method @meth_bang
-    @klass.add_attribute @attr
-
-    @ignored = @top_level.add_class RDoc::NormalClass, 'Ignored'
-    @ignored.ignore
-
-    @store.complete :private
-
-    @object      = @store.find_class_or_module 'Object'
-    @klass_alias = @store.find_class_or_module 'Klass::A'
-  end
-
-  def teardown
-    super
-
-    $LOAD_PATH.shift
-    Dir.chdir @pwd
-    FileUtils.rm_rf @tmpdir
-  end
-
-  def test_generate
-    top_level = @store.add_file 'file.rb'
-    top_level.add_class @klass.class, @klass.name
-
-    @g.generate
-
-    assert_file 'index.html'
-    assert_file 'Object.html'
-    assert_file 'table_of_contents.html'
-    assert_file 'js/search_index.js'
-
-    assert_hard_link 'css/rdoc.css'
-    assert_hard_link 'css/fonts.css'
-
-    assert_hard_link 'fonts/SourceCodePro-Bold.ttf'
-    assert_hard_link 'fonts/SourceCodePro-Regular.ttf'
-
-    encoding = if Object.const_defined? :Encoding then
-                 Regexp.escape Encoding::UTF_8.name
-               else
-                 Regexp.escape 'UTF-8'
-               end
-
-    assert_match %r%<meta charset="#{encoding}">%, File.read('index.html')
-    assert_match %r%<meta charset="#{encoding}">%, File.read('Object.html')
-
-    refute_match(/Ignored/, File.read('index.html'))
-  end
-
-  def test_generate_dry_run
-    @g.dry_run = true
-    top_level = @store.add_file 'file.rb'
-    top_level.add_class @klass.class, @klass.name
-
-    @g.generate
-
-    refute_file 'index.html'
-    refute_file 'Object.html'
-  end
-
-  def test_generate_static
-    FileUtils.mkdir_p 'dir/images'
-    FileUtils.touch 'dir/images/image.png'
-    FileUtils.mkdir_p 'file'
-    FileUtils.touch 'file/file.txt'
-
-    @options.static_path = [
-      File.expand_path('dir'),
-      File.expand_path('file/file.txt'),
-    ]
-
-    @g.generate
-
-    assert_file 'images/image.png'
-    assert_file 'file.txt'
-  end
-
-  def test_generate_static_dry_run
-    FileUtils.mkdir 'static'
-    FileUtils.touch 'static/image.png'
-
-    @options.static_path = [File.expand_path('static')]
-    @g.dry_run = true
-
-    @g.generate
-
-    refute_file 'image.png'
-  end
-
-  def test_install_rdoc_static_file
-    src = Pathname(__FILE__)
-    dst = File.join @tmpdir, File.basename(src)
-    options = {}
-
-    @g.install_rdoc_static_file src, dst, options
-
-    assert_file dst
-
-    begin
-      assert_hard_link dst
-    rescue MiniTest::Assertion
-      return # hard links are not supported, no further tests needed
-    end
-
-    @g.install_rdoc_static_file src, dst, options
-
-    assert_hard_link dst
-  end
-
-  def test_install_rdoc_static_file_missing
-    src = Pathname(__FILE__) + 'nonexistent'
-    dst = File.join @tmpdir, File.basename(src)
-    options = {}
-
-    @g.install_rdoc_static_file src, dst, options
-
-    refute_file dst
-  end
-
-  def test_setup
-    @g.setup
-
-    assert_equal [@klass_alias, @ignored, @klass, @object],
-                 @g.classes.sort_by { |klass| klass.full_name }
-    assert_equal [@top_level],                           @g.files
-    assert_equal [@meth, @meth, @meth_bang, @meth_bang], @g.methods
-    assert_equal [@klass_alias, @klass, @object], @g.modsort
-  end
-
-  def test_template_for
-    classpage = Pathname.new @options.template_dir + 'class.rhtml'
-
-    template = @g.send(:template_for, classpage, true, RDoc::ERBIO)
-    assert_kind_of RDoc::ERBIO, template
-
-    assert_same template, @g.send(:template_for, classpage)
-  end
-
-  def test_template_for_dry_run
-    classpage = Pathname.new @options.template_dir + 'class.rhtml'
-
-    template = @g.send(:template_for, classpage, true, ERB)
-    assert_kind_of ERB, template
-
-    assert_same template, @g.send(:template_for, classpage)
-  end
-
-  def test_template_for_partial
-    partial = Pathname.new @options.template_dir + '_sidebar_classes.rhtml'
-
-    template = @g.send(:template_for, partial, false, RDoc::ERBPartial)
-
-    assert_kind_of RDoc::ERBPartial, template
-
-    assert_same template, @g.send(:template_for, partial)
-  end
-
-  ##
-  # Asserts that +filename+ has a link count greater than 1 if hard links to
-  # @tmpdir are supported.
-
-  def assert_hard_link filename
-    assert_file filename
-
-    src = @g.template_dir + '_head.rhtml'
-    dst = File.join @tmpdir, 'hardlinktest'
-
-    begin
-      FileUtils.ln src, dst
-      nlink = File.stat(dst).nlink if File.identical? src, dst
-      FileUtils.rm dst
-      return if nlink == 1
-    rescue SystemCallError
-      return
-    end
-
-    assert_operator File.stat(filename).nlink, :>, 1,
-                    "#{filename} is not hard-linked"
-  end
-
-end
-

data/test/test_rdoc_generator_json_index.rb

@@ -1,324 +0,0 @@
-# coding: US-ASCII
-
-require 'rdoc/test_case'
-
-class TestRDocGeneratorJsonIndex < RDoc::TestCase
-
-  def setup
-    super
-
-    @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_darkfish_#{$$}"
-    FileUtils.mkdir_p @tmpdir
-
-    @options = RDoc::Options.new
-    @options.files = []
-    # JsonIndex is used in conjunction with another generator
-    @options.setup_generator 'darkfish'
-    @options.template_dir = ''
-    @options.op_dir = @tmpdir
-    @options.option_parser = OptionParser.new
-    @options.finish
-
-    @darkfish = RDoc::Generator::Darkfish.new @store, @options
-    @g = RDoc::Generator::JsonIndex.new @darkfish, @options
-
-    @rdoc.options = @options
-    @rdoc.generator = @g
-
-    @top_level = @store.add_file 'file.rb'
-    @top_level.parser = RDoc::Parser::Ruby
-
-    @klass = @top_level.add_class RDoc::NormalClass, 'C'
-
-    @meth = @klass.add_method RDoc::AnyMethod.new(nil, 'meth')
-    @meth.record_location @top_level
-
-    @nest_klass = @klass.add_class RDoc::NormalClass, 'D'
-    @nest_klass.record_location @top_level
-
-    @nest_meth = @nest_klass.add_method RDoc::AnyMethod.new(nil, 'meth')
-
-    @ignored = @top_level.add_class RDoc::NormalClass, 'Ignored'
-    @ignored.ignore
-
-    @page = @store.add_file 'page.rdoc'
-    @page.parser = RDoc::Parser::Simple
-
-    @top_levels = [@top_level, @page].sort
-    @klasses    = [@klass, @nest_klass, @ignored]
-
-    Dir.chdir @tmpdir
-  end
-
-  def teardown
-    super
-
-    Dir.chdir @pwd
-    FileUtils.rm_rf @tmpdir
-  end
-
-  def test_build_index
-    index = @g.build_index
-
-    expected = {
-      :index => {
-        :searchIndex     => %w[c d meth() meth() page],
-        :longSearchIndex => %w[c c::d c#meth() c::d#meth()],
-        :info            => [
-          @klass.search_record[2..-1],
-          @nest_klass.search_record[2..-1],
-          @meth.search_record[2..-1],
-          @nest_meth.search_record[2..-1],
-          @page.search_record[2..-1],
-        ],
-      },
-    }
-
-    expected[:index][:longSearchIndex] << ''
-
-    assert_equal expected, index
-  end
-
-  def test_class_dir
-    assert_equal @darkfish.class_dir, @g.class_dir
-  end
-
-  def test_file_dir
-    assert_equal @darkfish.file_dir, @g.file_dir
-  end
-
-  def test_generate
-    @g.generate
-
-    assert_file 'js/searcher.js'
-    assert_file 'js/navigation.js'
-    assert_file 'js/search_index.js'
-
-    json = File.read 'js/search_index.js'
-
-    json =~ /\Avar search_data = /
-
-    assignment = $&
-    index = $'
-
-    refute_empty assignment
-
-    index = JSON.parse index
-
-    info = [
-      @klass.search_record[2..-1],
-      @nest_klass.search_record[2..-1],
-      @meth.search_record[2..-1],
-      @nest_meth.search_record[2..-1],
-      @page.search_record[2..-1],
-    ]
-
-    expected = {
-      'index' => {
-        'searchIndex' => [
-          'c',
-          'd',
-          'meth()',
-          'meth()',
-          'page',
-        ],
-        'longSearchIndex' => [
-          'c',
-          'c::d',
-          'c#meth()',
-          'c::d#meth()',
-          '',
-        ],
-        'info' => info,
-      },
-    }
-
-    assert_equal expected, index
-  end
-
-  def test_generate_gzipped
-    begin
-      require 'zlib'
-    rescue LoadError
-      skip "no zlib"
-    end
-    @g.generate
-    @g.generate_gzipped
-
-    assert_file 'js/searcher.js'
-    assert_file 'js/searcher.js.gz'
-    assert_file 'js/navigation.js'
-    assert_file 'js/navigation.js.gz'
-    assert_file 'js/search_index.js'
-    assert_file 'js/search_index.js.gz'
-
-    json = File.open('js/search_index.js.gz') {|gzip|
-      Zlib::GzipReader.new(gzip).read
-    }
-
-    json =~ /\Avar search_data = /
-
-    assignment = $&
-    index = $'
-
-    refute_empty assignment
-
-    index = JSON.parse index
-
-    info = [
-      @klass.search_record[2..-1],
-      @nest_klass.search_record[2..-1],
-      @meth.search_record[2..-1],
-      @nest_meth.search_record[2..-1],
-      @page.search_record[2..-1],
-    ]
-
-    expected = {
-      'index' => {
-        'searchIndex' => [
-          'c',
-          'd',
-          'meth()',
-          'meth()',
-          'page',
-        ],
-        'longSearchIndex' => [
-          'c',
-          'c::d',
-          'c#meth()',
-          'c::d#meth()',
-          '',
-        ],
-        'info' => info,
-      },
-    }
-
-    assert_equal expected, index
-  end
-
-  def test_generate_utf_8
-    skip "Encoding not implemented" unless Object.const_defined? :Encoding
-
-    text = "5\xB0"
-    text.force_encoding Encoding::ISO_8859_1
-    @klass.add_comment comment(text), @top_level
-
-    @g.generate
-
-    json = File.read 'js/search_index.js'
-    json.force_encoding Encoding::UTF_8
-
-    json =~ /\Avar search_data = /
-
-    index = $'
-
-    index = JSON.parse index
-
-    klass_record = @klass.search_record[2..-1]
-    klass_record[-1] = "<p>5\xc2\xb0\n"
-    klass_record.last.force_encoding Encoding::UTF_8
-
-    info = [
-      klass_record,
-      @nest_klass.search_record[2..-1],
-      @meth.search_record[2..-1],
-      @nest_meth.search_record[2..-1],
-      @page.search_record[2..-1],
-    ]
-
-    expected = {
-      'index' => {
-        'searchIndex' => [
-          'c',
-          'd',
-          'meth()',
-          'meth()',
-          'page',
-        ],
-        'longSearchIndex' => [
-          'c',
-          'c::d',
-          'c#meth()',
-          'c::d#meth()',
-          '',
-        ],
-        'info' => info,
-      },
-    }
-
-    assert_equal expected, index
-  end
-
-  def test_index_classes
-    @g.reset @top_levels, @klasses
-
-    @g.index_classes
-
-    expected = {
-      :searchIndex     => %w[c d],
-      :longSearchIndex => %w[c c::d],
-      :info            => [
-        @klass.search_record[2..-1],
-        @nest_klass.search_record[2..-1],
-      ],
-    }
-
-    assert_equal expected, @g.index
-  end
-
-  def test_index_classes_nodoc
-    @klass.document_self      = false
-    @nest_klass.document_self = false
-    @meth.document_self       = false
-    @nest_meth.document_self  = false
-
-    @g.reset @top_levels, @klasses
-
-    @g.index_classes
-
-    expected = {
-      :searchIndex     => [],
-      :longSearchIndex => [],
-      :info            => [],
-    }
-
-    assert_equal expected, @g.index
-  end
-
-  def test_index_methods
-    @g.reset @top_levels, @klasses
-
-    @g.index_methods
-
-    expected = {
-      :searchIndex     => %w[meth() meth()],
-      :longSearchIndex => %w[c#meth() c::d#meth()],
-      :info            => [
-        @meth.search_record[2..-1],
-        @nest_meth.search_record[2..-1],
-      ],
-    }
-
-    assert_equal expected, @g.index
-  end
-
-  def test_index_pages
-    @g.reset @top_levels, @klasses
-
-    @g.index_pages
-
-    expected = {
-      :searchIndex     => %w[page],
-      :longSearchIndex => [''],
-      :info            => [@page.search_record[2..-1]],
-    }
-
-    assert_equal expected, @g.index
-  end
-
-  def test_search_string
-    assert_equal 'cd', @g.search_string('C d')
-  end
-
-end
-

data/test/test_rdoc_generator_markup.rb

@@ -1,59 +0,0 @@
-require 'rdoc/test_case'
-
-class TestRDocGeneratorMarkup < RDoc::TestCase
-
-  include RDoc::Text
-  include RDoc::Generator::Markup
-
-  attr_reader :store
-
-  def setup
-    super
-
-    @options = RDoc::Options.new
-    @rdoc.options = @options
-
-    @parent = self
-    @path = '/index.html'
-    @symbols = {}
-  end
-
-  def test_aref_to
-    assert_equal 'Foo/Bar.html', aref_to('Foo/Bar.html')
-  end
-
-  def test_as_href
-    assert_equal '../index.html', as_href('Foo/Bar.html')
-  end
-
-  def test_cvs_url
-    assert_equal 'http://example/this_page',
-                 cvs_url('http://example/', 'this_page')
-
-    assert_equal 'http://example/?page=this_page&foo=bar',
-                 cvs_url('http://example/?page=%s&foo=bar', 'this_page')
-  end
-
-  def test_description
-    @comment = '= Hello'
-
-    links = '<span><a href="#label-Hello">&para;</a> ' +
-            '<a href="#top">&uarr;</a></span>'
-
-    assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n", description
-  end
-
-  def test_formatter
-    assert_kind_of RDoc::Markup::ToHtmlCrossref, formatter
-    refute formatter.show_hash
-    assert_same self, formatter.context
-  end
-
-  attr_reader :path
-
-  def find_symbol name
-    @symbols[name]
-  end
-
-end
-

data/test/test_rdoc_generator_pot.rb

@@ -1,91 +0,0 @@
-require 'rdoc/test_case'
-
-class TestRDocGeneratorPOT < RDoc::TestCase
-
-  def setup
-    super
-
-    @options = RDoc::Options.new
-    @tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_pot_#{$$}"
-    FileUtils.mkdir_p @tmpdir
-
-    @generator = RDoc::Generator::POT.new @store, @options
-
-    @top_level = @store.add_file 'file.rb'
-    @klass = @top_level.add_class RDoc::NormalClass, 'Object'
-    @klass.add_comment 'This is a class', @top_level
-    @klass.add_section 'This is a section', comment('This is a section comment')
-
-    @const = RDoc::Constant.new "CONSTANT", "29", "This is a constant"
-
-    @meth = RDoc::AnyMethod.new nil, 'method'
-    @meth.record_location @top_level
-    @meth.comment = 'This is a method'
-
-    @attr = RDoc::Attr.new nil, 'attr', 'RW', ''
-    @attr.record_location @top_level
-    @attr.comment = 'This is an attribute'
-
-    @klass.add_constant @const
-    @klass.add_method @meth
-    @klass.add_attribute @attr
-
-    Dir.chdir @tmpdir
-  end
-
-  def teardown
-    super
-
-    Dir.chdir @pwd
-    FileUtils.rm_rf @tmpdir
-  end
-
-  def test_generate
-    @generator.generate
-
-    assert_equal <<-POT, File.read(File.join(@tmpdir, 'rdoc.pot'))
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
-# This file is distributed under the same license as the PACKAGE package.
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#, fuzzy
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSEION\\n"
-"Report-Msgid-Bugs-To:\\n"
-"PO-Revision-Date: YEAR-MO_DA HO:MI+ZONE\\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\\n"
-"Language-Team: LANGUAGE <LL@li.org>\\n"
-"Language:\\n"
-"MIME-Version: 1.0\\n"
-"Content-Type: text/plain; charset=CHARSET\\n"
-"Content-Transfer-Encoding: 8bit\\n"
-"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\\n"
-
-#. Object
-msgid "This is a class"
-msgstr ""
-
-#. Object::CONSTANT
-msgid "This is a constant"
-msgstr ""
-
-#. Object#method
-msgid "This is a method"
-msgstr ""
-
-#. Object: section title
-msgid "This is a section"
-msgstr ""
-
-#. Object: This is a section
-msgid "This is a section comment"
-msgstr ""
-
-#. Object#attr
-msgid "This is an attribute"
-msgstr ""
-    POT
-  end
-
-end