horseman 0.0.2 → 0.0.3

data/vendor/ruby/1.9.1/gems/rdoc-3.12/test/test_rdoc_stats.rb

@@ -0,0 +1,588 @@
+require 'rdoc/test_case'
+
+class TestRDocStats < RDoc::TestCase
+
+  def setup
+    super
+
+    @s = RDoc::Stats.new 0
+
+    @tl = RDoc::TopLevel.new 'file.rb'
+    @tl.parser = RDoc::Parser::Ruby
+  end
+
+  def test_doc_stats
+    c = RDoc::CodeObject.new
+
+    assert_equal [1, 1], @s.doc_stats([c])
+  end
+
+  def test_doc_stats_documented
+    c = RDoc::CodeObject.new
+    c.comment = comment 'x'
+
+    assert_equal [1, 0], @s.doc_stats([c])
+  end
+
+  def test_doc_stats_display_eh
+    c = RDoc::CodeObject.new
+    c.ignore
+
+    assert_equal [0, 0], @s.doc_stats([c])
+  end
+
+  def test_report_attr
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    a = RDoc::Attr.new nil, 'a', 'RW', nil
+    a.record_location @tl
+    c.add_attribute a
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+class C # is documented
+
+  attr_accessor :a # in file file.rb
+end
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_attr_documented
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    a = RDoc::Attr.new nil, 'a', 'RW', 'a'
+    a.record_location @tl
+    c.add_attribute a
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    assert_equal @s.great_job, report
+  end
+
+  def test_report_constant
+    m = @tl.add_module RDoc::NormalModule, 'M'
+    m.record_location @tl
+    m.add_comment 'M', @tl
+
+    c = RDoc::Constant.new 'C', nil, nil
+    c.record_location @tl
+    m.add_constant c
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+module M # is documented
+
+  # in file file.rb
+  C = nil
+end
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_constant_alias
+    mod = @tl.add_module RDoc::NormalModule, 'M'
+
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    mod.add_constant c
+
+    ca = RDoc::Constant.new 'CA', nil, nil
+    ca.is_alias_for = c
+
+    @tl.add_constant ca
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    # TODO change this to refute match, aliases should be ignored as they are
+    # programmer convenience constructs
+    assert_match(/class Object/, report)
+  end
+
+  def test_report_constant_documented
+    m = @tl.add_module RDoc::NormalModule, 'M'
+    m.record_location @tl
+    m.comment = 'M'
+
+    c = RDoc::Constant.new 'C', nil, 'C'
+    c.record_location @tl
+    m.add_constant c
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    assert_equal @s.great_job, report
+  end
+
+  def test_report_class
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+
+    m = RDoc::AnyMethod.new nil, 'm'
+    m.record_location @tl
+    c.add_method m
+    m.comment = 'm'
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+# in files:
+#   file.rb
+
+class C
+end
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_class_documented
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    m = RDoc::AnyMethod.new nil, 'm'
+    m.record_location @tl
+    c.add_method m
+    m.comment = 'm'
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    assert_equal @s.great_job, report
+  end
+
+  def test_report_class_documented_level_1
+    c1 = @tl.add_class RDoc::NormalClass, 'C1'
+    c1.record_location @tl
+    c1.add_comment 'C1', @tl
+
+    m1 = RDoc::AnyMethod.new nil, 'm1'
+    m1.record_location @tl
+    c1.add_method m1
+    m1.comment = 'm1'
+
+    c2 = @tl.add_class RDoc::NormalClass, 'C2'
+    c2.record_location @tl
+
+    m2 = RDoc::AnyMethod.new nil, 'm2'
+    m2.record_location @tl
+    c2.add_method m2
+    m2.comment = 'm2'
+
+    RDoc::TopLevel.complete :public
+
+    @s.coverage_level = 1
+
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+
+# in files:
+#   file.rb
+
+class C2
+end
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_class_empty
+    @tl.add_class RDoc::NormalClass, 'C'
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+# class C is referenced but empty.
+#
+# It probably came from another project.  I'm sorry I'm holding it against you.
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_class_empty_2
+    c1 = @tl.add_class RDoc::NormalClass, 'C1'
+    c1.record_location @tl
+
+    c2 = @tl.add_class RDoc::NormalClass, 'C2'
+    c2.record_location @tl
+    c2.add_comment 'C2', @tl
+
+    RDoc::TopLevel.complete :public
+
+    @s.coverage_level = 1
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+# in files:
+#   file.rb
+
+class C1
+end
+
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_class_method_documented
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+
+    m = RDoc::AnyMethod.new nil, 'm'
+    m.record_location @tl
+    c.add_method m
+    m.comment = 'm'
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+# in files:
+#   file.rb
+
+class C
+end
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_class_module_ignore
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.ignore
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report_class_module c
+
+    assert_nil report
+  end
+
+  def test_report_empty
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    assert_equal @s.great_job, report
+  end
+
+  def test_report_method
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    m1 = RDoc::AnyMethod.new nil, 'm1'
+    m1.record_location @tl
+    c.add_method m1
+
+    m2 = RDoc::AnyMethod.new nil, 'm2'
+    m2.record_location @tl
+    c.add_method m2
+    m2.comment = 'm2'
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+class C # is documented
+
+  # in file file.rb
+  def m1; end
+
+end
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_method_class
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    m1 = RDoc::AnyMethod.new nil, 'm1'
+    m1.record_location @tl
+    m1.singleton = true
+    c.add_method m1
+
+    m2 = RDoc::AnyMethod.new nil, 'm2'
+    m2.record_location @tl
+    m2.singleton = true
+    c.add_method m2
+    m2.comment = 'm2'
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+class C # is documented
+
+  # in file file.rb
+  def self.m1; end
+
+end
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_method_documented
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    m = RDoc::AnyMethod.new nil, 'm'
+    m.record_location @tl
+    c.add_method m
+    m.comment = 'm'
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    assert_equal @s.great_job, report
+  end
+
+  def test_report_method_parameters
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    m1 = RDoc::AnyMethod.new nil, 'm1'
+    m1.record_location @tl
+    m1.params = '(p1, p2)'
+    m1.comment = 'Stuff with +p1+'
+    c.add_method m1
+
+    m2 = RDoc::AnyMethod.new nil, 'm2'
+    m2.record_location @tl
+    c.add_method m2
+    m2.comment = 'm2'
+
+    RDoc::TopLevel.complete :public
+
+    @s.coverage_level = 1
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+class C # is documented
+
+  # in file file.rb
+  # +p2+ is not documented
+  def m1(p1, p2); end
+
+end
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_method_parameters_documented
+    @tl.parser = RDoc::Parser::Ruby
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    m = RDoc::AnyMethod.new nil, 'm'
+    m.record_location @tl
+    m.params = '(p1)'
+    m.comment = 'Stuff with +p1+'
+    c.add_method m
+
+    RDoc::TopLevel.complete :public
+
+    @s.coverage_level = 1
+    report = @s.report
+
+    assert_equal @s.great_job, report
+  end
+
+  def test_report_method_parameters_yield
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    m = RDoc::AnyMethod.new nil, 'm'
+    m.record_location @tl
+    m.call_seq = <<-SEQ
+m(a) { |c| ... }
+m(a, b) { |c, d| ... }
+    SEQ
+    m.comment = 'Stuff with +a+, yields +c+ for you to do stuff with'
+    c.add_method m
+
+    RDoc::TopLevel.complete :public
+
+    @s.coverage_level = 1
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+class C # is documented
+
+  # in file file.rb
+  # +b+, +d+ is not documented
+  def m; end
+
+end
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_summary
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+
+    m = @tl.add_module RDoc::NormalModule, 'M'
+    m.record_location @tl
+
+    a = RDoc::Attr.new nil, 'a', 'RW', nil
+    a.record_location @tl
+    c.add_attribute a
+
+    c_c = RDoc::Constant.new 'C', nil, nil
+    c_c.record_location @tl
+    c.add_constant c_c
+
+    m = RDoc::AnyMethod.new nil, 'm'
+    m.record_location @tl
+    c.add_method m
+
+    RDoc::TopLevel.complete :public
+
+    summary = @s.summary
+    summary.sub!(/Elapsed:.*/, '')
+
+    expected = <<-EXPECTED
+Files:      0
+
+Classes:    1 (1 undocumented)
+Modules:    1 (1 undocumented)
+Constants:  1 (1 undocumented)
+Attributes: 1 (1 undocumented)
+Methods:    1 (1 undocumented)
+
+Total:      5 (5 undocumented)
+  0.00% documented
+
+    EXPECTED
+
+    assert_equal summary, expected
+  end
+
+  def test_summary_level_false
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+
+    RDoc::TopLevel.complete :public
+
+    @s.coverage_level = false
+
+    summary = @s.summary
+    summary.sub!(/Elapsed:.*/, '')
+
+    expected = <<-EXPECTED
+Files:      0
+
+Classes:    1 (1 undocumented)
+Modules:    0 (0 undocumented)
+Constants:  0 (0 undocumented)
+Attributes: 0 (0 undocumented)
+Methods:    0 (0 undocumented)
+
+Total:      1 (1 undocumented)
+  0.00% documented
+
+    EXPECTED
+
+    assert_equal summary, expected
+  end
+
+  def test_summary_level_1
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    m = RDoc::AnyMethod.new nil, 'm'
+    m.record_location @tl
+    m.params = '(p1, p2)'
+    m.comment = 'Stuff with +p1+'
+    c.add_method m
+
+    RDoc::TopLevel.complete :public
+
+    @s.coverage_level = 1
+    @s.report
+
+    summary = @s.summary
+    summary.sub!(/Elapsed:.*/, '')
+
+    expected = <<-EXPECTED
+Files:      0
+
+Classes:    1 (0 undocumented)
+Modules:    0 (0 undocumented)
+Constants:  0 (0 undocumented)
+Attributes: 0 (0 undocumented)
+Methods:    1 (0 undocumented)
+Parameters: 2 (1 undocumented)
+
+Total:      4 (1 undocumented)
+ 75.00% documented
+
+    EXPECTED
+
+    assert_equal summary, expected
+  end
+
+end
+

