libxml-ruby 4.1.1 → 5.0.0

data/lib/libxml/document.rb

@@ -17,21 +17,21 @@ module LibXML
 
       # call-seq:
       #    XML::Document.file(path) -> XML::Document
-      #    XML::Document.file(path, :encoding => XML::Encoding::UTF_8,
-      #                             :options => XML::Parser::Options::NOENT) -> XML::Document
+      #    XML::Document.file(path, encoding: XML::Encoding::UTF_8,
+      #                             options: XML::Parser::Options::NOENT) -> XML::Document
       #
       # Creates a new document from the specified file or uri.
       #
-      # You may provide an optional hash table to control how the
-      # parsing is performed.  Valid options are:
+      # Parameters:
       #
+      #  path - Path to file
       #  encoding - The document encoding, defaults to nil. Valid values
       #             are the encoding constants defined on XML::Encoding.
       #  options - Parser options.  Valid values are the constants defined on
       #            XML::Parser::Options.  Mutliple options can be combined
       #            by using Bitwise OR (|).
-      def self.file(value, options = {})
-        Parser.file(value, options).parse
+      def self.file(path, encoding: nil, options: nil)
+        Parser.file(path, encoding: encoding, options: options).parse
       end
 
       # call-seq:
@@ -57,23 +57,23 @@ module LibXML
 
       # call-seq:
       #    XML::Document.string(string) -> XML::Document
-      #    XML::Document.string(string, :encoding => XML::Encoding::UTF_8,
-      #                               :options => XML::Parser::Options::NOENT
-      #                               :base_uri="http://libxml.org") -> XML::Document
+      #    XML::Document.string(string, encoding: XML::Encoding::UTF_8,
+      #                                 options: XML::Parser::Options::NOENT
+      #                                 base_uri: "http://libxml.org") -> XML::Document
       #
       # Creates a new document from the specified string.
       #
-      # You may provide an optional hash table to control how the
-      # parsing is performed.  Valid options are:
+      # Parameters:
       #
+      #   string - String to parse
       #   base_uri - The base url for the parsed document.
       #   encoding - The document encoding, defaults to nil. Valid values
       #              are the encoding constants defined on XML::Encoding.
       #   options  - Parser options.  Valid values are the constants defined on
       #              XML::Parser::Options.  Mutliple options can be combined
       #              by using Bitwise OR (|).
-      def self.string(value, options = {})
-        Parser.string(value, options).parse
+      def self.string(value, base_uri: nil, encoding: nil, options: nil)
+        Parser.string(value, base_uri: base_uri, encoding: encoding, options: options).parse
       end
 
       # Returns a new XML::XPathContext for the document.

data/lib/libxml/html_parser.rb

@@ -5,31 +5,31 @@ module LibXML
     class HTMLParser
       # call-seq:
       #    XML::HTMLParser.file(path) -> XML::HTMLParser
-      #    XML::HTMLParser.file(path, :encoding => XML::Encoding::UTF_8,
-      #                           :options => XML::HTMLParser::Options::NOENT) -> XML::HTMLParser
+      #    XML::HTMLParser.file(path, encoding: XML::Encoding::UTF_8,
+      #                               options: XML::HTMLParser::Options::NOENT) -> XML::HTMLParser
       #
       # Creates a new parser by parsing the specified file or uri.
       #
-      # You may provide an optional hash table to control how the
-      # parsing is performed.  Valid options are:
+      # Parameters:
       #
+      #  path - Path to file to parse
       #  encoding - The document encoding, defaults to nil. Valid values
       #             are the encoding constants defined on XML::Encoding.
       #  options - Parser options.  Valid values are the constants defined on
       #            XML::HTMLParser::Options.  Mutliple options can be combined
       #            by using Bitwise OR (|).
-      def self.file(path, options = {})
+      def self.file(path, encoding: nil, options: nil)
         context = XML::HTMLParser::Context.file(path)
-        context.encoding = options[:encoding] if options[:encoding]
-        context.options = options[:options] if options[:options]
+        context.encoding = encoding if encoding
+        context.options = options if options
         self.new(context)
       end
 
       # call-seq:
       #    XML::HTMLParser.io(io) -> XML::HTMLParser
-      #    XML::HTMLParser.io(io, :encoding => XML::Encoding::UTF_8,
-      #                       :options => XML::HTMLParser::Options::NOENT
-      #                       :base_uri="http://libxml.org") -> XML::HTMLParser
+      #    XML::HTMLParser.io(io, encoding: XML::Encoding::UTF_8,
+      #                           options: XML::HTMLParser::Options::NOENT
+      #                           base_uri: "http://libxml.org") -> XML::HTMLParser
       #
       # Creates a new reader by parsing the specified io object.
       #
@@ -42,36 +42,36 @@ module LibXML
       #  options - Parser options.  Valid values are the constants defined on
       #            XML::HTMLParser::Options.  Mutliple options can be combined
       #            by using Bitwise OR (|).
-      def self.io(io, options = {})
+      def self.io(io, base_uri: nil, encoding: nil, options: nil)
         context = XML::HTMLParser::Context.io(io)
