Support Ruby 3 #38

skalee · 2021-01-07T09:02:28Z

This pull request adds Ruby 3.0 compatibility, or at least makes tests passing locally. It's likely that other Relaton gems require changes too. I was experimenting with Ruby 3.0 compatibility on this gem only.

The only significant change is that double splat operator (**) is used when passing a hash to a method which expects keyword arguments rather than actual hash. This is required because Ruby 3.0 no longer decomposes such hashes implicitly (see https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/).

I am not sure if these are the only required changes, but they are enough to make tests passing.

Neither I'm sure if all these methods really should accept keyword arguments. Perhaps it'd be better to accept hash as a single positional argument. I wasn't analyzing that.

Apart from codebase itself, some dependencies also aren't compatible with Ruby 3.0 yet:

~~bibtex-ruby (waiting for Support Ruby 3.0 inukshuk/bibtex-ruby#146)~~
debase
ruby-debug-ide

Ruby 3 separates positional and keyword arguments. Hence, double splat must be used to turn hashes into positional arguments. See: https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/

ronaldtse · 2021-01-07T12:20:22Z

relaton-bib.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
  spec.add_dependency "bibtex-ruby"
  spec.add_dependency "iso639"
  spec.add_dependency "nokogiri"
+  spec.add_dependency "rexml"


That's very strange -- we don't use REXML...?

We do. Or more precisely, BibTeX-Ruby uses it (see inukshuk/bibtex-ruby#146).

Ruby Standard Library is in the process of moving into gems. REXML has been degraded to a bundled gem in Ruby 3.0, therefore has to be specified as dependency somewhere (see https://stdgems.org/rexml/). BibTeX-Ruby maintainer has decided to make it an optional dependency, so we got to specify it ourselves.

We don't write out to BibTeXML though, so that functionality is not needed here.

Indeed. Initially it wasn't working without REXML, but it has been fixed in inukshuk/bibtex-ruby@4308f93. I'll remove this commit from the pull request.

Older versions do not work with Ruby 3.0.

ronaldtse · 2021-04-19T06:10:02Z

@andrew2net @skalee this is also blocking metanorma-standoc:
https://github.com/metanorma/metanorma-standoc/pull/459/checks?check_run_id=2377920739

ronaldtse · 2021-04-19T06:10:17Z

And we need a rebase please, thanks!

w00lf · 2021-04-19T06:12:16Z

Hi there, @skalee we have an issue with relaton: https://github.com/metanorma/metanorma-standoc/pull/459/checks?check_run_id=2377920739

Failure/Error: bibitemxml = RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next

     ArgumentError:
       wrong number of arguments (given 1, expected 0)
     # ./vendor/bundle/ruby/3.0.0/gems/relaton-bib-1.7.4/lib/relaton_bib/bibliographic_item.rb:192:in `initialize'

andrew2net · 2021-04-19T11:53:31Z

@ronaldtse relaton fully supports Ruby 3.0 now. We don't need this PR anymore.

ronaldtse · 2021-04-19T11:59:55Z

Thanks @andrew2net @skalee , closing.

andrew2net · 2021-04-19T12:01:30Z

Hi there, @skalee we have an issue with relaton: https://github.com/metanorma/metanorma-standoc/pull/459/checks?check_run_id=2377920739

@w00lf the issue is in the ./lib/asciidoctor/standoc/cleanup_ref_dl.rb:11 line:

bibitemxml = RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next

To work in Ruby 3.0 it should call RelatonBib::HashConverter::hash_to_bib(**bib)

skalee · 2021-04-19T23:28:35Z

I confirm that relaton-bib works in Ruby 3 now. Thanks!

w00lf · 2021-04-20T08:31:34Z

Hi there, @skalee we have an issue with relaton: https://github.com/metanorma/metanorma-standoc/pull/459/checks?check_run_id=2377920739

@w00lf the issue is in the ./lib/asciidoctor/standoc/cleanup_ref_dl.rb:11 line:
bibitemxml = RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next
To work in Ruby 3.0 it should call RelatonBib::HashConverter::hash_to_bib(**bib)

Tried to apply your hotfix but encountered a situation when specs fail on ruby version less than 2.7 with error:

 TypeError:
       hash key "id" is not a Symbol

It seems that ruby version less than 2.7 does not support string keys, if i try to use RelatonBib::HashConverter::hash_to_bib(**bib.symbolize_keys) i got an error in ruby 3.0: wrong number of arguments (given 1, expected 0)

andrew2net · 2021-04-20T09:33:58Z

@w00lf sorry, it's my mistake. Try to replace the line

bibitemxml = RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next

with this

bibitemxml = RelatonBib::BibliographicItem.from_hash(bib).to_xml

w00lf · 2021-04-20T11:47:57Z

@w00lf sorry, it's my mistake. Try to replace the line

bibitemxml = RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next

with this

bibitemxml = RelatonBib::BibliographicItem.from_hash(bib).to_xml

That works, all tests are passing. Thanks!

skalee added 2 commits January 7, 2021 06:21

Use double splat (**) when calling methods

286b164

Ruby 3 separates positional and keyword arguments. Hence, double splat must be used to turn hashes into positional arguments. See: https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/

Test against Ruby 2.7 and 3.0 as well

9979685

skalee force-pushed the ruby-3 branch from 8620cc0 to 9979685 Compare January 7, 2021 09:05

skalee mentioned this pull request Jan 7, 2021

Migrate to Ruby 3.0 glossarist/iev-data#79

Closed

ronaldtse reviewed Jan 7, 2021

View reviewed changes

Update BibTeX-Ruby to 6.x

52b6ad9

Older versions do not work with Ruby 3.0.

skalee force-pushed the ruby-3 branch from cfc6764 to 52b6ad9 Compare January 8, 2021 08:10

ronaldtse closed this Apr 19, 2021

skalee deleted the ruby-3 branch April 20, 2021 00:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Ruby 3 #38

Support Ruby 3 #38

skalee commented Jan 7, 2021 •

edited

Loading

ronaldtse Jan 7, 2021

skalee Jan 7, 2021 •

edited

Loading

ronaldtse Jan 7, 2021

skalee Jan 8, 2021 •

edited

Loading

ronaldtse commented Apr 19, 2021

ronaldtse commented Apr 19, 2021

w00lf commented Apr 19, 2021 •

edited

Loading

andrew2net commented Apr 19, 2021

ronaldtse commented Apr 19, 2021

andrew2net commented Apr 19, 2021

skalee commented Apr 19, 2021

w00lf commented Apr 20, 2021

andrew2net commented Apr 20, 2021

w00lf commented Apr 20, 2021

Support Ruby 3 #38

Support Ruby 3 #38

Conversation

skalee commented Jan 7, 2021 • edited Loading

ronaldtse Jan 7, 2021

Choose a reason for hiding this comment

skalee Jan 7, 2021 • edited Loading

Choose a reason for hiding this comment

ronaldtse Jan 7, 2021

Choose a reason for hiding this comment

skalee Jan 8, 2021 • edited Loading

Choose a reason for hiding this comment

ronaldtse commented Apr 19, 2021

ronaldtse commented Apr 19, 2021

w00lf commented Apr 19, 2021 • edited Loading

andrew2net commented Apr 19, 2021

ronaldtse commented Apr 19, 2021

andrew2net commented Apr 19, 2021

skalee commented Apr 19, 2021

w00lf commented Apr 20, 2021

andrew2net commented Apr 20, 2021

w00lf commented Apr 20, 2021

skalee commented Jan 7, 2021 •

edited

Loading

skalee Jan 7, 2021 •

edited

Loading

skalee Jan 8, 2021 •

edited

Loading

w00lf commented Apr 19, 2021 •

edited

Loading