shale 0.4.0 → 0.7.0

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,29 +16,34 @@ 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
       #
       # @param [::Ox::Document, ::Ox::Element] doc Ox document
-      # @param [Array<Symbol>] options
+      # @param [true, false] pretty
+      # @param [true, false] declaration
       #
       # @return [String]
       #
       # @api private
-      def self.dump(doc, *options)
+      def self.dump(doc, pretty: false, declaration: false)
         opts = { indent: -1, with_xml: false }
 
-        if options.include?(:pretty)
+        if pretty
           opts[:indent] = 2
         end
 
-        if options.include?(:declaration)
+        if declaration
           doc[:version] = '1.0'
           opts[:with_xml] = true
         end
@@ -48,139 +57,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,98 @@
+# 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
+
+        # Create CDATA node and add it to parent
+        #
+        # @param [String] text
+        # @param [::REXML::Element] parent
+        #
+        # @api private
+        def create_cdata(text, parent)
+          ::REXML::CData.new(text, true, parent)
+        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

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative '../../utils'
+
+module Shale
+  module Adapter
+    module REXML
+      # Wrapper around REXML::Element API
+      #
+      # @api private
+      class Node
+        # Initialize object with REXML element
+        #
+        # @param [::REXML::Element] node REXML element
+        #
+        # @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
+        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
+          [Utils.presence(@node.namespace), @node.name].compact.join(':')
+        end
+
+        # Return all attributes associated with the node
+        #
+        # @return [Hash]
+        #
+        # @api private
+        def attributes
+          attributes = @node.attributes.values.map do |attribute|
+            attribute.is_a?(Hash) ? attribute.values : attribute
+          end.flatten
+
+          attributes.each_with_object({}) do |attribute, hash|
+            name = [Utils.presence(attribute.namespace), attribute.name].compact.join(':')
+            hash[name] = attribute.value
+          end
+        end
+
+        # Return node's parent
+        #
+        # @return [Shale::Adapter::REXML::Node, nil]
+        #
+        # @api private
+        def parent
+          if @node.parent && @node.parent.name != ''
+            self.class.new(@node.parent)
+          end
+        end
+
+        # Return node's element children
+        #
+        # @return [Array<Shale::Adapter::REXML::Node>]
+        #
+        # @api private
+        def children
+          @node
+            .children
+            .filter { |e| e.node_type == :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.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 require 'rexml/document'
-require_relative '../utils'
+
+require_relative '../error'
+require_relative 'rexml/document'
+require_relative 'rexml/node'
 
 module Shale
   module Adapter
@@ -13,30 +16,35 @@ module Shale
       #
       # @param [String] xml XML document
       #
-      # @return [::REXML::Document]
+      # @raise [ParseError] when XML document has errors
+      #
+      # @return [Shale::Adapter::REXML::Node]
       #
       # @api private
       def self.load(xml)
         doc = ::REXML::Document.new(xml, ignore_whitespace_nodes: :all)
         Node.new(doc.root)
+      rescue ::REXML::ParseException => e
+        raise ParseError, "Document is invalid: #{e.message}"
       end
 
       # Serialize REXML document into XML
       #
       # @param [::REXML::Document] doc REXML document
-      # @param [Array<Symbol>] options
+      # @param [true, false] pretty
+      # @param [true, false] declaration
       #
       # @return [String]
       #
       # @api private
-      def self.dump(doc, *options)
-        if options.include?(:declaration)
+      def self.dump(doc, pretty: false, declaration: false)
+        if declaration
           doc.add(::REXML::XMLDecl.new)
         end
 
         io = StringIO.new
 
-        if options.include?(:pretty)
+        if pretty
           formatter = ::REXML::Formatters::Pretty.new
           formatter.compact = true
         else
@@ -53,154 +61,6 @@ module Shale
       def self.create_document
         Document.new
       end
-
-      # 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
-
-      # Wrapper around REXML::Element API
-      #
-      # @api private
-      class Node
-        # Initialize object with REXML element
-        #
-        # @param [::REXML::Element] node REXML element
-        #
-        # @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
-          [Utils.presence(@node.namespace), @node.name].compact.join(':')
-        end
-
-        # Return all attributes associated with the node
-        #
-        # @return [Hash]
-        #
-        # @api private
-        def attributes
-          attributes = @node.attributes.values.map do |attribute|
-            attribute.is_a?(Hash) ? attribute.values : attribute
-          end.flatten
-
-          attributes.each_with_object({}) do |attribute, hash|
-            name = [Utils.presence(attribute.namespace), attribute.name].compact.join(':')
-            hash[name] = attribute.value
-          end
-        end
-
-        # Return node's element children
-        #
-        # @return [Array<Shale::Adapter::REXML::Node>]
-        #
-        # @api private
-        def children
-          @node
-            .children
-            .filter { |e| e.node_type == :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/toml_rb.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'toml-rb'
+
+module Shale
+  module Adapter
+    # TOML adapter
+    #
+    # @api public
+    class TomlRB
+      # Parse TOML into Hash
+      #
+      # @param [String] toml TOML document
+      #
+      # @return [Hash]
+      #
+      # @api private
+      def self.load(toml)
+        ::TomlRB.parse(toml)
+      end
+
+      # Serialize Hash into TOML
+      #
+      # @param [Hash] obj Hash object
+      #
+      # @return [String]
+      #
+      # @api private
+      def self.dump(obj)
+        ::TomlRB.dump(obj)
+      end
+    end
+  end
+end

data/lib/shale/error.rb

@@ -1,6 +1,43 @@
 # frozen_string_literal: true
 
 module Shale
+  # Error message displayed when TOML adapter is not set
+  # @api private
+  TOML_ADAPTER_NOT_SET_MESSAGE = <<~MSG
+    TOML Adapter is not set.
+    To use Shale with TOML documents you have to install parser and set adapter.
+
+    # To use Tomlib:
+    # Make sure tomlib is installed eg. execute: gem install tomlib
+    Shale.toml_adapter = Tomlib
+
+    # To use toml-rb:
+    # Make sure toml-rb is installed eg. execute: gem install toml-rb
+    require 'shale/adapter/toml_rb'
+    Shale.toml_adapter = Shale::Adapter::TomlRB
+  MSG
+
+  # Error message displayed when XML adapter is not set
+  # @api private
+  XML_ADAPTER_NOT_SET_MESSAGE = <<~MSG
+    XML Adapter is not set.
+    To use Shale with XML documents you have to install parser and set adapter.
+
+    # To use REXML:
+    require 'shale/adapter/rexml'
+    Shale.xml_adapter = Shale::Adapter::REXML
+
+    # To use Nokogiri:
+    # Make sure Nokogiri is installed eg. execute: gem install nokogiri
+    require 'shale/adapter/nokogiri'
+    Shale.xml_adapter = Shale::Adapter::Nokogiri
+
+    # To use OX:
+    # Make sure Ox is installed eg. execute: gem install ox
+    require 'shale/adapter/ox'
+    Shale.xml_adapter = Shale::Adapter::Ox
+  MSG
+
   # Error for assigning value to not existing attribute
   #
   # @api private
@@ -31,6 +68,12 @@ module Shale
     end
   end
 
+  # Error for passing incorrect model type
+  #
+  # @api private
+  class IncorrectModelError < StandardError
+  end
+
   # Error for passing incorrect arguments to map functions
   #
   # @api private
@@ -43,9 +86,21 @@ module Shale
   class NotAShaleMapperError < StandardError
   end
 
-  # JSON Schema compilation error
+  # Schema compilation error
+  #
+  # @api private
+  class SchemaError < StandardError
+  end
+
+  # Parsing error
+  #
+  # @api private
+  class ParseError < StandardError
+  end
+
+  # Adapter error
   #
   # @api private
-  class JSONSchemaError < StandardError
+  class AdapterError < StandardError
   end
 end