shale 0.5.0 → 0.7.1

data/lib/shale/adapter/ox.rb

@@ -30,19 +30,20 @@ module Shale
       # 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

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

@@ -42,6 +42,16 @@ module Shale
           ::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
@@ -60,7 +70,7 @@ module Shale
         #
         # @api private
         def add_attribute(element, name, value)
-          element.add_attribute(name, value)
+          element.add_attribute(name, value || '')
         end
 
         # Add child element to REXML element

data/lib/shale/adapter/rexml.rb

@@ -31,19 +31,20 @@ module Shale
       # 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

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,22 +1,38 @@
 # frozen_string_literal: true
 
 module Shale
-  # Error message displayed when adapter is not set
+  # Error message displayed when TOML adapter is not set
   # @api private
-  ADAPTER_NOT_SET_MESSAGE = <<~MSG
+  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:
+    # To use REXML:
     require 'shale/adapter/rexml'
     Shale.xml_adapter = Shale::Adapter::REXML
 
-    To use Nokogiri:
+    # 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:
+    # To use OX:
     # Make sure Ox is installed eg. execute: gem install ox
     require 'shale/adapter/ox'
     Shale.xml_adapter = Shale::Adapter::Ox
@@ -52,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

data/lib/shale/mapper.rb

@@ -43,10 +43,12 @@ module Shale
   #
   # @api public
   class Mapper < Type::Complex
+    @model = nil
     @attributes = {}
     @hash_mapping = Mapping::Dict.new
     @json_mapping = Mapping::Dict.new
     @yaml_mapping = Mapping::Dict.new
+    @toml_mapping = Mapping::Dict.new
     @xml_mapping = Mapping::Xml.new
 
     class << self
@@ -78,6 +80,13 @@ module Shale
       # @api public
       attr_reader :yaml_mapping
 
+      # Return TOML mapping object
+      #
+      # @return [Shale::Mapping::Dict]
+      #
+      # @api public
+      attr_reader :toml_mapping
+
       # Return XML mapping object
       #
       # @return [Shale::Mapping::XML]
@@ -88,16 +97,20 @@ module Shale
       # @api private
       def inherited(subclass)
         super
+
+        subclass.instance_variable_set('@model', subclass)
         subclass.instance_variable_set('@attributes', @attributes.dup)
 
         subclass.instance_variable_set('@__hash_mapping_init', @hash_mapping.dup)
         subclass.instance_variable_set('@__json_mapping_init', @json_mapping.dup)
         subclass.instance_variable_set('@__yaml_mapping_init', @yaml_mapping.dup)
+        subclass.instance_variable_set('@__toml_mapping_init', @toml_mapping.dup)
         subclass.instance_variable_set('@__xml_mapping_init', @xml_mapping.dup)
 
         subclass.instance_variable_set('@hash_mapping', @hash_mapping.dup)
         subclass.instance_variable_set('@json_mapping', @json_mapping.dup)
         subclass.instance_variable_set('@yaml_mapping', @yaml_mapping.dup)
+        subclass.instance_variable_set('@toml_mapping', @toml_mapping.dup)
 
         xml_mapping = @xml_mapping.dup
         xml_mapping.root(Utils.underscore(subclass.name || ''))
@@ -105,6 +118,15 @@ module Shale
         subclass.instance_variable_set('@xml_mapping', xml_mapping.dup)
       end
 
+      def model(klass = nil)
+        if klass
+          @model = klass
+          xml_mapping.root(Utils.underscore(@model.name))
+        else
+          @model
+        end
+      end
+
       # Define attribute on class
       #
       # @param [Symbol] name Name of the attribute
@@ -143,10 +165,11 @@ module Shale
 
         @attributes[name] = Attribute.new(name, type, collection, default)
 
