shale 0.2.2 → 0.4.0

data/lib/shale/adapter/nokogiri.rb

@@ -26,12 +26,29 @@ module Shale
       # Serialize Nokogiri document into XML
       #
       # @param [::Nokogiri::XML::Document] doc Nokogiri document
+      # @param [Array<Symbol>] options
       #
       # @return [String]
       #
       # @api private
-      def self.dump(doc)
-        doc.to_xml
+      def self.dump(doc, *options)
+        save_with = ::Nokogiri::XML::Node::SaveOptions::AS_XML
+
+        if options.include?(:pretty)
+          save_with |= ::Nokogiri::XML::Node::SaveOptions::FORMAT
+        end
+
+        unless options.include?(:declaration)
+          save_with |= ::Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
+        end
+
+        result = doc.to_xml(save_with: save_with)
+
+        unless options.include?(:pretty)
+          result = result.sub(/\n/, '')
+        end
+
+        result
       end
 
       # Create Shale::Adapter::Nokogiri::Document instance
@@ -45,18 +62,27 @@ module Shale
       #
       # @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
-        attr_reader :doc
+        def doc
+          if @doc.root
+            @namespaces.each do |prefix, namespace|
+              @doc.root.add_namespace(prefix, namespace)
+            end
+          end
 
-        # Initialize object
-        #
-        # @api private
-        def initialize
-          @doc = ::Nokogiri::XML::Document.new
+          @doc
         end
 
         # Create Nokogiri element
@@ -70,6 +96,16 @@ module Shale
           ::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
@@ -115,7 +151,7 @@ module Shale
           @node = node
         end
 
-        # Return fully qualified name of the node in the format of
+        # 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]
@@ -124,11 +160,11 @@ module Shale
         #   node.name # => Bar
         #
         # @example with namespace
-        #   node.name # => foo:Bar
+        #   node.name # => http://foo:Bar
         #
         # @api private
         def name
-          [@node.namespace&.prefix, @node.name].compact.join(':')
+          [@node.namespace&.href, @node.name].compact.join(':')
         end
 
         # Return all attributes associated with the node
@@ -138,7 +174,7 @@ module Shale
         # @api private
         def attributes
           @node.attribute_nodes.each_with_object({}) do |node, hash|
-            name = [node.namespace&.prefix, node.name].compact.join(':')
+            name = [node.namespace&.href, node.name].compact.join(':')
             hash[name] = node.value
           end
         end

data/lib/shale/adapter/ox.rb

@@ -22,12 +22,24 @@ module Shale
       # Serialize Ox document into XML
       #
       # @param [::Ox::Document, ::Ox::Element] doc Ox document
+      # @param [Array<Symbol>] options
       #
       # @return [String]
       #
       # @api private
-      def self.dump(doc)
-        ::Ox.dump(doc)
+      def self.dump(doc, *options)
+        opts = { indent: -1, with_xml: false }
+
+        if options.include?(:pretty)
+          opts[:indent] = 2
+        end
+
+        if options.include?(:declaration)
+          doc[:version] = '1.0'
+          opts[:with_xml] = true
+        end
+
+        ::Ox.dump(doc, opts).sub(/\A\n/, '')
       end
 
       # Create Shale::Adapter::Ox::Document instance
@@ -66,6 +78,18 @@ module Shale
           ::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
@@ -111,8 +135,8 @@ module Shale
           @node = node
         end
 
-        # Return fully qualified name of the node in the format of
-        # namespace:name when the node is namespaced or just name when it's not
+        # 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]
         #

data/lib/shale/adapter/rexml.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rexml/document'
+require_relative '../utils'
 
 module Shale
   module Adapter
@@ -23,12 +24,27 @@ module Shale
       # Serialize REXML document into XML
       #
       # @param [::REXML::Document] doc REXML document
+      # @param [Array<Symbol>] options
       #
       # @return [String]
       #
       # @api private
-      def self.dump(doc)
-        doc.to_s
+      def self.dump(doc, *options)
+        if options.include?(:declaration)
+          doc.add(::REXML::XMLDecl.new)
+        end
+
+        io = StringIO.new
+
+        if options.include?(:pretty)
+          formatter = ::REXML::Formatters::Pretty.new
+          formatter.compact = true
+        else
+          formatter = ::REXML::Formatters::Default.new
+        end
+
+        formatter.write(doc, io)
+        io.string
       end
 
       # Create Shale::Adapter::REXML::Document instance
@@ -42,18 +58,28 @@ module Shale
       #
       # @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
-        attr_reader :doc
+        def doc
+          if @doc.root
+            @namespaces.each do |prefix, namespace|
+              @doc.root.add_namespace(prefix, namespace)
+            end
+          end
 
-        # Initialize object
-        #
-        # @api private
-        def initialize
-          @doc = ::REXML::Document.new
+          @doc
         end
 
         # Create REXML element
@@ -64,7 +90,17 @@ module Shale
         #
         # @api private
         def create_element(name)
