Fix loading of config file with recent Rubies (Psych 4.0) #779
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
added 2 commits
February 17, 2023 19:15
Using Ruby 3.2, the following command would fail like this without the fix:
> bin\kramdown --config-file .kramdown.yml -i GFM -o html README.md
.../ruby-3.2-lean/lib/ruby/3.2.0/psych.rb:322:in `safe_load': wrong number of arguments (given 2, expected 1) (ArgumentError)
from .../vendor/ruby/3.2.0/gems/kramdown-2.4.0/bin/kramdown:114:in `<top (required)>'
from .../bin/kramdown.cmd:30:in `load'
from .../bin/kramdown.cmd:30:in `<main>'
The whole story is that Psych 4.0 removed the support for the legacy API with positional arguments, but the permitted_classes keyword argument was already supported since Psych 3.1.0.
|
I created #781 before I saw this. Ruby 2.4-2.6 are EOL, so perhaps we can just avoid the |
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.
Hello,
I've been using the
bin/kramdownutility recently with Ruby 3.2, and I hit an error when I use the--config-fileoption.Using Ruby 3.2, the following command would fail like this without the fix:
The kramdown script still uses the legacy
YAML.safe_loadAPI, which has been removed in Psych version 4.0 (cf. ruby/psych@07672270 and ruby/psych#533). Here's a fix that works for me, tested with Ruby v2.4, v2.7, v3.0, and v3.2.As for the fix, using the keyword argument directly instead of checking whether it is supported is also an option if you think there's no need to support Psych versions older than v3.1.0 (ruby/psych@682abf20). The comment in the commit should indeed have been
# compatibility with Psych < 3.1.0.