shale 0.3.0 → 0.5.0

data/lib/shale/adapter/nokogiri/node.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Shale
+  module Adapter
+    module Nokogiri
+      # Wrapper around Nokogiri::XML::Node API
+      #
+      # @api private
+      class Node
+        # Initialize object with Nokogiri node
+        #
+        # @param [::Nokogiri::XML::Node] node Nokogiri node
+        #
+        # @api private
+        def initialize(node)
+          @node = node
+        end
+
+        # Return namespaces defined on document
+        #
+        # @return [Hash<String, String>]
+        #
+        # @example
+        #   node.namespaces # => { 'foo' => 'http://foo.com', 'bar' => 'http://bar.com' }
+        #
+        # @api private
+        def namespaces
+          @node.namespaces.transform_keys { |e| e.sub('xmlns:', '') }
+        end
+
+        # Return name of the node in the format of
+        # namespace:name when the node is namespaced or just name when it's not
+        #
+        # @return [String]
+        #
+        # @example without namespace
+        #   node.name # => Bar
+        #
+        # @example with namespace
+        #   node.name # => http://foo:Bar
+        #
+        # @api private
+        def name
+          [@node.namespace&.href, @node.name].compact.join(':')
+        end
+
+        # Return all attributes associated with the node
+        #
+        # @return [Hash]
+        #
+        # @api private
+        def attributes
+          @node.attribute_nodes.each_with_object({}) do |node, hash|
+            name = [node.namespace&.href, node.name].compact.join(':')
+            hash[name] = node.value
+          end
+        end
+
+        # Return node's parent
+        #
+        # @return [Shale::Adapter::Nokogiri::Node, nil]
+        #
+        # @api private
+        def parent
+          if @node.respond_to?(:parent) && @node.parent && @node.parent.name != 'document'
+            self.class.new(@node.parent)
+          end
+        end
+
+        # Return node's element children
+        #
+        # @return [Array<Shale::Adapter::Nokogiri::Node>]
+        #
+        # @api private
+        def children
+          @node
+            .children
+            .to_a
+            .filter(&:element?)
+            .map { |e| self.class.new(e) }
+        end
+
+        # Return first text child of a node
+        #
+        # @return [String]
+        #
+        # @api private
+        def text
+          first = @node
+            .children
+            .to_a
+            .filter(&:text?)
+            .first
+
+          first&.text
+        end
+      end
+    end
+  end
+end

data/lib/shale/adapter/nokogiri.rb

@@ -2,6 +2,10 @@
 
 require 'nokogiri'
 
+require_relative '../error'
+require_relative 'nokogiri/document'
+require_relative 'nokogiri/node'
+
 module Shale
   module Adapter
     # Nokogiri adapter
@@ -12,7 +16,9 @@ module Shale
       #
       # @param [String] xml XML document
       #
-      # @return [::Nokogiri::XML::Document]
+      # @raise [ParseError] when XML document has errors
+      #
+      # @return [Shale::Adapter::Nokogiri::Node]
       #
       # @api private
       def self.load(xml)
@@ -20,6 +26,10 @@ module Shale
           config.noblanks
         end
 
+        unless doc.errors.empty?
+          raise ParseError, "Document is invalid: #{doc.errors}"
+        end
+
         Node.new(doc.root)
       end
 
@@ -57,156 +67,6 @@ module Shale
       def self.create_document
         Document.new
       end