-          ::REXML::Element.new(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
@@ -112,7 +148,7 @@ module Shale
           @node = node
         end
 
-        # Return fully qualified name of the node in the format of
+        # 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]
@@ -121,11 +157,11 @@ module Shale
         #   node.name # => Bar
         #
         # @example with namespace
-        #   node.name # => foo:Bar
+        #   node.name # => http://foo:Bar
         #
         # @api private
         def name
-          @node.expanded_name
+          [Utils.presence(@node.namespace), @node.name].compact.join(':')
         end
 
         # Return all attributes associated with the node
@@ -134,7 +170,14 @@ module Shale
         #
         # @api private
         def attributes
-          @node.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

data/lib/shale/attribute.rb

@@ -20,16 +20,22 @@ module Shale
     # @api private
     attr_reader :default
 
+    # Return setter name
+    #
+    # @api private
+    attr_reader :setter
+
     # Initialize Attribute object
     #
     # @param [Symbol] name Name of the attribute
-    # @param [Shale::Type::Base] type Type of the attribute
+    # @param [Shale::Type::Value] type Type of the attribute
     # @param [Boolean] collection Is this attribute a collection
     # @param [Proc] default Default value
     #
     # @api private
     def initialize(name, type, collection, default)
       @name = name
+      @setter = "#{name}="
       @type = type
       @collection = collection
       @default = collection ? -> { [] } : default

data/lib/shale/error.rb

@@ -36,4 +36,16 @@ module Shale
   # @api private
   class IncorrectMappingArgumentsError < StandardError
   end
+
+  # Error for passing incorrect arguments to schema generation function
+  #
+  # @api private
+  class NotAShaleMapperError < StandardError
+  end
+
+  # JSON Schema compilation error
+  #
+  # @api private
+  class JSONSchemaError < StandardError
+  end
 end

data/lib/shale/mapper.rb

@@ -3,7 +3,7 @@
 require_relative 'attribute'
 require_relative 'error'
 require_relative 'utils'
-require_relative 'mapping/key_value'
+require_relative 'mapping/dict'
 require_relative 'mapping/xml'
 require_relative 'type/composite'
 
@@ -44,9 +44,9 @@ module Shale
   # @api public
   class Mapper < Type::Composite
     @attributes = {}
-    @hash_mapping = Mapping::KeyValue.new
-    @json_mapping = Mapping::KeyValue.new
-    @yaml_mapping = Mapping::KeyValue.new
+    @hash_mapping = Mapping::Dict.new
+    @json_mapping = Mapping::Dict.new
+    @yaml_mapping = Mapping::Dict.new
     @xml_mapping = Mapping::Xml.new
 
     class << self
@@ -59,21 +59,21 @@ module Shale
 
       # Return Hash mapping object
       #
-      # @return [Shale::Mapping::KeyValue]
+      # @return [Shale::Mapping::Dict]
       #
       # @api public
       attr_reader :hash_mapping
 
       # Return JSON mapping object
       #
-      # @return [Shale::Mapping::KeyValue]
+      # @return [Shale::Mapping::Dict]
       #
       # @api public
       attr_reader :json_mapping
 
       # Return YAML mapping object
       #
-      # @return [Shale::Mapping::KeyValue]
+      # @return [Shale::Mapping::Dict]
       #
       # @api public
       attr_reader :yaml_mapping
@@ -108,7 +108,7 @@ module Shale
       # Define attribute on class
       #
       # @param [Symbol] name Name of the attribute
-      # @param [Shale::Type::Base] type Type of the attribute
+      # @param [Shale::Type::Value] type Type of the attribute
       # @param [Boolean] collection Is the attribute a collection
       # @param [Proc] default Default value for the attribute
       #
@@ -167,7 +167,7 @@ module Shale
       #     attribute :last_name, Shale::Type::String
       #     attribute :age, Shale::Type::Integer
       #
-      #     yaml do
+      #     hsh do
       #       map 'firatName', to: :first_name
       #       map 'lastName', to: :last_name
       #       map 'age', to: :age
@@ -175,7 +175,7 @@ module Shale
       #   end
       #
       # @api public
-      def hash(&block)
+      def hsh(&block)
         @hash_mapping = @__hash_mapping_init.dup
         @hash_mapping.instance_eval(&block)
       end
@@ -190,7 +190,7 @@ module Shale
       #     attribute :last_name, Shale::Type::String
       #     attribute :age, Shale::Type::Integer
       #
-      #     yaml do
+      #     json do
       #       map 'firatName', to: :first_name
       #       map 'lastName', to: :last_name
       #       map 'age', to: :age
@@ -272,9 +272,11 @@ module Shale
     def initialize(**props)
       super()
 
-      props.each_key do |name|
-        unless self.class.attributes.keys.include?(name)
-          raise UnknownAttributeError.new(self.class.to_s, name.to_s)
+      unless props.empty?
+        unknown_attributes = props.keys - self.class.attributes.keys
+
+        unless unknown_attributes.empty?
+          raise UnknownAttributeError.new(self.class.to_s, unknown_attributes[0].to_s)
         end
       end
 
@@ -285,7 +287,7 @@ module Shale
           value = attribute.default.call
         end
 
-        public_send("#{name}=", value)
+        send(attribute.setter, value)
       end
     end
   end

data/lib/shale/mapping/descriptor/dict.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Shale
+  module Mapping
+    module Descriptor
+      # Class representing attribute mapping
+      #
+      # @api private
+      class Dict
+        # Return mapping name
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :name
+
+        # Return attribute name
+        #
+        # @return [Symbol]
+        #
+        # @api private
+        attr_reader :attribute
+
+        # Return method symbol
+        #
+        # @return [Symbol]
+        #
+        # @api private
+        attr_reader :method_from
+
+        # Return method symbol
+        #
+        # @return [Symbol]
+        #
+        # @api private
+        attr_reader :method_to
+
+        # Initialize instance
+        #
+        # @param [String] name
+        # @param [Symbol, nil] attribute
+        # @param [Hash, nil] methods
+        #
+        # @api private
+        def initialize(name:, attribute:, methods:)
+          @name = name
+          @attribute = attribute
+
+          if methods
+            @method_from = methods[:from]
+            @method_to = methods[:to]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shale/mapping/descriptor/xml.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'dict'
+
+module Shale
+  module Mapping
+    module Descriptor
+      # Class representing XML attribute mapping
+      #
+      # @api private
+      class Xml < Dict
+        # Return namespace
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :namespace
+
+        # Initialize instance
+        #
+        # @param [String] name
+        # @param [Symbol, String] attribute
+        # @param [Hash, nil] methods
+        # @param [Shale::Mapping::XmlNamespace] namespace
+        #
+        # @api private
+        def initialize(name:, attribute:, methods:, namespace:)
+          super(name: name, attribute: attribute, methods: methods)
+          @namespace = namespace
+        end
+
+        # Return name with XML prefix
+        #
+        # @return [String]
+        #
+        # @api private
+        def prefixed_name
+          [namespace.prefix, name].compact.join(':')
+        end
+      end
+    end
+  end
+end

data/lib/shale/mapping/descriptor/xml_namespace.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Shale
+  module Mapping
+    module Descriptor
+      # Class representing XML namespace
+      #
+      # @api private
+      class XmlNamespace
+        # Return name
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_accessor :name
+
+        # Return prefix
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_accessor :prefix
+
+        # Initialize instance
+        #
+        # @param [String, nil] name
+        # @param [String, nil] prefix
+        #
+        # @api private
+        def initialize(name = nil, prefix = nil)
+          @name = name
+          @prefix = prefix
+        end
+      end
+    end
+  end
+end

data/lib/shale/mapping/{key_value.rb → dict.rb}

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+require_relative 'descriptor/dict'
+require_relative 'validator'
 
 module Shale
   module Mapping
-    # Mapping for key/value serialization formats (Hash/JSON/YAML)
+    # Mapping for dictionary serialization formats (Hash/JSON/YAML)
     #
     # @api private
-    class KeyValue < Base
+    class Dict
       # Return keys mapping hash
       #
       # @return [Hash]
@@ -26,14 +27,15 @@ module Shale
       # Map key to attribute
       #
       # @param [String] key Document's key
-      # @param [Symbol] to Object's attribute
+      # @param [Symbol, nil] to Object's attribute
+      # @param [Hash, nil] using
       #
       # @raise [IncorrectMappingArgumentsError] when arguments are incorrect
       #
       # @api private
       def map(key, to: nil, using: nil)
-        validate_arguments(key, to, using)
-        @keys[key] = to || using
+        Validator.validate_arguments(key, to, using)
+        @keys[key] = Descriptor::Dict.new(name: key, attribute: to, methods: using)
       end
 
       # @api private

data/lib/shale/mapping/validator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../error'
+
+module Shale
+  module Mapping
+    module Validator
+      # Validate correctness of argument passed to map functions
+      #
+      # @param [String] key
+      # @param [Symbol] to
+      # @param [Hash] using
+      #
+      # @raise [IncorrectMappingArgumentsError] when arguments are incorrect
+      #
+      # @api private
+      def self.validate_arguments(key, to, using)
+        if to.nil? && using.nil?
+          msg = ":to or :using argument is required for mapping '#{key}'"
+          raise IncorrectMappingArgumentsError, msg
+        end
+
+        if !using.nil? && (using[:from].nil? || using[:to].nil?)
+          msg = ":using argument for mapping '#{key}' requires :to and :from keys"
+          raise IncorrectMappingArgumentsError, msg
+        end
+      end
+
+      # Validate correctness of namespace arguments
+      #
+      # @param [String] key
+      # @param [String, Symbol, nil] namespace
+      # @param [String, Symbol, nil] prefix
+      #
+      # @raise [IncorrectMappingArgumentsError] when arguments are incorrect
+      #
+      # @api private
+      def self.validate_namespace(key, namespace, prefix)
+        return if namespace == :undefined && prefix == :undefined
+
+        nsp = namespace == :undefined ? nil : namespace
+        pfx = prefix == :undefined ? nil : prefix
+
+        if (nsp && !pfx) || (!nsp && pfx)
+          msg = "both :namespace and :prefix arguments are required for mapping '#{key}'"
+          raise IncorrectMappingArgumentsError, msg
+        end
+      end
+    end
+  end
+end