rdoc 4.1.2 → 4.2.0

data/test/test_rdoc_generator_json_index.rb

@@ -136,6 +136,61 @@ class TestRDocGeneratorJsonIndex < RDoc::TestCase
     assert_equal expected, index
   end
 
+  def test_generate_gzipped
+    require 'zlib'
+    @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'
+
+    gzip = File.open 'js/search_index.js.gz'
+    json = 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
 

data/test/test_rdoc_generator_markup.rb

@@ -38,7 +38,7 @@ class TestRDocGeneratorMarkup < RDoc::TestCase
     @comment = '= Hello'
 
     links = '<span><a href="#label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
 
     assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n", description
   end

data/test/test_rdoc_generator_pot.rb

@@ -0,0 +1,91 @@
+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

data/test/test_rdoc_generator_pot_po.rb

@@ -0,0 +1,51 @@
+require 'rdoc/test_case'
+
+class TestRDocGeneratorPOTPO < RDoc::TestCase
+
+  def setup
+    super
+    @po = RDoc::Generator::POT::PO.new
+  end
+
+  def test_empty
+    assert_equal header, @po.to_s
+  end
+
+  def test_have_entry
+    @po.add(entry("Hello", {}))
+    assert_equal <<-PO, @po.to_s
+#{header}
+msgid "Hello"
+msgstr ""
+    PO
+  end
+
+  private
+
+  def entry(msgid, options)
+    RDoc::Generator::POT::POEntry.new(msgid, options)
+  end
+
+  def header
+    <<-'HEADER'
+# 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"
+    HEADER
+  end
+
+end

data/test/test_rdoc_generator_pot_po_entry.rb

@@ -0,0 +1,139 @@
+require 'rdoc/test_case'
+
+class TestRDocGeneratorPOTPOEntry < RDoc::TestCase
+
+  def test_msgid_normal
+    assert_equal <<-'ENTRY', entry("Hello", {}).to_s
+msgid "Hello"
+msgstr ""
+    ENTRY
+  end
+
+  def test_msgid_multiple_lines
+    assert_equal <<-'ENTRY', entry("Hello\nWorld", {}).to_s
+msgid ""
+"Hello\n"
+"World"
+msgstr ""
+    ENTRY
+  end
+
+  def test_msgid_tab
+    assert_equal <<-'ENTRY', entry("Hello\tWorld", {}).to_s
+msgid "Hello\tWorld"
+msgstr ""
+    ENTRY
+  end
+
+  def test_msgid_back_slash
+    assert_equal <<-'ENTRY', entry("Hello \\ World", {}).to_s
+msgid "Hello \\ World"
+msgstr ""
+    ENTRY
+  end
+
+  def test_msgid_double_quote
+    assert_equal <<-'ENTRY', entry("Hello \"World\"!", {}).to_s
+msgid "Hello \"World\"!"
+msgstr ""
+    ENTRY
+  end
+
+  def test_translator_comment_normal
+    options = {:translator_comment => "Greeting"}
+    assert_equal <<-'ENTRY', entry("Hello", options).to_s
+# Greeting
+msgid "Hello"
+msgstr ""
+    ENTRY
+  end
+
+  def test_translator_comment_multiple_lines
+    options = {:translator_comment => "Greeting\nfor morning"}
+    assert_equal <<-'ENTRY', entry("Hello", options).to_s
+# Greeting
+# for morning
+msgid "Hello"
+msgstr ""
+    ENTRY
+  end
+
+  def test_extracted_comment_normal
+    options = {:extracted_comment => "Object"}
+    assert_equal <<-'ENTRY', entry("Hello", options).to_s
+#. Object
+msgid "Hello"
+msgstr ""
+    ENTRY
+  end
+
+  def test_extracted_comment_multiple_lines
+    options = {:extracted_comment => "Object\nMorning#greeting"}
+    assert_equal <<-'ENTRY', entry("Hello", options).to_s
+#. Object
+#. Morning#greeting
+msgid "Hello"
+msgstr ""
+    ENTRY
+  end
+
+  def test_references_normal
+    options = {:references => [["lib/rdoc.rb", 29]]}
+    assert_equal <<-'ENTRY', entry("Hello", options).to_s
+#: lib/rdoc.rb:29
+msgid "Hello"
+msgstr ""
+    ENTRY
+  end
+
+  def test_references_multiple
+    options = {:references => [["lib/rdoc.rb", 29], ["lib/rdoc/i18n.rb", 9]]}
+    assert_equal <<-'ENTRY', entry("Hello", options).to_s
+#: lib/rdoc.rb:29
+#: lib/rdoc/i18n.rb:9
+msgid "Hello"
+msgstr ""
+    ENTRY
+  end
+
+  def test_flags_normal
+    options = {:flags => ["fuzzy"]}
+    assert_equal <<-'ENTRY', entry("Hello", options).to_s
+#, fuzzy
+msgid "Hello"
+msgstr ""
+    ENTRY
+  end
+
+  def test_flags_multiple
+    options = {:flags => ["fuzzy", "ruby-format"]}
+    assert_equal <<-'ENTRY', entry("Hello", options).to_s
+#, fuzzy,ruby-format
+msgid "Hello"
+msgstr ""
+    ENTRY
+  end
+
+  def test_full
+    options = {
+      :translator_comment => "Greeting",
+      :extracted_comment  => "Morning#greeting",
+      :references         => [["lib/rdoc.rb", 29]],
+      :flags              => ["fuzzy"],
+    }
+    assert_equal <<-'ENTRY', entry("Hello", options).to_s
+# Greeting
+#. Morning#greeting
+#: lib/rdoc.rb:29
+#, fuzzy
+msgid "Hello"
+msgstr ""
+    ENTRY
+  end
+
+  private
+  def entry(msgid, options)
+    RDoc::Generator::POT::POEntry.new(msgid, options)
+  end
+
+end

data/test/test_rdoc_i18n_locale.rb

@@ -0,0 +1,73 @@
+require 'rdoc/test_case'
+
+class TestRDocI18nLocale < RDoc::TestCase
+
+  def setup
+    super
+    @locale = locale('fr')
+
+    @tmpdir = File.join Dir.tmpdir, "test_rdoc_i18n_locale_#{$$}"
+    FileUtils.mkdir_p @tmpdir
+
+    @locale_dir = @tmpdir
+  end
+
+  def teardown
+    FileUtils.rm_rf @tmpdir
+    super
+  end
+
+  def test_name
+    assert_equal 'fr', locale('fr').name
+  end
+
+  def test_load_nonexistent_po
+    File.stub(:exist?, false) do
+      refute @locale.load('nonexsitent-locale')
+    end
+  end
+
+  def test_load_existent_po
+    begin
+      require 'gettext/po_parser'
+    rescue LoadError
+      skip 'gettext gem is not found'
+    end
+
+    fr_locale_dir = File.join @locale_dir, 'fr'
+    FileUtils.mkdir_p fr_locale_dir
+    File.open File.join(fr_locale_dir, 'rdoc.po'), 'w' do |po|
+      po.puts <<-PO
+msgid ""
+msgstr ""
+"Language: fr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+msgid "Hello"
+msgstr "Bonjour"
+      PO
+    end
+
+    assert @locale.load(@locale_dir)
+    assert_equal 'Bonjour', @locale.translate('Hello')
+  end
+
+  def test_translate_existent_message
+    messages = @locale.instance_variable_get(:@messages)
+    messages['Hello'] = 'Bonjour'
+    assert_equal 'Bonjour', @locale.translate('Hello')
+  end
+
+  def test_translate_nonexistent_message
+    assert_equal 'Hello', @locale.translate('Hello')
+  end
+
+  private
+
+  def locale(name)
+    RDoc::I18n::Locale.new(name)
+  end
+
+end

data/test/test_rdoc_i18n_text.rb

@@ -0,0 +1,123 @@
+require 'rdoc/test_case'
+
+class TestRDocI18nText < RDoc::TestCase
+
+  def test_multiple_paragraphs
+    paragraph1 = <<-PARAGRAPH.strip
+RDoc produces HTML and command-line documentation for Ruby projects.  RDoc
+includes the +rdoc+ and +ri+ tools for generating and displaying documentation
+from the command-line.
+    PARAGRAPH
+
+    paragraph2 = <<-PARAGRAPH.strip
+This command generates documentation for all the Ruby and C source
+files in and below the current directory.  These will be stored in a
+documentation tree starting in the subdirectory +doc+.
+    PARAGRAPH
+
+    raw = <<-RAW
+#{paragraph1}
+
+#{paragraph2}
+    RAW
+
+    expected = [
+      {
+        :type      => :paragraph,
+        :paragraph => paragraph1,
+        :line_no   => 1,
+      },
+      {
+        :type      => :paragraph,
+        :paragraph => paragraph2,
+        :line_no   => 5,
+      },
+    ]
+    assert_equal expected, extract_messages(raw)
+  end
+
+  def test_translate_multiple_paragraphs
+    paragraph1 = <<-PARAGRAPH.strip
+Paragraph 1.
+    PARAGRAPH
+    paragraph2 = <<-PARAGRAPH.strip
+Paragraph 2.
+    PARAGRAPH
+
+    raw = <<-RAW
+#{paragraph1}
+
+#{paragraph2}
+    RAW
+
+    expected = <<-TRANSLATED
+Paragraphe 1.
+
+Paragraphe 2.
+    TRANSLATED
+    assert_equal expected, translate(raw)
+  end
+
+  def test_translate_not_transalted_message
+    nonexistent_paragraph = <<-PARAGRAPH.strip
+Nonexistent paragraph.
+    PARAGRAPH
+
+    raw = <<-RAW
+#{nonexistent_paragraph}
+    RAW
+
+    expected = <<-TRANSLATED
+#{nonexistent_paragraph}
+    TRANSLATED
+    assert_equal expected, translate(raw)
+  end
+
+  def test_translate_keep_empty_lines
+    raw = <<-RAW
+Paragraph 1.
+
+
+
+
+Paragraph 2.
+    RAW
+
+    expected = <<-TRANSLATED
+Paragraphe 1.
+
+
+
+
+Paragraphe 2.
+    TRANSLATED
+    assert_equal expected, translate(raw)
+  end
+
+  private
+
+  def extract_messages(raw)
+    text = RDoc::I18n::Text.new(raw)
+    messages = []
+    text.extract_messages do |message|
+      messages << message
+    end
+    messages
+  end
+
+  def locale
+    locale = RDoc::I18n::Locale.new('fr')
+    messages = locale.instance_variable_get(:@messages)
+    messages['markdown'] = 'markdown (markdown in fr)'
+    messages['Hello'] = 'Bonjour (Hello in fr)'
+    messages['Paragraph 1.'] = 'Paragraphe 1.'
+    messages['Paragraph 2.'] = 'Paragraphe 2.'
+    locale
+  end
+
+  def translate(raw)
+    text = RDoc::I18n::Text.new(raw)
+    text.translate(locale)
+  end
+
+end