-        context.base_uri = options[:base_uri] if options[:base_uri]
-        context.encoding = options[:encoding] if options[:encoding]
-        context.options = options[:options] if options[:options]
+        context.base_uri = base_uri if base_uri
+        context.encoding = encoding if encoding
+        context.options = options if options
         self.new(context)
       end
 
       # call-seq:
       #    XML::HTMLParser.string(string)
-      #    XML::HTMLParser.string(string, :encoding => XML::Encoding::UTF_8,
-      #                               :options => XML::HTMLParser::Options::NOENT
-      #                               :base_uri="http://libxml.org") -> XML::HTMLParser
+      #    XML::HTMLParser.string(string, encoding: XML::Encoding::UTF_8,
+      #                                   options: XML::HTMLParser::Options::NOENT
+      #                                   base_uri: "http://libxml.org") -> XML::HTMLParser
       #
       # Creates a new parser by parsing the specified string.
       #
-      # You may provide an optional hash table to control how the
-      # parsing is performed.  Valid options are:
+      # Parameters:
       #
+      #  string - String to parse
       #  base_uri - The base url for the parsed document.
       #  encoding - The document encoding, defaults to nil. Valid values
       #             are the encoding constants defined on XML::Encoding.
       #  options - Parser options.  Valid values are the constants defined on
       #            XML::HTMLParser::Options.  Mutliple options can be combined
       #            by using Bitwise OR (|).
-      def self.string(string, options = {})
+      def self.string(string, base_uri: nil, encoding: nil, options: nil)
         context = XML::HTMLParser::Context.string(string)
-        context.base_uri = options[:base_uri] if options[:base_uri]
-        context.encoding = options[:encoding] if options[:encoding]
-        context.options = options[:options] if options[:options]
+        context.base_uri = base_uri if base_uri
+        context.encoding = encoding if encoding
+        context.options = options if options
         self.new(context)
       end
 

data/lib/libxml/parser.rb

@@ -18,31 +18,33 @@ module LibXML
 
       # call-seq:
       #    XML::Parser.file(path) -> XML::Parser
-      #    XML::Parser.file(path, :encoding => XML::Encoding::UTF_8,
-      #                           :options => XML::Parser::Options::NOENT) -> XML::Parser
+      #    XML::Parser.file(path, encoding: XML::Encoding::UTF_8,
+      #                           options: XML::Parser::Options::NOENT) -> XML::Parser
       #
       # Creates a new parser for the specified file or uri.
       #
-      # You may provide an optional hash table to control how the
-      # parsing is performed.  Valid options are:
+      # Parameters:
       #
+      #  path - Path to file
+      #  base_uri - The base url for the parsed document.
       #  encoding - The document encoding, defaults to nil. Valid values
       #             are the encoding constants defined on XML::Encoding.
       #  options - Parser options.  Valid values are the constants defined on
       #            XML::Parser::Options.  Mutliple options can be combined
       #            by using Bitwise OR (|).
-      def self.file(path, options = {})
+      def self.file(path, base_uri: nil, encoding: nil, options: nil)
         context = XML::Parser::Context.file(path)
-        context.encoding = options[:encoding] if options[:encoding]
-        context.options = options[:options] if options[:options]
+        context.base_uri = base_uri if base_uri
+        context.encoding = encoding if encoding
+        context.options = options if options
         self.new(context)
       end
 
       # call-seq:
       #    XML::Parser.io(io) -> XML::Parser
-      #    XML::Parser.io(io, :encoding => XML::Encoding::UTF_8,
-      #                       :options => XML::Parser::Options::NOENT
-      #                       :base_uri="http://libxml.org") -> XML::Parser
+      #    XML::Parser.io(io, encoding: XML::Encoding::UTF_8,
+      #                       options: XML::Parser::Options::NOENT
+      #                       base_uri: "http://libxml.org") -> XML::Parser
       #
       # Creates a new parser for the specified io object.
       #
@@ -55,36 +57,36 @@ module LibXML
       #  options - Parser options.  Valid values are the constants defined on
       #            XML::Parser::Options.  Mutliple options can be combined
       #            by using Bitwise OR (|).
-      def self.io(io, options = {})
+      def self.io(io, base_uri: nil, encoding: nil, options: nil)
         context = XML::Parser::Context.io(io)
-        context.base_uri = options[:base_uri] if options[:base_uri]
-        context.encoding = options[:encoding] if options[:encoding]
-        context.options = options[:options] if options[:options]
+        context.base_uri = base_uri if base_uri
+        context.encoding = encoding if encoding
+        context.options = options if options
         self.new(context)
       end
 
       # call-seq:
       #    XML::Parser.string(string)
-      #    XML::Parser.string(string, :encoding => XML::Encoding::UTF_8,
-      #                               :options => XML::Parser::Options::NOENT
-      #                               :base_uri="http://libxml.org") -> XML::Parser
+      #    XML::Parser.string(string, encoding: XML::Encoding::UTF_8,
+      #                               options: XML::Parser::Options::NOENT
+      #                               base_uri: "http://libxml.org") -> XML::Parser
       #
       # Creates a new parser by parsing the specified string.
       #