-        @hash_mapping.map(name.to_s, to: name)
-        @json_mapping.map(name.to_s, to: name)
-        @yaml_mapping.map(name.to_s, to: name)
-        @xml_mapping.map_element(name.to_s, to: name)
+        @hash_mapping.map(name.to_s, to: name) unless @hash_mapping.finalized?
+        @json_mapping.map(name.to_s, to: name) unless @json_mapping.finalized?
+        @yaml_mapping.map(name.to_s, to: name) unless @yaml_mapping.finalized?
+        @toml_mapping.map(name.to_s, to: name) unless @toml_mapping.finalized?
+        @xml_mapping.map_element(name.to_s, to: name) unless @xml_mapping.finalized?
 
         class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
           attr_reader :#{name}
@@ -168,7 +191,7 @@ module Shale
       #     attribute :age, Shale::Type::Integer
       #
       #     hsh do
-      #       map 'firatName', to: :first_name
+      #       map 'firstName', to: :first_name
       #       map 'lastName', to: :last_name
       #       map 'age', to: :age
       #     end
@@ -177,6 +200,7 @@ module Shale
       # @api public
       def hsh(&block)
         @hash_mapping = @__hash_mapping_init.dup
+        @hash_mapping.finalize!
         @hash_mapping.instance_eval(&block)
       end
 
@@ -191,7 +215,7 @@ module Shale
       #     attribute :age, Shale::Type::Integer
       #
       #     json do
-      #       map 'firatName', to: :first_name
+      #       map 'firstName', to: :first_name
       #       map 'lastName', to: :last_name
       #       map 'age', to: :age
       #     end
@@ -200,6 +224,7 @@ module Shale
       # @api public
       def json(&block)
         @json_mapping = @__json_mapping_init.dup
+        @json_mapping.finalize!
         @json_mapping.instance_eval(&block)
       end
 
@@ -214,7 +239,7 @@ module Shale
       #     attribute :age, Shale::Type::Integer
       #
       #     yaml do
-      #       map 'firat_name', to: :first_name
+      #       map 'first_name', to: :first_name
       #       map 'last_name', to: :last_name
       #       map 'age', to: :age
       #     end
@@ -223,9 +248,34 @@ module Shale
       # @api public
       def yaml(&block)
         @yaml_mapping = @__yaml_mapping_init.dup
+        @yaml_mapping.finalize!
         @yaml_mapping.instance_eval(&block)
       end
 
+      # Define TOML mapping
+      #
+      # @param [Proc] block
+      #
+      # @example
+      #   calss Person < Shale::Mapper
+      #     attribute :first_name, Shale::Type::String
+      #     attribute :last_name, Shale::Type::String
+      #     attribute :age, Shale::Type::Integer
+      #
+      #     toml do
+      #       map 'first_name', to: :first_name
+      #       map 'last_name', to: :last_name
+      #       map 'age', to: :age
+      #     end
+      #   end
+      #
+      # @api public
+      def toml(&block)
+        @toml_mapping = @__toml_mapping_init.dup
+        @toml_mapping.finalize!
+        @toml_mapping.instance_eval(&block)
+      end
+
       # Define XML mapping
       #
       # @param [Proc] block
@@ -247,6 +297,8 @@ module Shale
       # @api public
       def xml(&block)
         @xml_mapping = @__xml_mapping_init.dup
+        @xml_mapping.finalize!
+        @xml_mapping.root('')
         @xml_mapping.instance_eval(&block)
       end
     end

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

@@ -40,17 +40,28 @@ module Shale
         # @param [String] name
         # @param [Symbol, nil] attribute
         # @param [Hash, nil] methods
+        # @param [true, false] render_nil
         #
         # @api private
-        def initialize(name:, attribute:, methods:)
+        def initialize(name:, attribute:, methods:, render_nil:)
           @name = name
           @attribute = attribute
+          @render_nil = render_nil
 
           if methods
             @method_from = methods[:from]
             @method_to = methods[:to]
           end
         end
