fix: C variables should never show up in Ancestors tree #1217
Conversation
This file contains 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
st0012
reviewed
Nov 29, 2024
| @s.resolve_c_references | ||
|
|
||
| # now the ancestor tree correctly references the NormalClass objects | ||
| assert_equal(parent, @s.classes_hash['Child'].superclass) |
There was a problem hiding this comment.
(#superclass can return either string or RDoc::NormalClass really hurts my brain 🙈)
There was a problem hiding this comment.
And of course the bug in #1221 is related to this confusion. 🤦
If a NormalClass's superclass is a C enclosure, then update the superclass to point to the RDoc::NormalClass. This is done in a single pass after all files have been parsed. Fixes ruby#1205.
flavorjones
force-pushed
the
flavorjones-fix-up-c-variables-in-ancestor-tree
branch
from
ae631cb to
8013d3d
Compare
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Nov 30, 2024
(ruby/rdoc#1217) If a NormalClass's superclass is a C enclosure, then update the superclass to point to the RDoc::NormalClass. This is done in a single pass after all files have been parsed. Fixes ruby/rdoc#1205. ruby/rdoc@1ecd9581b1
flavorjones
deleted the
flavorjones-fix-up-c-variables-in-ancestor-tree
branch
flavorjones
added a commit
to flavorjones/rdoc
that referenced
this pull request
Dec 2, 2024
It is necessary for ClassModule's instance variable @superclass to always be a String (or nil) so that the class can be saved with `#marshal_dump` and loaded with `#marshal_load`. However, there's no type checking being done, which allows a bug like the one reported in ruby#1221 (which was introduced in ruby#1217) that sets superclass to a ClassModule. That bug requires: - setting a superclass to a NormalClass - marshal_save - marshal_load (which raises an exception) With this change, passing a ClassModule to ClassModule#superclass= is explicitly allowed by saving the full name of the ClassModule in the @superclass instance variable.
st0012
pushed a commit
that referenced
this pull request
Dec 2, 2024
It is necessary for ClassModule's instance variable @superclass to always be a String (or nil) so that the class can be saved with `#marshal_dump` and loaded with `#marshal_load`. However, there's no type checking being done, which allows a bug like the one reported in #1221 (which was introduced in #1217) that sets superclass to a ClassModule. That bug requires: - setting a superclass to a NormalClass - marshal_save - marshal_load (which raises an exception) With this change, passing a ClassModule to ClassModule#superclass= is explicitly allowed by saving the full name of the ClassModule in the @superclass instance variable.
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.
If a
NormalClass's superclass is a C variable ("enclosure"), then update the superclass to point to the RDoc::NormalClass.This is done in a single pass after all files have been parsed.
Fixes #1205.
Before:
After: