New version broke XML::Document.io

[fade2black]

libxml-ruby-5.0.0 broke XML::Document.io method.
I invoke it using XML::Document.io(ioobj) and it fails with

ruby/3.1.2/lib/ruby/gems/3.1.0/gems/libxml-ruby-5.0.0/lib/libxml/parser.rb:60:in `io': wrong number of arguments (given 2, expected 1) (ArgumentError)
        from /Users/bayramkuliyev/.asdf/installs/ruby/3.1.2/lib/ruby/gems/3.1.0/gems/libxml-ruby-5.0.0/lib/libxml/document.rb:55:in `io'
        from main.rb:82:in `extract'
        from main.rb:108:in `handler'
        from main.rb:113:in `<main>'

It is probably because def self.io(io, options = {}) changed to def self.io(io, base_uri: nil, encoding: nil, options: nil) in parser.rb.
Maybe you should use Parser.io(value, **options).parse instead of Parser.io(value, options).parse in document.rb:55 or ? Or do I miss something?

[cfis]

Yes, that is correct, and a breaking change (thus the 5.0.0 version). Passing options was switched to use keyword parameters instead of the old style of passing hashes (see the release notes). You'll have to update your code. Sorry for the breakage, but this seemed like the right time to do the API change to go along with the deprecation of global settings in limbxml2 2.12.

[fade2black]

Sorry, I couldn't find a place in the documentation where it says that we need to pass keyword params. Here? (link from the github page).

Well, this is how the the method io is defined:

module LibXML
  module XML
    class Document
     #...
     def self.io(value, options = {})
         Parser.io(value, options).parse
     end
     #...
  end
end

which invokes this method here

module LibXML
  module XML
    class Parser
      #...
      def self.io(io, base_uri: nil, encoding: nil, options: nil)
        context = XML::Parser::Context.io(io)
        context.base_uri = base_uri if base_uri
        context.encoding = encoding if encoding
        context.options = options if options
        self.new(context)
      end
      #...
  end
end

So, self.io methods requires an IO object and an optional options.

Moreover, I call simply by

XML::Document.io(StringIO.new("<xml>Hello, world!</xml>"))

[vseguin]

Seems like I opened a duplicate but similar query here -> #211

It looks like the library has a bug from what I understand.

[fade2black]

@vseguin But @cfis thinks differently, "breaking changes" and closed right away.

[cfis]

The note is in the changelog. See https://github.com/xml4r/libxml-ruby/blob/master/HISTORY

FYI #211 is a definitely a bug and fixed.

[vseguin]

@fade2black it does seem that @cfis fixed it now, just waiting for a new update to be released 🙌 Thanks for being super-reactive here.

[fade2black]

@cfis You wrote to me

Yes, that is correct, and a breaking change (thus the 5.0.0 version). Passing options was switched to use keyword parameters instead of the old style of passing hashes (see the release notes). You'll have to update your code. Sorry for the breakage, but this seemed like the right time to do the API change to go along with the deprecation of global settings in limbxml2 2.12.

What does that mean? I guess it is YOU should fix your buggy code (if it is a bug) or add corresponding docs, not me to update my APIs.

[fade2black]

@cfis FYI Unlike you I do know very well semver and CO and can tell apart bug from a breaking changes.
You first screw up, next blame me that I need to "update my APIs" instead of having close look at your bug, and then make a sneak fix? This is childish, irrespecutful, and unprofessional of you. I wonder how a "developer" like you maintains this gem. That explains why it lacks a proper documentation and does not have proper tests that catch such simple bugs.