Delegate ActionText::Content#deconstruct to Nokogiri
#50473
Merged
+44
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since `ActionText::Content` wraps an `ActionText::Fragment`, and
`ActionText::Fragment` wraps a `Nokogiri::XML::DocumentFragment`, then
`ActionText::Content` should be able to rely on the newer Ruby pattern
matching introduced by [nokogiri@1.16.0][] (mainly the
[DocumentFragment#deconstruct][] method):
```ruby
content = ActionText::Content.new <<~HTML
<h1>Hello, world</h1>
<div>The body</div>
HTML
content => [h1, div]
assert_pattern { h1 => { content: "Hello, world" } }
assert_pattern { div => { content: "The body" } }
```
The implementation change relies on delegating from `Content` to
`Fragment`, and from `Fragment` to `DocumentFragment#elements` (to
deliberately exclude text nodes).
[nokogiri@1.16.0]: https://nokogiri.org/CHANGELOG.html?h=pattern
[DocumentFragment#deconstruct]: https://nokogiri.org/rdoc/Nokogiri/XML/DocumentFragment.html?h=deconstruct#method-i-deconstruct
seanpdoyle
commented
Dec 28, 2023
| @@ -21,6 +21,8 @@ def from_html(html) | |||
|
|
|||
| attr_reader :source | |||
|
|
|||
| delegate :deconstruct, to: "source.elements" | |||
There was a problem hiding this comment.
As an alternative to making design decisions around the #deconstruct method, this change could instead forward all unknown methods from Content straight to DocumentFragment, through a chain of delegate_missing_to definitions.
That would mean that callers could be able to invoke content.elements directly. That would drastically broaden the public API of the class, but would remove the burden of making pattern matching interface considerations.
zzak
reviewed
Dec 31, 2023
| @@ -210,3 +210,7 @@ def with_attachment_tag_name(tag_name) | |||
| ActionText::Attachment.tag_name = previous_tag_name | |||
| end | |||
| end | |||
|
|
|||
| if RUBY_VERSION >= "3.1" | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation / Background
Since
ActionText::Contentwraps anActionText::Fragment, andActionText::Fragmentwraps aNokogiri::XML::DocumentFragment, thenActionText::Contentshould be able to rely on the newer Ruby pattern matching introduced by nokogiri@1.16.0 (mainly the DocumentFragment#deconstruct method):Detail
The implementation change relies on delegating from
ContenttoFragment, and fromFragmenttoDocumentFragment#elements(to deliberately exclude text nodes).Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]