data/vendor/ruby/1.9.1/gems/rdoc-3.12/test/test_rdoc_task.rb

@@ -0,0 +1,120 @@
+require 'rdoc/test_case'
+require 'rake'
+
+class TestRDocTask < RDoc::TestCase
+
+  def setup
+    super
+
+    Rake::Task.clear
+
+    @t = RDoc::Task.new
+  end
+
+  def test_clobber_task_description
+    assert_equal 'Remove RDoc HTML files', @t.clobber_task_description
+  end
+
+  def test_inline_source
+    _, err = capture_io do
+      assert @t.inline_source
+    end
+
+    assert_equal "RDoc::Task#inline_source is deprecated\n", err
+
+    _, err = capture_io do
+      @t.inline_source = false
+    end
+
+    assert_equal "RDoc::Task#inline_source is deprecated\n", err
+
+    capture_io do
+      assert @t.inline_source
+    end
+  end
+
+  def test_markup_option
+    rdoc_task = RDoc::Task.new do |rd|
+      rd.markup = "tomdoc"
+    end
+
+    assert_equal %w[-o html --markup tomdoc], rdoc_task.option_list
+  end
+
+  def test_tasks_creation
+    RDoc::Task.new
+    assert Rake::Task[:rdoc]
+    assert Rake::Task[:clobber_rdoc]
+    assert Rake::Task[:rerdoc]
+  end
+
+  def test_tasks_creation_with_custom_name_symbol
+    rd = RDoc::Task.new(:rdoc_dev)
+    assert Rake::Task[:rdoc_dev]
+    assert Rake::Task[:clobber_rdoc_dev]
+    assert Rake::Task[:rerdoc_dev]
+    assert_equal :rdoc_dev, rd.name
+  end
+
+  def test_generator_option
+    rdoc_task = RDoc::Task.new do |rd|
+      rd.generator = "ri"
+    end
+
+    assert_equal %w[-o html -f ri], rdoc_task.option_list
+  end
+
+  def test_rdoc_task_description
+    assert_equal 'Build RDoc HTML files', @t.rdoc_task_description
+  end
+
+  def test_rerdoc_task_description
+    assert_equal 'Rebuild RDoc HTML files', @t.rerdoc_task_description
+  end
+
+  def test_tasks_creation_with_custom_name_string
+    rd = RDoc::Task.new("rdoc_dev")
+    assert Rake::Task[:rdoc_dev]
+    assert Rake::Task[:clobber_rdoc_dev]
+    assert Rake::Task[:rerdoc_dev]
+    assert_equal "rdoc_dev", rd.name
+  end
+
+  def test_tasks_creation_with_custom_name_hash
+    options = {
+      :rdoc => "rdoc",
+      :clobber_rdoc => "rdoc:clean",
+      :rerdoc => "rdoc:force"
+    }
+
+    Rake::Task.clear
+
+    rd = RDoc::Task.new(options)
+    assert Rake::Task[:"rdoc"]
+    assert Rake::Task[:"rdoc:clean"]
+    assert Rake::Task[:"rdoc:force"]
+    assert_raises(RuntimeError) { Rake::Task[:clobber_rdoc] }
+    assert_equal options, rd.name
+  end
+
+  def test_tasks_creation_with_custom_name_hash_will_use_default_if_an_option_isnt_given
+    RDoc::Task.new(:clobber_rdoc => "rdoc:clean")
+    assert Rake::Task[:rdoc]
+    assert Rake::Task[:"rdoc:clean"]
+    assert Rake::Task[:rerdoc]
+  end
+
+  def test_tasks_creation_with_custom_name_hash_raises_exception_if_invalid_option_given
+    assert_raises(ArgumentError) do
+      RDoc::Task.new(:foo => "bar")
+    end
+
+    begin
+      RDoc::Task.new(:foo => "bar")
+    rescue ArgumentError => e
+      assert_match(/foo/, e.message)
+    end
+  end
+
+end
+