search

gettalong / kramdown

kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and supporting several common extensions.
http://kramdown.gettalong.org
Other
1.72k stars 271 forks source link

Fix loading of config file with recent Rubies (Psych 4.0) #779

Closed cboos closed 1 year ago

cboos commented 1 year ago

Hello,

I've been using the bin/kramdown utility recently with Ruby 3.2, and I hit an error when I use the --config-file option.

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 kramdown script still uses the legacy YAML.safe_load API, 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.

stanhu commented 1 year ago

I created #781 before I saw this. Ruby 2.4-2.6 are EOL, so perhaps we can just avoid the if statement?

gettalong commented 1 year ago

@cboos Thanks for the pull request! I have rebased and squashed your changes, see https://github.com/gettalong/kramdown/commit/85c4370043586f248cacf74a10f5a9211d5322dc