Skip to content

Commit

Permalink
Add specs for linkification in doc generator
Browse files Browse the repository at this point in the history
  • Loading branch information
@oprypin
oprypin committed Oct 11, 2020
1 parent 0fa9550 commit 50aa74d
Show file tree
Hide file tree
Showing 2 changed files with 264 additions and 9 deletions.
259 changes: 259 additions & 0 deletions spec/compiler/crystal/tools/doc/doc_renderer_spec.cr
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,259 @@
require "../../../spec_helper"

private def assert_code_link(obj, before, after = before)
renderer = Doc::Markdown::DocRenderer.new(obj, IO::Memory.new)
renderer.detect_code_link(before).should eq(after)
end

describe Doc::Markdown::DocRenderer do
describe "detect_code_link" do
program = semantic("
class Base
def foo
end
def bar
end
def self.baz
end
def foo2(a, b)
end
def foo3(a, b, c)
end
def que?
end
def one!(one)
end
def <=(other)
end
class Nested
CONST = true
def foo
end
end
end
class Sub < Base
def foo
end
end
", wants_doc: true).program
generator = Doc::Generator.new(program, [""])

base = generator.type(program.types["Base"])
base_foo = base.lookup_method("foo").not_nil!
sub = generator.type(program.types["Sub"])
sub_foo = sub.lookup_method("foo").not_nil!
nested = generator.type(program.types["Base"].types["Nested"])
nested_foo = nested.lookup_method("foo").not_nil!

it "finds sibling methods" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "bar", %(<a href="Base.html#bar-instance-method">#bar</a>))
assert_code_link(obj, "baz", %(<a href="Base.html#baz-class-method">.baz</a>))
end
end

it "finds sibling methods" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "#bar", %(<a href="Base.html#bar-instance-method">#bar</a>))
assert_code_link(obj, ".baz", %(<a href="Base.html#baz-class-method">.baz</a>))
end
end

it "doesn't find substrings for methods" do
assert_code_link(base_foo, "not bar")
assert_code_link(base_foo, "bazzy")
end

it "doesn't find sibling methods of wrong type" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "Wrong#bar")
assert_code_link(obj, "Wrong.bar")
end
end

pending "doesn't find sibling methods with fake receiver" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "wrong#bar")
assert_code_link(obj, "wrong.bar")
end
end

it "doesn't find parents' methods" do
{sub, sub_foo, nested, nested_foo}.each do |obj|
assert_code_link(obj, "bar")
assert_code_link(obj, "baz")
end
end

it "doesn't find parents' methods" do
{sub, sub_foo, nested, nested_foo}.each do |obj|
assert_code_link(obj, "#bar")
assert_code_link(obj, ".baz")
end
end

it "finds method with args" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "foo2(a, b)", %(<a href="Base.html#foo2(a,b)-instance-method">#foo2(a, b)</a>))
assert_code_link(obj, "#foo2(a, a)", %(<a href="Base.html#foo2(a,b)-instance-method">#foo2(a, a)</a>))
assert_code_link(obj, "Base#foo2(a, a)", %(<a href="Base.html#foo2(a,b)-instance-method">Base#foo2(a, a)</a>))
end
end

pending "finds method with zero args" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "bar()", %(<a href="Base.html#bar-instance-method">#bar()</a>))
assert_code_link(obj, "#bar()", %(<a href="Base.html#bar-instance-method">#bar()</a>))
assert_code_link(obj, "Base#bar()", %(<a href="Base.html#bar-instance-method">Base#bar()</a>))
end
end

it "doesn't find method with wrong number of args" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "#foo2(a, a, a, a)")
assert_code_link(obj, "#bar(a)")
end
end

it "doesn't find method with wrong number of args" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "Base#foo2(a)")
assert_code_link(obj, "Base#bar(a)")
end
end

pending "doesn't find method with wrong number of args (zero)" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "foo2()")
assert_code_link(obj, "#foo2()")
assert_code_link(obj, "Base#foo2()")
end
end

it "finds method with unspecified args" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "foo2", %(<a href="Base.html#foo2(a,b)-instance-method">#foo2</a>))
assert_code_link(obj, "#foo2", %(<a href="Base.html#foo2(a,b)-instance-method">#foo2</a>))
assert_code_link(obj, "Base#foo2", %(<a href="Base.html#foo2(a,b)-instance-method">Base#foo2</a>))
end
end

it "finds method with question mark" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "que?", %(<a href="Base.html#que?-instance-method">#que?</a>))
assert_code_link(obj, "#que?", %(<a href="Base.html#que?-instance-method">#que?</a>))
assert_code_link(obj, "Base#que?", %(<a href="Base.html#que?-instance-method">Base#que?</a>))
end
end

it "finds method with exclamation mark" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "one!(one)", %(<a href="Base.html#one!(one)-instance-method">#one!(one)</a>))
assert_code_link(obj, "#one!(one)", %(<a href="Base.html#one!(one)-instance-method">#one!(one)</a>))
assert_code_link(obj, "Base#one!(one)", %(<a href="Base.html#one!(one)-instance-method">Base#one!(one)</a>))
end
end

it "finds operator method" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "<=(other)", %(<a href="Base.html#%3C=(other)-instance-method">#<=(other)</a>))
assert_code_link(obj, "#<=(other)", %(<a href="Base.html#%3C=(other)-instance-method">#<=(other)</a>))
assert_code_link(obj, "Base#<=(other)", %(<a href="Base.html#%3C=(other)-instance-method">Base#<=(other)</a>))
end
end

it "finds operator method with unspecified args" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "<=", %(<a href="Base.html#%3C=(other)-instance-method">#<=</a>))
assert_code_link(obj, "#<=", %(<a href="Base.html#%3C=(other)-instance-method">#<=</a>))
assert_code_link(obj, "Base#<=", %(<a href="Base.html#%3C=(other)-instance-method">Base#<=</a>))
end
end

it "finds methods of a type" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "Base#bar", %(<a href="Base.html#bar-instance-method">Base#bar</a>))
assert_code_link(obj, "Base.baz", %(<a href="Base.html#baz-class-method">Base.baz</a>))
end
end

pending "finds method of an absolute type" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "::Base::Nested#foo", %(<a href="Base/Nested.html#foo-instance-method">::Base::Nested#foo</a>))
assert_code_link(obj, "::Base.baz", %(<a href="Base.html#baz-class-method">::Base.baz</a>))
end
end

pending "doesn't find wrong kind of sibling methods" do
{base, base_foo}.each do |obj|
assert_code_link(obj, ".bar")
assert_code_link(obj, "#baz")
end
end

pending "doesn't find wrong kind of methods" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "Base.bar")
assert_code_link(obj, "Base#baz")
end
end

it "finds multiple methods with brackets" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "#foo2(a, a) and Base#foo3(a,b, c)",
%(<a href="Base.html#foo2(a,b)-instance-method">#foo2(a, a)</a> and <a href="Base.html#foo3(a,b,c)-instance-method">Base#foo3(a,b, c)</a>))
end
end

it "finds types from base" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "Base and Sub and Nested",
%(<a href="Base.html">Base</a> and <a href="Sub.html">Sub</a> and <a href="Base/Nested.html">Nested</a>))
end
end

it "finds types from nested" do
{nested, nested_foo}.each do |obj|
assert_code_link(obj, "Base and Sub and Nested",
%(<a href="../Base.html">Base</a> and <a href="../Sub.html">Sub</a> and <a href="../Base/Nested.html">Nested</a>))
end
end

it "finds constant" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "Nested::CONST", %(<a href="Base/Nested.html#CONST">Nested::CONST</a>))
end
end

it "finds nested type" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "Base::Nested", %(<a href="Base/Nested.html">Base::Nested</a>))
end
end

it "finds absolute type" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "::Base::Nested",
%(<a href="Base/Nested.html">::Base::Nested</a>))
end
end

it "doesn't find wrong absolute type" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "::Nested")
end
end

pending "doesn't find type not at word boundary" do
{base, base_foo}.each do |obj|
assert_code_link(obj, "aBase")
end
end
end
end
14 changes: 5 additions & 9 deletions src/compiler/crystal/tools/doc/markdown/doc_renderer.cr
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,19 @@ class Crystal::Doc::Markdown::DocRenderer < Crystal::Doc::Markdown::HTMLRenderer
def end_inline_code
@inside_inline_code = false

text = @code_buffer.to_s
@io << detect_code_link(@code_buffer.to_s)
super
end

def detect_code_link(text : String) : String
# Check method reference (without #, but must be the whole text)
if text =~ /\A((?:\w|\<|\=|\>|\+|\-|\*|\/|\[|\]|\&|\||\?|\!|\^|\~)+(?:\?|\!)?)(\(.+?\))?\Z/
name = $1
args = $~.not_nil![2]? || ""

method = lookup_method @type, name, args
if method
text = method_link method, "#{method.prefix}#{text}"
@io << text
super
return
return method_link method, "#{method.prefix}#{text}"
end
end

Expand Down Expand Up @@ -110,10 +110,6 @@ class Crystal::Doc::Markdown::DocRenderer < Crystal::Doc::Markdown::HTMLRenderer

match_text
end

@io << text

super
end

def begin_code(language = nil)
Expand Down

0 comments on commit 50aa74d

Please sign in to comment.