Add SDoc::Renderer#inline
#314
Conversation
jonathanhefner
force-pushed
the
renderer-inline
branch
2 times, most recently
from
80a5111 to
a1b88c2
Compare
|
The TruffleRuby tests are currently failing due to (I believe) a bug in TruffleRuby. I'm not sure if there is a workaround. Rails does not officially support TruffleRuby, so I am inclined to say that SDoc should not be bound by TruffleRuby. |
jonathanhefner
force-pushed
the
renderer-inline
branch
from
a1b88c2 to
eed2539
Compare
|
To work with TruffleRuby, I have (1) given an explicit name to the block that Requiring an explicitly named block is not ideal. From an API perspective, having the name as a part of the API is less clean than an anonymous @eregon I see that you added TruffleRuby back to the testing matrix in #202. I don't see any discussion about why it was removed in #199, nor why added it was added back in #202. Is it just to act as a "canary" for TruffleRuby (a la https://github.com/orgs/community/discussions/15452)? Also, is this behavior a known issue for TruffleRuby? |
|
Could you file an issue at https://github.com/oracle/truffleruby/issues with that bug/incompatibility in TruffleRuby?
It would very helpful if you can provide a small reproducer. Re TruffleRuby in CI, I added it back because it was removed due to failing, and we fixed the issue so it's passing again. |
There is currently a bug in TruffleRuby ([truffleruby#3285][]) wherein `Kernel#binding` does not capture a given anonymous block, which breaks `yield` calls evaluated using that binding. This bug is preventing us from extending our rendering API. Furthermore, this bug was caught by a test unit for said API extension, but our views themselves aren't tested by CI. So if such a `yield` call were added to a view, CI would still pass but the `sdoc` command would be broken when using TruffleRuby. Also, Rails itself does not officially support TruffleRuby. Considering all of the above, this commit removes TruffleRuby from CI. [truffleruby#3285]: oracle/truffleruby#3285
`SDoc::Renderer#inline` renders a template to the current output buffer
instead of as a separate string. It also allows a block to be specified
so that the template can `yield` to perform interleaved rendering. For
example:
```erb
<% inline "_partial.erb" do %>
content
<% end %>
```
```erb
<%# _partial.erb %>
<div><% yield %></div>
```
Renders:
```html
<div>
content
</div>
```
jonathanhefner
force-pushed
the
renderer-inline
branch
from
eed2539 to
3f81fde
Compare
|
I have filed oracle/truffleruby#3285. For now, I will remove TruffleRuby from CI. Perhaps we can add it back after GitHub implements something like https://github.com/orgs/community/discussions/15452. |
SDoc::Renderer#inlinerenders a template to the current output buffer instead of as a separate string. It also allows a block to be specified so that the template canyieldto perform interleaved rendering. For example:Renders: