Skip to content

Fix escape in string #474

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 6 commits into from
Aug 22, 2017
Merged

Fix escape in string #474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3364622
Fix escape in string
aycabta Jul 29, 2017
b096046
Add test_accept_verbatim_escape_in_string
aycabta Jul 29, 2017
e104cd1
Add test_class_tokenize_string_with_escape
aycabta Aug 2, 2017
f17a85f
Merge branch 'fix-escape-in-string' of github.com:aycabta/rdoc into f…
aycabta Aug 4, 2017
941b441
Merge branch 'master' into fix-escape-in-string
aycabta Aug 8, 2017
2b02e37
Merge branch 'master' into fix-escape-in-string
aycabta Aug 9, 2017
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
9 changes: 5 additions & 4 deletions lib/rdoc/ruby_lex.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1331,13 +1331,14 @@ def identify_string(ltype, quoted = ltype, type = nil)
ungetc
end
elsif ch == '\\'
if %w[' /].include? @ltype then
case @ltype
when "'" then
case ch = getc
when "\n", "'"
when @ltype
when "'", '\\' then
str << ch
else
ungetc
str << '\\'
str << ch
end
else
str << read_escape
Expand Down
60 changes: 60 additions & 0 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 @@ -485,6 +485,66 @@ def test_accept_verbatim_pipe
assert_equal expected, @to.res.join
end

def test_accept_verbatim_escape_in_string
code = <<-'RUBY'
def foo
[
'\\',
'\'',
"'",
"\'\"\`",
"\#",
"\#{}",
"#",
"#{}",
/'"/,
/\'\"/,
/\//,
/\\/,
/\#/,
/\#{}/,
/#/,
/#{}/
]
end
def bar
end
RUBY
verb = @RM::Verbatim.new(*code.split(/(?<=\n)/))

@to.start_accepting
@to.accept_verbatim verb

expected = <<-'EXPECTED'

<pre class="ruby"><span class="ruby-keyword">def</span> <span class="ruby-identifier">foo</span>
[
<span class="ruby-string">&#39;\\&#39;</span>,
<span class="ruby-string">&#39;\&#39;&#39;</span>,
<span class="ruby-string">&quot;&#39;&quot;</span>,
<span class="ruby-string">&quot;\&#39;\&quot;\`&quot;</span>,
<span class="ruby-string">&quot;\#&quot;</span>,
<span class="ruby-string">&quot;\#{}&quot;</span>,
<span class="ruby-string">&quot;#&quot;</span>,
<span class="ruby-node">&quot;#{}&quot;</span>,
<span class="ruby-regexp">/&#39;&quot;/</span>,
<span class="ruby-regexp">/\&#39;\&quot;/</span>,
<span class="ruby-regexp">/\//</span>,
<span class="ruby-regexp">/\\/</span>,
<span class="ruby-regexp">/\#/</span>,
<span class="ruby-regexp">/\#{}/</span>,
<span class="ruby-regexp">/#/</span>,
<span class="ruby-regexp">/#{}/</span>
]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">bar</span>
<span class="ruby-keyword">end</span>
</pre>
EXPECTED

assert_equal expected, @to.res.join
end

def test_accept_verbatim_ruby
verb = @RM::Verbatim.new("1 + 1\n")
verb.format = :ruby
Expand Down
95 changes: 95 additions & 0 deletions test/test_rdoc_ruby_lex.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,101 @@ def test_class_tokenize_string
assert_equal expected, tokens
end

def test_class_tokenize_string_with_escape
tokens = RDoc::RubyLex.tokenize <<'RUBY', nil
[
'\\',
'\'',
"'",
"\'\"\`",
"\#",
"\#{}",
"#",
"#{}",
/'"/,
/\'\"/,
/\//,
/\\/,
/\#/,
/\#{}/,
/#/,
/#{}/
]
RUBY

expected = [
@TK::TkLBRACK .new( 0, 1, 0, "["),
@TK::TkNL .new( 1, 1, 1, "\n"),
@TK::TkSPACE .new( 2, 2, 0, " "),
@TK::TkSTRING .new( 4, 2, 2, "'\\\\'"),
@TK::TkCOMMA .new( 8, 2, 6, ","),
@TK::TkNL .new( 9, 2, 2, "\n"),
@TK::TkSPACE .new( 10, 3, 0, " "),
@TK::TkSTRING .new( 12, 3, 2, "'\\''"),
@TK::TkCOMMA .new( 16, 3, 6, ","),
@TK::TkNL .new( 17, 3, 10, "\n"),
@TK::TkSPACE .new( 18, 4, 0, " "),
@TK::TkSTRING .new( 20, 4, 2, "\"'\""),
@TK::TkCOMMA .new( 23, 4, 5, ","),
@TK::TkNL .new( 24, 4, 18, "\n"),
@TK::TkSPACE .new( 25, 5, 0, " "),
@TK::TkSTRING .new( 27, 5, 2, "\"\\'\\\"\\`\""),
@TK::TkCOMMA .new( 35, 5, 10, ","),
@TK::TkNL .new( 36, 5, 25, "\n"),
@TK::TkSPACE .new( 37, 6, 0, " "),
@TK::TkSTRING .new( 39, 6, 2, "\"\\#\""),
@TK::TkCOMMA .new( 43, 6, 6, ","),
@TK::TkNL .new( 44, 6, 37, "\n"),
@TK::TkSPACE .new( 45, 7, 0, " "),
@TK::TkSTRING .new( 47, 7, 2, "\"\\\#{}\""),
@TK::TkCOMMA .new( 53, 7, 8, ","),
@TK::TkNL .new( 54, 7, 45, "\n"),
@TK::TkSPACE .new( 55, 8, 0, " "),
@TK::TkSTRING .new( 57, 8, 2, "\"#\""),
@TK::TkCOMMA .new( 60, 8, 5, ","),
@TK::TkNL .new( 61, 8, 55, "\n"),
@TK::TkSPACE .new( 62, 9, 0, " "),
@TK::TkDSTRING.new( 64, 9, 2, "\"\#{}\""),
@TK::TkCOMMA .new( 69, 9, 7, ","),
@TK::TkNL .new( 70, 9, 62, "\n"),
@TK::TkSPACE .new( 71, 10, 0, " "),
@TK::TkREGEXP .new( 73, 10, 2, "/'\"/"),
@TK::TkCOMMA .new( 77, 10, 6, ","),
@TK::TkNL .new( 78, 10, 71, "\n"),
@TK::TkSPACE .new( 79, 11, 0, " "),
@TK::TkREGEXP .new( 81, 11, 2, "/\\'\\\"/"),
@TK::TkCOMMA .new( 87, 11, 8, ","),
@TK::TkNL .new( 88, 11, 79, "\n"),
@TK::TkSPACE .new( 89, 12, 0, " "),
@TK::TkREGEXP .new( 91, 12, 2, "/\\//"),
@TK::TkCOMMA .new( 95, 12, 6, ","),
@TK::TkNL .new( 96, 12, 89, "\n"),
@TK::TkSPACE .new( 97, 13, 0, " "),
@TK::TkREGEXP .new( 99, 13, 2, "/\\\\/"),
@TK::TkCOMMA .new(103, 13, 6, ","),
@TK::TkNL .new(104, 13, 97, "\n"),
@TK::TkSPACE .new(105, 14, 0, " "),
@TK::TkREGEXP .new(107, 14, 2, "/\\#/"),
@TK::TkCOMMA .new(111, 14, 6, ","),
@TK::TkNL .new(112, 14, 105, "\n"),
@TK::TkSPACE .new(113, 15, 0, " "),
@TK::TkREGEXP .new(115, 15, 2, "/\\\#{}/"),
@TK::TkCOMMA .new(121, 15, 8, ","),
@TK::TkNL .new(122, 15, 113, "\n"),
@TK::TkSPACE .new(123, 16, 0, " "),
@TK::TkREGEXP .new(125, 16, 2, "/#/"),
@TK::TkCOMMA .new(128, 16, 5, ","),
@TK::TkNL .new(129, 16, 123, "\n"),
@TK::TkSPACE .new(130, 17, 0, " "),
@TK::TkDREGEXP.new(132, 17, 2, "/\#{}/"),
@TK::TkNL .new(137, 17, 7, "\n"),
@TK::TkRBRACK .new(138, 18, 0, "]"),
@TK::TkNL .new(139, 18, 138, "\n")
]

assert_equal expected, tokens
end

def test_class_tokenize_string_escape
tokens = RDoc::RubyLex.tokenize '"\\n"', nil
assert_equal @TK::TkSTRING.new( 0, 1, 0, "\"\\n\""), tokens.first
Expand Down