Contents

require File.expand_path(File.dirname(__FILE__) + "/../../../../test_helper")

describe ::Inch::CodeObject::Provider::YARD::NodocHelper do
  before do
    @provider = ::Inch::CodeObject::Provider::YARD.parse(fixture_path(:simple))
    @objects = @provider.objects
  end

  it "should return true for explicitly or implicitly tagged objects" do
    [
      "Foo::Qux",
      "Foo::Qux#method_with_implicit_nodoc",
      "Foo::Qux::Quux#method_with_private_tag",
      "Foo::Qux::Quux#method_with_explicit_nodoc",
      "Foo::Qux::Quux::PRIVATE_VALUE",
      "Foo::HiddenClass",
      "Foo::HiddenClass::EvenMoreHiddenClass",
      "Foo::HiddenClass::EvenMoreHiddenClass#method_with_implicit_nodoc",
      "Foo::HiddenClassViaTag",
      "Foo::HiddenClassViaTag#some_value"
    ].each do |query|
      m = @objects.find { |o| o.fullname == query }
      assert m.nodoc?, "nodoc? should return true for #{query}"
    end
  end

  it "should return false for other objects" do
    [
      "Foo::Qux::Quux#method_without_nodoc",
      "Foo::Qux::Quux::PUBLIC_VALUE",
      "Foo::Qux::DOCCED_VALUE",
      "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass",
      "Foo::HiddenClass::EvenMoreHiddenClass::SuddenlyVisibleClass#method_with_implicit_doc"
    ].each do |query|
      m = @objects.find { |o| o.fullname == query }
      refute m.nodoc?, "nodoc? should return false for #{query}"
    end
  end

end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
inch-0.4.7	test/unit/code_object/provider/yard/nodoc_helper_test.rb