-      # You may provide an optional hash table to control how the
-      # parsing is performed.  Valid options are:
+      # Parameters:
       #
+      #  string - The string to parse
       #  base_uri - The base url for the parsed document.
       #  encoding - The document encoding, defaults to nil. Valid values
       #             are the encoding constants defined on XML::Encoding.
       #  options - Parser options.  Valid values are the constants defined on
-      #            XML::Parser::Options.  Mutliple options can be combined
+      #            XML::Parser::Options.  Multiple options can be combined
       #            by using Bitwise OR (|).
-      def self.string(string, options = {})
+      def self.string(string, base_uri: nil, encoding: nil, options: nil)
         context = XML::Parser::Context.string(string)
-        context.base_uri = options[:base_uri] if options[:base_uri]
-        context.encoding = options[:encoding] if options[:encoding]
-        context.options = options[:options] if options[:options]
+        context.base_uri = base_uri if base_uri
+        context.encoding = encoding if encoding
+        context.options = options if options
         self.new(context)
       end
 

data/lib/libxml/schema/element.rb

@@ -1,19 +1,27 @@
-# encoding: UTF-8
-
-module LibXML
-  module XML
-    class Schema::Element
-      def required?
-        !min_occurs.zero?
-      end
-
-      def array?
-        max_occurs > 1
-      end
-
-      def elements
-        type.elements
-      end
-    end
-  end
-end
+# encoding: UTF-8
+
+module LibXML
+  module XML
+    class Schema::Element
+      def min_occurs
+        @min
+      end
+
+      def max_occurs
+        @max
+      end
+
+      def required?
+        !min_occurs.zero?
+      end
+
+      def array?
+        max_occurs > 1
+      end
+
+      def elements
+        type.elements
+      end
+    end
+  end
+end

data/test/test.rb

@@ -0,0 +1,5 @@
+begin
+  File.open("/does/not/exist")
+rescue => e
+  puts e
+end

data/test/test_document_write.rb

@@ -7,14 +7,11 @@ class TestDocumentWrite < Minitest::Test
   def setup
     @file_name = "model/bands.utf-8.xml"
 
-    # Strip spaces to make testing easier
-    LibXML::XML.default_keep_blanks = false
     file = File.join(File.dirname(__FILE__), @file_name)
-    @doc = LibXML::XML::Document.file(file)
+    @doc = LibXML::XML::Document.file(file, options: LibXML::XML::Parser::Options::NOBLANKS)
   end
 
   def teardown
-    LibXML::XML.default_keep_blanks = true
     @doc = nil
   end
 

data/test/test_dtd.rb

@@ -106,13 +106,11 @@ class TestDtd < Minitest::Test
       errors << error
     end
 
-    LibXML::XML.default_load_external_dtd = false
     LibXML::XML::Parser.string(xml).parse
     assert_equal(0, errors.length)
 
     errors.clear
-    LibXML::XML.default_load_external_dtd = true
-    LibXML::XML::Parser.string(xml).parse
+    LibXML::XML::Parser.string(xml, options: LibXML::XML::Parser::Options::DTDLOAD).parse
     assert_equal(1, errors.length)
     assert_equal("Warning: failed to load external entity \"test.dtd\" at :1.",
                  errors[0].to_s)
@@ -123,7 +121,6 @@ class TestDtd < Minitest::Test
     assert_equal("Warning: failed to load external entity \"test.dtd\" at :1.",
                  errors[0].to_s)
   ensure
-    LibXML::XML.default_load_external_dtd = false
     LibXML::XML::Error.reset_handler
   end
 end

data/test/test_encoding.rb

@@ -38,10 +38,7 @@ class TestEncoding < Minitest::Test
     @encoding = encoding
     file = file_for_encoding(encoding)
 
-    # Strip spaces to make testing easier
-    LibXML::XML.default_keep_blanks = false
-    @doc = LibXML::XML::Document.file(file)
-    LibXML::XML.default_keep_blanks = true
+    @doc = LibXML::XML::Document.file(file, options: LibXML::XML::Parser::Options::NOBLANKS)
   end
 
   def test_encoding

data/test/test_helper.rb

@@ -1,9 +1,13 @@
 # encoding: UTF-8
 
 # To make testing/debugging easier, test within this source tree versus an installed gem
-
 require 'bundler/setup'
-require 'minitest/autorun'
+
+# Add ext directory to load path to make it easier to test locally built extensions
+ext_path = File.expand_path(File.join(__dir__, '..', 'ext', 'libxml'))
+$LOAD_PATH.unshift(File.expand_path(ext_path))
+
+# Now load code
 require 'libxml-ruby'
 
 def windows?
@@ -11,3 +15,6 @@ def windows?
 end
 
 STDOUT.write "\nlibxml2: #{LibXML::XML::LIBXML_VERSION}\n#{RUBY_DESCRIPTION}\n\n"
+
+require 'minitest/autorun'
+