Skip to content

Trim even spaces only in code #1405

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 2 commits into from
Aug 12, 2025
Merged

Trim even spaces only in code #1405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0551151
Trim even spaces only in code
nobu Aug 11, 2025
268ff77
Tests for code enclosing a tab and a space
nobu Aug 12, 2025
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
32 changes: 17 additions & 15 deletions lib/rdoc/markdown.kpeg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,8 @@
# Wraps `text` in code markup for rdoc inline formatting

def code text
# trim even spaces
text = $2 while /\A( +|\t+)(.*)\1\z/ =~ text
# escape unescaped backslash at the end
backslash_at_end = "\\" if /(?<!\\)(?:\\\\)*\\\z/.match?(text)
"<code>#{text}#{backslash_at_end}</code>"
Expand Down Expand Up @@ -1113,30 +1115,30 @@ Ticks3 = "```" !"`"
Ticks4 = "````" !"`"
Ticks5 = "`````" !"`"

Code = ( Ticks1 @Sp < (
Code = ( Ticks1 < (
( !"`" Nonspacechar )+ | !Ticks1 /`+/ |
!( @Sp Ticks1 ) ( @Spacechar | @Newline !@BlankLine )
)+ > @Sp Ticks1 |
Ticks2 @Sp < (
!Ticks1 ( @Spacechar | @Newline !@BlankLine )
)+ > Ticks1 |
Ticks2 < (
( !"`" Nonspacechar )+ |
!Ticks2 /`+/ |
!( @Sp Ticks2 ) ( @Spacechar | @Newline !@BlankLine )
)+ > @Sp Ticks2 |
Ticks3 @Sp < (
!Ticks2 ( @Spacechar | @Newline !@BlankLine )
)+ > Ticks2 |
Ticks3 < (
( !"`" Nonspacechar )+ |
!Ticks3 /`+/ |
!( @Sp Ticks3 ) ( @Spacechar | @Newline !@BlankLine )
)+ > @Sp Ticks3 |
Ticks4 @Sp < (
!Ticks3 ( @Spacechar | @Newline !@BlankLine )
)+ > Ticks3 |
Ticks4 < (
( !"`" Nonspacechar )+ |
!Ticks4 /`+/ |
!( @Sp Ticks4 ) ( @Spacechar | @Newline !@BlankLine )
)+ > @Sp Ticks4 |
Ticks5 @Sp < (
!Ticks4 ( @Spacechar | @Newline !@BlankLine )
)+ > Ticks4 |
Ticks5 < (
( !"`" Nonspacechar )+ |
!Ticks5 /`+/ |
!( @Sp Ticks5 ) ( @Spacechar | @Newline !@BlankLine )
)+ > @Sp Ticks5
!Ticks5 ( @Spacechar | @Newline !@BlankLine )
)+ > Ticks5
)
{ code text }

Expand Down
54 changes: 51 additions & 3 deletions test/rdoc/rdoc_markdown_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,26 +139,74 @@ def test_parse_code
expected = doc(para("Code: <code>text</code>"))
assert_equal expected, doc

doc = parse "Code: ` text`"
expected = doc(para("Code: <code> text</code>"))
assert_equal expected, doc

doc = parse "Code: `text `"
expected = doc(para("Code: <code>text </code>"))
assert_equal expected, doc

doc = parse "Code: ` text `"
expected = doc(para("Code: <code>text</code>"))
assert_equal expected, doc

doc = parse "Code: ` text\t`"
expected = doc(para("Code: <code> text\t</code>"))
assert_equal expected, doc

doc = parse "Code: `\ttext `"
expected = doc(para("Code: <code>\ttext </code>"))
assert_equal expected, doc

doc = parse "Code: ``text`s``"
expected = doc(para("Code: <code>text`s</code>"))
assert_equal expected, doc

doc = parse "Code: `` text`s``"
expected = doc(para("Code: <code> text`s</code>"))
assert_equal expected, doc

doc = parse "Code: ``text`s ``"
expected = doc(para("Code: <code>text`s </code>"))
assert_equal expected, doc

doc = parse "Code: `` text`s ``"
expected = doc(para("Code: <code>text`s</code>"))
assert_equal expected, doc

doc = parse "Code: `` text`s\t``"
expected = doc(para("Code: <code> text`s\t</code>"))
assert_equal expected, doc

doc = parse "Code: ``\ttext`s ``"
expected = doc(para("Code: <code>\ttext`s </code>"))
assert_equal expected, doc

doc = parse "Code: ```text`s```"
expected = doc(para("Code: <code>text`s</code>"))
assert_equal expected, doc

doc = parse "Code: ``` text`s```"
expected = doc(para("Code: <code> text`s</code>"))
assert_equal expected, doc

doc = parse "Code: ```text`s ```"
expected = doc(para("Code: <code>text`s </code>"))
assert_equal expected, doc

doc = parse "Code: ``` text`s ```"
expected = doc(para("Code: <code>text`s</code>"))
assert_equal expected, doc

doc = parse "Code: ``` text`s\t```"
expected = doc(para("Code: <code> text`s\t</code>"))
assert_equal expected, doc

doc = parse "Code: ```\ttext`s ```"
expected = doc(para("Code: <code>\ttext`s </code>"))
assert_equal expected, doc

doc = parse "Code: `\\`"
expected = doc(para("Code: <code>\\\\</code>"))
assert_equal expected, doc
Expand Down Expand Up @@ -223,7 +271,7 @@ def test_parse_code_github_format
doc = <<-MD
Example:

``` ruby
```ruby
code goes here
```
MD
Expand Down Expand Up @@ -1201,14 +1249,14 @@ def test_gfm_table_with_backslashes_in_code_spans

body = [
['Plain', '<code>$\\\\</code>', 'Should show backslash'],
['Escaped', '<code>$\\\\</code>', 'Should show backslash'],
['Escaped', '<code>$\\\\ </code>', 'Should show backslash'],
['Multiple', '<code>\\\\n\\\\t</code>', 'Should show backslashes'],
]

expected_table = @RM::Table.new(head, align, body)

expected = doc(
para('Plain text: <code>$\\\\</code> and <code>$\\\\</code> should work.'),
para('Plain text: <code>$\\\\</code> and <code>$\\\\ </code> should work.'),
expected_table
)

Expand Down
Loading