-
-      # Wrapper around Nokogiri API
-      #
-      # @api private
-      class Document
-        # Initialize object
-        #
-        # @api private
-        def initialize
-          @doc = ::Nokogiri::XML::Document.new
-          @namespaces = {}
-        end
-
-        # Return Nokogiri document
-        #
-        # @return [::Nokogiri::XML::Document]
-        #
-        # @api private
-        def doc
-          if @doc.root
-            @namespaces.each do |prefix, namespace|
-              @doc.root.add_namespace(prefix, namespace)
-            end
-          end
-
-          @doc
-        end
-
-        # Create Nokogiri element
-        #
-        # @param [String] name Name of the XML element
-        #
-        # @return [::Nokogiri::XML::Element]
-        #
-        # @api private
-        def create_element(name)
-          ::Nokogiri::XML::Element.new(name, @doc)
-        end
-
-        # Add XML namespace to document
-        #
-        # @param [String] prefix
-        # @param [String] namespace
-        #
-        # @api private
-        def add_namespace(prefix, namespace)
-          @namespaces[prefix] = namespace if prefix && namespace
-        end
-
-        # Add attribute to Nokogiri element
-        #
-        # @param [::Nokogiri::XML::Element] element Nokogiri element
-        # @param [String] name Name of the XML attribute
-        # @param [String] value Value of the XML attribute
-        #
-        # @api private
-        def add_attribute(element, name, value)
-          element[name] = value
-        end
-
-        # Add child element to Nokogiri element
-        #
-        # @param [::Nokogiri::XML::Element] element Nokogiri parent element
-        # @param [::Nokogiri::XML::Element] child Nokogiri child element
-        #
-        # @api private
-        def add_element(element, child)
-          element.add_child(child)
-        end
-
-        # Add text node to Nokogiri element
-        #
-        # @param [::Nokogiri::XML::Element] element Nokogiri element
-        # @param [String] text Text to add
-        #
-        # @api private
-        def add_text(element, text)
-          element.content = text
-        end
-      end
-
-      # Wrapper around Nokogiri::XML::Node API
-      #
-      # @api private
-      class Node
-        # Initialize object with Nokogiri node
-        #
-        # @param [::Nokogiri::XML::Node] node Nokogiri node
-        #
-        # @api private
-        def initialize(node)
-          @node = node
-        end
-
-        # Return name of the node in the format of
-        # namespace:name when the node is namespaced or just name when it's not
-        #
-        # @return [String]
-        #
-        # @example without namespace
-        #   node.name # => Bar
-        #
-        # @example with namespace
-        #   node.name # => http://foo:Bar
-        #
-        # @api private
-        def name
-          [@node.namespace&.href, @node.name].compact.join(':')
-        end
-
-        # Return all attributes associated with the node
-        #
-        # @return [Hash]
-        #
-        # @api private
-        def attributes
-          @node.attribute_nodes.each_with_object({}) do |node, hash|
-            name = [node.namespace&.href, node.name].compact.join(':')
-            hash[name] = node.value
-          end
-        end
-
-        # Return node's element children
-        #
-        # @return [Array<Shale::Adapter::Nokogiri::Node>]
-        #
-        # @api private
-        def children
-          @node
-            .children
-            .to_a
-            .filter(&:element?)
-            .map { |e| self.class.new(e) }
-        end
-
-        # Return first text child of a node
-        #
-        # @return [String]
-        #
-        # @api private
-        def text
-          first = @node
-            .children
-            .to_a
-            .filter(&:text?)
-            .first
-
-          first&.text
-        end
-      end
     end
   end
 end

data/lib/shale/adapter/ox/document.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Shale
+  module Adapter
+    module Ox
+      # Wrapper around Ox API
+      #
+      # @api private
+      class Document
+        # Return Ox document
+        #
+        # @return [::Ox::Document]
+        #
+        # @api private
+        attr_reader :doc
+
+        # Initialize object
+        #
+        # @api private
+        def initialize
+          @doc = ::Ox::Document.new
+        end
+
+        # Create Ox element
+        #
+        # @param [String] name Name of the XML element
+        #
+        # @return [::Ox::Element]
+        #
+        # @api private
+        def create_element(name)
+          ::Ox::Element.new(name)
+        end
+
+        # Add XML namespace to document
+        #
+        # Ox doesn't support XML namespaces so this method does nothing.
+        #
+        # @param [String] prefix
+        # @param [String] namespace
+        #
+        # @api private
+        def add_namespace(prefix, namespace)
+          # :noop:
+        end
+
+        # Add attribute to Ox element
+        #
+        # @param [::Ox::Element] element Ox element
+        # @param [String] name Name of the XML attribute
+        # @param [String] value Value of the XML attribute
+        #
+        # @api private
+        def add_attribute(element, name, value)
+          element[name] = value
+        end
+
+        # Add child element to Ox element
+        #
+        # @param [::Ox::Element] element Ox parent element
+        # @param [::Ox::Element] child Ox child element
+        #
+        # @api private
+        def add_element(element, child)
+          element << child
+        end
+
+        # Add text node to Ox element
+        #
+        # @param [::Ox::Element] element Ox element
+        # @param [String] text Text to add
+        #
+        # @api private
+        def add_text(element, text)
+          element << text
+        end
+      end
+    end
+  end
+end

