Skip to content

Use a real parser for RDoc::Markup::ToHtml#parseable? (Fixes #320) #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 7, 2014
Merged

Use a real parser for RDoc::Markup::ToHtml#parseable? (Fixes #320) #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions lib/rdoc/markup/to_html.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,11 +379,12 @@ def list_end_for(list_type)
end

##
# Returns true if Ripper is available it can create a sexp from +text+
# Returns true if text is valid ruby syntax

def parseable? text
text =~ /\b(def|class|module|require) |=>|\{\s?\||do \|/ and
text !~ /<%|%>/
eval("BEGIN {return true}\n#{text}")
rescue SyntaxError
false
end

##
Expand Down
50 changes: 35 additions & 15 deletions test/test_rdoc_markup_to_html.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ def accept_rule
end

def accept_verbatim
assert_equal "\n<pre>hi\n world</pre>\n", @to.res.join
assert_equal "\n<pre class=\"ruby\"><span class=\"ruby-identifier\">hi</span>\n <span class=\"ruby-identifier\">world</span>\n</pre>\n", @to.res.join
end

def end_accepting
Expand Down Expand Up @@ -444,8 +444,7 @@ def test_accept_verbatim_parseable_error

expected = <<-EXPECTED

<pre>#{inner}
</pre>
<pre>#{inner}</pre>
EXPECTED

assert_equal expected, @to.res.join
Expand Down Expand Up @@ -604,8 +603,9 @@ def test_list_verbatim_2
<ul><li>
<p>one</p>

<pre>verb1
verb2</pre>
<pre class=\"ruby\"><span class=\"ruby-identifier\">verb1</span>
<span class=\"ruby-identifier\">verb2</span>
</pre>
</li><li>
<p>two</p>
</li></ul>
Expand All @@ -615,16 +615,36 @@ def test_list_verbatim_2
end

def test_parseable_eh
assert @to.parseable?('def x() end'), 'def'
assert @to.parseable?('class C end'), 'class'
assert @to.parseable?('module M end'), 'module'
assert @to.parseable?('a # => blah'), '=>'
assert @to.parseable?('x { |y| ... }'), '{ |x|'
assert @to.parseable?('x do |y| ... end'), 'do |x|'
refute @to.parseable?('* 1'), '* 1'
refute @to.parseable?('# only a comment'), '# only a comment'
refute @to.parseable?('<% require "foo" %>'), 'ERB'
refute @to.parseable?('class="foo"'), 'HTML class'
valid_syntax = [
'def x() end',
'def x; end',
'class C; end',
"module M end",
'a # => blah',
'x { |y| nil }',
'x do |y| nil end',
'# only a comment',
'require "foo"',
'cls="foo"'
]
invalid_syntax = [
'def x end',
'class C end',
'class C < end',
'module M < C end',
'a=># blah',
'x { |y| ... }',
'x do |y| ... end',
'// only a comment',
'<% require "foo" %>',
'class="foo"'
]
valid_syntax.each do |t|
assert @to.parseable?(t), "valid syntax considered invalid: #{t}"
end
invalid_syntax.each do |t|
refute @to.parseable?(t), "invalid syntax considered valid: #{t}"
end
end

def test_to_html
Expand Down
15 changes: 8 additions & 7 deletions test/test_rdoc_markup_to_html_snippet.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ def accept_rule
end

def accept_verbatim
assert_equal "\n<pre>hi\n world</pre>\n", @to.res.join
assert_equal "\n<pre class=\"ruby\"><span class=\"ruby-identifier\">hi</span>\n <span class=\"ruby-identifier\">world</span>\n</pre>\n", @to.res.join
assert_equal 10, @to.characters
end

Expand Down Expand Up @@ -427,8 +427,7 @@ def test_accept_verbatim_ruby_error

expected = <<-EXPECTED

<pre>#{inner}
</pre>
<pre>#{inner}</pre>
EXPECTED

assert_equal expected, @to.res.join
Expand Down Expand Up @@ -588,8 +587,9 @@ def test_convert_limit_verbatim_multiline
expected = <<-EXPECTED
<p>Look for directives in a normal comment block:

<pre># :stopdoc:
#{inner}</pre>
<pre class=\"ruby\"><span class=\"ruby-comment\"># :stopdoc:</span>
<span class=\"ruby-comment\">#{inner}</span>
</pre>
EXPECTED

actual = @to.convert rdoc
Expand Down Expand Up @@ -665,8 +665,9 @@ def test_list_verbatim_2
expected = <<-EXPECTED
<p>one

<pre>verb1
verb2</pre>
<pre class=\"ruby\"><span class=\"ruby-identifier\">verb1</span>
<span class=\"ruby-identifier\">verb2</span>
</pre>
<p>two

EXPECTED
Expand Down