+
+        # Check render_nil
+        #
+        # @return [true, false]
+        #
+        # @api private
+        def render_nil?
+          @render_nil == true
+        end
       end
     end
   end

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

@@ -16,17 +16,27 @@ module Shale
         # @api private
         attr_reader :namespace
 
+        # Return cdata
+        #
+        # @return [true, false]
+        #
+        # @api private
+        attr_reader :cdata
+
         # Initialize instance
         #
         # @param [String] name
         # @param [Symbol, String] attribute
         # @param [Hash, nil] methods
         # @param [Shale::Mapping::XmlNamespace] namespace
+        # @param [true, false] cdata
+        # @param [true, false] render_nil
         #
         # @api private
-        def initialize(name:, attribute:, methods:, namespace:)
-          super(name: name, attribute: attribute, methods: methods)
+        def initialize(name:, attribute:, methods:, namespace:, cdata:, render_nil:)
+          super(name: name, attribute: attribute, methods: methods, render_nil: render_nil)
           @namespace = namespace
+          @cdata = cdata
         end
 
         # Return name with XML prefix

data/lib/shale/mapping/dict.rb

@@ -22,6 +22,7 @@ module Shale
       def initialize
         super
         @keys = {}
+        @finalized = false
       end
 
       # Map key to attribute
@@ -29,18 +30,41 @@ module Shale
       # @param [String] key Document's key
       # @param [Symbol, nil] to Object's attribute
       # @param [Hash, nil] using
+      # @param [true, false] render_nil
       #
       # @raise [IncorrectMappingArgumentsError] when arguments are incorrect
       #
       # @api private
-      def map(key, to: nil, using: nil)
+      def map(key, to: nil, using: nil, render_nil: false)
         Validator.validate_arguments(key, to, using)
-        @keys[key] = Descriptor::Dict.new(name: key, attribute: to, methods: using)
+        @keys[key] = Descriptor::Dict.new(
+          name: key,
+          attribute: to,
+          methods: using,
+          render_nil: render_nil
+        )
+      end
+
+      # Set the "finalized" instance variable to true
+      #
+      # @api private
+      def finalize!
+        @finalized = true
+      end
+
+      # Query the "finalized" instance variable
+      #
+      # @return [truem false]
+      #
+      # @api private
+      def finalized?
+        @finalized
       end
 
       # @api private
       def initialize_dup(other)
         @keys = other.instance_variable_get('@keys').dup
+        @finalized = false
         super
       end
     end

data/lib/shale/mapping/xml.rb

@@ -63,6 +63,7 @@ module Shale
         @content = nil
         @root = ''
         @default_namespace = Descriptor::XmlNamespace.new
+        @finalized = false
       end
 
       # Map element to attribute
@@ -76,7 +77,15 @@ module Shale
       # @raise [IncorrectMappingArgumentsError] when arguments are incorrect
       #
       # @api private
-      def map_element(element, to: nil, using: nil, namespace: :undefined, prefix: :undefined)
+      def map_element(
+        element,
+        to: nil,
+        using: nil,
+        namespace: :undefined,
+        prefix: :undefined,
+        cdata: false,
+        render_nil: false
+      )
         Validator.validate_arguments(element, to, using)
         Validator.validate_namespace(element, namespace, prefix)
 
@@ -94,7 +103,9 @@ module Shale
           name: element,
           attribute: to,
           methods: using,
-          namespace: Descriptor::XmlNamespace.new(nsp, pfx)
+          namespace: Descriptor::XmlNamespace.new(nsp, pfx),
+          cdata: cdata,
+          render_nil: render_nil
         )
       end
 
@@ -109,7 +120,14 @@ module Shale
       # @raise [IncorrectMappingArgumentsError] when arguments are incorrect
       #
       # @api private