data/lib/shale/adapter/ox/node.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Shale
+  module Adapter
+    module Ox
+      # Wrapper around Ox::Element API
+      #
+      # @api private
+      class Node
+        # Initialize object with Ox element
+        #
+        # @param [::Ox::Element] node Ox element
+        #
+        # @api private
+        def initialize(node)
+          @node = node
+        end
+
+        # Return namespaces defined on document (Not supported by Ox)
+        #
+        # @return [Hash<String, String>]
+        #
+        # @example
+        #   node.namespaces # => {}
+        #
+        # @api private
+        def namespaces
+          {}
+        end
+
+        # Return name of the node in the format of
+        # prefix:name when the node is namespaced or just name when it's not
+        #
+        # @return [String]
+        #
+        # @example without namespace
+        #   node.name # => Bar
+        #
+        # @example with namespace
+        #   node.name # => foo:Bar
+        #
+        # @api private
+        def name
+          @node.name
+        end
+
+        # Return all attributes associated with the node
+        #
+        # @return [Hash]
+        #
+        # @api private
+        def attributes
+          @node.attributes
+        end
+
+        # Return node's parent (Not supported by OX)
+        #
+        # @return [nil]
+        #
+        # @api private
+        def parent
+          # :noop:
+        end
+
+        # Return node's element children
+        #
+        # @return [Array<Shale::Adapter::Ox::Node>]
+        #
+        # @api private
+        def children
+          @node
+            .nodes
+            .filter { |e| e.is_a?(::Ox::Element) }
+            .map { |e| self.class.new(e) }
+        end
+
+        # Return first text child of a node
+        #
+        # @return [String]
+        #
+        # @api private
+        def text
+          @node.text
+        end
+      end
+    end
+  end
+end

data/lib/shale/adapter/ox.rb

@@ -2,6 +2,10 @@
 
 require 'ox'
 
+require_relative '../error'
+require_relative 'ox/document'
+require_relative 'ox/node'
+
 module Shale
   module Adapter
     # Ox adapter
@@ -12,11 +16,15 @@ module Shale
       #
       # @param [String] xml XML document
       #
-      # @return [::Ox::Document, ::Ox::Element]
+      # @raise [ParseError] when XML document has errors
+      #
+      # @return [Shale::Adapter::Ox::Node]
       #
       # @api private
       def self.load(xml)
         Node.new(::Ox.parse(xml))
+      rescue ::Ox::ParseError => e
+        raise ParseError, "Document is invalid: #{e.message}"
       end
 
       # Serialize Ox document into XML
@@ -48,139 +56,6 @@ module Shale
       def self.create_document
         Document.new
       end
