shale 0.3.1 → 0.6.0

data/lib/shale/error.rb

@@ -1,6 +1,38 @@
 # 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.
+
+    # 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 +63,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
@@ -42,4 +80,22 @@ module Shale
   # @api private
   class NotAShaleMapperError < StandardError
   end
+
+  # Schema compilation error
+  #
+  # @api private
+  class SchemaError < StandardError
+  end
+
+  # Parsing error
+  #
+  # @api private
+  class ParseError < StandardError
+  end
+
+  # Adapter error
+  #
+  # @api private
+  class AdapterError < StandardError
+  end
 end

data/lib/shale/mapper.rb

@@ -5,7 +5,7 @@ require_relative 'error'
 require_relative 'utils'
 require_relative 'mapping/dict'
 require_relative 'mapping/xml'
-require_relative 'type/composite'
+require_relative 'type/complex'
 
 module Shale
   # Base class used for mapping
@@ -42,11 +42,13 @@ module Shale
   #   person.to_json
   #
   # @api public
-  class Mapper < Type::Composite
+  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
@@ -272,9 +324,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 +339,7 @@ module Shale
           value = attribute.default.call
         end
 
-        public_send("#{name}=", value)
+        send(attribute.setter, value)
       end
     end
   end

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

@@ -16,17 +16,26 @@ 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
         #
         # @api private
-        def initialize(name:, attribute:, methods:, namespace:)
+        def initialize(name:, attribute:, methods:, namespace:, cdata:)
           super(name: name, attribute: attribute, methods: methods)
           @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
@@ -38,9 +39,26 @@ module Shale
         @keys[key] = Descriptor::Dict.new(name: key, attribute: to, methods: using)
       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,14 @@ 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
+      )
         Validator.validate_arguments(element, to, using)
         Validator.validate_namespace(element, namespace, prefix)
 
@@ -94,7 +102,8 @@ module Shale
           name: element,
           attribute: to,
           methods: using,
-          namespace: Descriptor::XmlNamespace.new(nsp, pfx)
+          namespace: Descriptor::XmlNamespace.new(nsp, pfx),
+          cdata: cdata
         )
       end
 
@@ -119,7 +128,8 @@ module Shale
           name: attribute,
           attribute: to,
           methods: using,
-          namespace: Descriptor::XmlNamespace.new(namespace, prefix)
+          namespace: Descriptor::XmlNamespace.new(namespace, prefix),
+          cdata: false
         )
       end
 
@@ -128,8 +138,16 @@ 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
+        )
       end
 
       # Set the name for root element
@@ -152,6 +170,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 +193,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/compiler/boolean.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Shale
+  module Schema
+    module Compiler
+      # Class that maps Schema type to Shale Boolean type
+      #
+      # @api private
+      class Boolean
+        # Return name of the Shale type
+        #
+        # @return [String]
+        #
+        # @api private
+        def name
+          'Shale::Type::Boolean'
+        end
+      end
+    end
+  end
+end

data/lib/shale/schema/compiler/complex.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative '../../utils'
+
+module Shale
+  module Schema
+    module Compiler
+      # Class representing Shale's complex type
+      #
+      # @api private
+      class Complex
+        # Return id
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :id
+
+        # Return properties
+        #
+        # @return [Array<Shale::Schema::Compiler::Property>]
+        #
+        # @api private
+        attr_reader :properties
+
+        # Name setter
+        #
+        # @param [String] val
+        #
+        # @api private
+        attr_writer :name
+
+        # Initialize object
+        #
+        # @param [String] id
+        # @param [String] name
+        #
+        # @api private
+        def initialize(id, name)
+          @id = id
+          @name = name
+          @properties = []
+        end
+
+        # Return name
+        #
+        # @return [String]
+        #
+        # @api private
+        def name
+          Utils.classify(@name)
+        end
+
+        # Return file name
+        #
+        # @return [String]
+        #
+        # @api private
+        def file_name
+          Utils.snake_case(@name)
+        end
+
+        # Return references
+        #
+        # @return [Array<Shale::Schema::Compiler::Property>]
+        #
+        # @api private
+        def references
+          @properties
+            .filter { |e| e.type.is_a?(self.class) && e.type != self }
+            .uniq { |e| e.type.id }
+            .sort { |a, b| a.type.file_name <=> b.type.file_name }
+        end
+
+        # Add property to Object
+        #
+        # @param [Shale::Schema::Compiler::Property] property
+        #
+        # @api private
+        def add_property(property)
+          unless @properties.find { |e| e.mapping_name == property.mapping_name }
+            @properties << property
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shale/schema/compiler/date.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Shale
+  module Schema
+    module Compiler
+      # Class that maps Schema type to Shale Date type
+      #
+      # @api private
+      class Date
+        # Return name of the Shale type
+        #
+        # @return [String]
+        #
+        # @api private
+        def name
+          'Shale::Type::Date'
+        end
+      end
+    end
+  end
+end

data/lib/shale/schema/compiler/float.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Shale
+  module Schema
+    module Compiler
+      # Class that maps Schema type to Shale Float type
+      #
+      # @api private
+      class Float
+        # Return name of the Shale type
+        #
+        # @return [String]
+        #
+        # @api private
+        def name
+          'Shale::Type::Float'
+        end
+      end
+    end
+  end
+end

data/lib/shale/schema/compiler/integer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Shale
+  module Schema
+    module Compiler
+      # Class that maps Schema type to Shale Integer type
+      #
+      # @api private
+      class Integer
+        # Return name of the Shale type
+        #
+        # @return [String]
+        #
+        # @api private
+        def name
+          'Shale::Type::Integer'
+        end
+      end
+    end
+  end
+end

data/lib/shale/schema/compiler/property.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative '../../utils'
+
+module Shale
+  module Schema
+    module Compiler
+      # Class representing Shale's property
+      #
+      # @api private
+      class Property
+        # Return mapping's name
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :mapping_name
+
+        # Return attribute's name
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :attribute_name
+
+        # Return types's name
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :type
+
+        # Initialize Property object
+        #
+        # @param [String] name
+        # @param [Shale::Schema::Compiler::Type] type
+        # @param [true, false] collection
+        # @param [Object] default
+        #
+        # @api private
+        def initialize(name, type, collection, default)
+          @mapping_name = name
+          @attribute_name = Utils.snake_case(name)
+          @type = type
+          @collection = collection
+          @default = default
+        end
+
+        # Return whether property is a collection
+        #
+        # @return [true, false]
+        #
+        # @api private
+        def collection?
+          @collection
+        end
+
+        # Return default value
+        #
+        # @return [nil, Object]
+        #
+        # @api private
+        def default
+          return if collection?
+          @default.is_a?(::String) ? @default.dump : @default
+        end
+      end
+    end
+  end
+end

data/lib/shale/schema/compiler/string.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Shale
+  module Schema
+    module Compiler
+      # Class that maps Schema type to Shale String type
+      #
+      # @api private
+      class String
+        # Return name of the Shale type
+        #
+        # @return [String]
+        #
+        # @api private
+        def name
+          'Shale::Type::String'
+        end
+      end
+    end
+  end
+end