-      def map_attribute(attribute, to: nil, using: nil, namespace: nil, prefix: nil)
+      def map_attribute(
+        attribute,
+        to: nil,
+        using: nil,
+        namespace: nil,
+        prefix: nil,
+        render_nil: false
+      )
         Validator.validate_arguments(attribute, to, using)
         Validator.validate_namespace(attribute, namespace, prefix)
 
@@ -119,7 +137,9 @@ module Shale
           name: attribute,
           attribute: to,
           methods: using,
-          namespace: Descriptor::XmlNamespace.new(namespace, prefix)
+          namespace: Descriptor::XmlNamespace.new(namespace, prefix),
+          cdata: false,
+          render_nil: render_nil
         )
       end
 
@@ -128,8 +148,17 @@ module Shale
       # @param [Symbol] to Object's attribute
       #
       # @api private
-      def map_content(to:)
-        @content = to
+      def map_content(to: nil, using: nil, cdata: false)
+        Validator.validate_arguments('content', to, using)
+
+        @content = Descriptor::Xml.new(
+          name: nil,
+          attribute: to,
+          methods: using,
+          namespace: nil,
+          cdata: cdata,
+          render_nil: false
+        )
       end
 
       # Set the name for root element
@@ -152,6 +181,22 @@ module Shale
         @default_namespace.prefix = prefix
       end
 
+      # Set the "finalized" instance variable to true
+      #
+      # @api private
+      def finalize!
+        @finalized = true
+      end
+
+      # Query the "finalized" instance variable
+      #
+      # @return [truem false]
+      #
+      # @api private
+      def finalized?
+        @finalized
+      end
+
       # @api private
       def initialize_dup(other)
         @elements = other.instance_variable_get('@elements').dup
@@ -159,6 +204,7 @@ module Shale
         @content = other.instance_variable_get('@content').dup
         @root = other.instance_variable_get('@root').dup
         @default_namespace = other.instance_variable_get('@default_namespace').dup
+        @finalized = false
 
         super
       end

data/lib/shale/schema/json_generator.rb

@@ -124,9 +124,7 @@ module Shale
       # @api public
       def to_schema(klass, id: nil, title: nil, description: nil, pretty: false)
         schema = as_schema(klass, id: id, title: title, description: description)
-        options = pretty ? :pretty : nil
-
-        Shale.json_adapter.dump(schema, options)
+        Shale.json_adapter.dump(schema, pretty: pretty)
       end
 
       private

data/lib/shale/schema/xml_compiler.rb

@@ -200,7 +200,7 @@ module Shale
       # @api public
       def as_models(schemas)
         unless Shale.xml_adapter
-          raise AdapterError, ADAPTER_NOT_SET_MESSAGE
+          raise AdapterError, XML_ADAPTER_NOT_SET_MESSAGE
         end
 
         if Shale.xml_adapter.name == 'Shale::Adapter::Ox'

data/lib/shale/schema/xml_generator/import.rb

@@ -35,8 +35,8 @@ module Shale
         def as_xml(doc)
           import = doc.create_element('xs:import')
 
-          doc.add_attribute(import, 'namespace', @namespace)
-          doc.add_attribute(import, 'schemaLocation', @location)
+          doc.add_attribute(import, 'namespace', @namespace) if @namespace
+          doc.add_attribute(import, 'schemaLocation', @location) if @location
 
           import
         end

data/lib/shale/schema/xml_generator.rb

@@ -222,13 +222,11 @@ module Shale
       def to_schemas(klass, base_name = nil, pretty: false, declaration: false)
         schemas = as_schemas(klass, base_name)
 
-        options = [
-          pretty ? :pretty : nil,
-          declaration ? :declaration : nil,
-        ]
-
         schemas.to_h do |schema|
-          [schema.name, Shale.xml_adapter.dump(schema.as_xml, *options)]
+          [
+            schema.name,
+            Shale.xml_adapter.dump(schema.as_xml, pretty: pretty, declaration: declaration),
+          ]
         end
       end