-
-      # Wrapper around Ox API
-      #
-      # @api private
-      class Document
-        # Return Ox document
-        #
-        # @return [::Ox::Document]
-        #
-        # @api private
-        attr_reader :doc
-
-        # Initialize object
-        #
-        # @api private
-        def initialize
-          @doc = ::Ox::Document.new
-        end
-
-        # Create Ox element
-        #
-        # @param [String] name Name of the XML element
-        #
-        # @return [::Ox::Element]
-        #
-        # @api private
-        def create_element(name)
-          ::Ox::Element.new(name)
-        end
-
-        # Add XML namespace to document
-        #
-        # Ox doesn't support XML namespaces so this method does nothing.
-        #
-        # @param [String] prefix
-        # @param [String] namespace
-        #
-        # @api private
-        def add_namespace(prefix, namespace)
-          # :noop:
-        end
-
-        # Add attribute to Ox element
-        #
-        # @param [::Ox::Element] element Ox element
-        # @param [String] name Name of the XML attribute
-        # @param [String] value Value of the XML attribute
-        #
-        # @api private
-        def add_attribute(element, name, value)
-          element[name] = value
-        end
-
-        # Add child element to Ox element
-        #
-        # @param [::Ox::Element] element Ox parent element
-        # @param [::Ox::Element] child Ox child element
-        #
-        # @api private
-        def add_element(element, child)
-          element << child
-        end
-
-        # Add text node to Ox element
-        #
-        # @param [::Ox::Element] element Ox element
-        # @param [String] text Text to add
-        #
-        # @api private
-        def add_text(element, text)
-          element << text
-        end
-      end
-
-      # Wrapper around Ox::Element API
-      #
-      # @api private
-      class Node
-        # Initialize object with Ox element
-        #
-        # @param [::Ox::Element] node Ox element
-        #
-        # @api private
-        def initialize(node)
-          @node = node
-        end
-
-        # Return name of the node in the format of
-        # prefix:name when the node is namespaced or just name when it's not
-        #
-        # @return [String]
-        #
-        # @example without namespace
-        #   node.name # => Bar
-        #
-        # @example with namespace
-        #   node.name # => foo:Bar
-        #
-        # @api private
-        def name
-          @node.name
-        end
-
-        # Return all attributes associated with the node
-        #
-        # @return [Hash]
-        #
-        # @api private
-        def attributes
-          @node.attributes
-        end
-
-        # Return node's element children
-        #
-        # @return [Array<Shale::Adapter::Ox::Node>]
-        #
-        # @api private
-        def children
-          @node
-            .nodes
-            .filter { |e| e.is_a?(::Ox::Element) }
-            .map { |e| self.class.new(e) }
-        end
-
-        # Return first text child of a node
-        #
-        # @return [String]
-        #
-        # @api private
-        def text
-          @node.text
-        end
-      end
     end
   end
 end

data/lib/shale/adapter/rexml/document.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Shale
+  module Adapter
+    module REXML
+      # Wrapper around REXML API
+      #
+      # @api private
+      class Document
+        # Initialize object
+        #
+        # @api private
+        def initialize
+          context = { attribute_quote: :quote, prologue_quote: :quote }
+          @doc = ::REXML::Document.new(nil, context)
+          @namespaces = {}
+        end
+
+        # Return REXML document
+        #
+        # @return [::REXML::Document]
+        #
+        # @api private
+        def doc
+          if @doc.root
+            @namespaces.each do |prefix, namespace|
+              @doc.root.add_namespace(prefix, namespace)
+            end
+          end
+
+          @doc
+        end
+
+        # Create REXML element
+        #
+        # @param [String] name Name of the XML element
+        #
+        # @return [::REXML::Element]
+        #
+        # @api private
+        def create_element(name)
+          ::REXML::Element.new(name, nil, attribute_quote: :quote)
+        end
+
+        # Add XML namespace to document
+        #
+        # @param [String] prefix
+        # @param [String] namespace
+        #
+        # @api private
+        def add_namespace(prefix, namespace)
+          @namespaces[prefix] = namespace if prefix && namespace
+        end
+
+        # Add attribute to REXML element
+        #
+        # @param [::REXML::Element] element REXML element
+        # @param [String] name Name of the XML attribute
+        # @param [String] value Value of the XML attribute
+        #
+        # @api private
+        def add_attribute(element, name, value)
+          element.add_attribute(name, value)
+        end
+
+        # Add child element to REXML element
+        #
+        # @param [::REXML::Element] element REXML parent element
+        # @param [::REXML::Element] child REXML child element
+        #
+        # @api private
+        def add_element(element, child)
+          element.add_element(child)
+        end
+
+        # Add text node to REXML element
+        #
+        # @param [::REXML::Element] element REXML element
+        # @param [String] text Text to add
+        #
+        # @api private
+        def add_text(element, text)
+          element.add_text(text)
+        end
+      end
+    end
+  end
+end