shale 0.8.0 → 1.0.0

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

@@ -9,9 +9,14 @@ module Shale
       class Document
         # Initialize object
         #
+        # @param [String, nil] version
+        #
         # @api private
-        def initialize
-          @doc = ::Nokogiri::XML::Document.new
+        def initialize(version = nil)
+          ver = nil
+          ver = version if version.is_a?(String)
+
+          @doc = ::Nokogiri::XML::Document.new(ver)
           @namespaces = {}
         end
 

data/lib/shale/adapter/nokogiri.rb

@@ -37,12 +37,13 @@ module Shale
       #
       # @param [::Nokogiri::XML::Document] doc Nokogiri document
       # @param [true, false] pretty
-      # @param [true, false] declaration
+      # @param [true, false, String] declaration
+      # @param [true, false, String] encoding
       #
       # @return [String]
       #
       # @api private
-      def self.dump(doc, pretty: false, declaration: false)
+      def self.dump(doc, pretty: false, declaration: false, encoding: false)
         save_with = ::Nokogiri::XML::Node::SaveOptions::AS_XML
 
         if pretty
@@ -53,6 +54,10 @@ module Shale
           save_with |= ::Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
         end
 
+        if encoding
+          doc.encoding = encoding == true ? 'UTF-8' : encoding
+        end
+
         result = doc.to_xml(save_with: save_with)
 
         unless pretty
@@ -64,9 +69,11 @@ module Shale
 
       # Create Shale::Adapter::Nokogiri::Document instance
       #
+      # @param [true, false, String, nil] declaration
+      #
       # @api private
-      def self.create_document
-        Document.new
+      def self.create_document(version = nil)
+        Document.new(version)
       end
     end
   end

data/lib/shale/adapter/ox.rb

@@ -31,12 +31,13 @@ module Shale
       #
       # @param [::Ox::Document, ::Ox::Element] doc Ox document
       # @param [true, false] pretty
-      # @param [true, false] declaration
+      # @param [true, false, String] declaration
+      # @param [true, false, String] encoding
       #
       # @return [String]
       #
       # @api private
-      def self.dump(doc, pretty: false, declaration: false)
+      def self.dump(doc, pretty: false, declaration: false, encoding: false)
         opts = { indent: -1, with_xml: false }
 
         if pretty
@@ -44,7 +45,12 @@ module Shale
         end
 
         if declaration
-          doc[:version] = '1.0'
+          doc[:version] = declaration == true ? '1.0' : declaration
+
+          if encoding
+            doc[:encoding] = encoding == true ? 'UTF-8' : encoding
+          end
+
           opts[:with_xml] = true
         end
 
@@ -54,7 +60,7 @@ module Shale
       # Create Shale::Adapter::Ox::Document instance
       #
       # @api private
-      def self.create_document
+      def self.create_document(_version = nil)
         Document.new
       end
     end

data/lib/shale/adapter/rexml.rb

@@ -32,14 +32,28 @@ module Shale
       #
       # @param [::REXML::Document] doc REXML document
       # @param [true, false] pretty
-      # @param [true, false] declaration
+      # @param [true, false, String] declaration
+      # @param [true, false, String] encoding
       #
       # @return [String]
       #
       # @api private
-      def self.dump(doc, pretty: false, declaration: false)
+      def self.dump(doc, pretty: false, declaration: false, encoding: false)
         if declaration
-          doc.add(::REXML::XMLDecl.new)
+          ver = nil
+          enc = nil
+
+          if declaration.is_a?(String)
+            ver = declaration
+          end
+
+          if encoding == true
+            enc = 'UTF-8'
+          else
+            enc = encoding || nil
+          end
+
+          doc.add(::REXML::XMLDecl.new(ver, enc))
         end
 
         io = StringIO.new
@@ -58,7 +72,7 @@ module Shale
       # Create Shale::Adapter::REXML::Document instance
       #
       # @api private
-      def self.create_document
+      def self.create_document(_version = nil)
         Document.new
       end
     end

data/lib/shale/error.rb

@@ -53,10 +53,16 @@ module Shale
     end
   end
 
+  # Shale base error class
+  #
+  # @api private
+  class ShaleError < StandardError
+  end
+
   # Error for trying to assign not callable object as an attribute's default
   #
   # @api private
-  class DefaultNotCallableError < StandardError
+  class DefaultNotCallableError < ShaleError
     # Initialize error object
     #
     # @param [String] record
@@ -71,36 +77,42 @@ module Shale
   # Error for passing incorrect model type
   #
   # @api private
-  class IncorrectModelError < StandardError
+  class IncorrectModelError < ShaleError
   end
 
   # Error for passing incorrect arguments to map functions
   #
   # @api private
-  class IncorrectMappingArgumentsError < StandardError
+  class IncorrectMappingArgumentsError < ShaleError
+  end
+
+  # Error for using incorrect type
+  #
+  # @api private
+  class NotAShaleMapperError < ShaleError
   end
 
-  # Error for passing incorrect arguments to schema generation function
+  # Raised when receiver attribute is not defined
   #
   # @api private
-  class NotAShaleMapperError < StandardError
+  class AttributeNotDefinedError < ShaleError
   end
 
   # Schema compilation error
   #
   # @api private
-  class SchemaError < StandardError
+  class SchemaError < ShaleError
   end
 
   # Parsing error
   #
   # @api private
-  class ParseError < StandardError
+  class ParseError < ShaleError
   end
 
   # Adapter error
   #
   # @api private
-  class AdapterError < StandardError
+  class AdapterError < ShaleError
   end
 end

data/lib/shale/mapper.rb

@@ -49,6 +49,7 @@ module Shale
     @json_mapping = Mapping::Dict.new
     @yaml_mapping = Mapping::Dict.new
     @toml_mapping = Mapping::Dict.new
+    @csv_mapping = Mapping::Dict.new(render_nil_default: true)
     @xml_mapping = Mapping::Xml.new
 
     class << self
@@ -87,6 +88,13 @@ module Shale
       # @api public
       attr_reader :toml_mapping
 
+      # Return CSV mapping object
+      #
+      # @return [Shale::Mapping::Dict]
+      #
+      # @api public
+      attr_reader :csv_mapping
+
       # Return XML mapping object
       #
       # @return [Shale::Mapping::XML]
@@ -109,12 +117,14 @@ module Shale
         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('@__csv_mapping_init', @csv_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)
+        subclass.instance_variable_set('@csv_mapping', @csv_mapping.dup)
 
         xml_mapping = @xml_mapping.dup
         xml_mapping.root(Utils.underscore(subclass.name || ''))
@@ -141,7 +151,7 @@ module Shale
       # @raise [DefaultNotCallableError] when attribute's default is not callable
       #
       # @example
-      #   calss Person < Shale::Mapper
+      #   class Person < Shale::Mapper
       #     attribute :first_name, Shale::Type::String
       #     attribute :last_name, Shale::Type::String
       #     attribute :age, Shale::Type::Integer, default: -> { 1 }
@@ -173,6 +183,7 @@ module Shale
         @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?
+        @csv_mapping.map(name.to_s, to: name) unless @csv_mapping.finalized?
         @xml_mapping.map_element(name.to_s, to: name) unless @xml_mapping.finalized?
 
         @attributes_module.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
@@ -189,7 +200,7 @@ module Shale
       # @param [Proc] block
       #
       # @example
-      #   calss Person < Shale::Mapper
+      #   class Person < Shale::Mapper
       #     attribute :first_name, Shale::Type::String
       #     attribute :last_name, Shale::Type::String
       #     attribute :age, Shale::Type::Integer
@@ -213,7 +224,7 @@ module Shale
       # @param [Proc] block
       #
       # @example
-      #   calss Person < Shale::Mapper
+      #   class Person < Shale::Mapper
       #     attribute :first_name, Shale::Type::String
       #     attribute :last_name, Shale::Type::String
       #     attribute :age, Shale::Type::Integer
@@ -237,7 +248,7 @@ module Shale
       # @param [Proc] block
       #
       # @example
-      #   calss Person < Shale::Mapper
+      #   class Person < Shale::Mapper
       #     attribute :first_name, Shale::Type::String
       #     attribute :last_name, Shale::Type::String
       #     attribute :age, Shale::Type::Integer
@@ -261,7 +272,7 @@ module Shale
       # @param [Proc] block
       #
       # @example
-      #   calss Person < Shale::Mapper
+      #   class Person < Shale::Mapper
       #     attribute :first_name, Shale::Type::String
       #     attribute :last_name, Shale::Type::String
       #     attribute :age, Shale::Type::Integer
@@ -280,12 +291,36 @@ module Shale
         @toml_mapping.instance_eval(&block)
       end
 
+      # Define CSV mapping
+      #
+      # @param [Proc] block
+      #
+      # @example
+      #   class Person < Shale::Mapper
+      #     attribute :first_name, Shale::Type::String
+      #     attribute :last_name, Shale::Type::String
+      #     attribute :age, Shale::Type::Integer
+      #
+      #     csv do
+      #       map 'first_name', to: :first_name
+      #       map 'last_name', to: :last_name
+      #       map 'age', to: :age
+      #     end
+      #   end
+      #
+      # @api public
+      def csv(&block)
+        @csv_mapping = @__csv_mapping_init.dup
+        @csv_mapping.finalize!
+        @csv_mapping.instance_eval(&block)
+      end
+
       # Define XML mapping
       #
       # @param [Proc] block
       #
       # @example
-      #   calss Person < Shale::Mapper
+      #   class Person < Shale::Mapper
       #     attribute :first_name, Shale::Type::String
       #     attribute :last_name, Shale::Type::String
       #     attribute :age, Shale::Type::Integer

data/lib/shale/mapping/delegates.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Shale
+  module Mapping
+    # Class for handling attribute delegation
+    #
+    # @api private
+    class Delegates
+      # Class representing individual delegation
+      #
+      # @api private
+      class Delegate
+        # Return receiver_attribute
+        #
+        # @return [Shale::Attribute]
+        #
+        # @api private
+        attr_reader :receiver_attribute
+
+        # Return attribute setter on a delegate
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :setter
+
+        # Return value to set on a delegate
+        #
+        # @return [any]
+        #
+        # @api private
+        attr_reader :value
+
+        # Initialize instance
+        #
+        # @param [Shale::Attribute] receiver_attribute
+        # @param [String] setter
+        # @param [any] value
+        #
+        # @api private
+        def initialize(receiver_attribute, setter, value)
+          @receiver_attribute = receiver_attribute
+          @setter = setter
+          @value = value
+        end
+      end
+
+      # Initialize instance
+      #
+      # @api private
+      def initialize
+        @delegates = []
+      end
+
+      # Add single value to delegate
+      #
+      # @param [Shale::Attribute] receiver_attribute
+      # @param [String] setter
+      # @param [any] value
+      #
+      # @api private
+      def add(receiver_attribute, setter, value)
+        @delegates << Delegate.new(receiver_attribute, setter, value)
+      end
+
+      # Add collection to delegate
+      #
+      # @param [Shale::Attribute] receiver_attribute
+      # @param [String] setter
+      # @param [any] value
+      #
+      # @api private
+      def add_collection(receiver_attribute, setter, value)
+        delegate = @delegates.find do |e|
+          e.receiver_attribute == receiver_attribute && e.setter == setter
+        end
+
+        if delegate
+          delegate.value << value
+        else
+          @delegates << Delegate.new(receiver_attribute, setter, [value])
+        end
+      end
+
+      # Iterate over delegates and yield a block
+      #
+      # @param [Proc] block
+      #
+      # @api private
+      def each(&block)
+        @delegates.each(&block)
+      end
+    end
+  end
+end

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

@@ -21,6 +21,13 @@ module Shale
         # @api private
         attr_reader :attribute
 
+        # Return receiver name
+        #
+        # @return [Symbol]
+        #
+        # @api private
+        attr_reader :receiver
+
         # Return method symbol
         #
         # @return [Symbol]
@@ -46,14 +53,16 @@ module Shale
         #
         # @param [String] name
         # @param [Symbol, nil] attribute
+        # @param [Symbol, nil] receiver
         # @param [Hash, nil] methods
         # @param [String, nil] group
         # @param [true, false] render_nil
         #
         # @api private
-        def initialize(name:, attribute:, methods:, group:, render_nil:)
+        def initialize(name:, attribute:, receiver:, methods:, group:, render_nil:)
           @name = name
           @attribute = attribute
+          @receiver = receiver
           @group = group
           @render_nil = render_nil
 

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

@@ -26,7 +26,8 @@ module Shale
         # Initialize instance
         #
         # @param [String] name
-        # @param [Symbol, String] attribute
+        # @param [Symbol, nil] attribute
+        # @param [Symbol, nil] receiver
         # @param [Hash, nil] methods
         # @param [String, nil] group
         # @param [Shale::Mapping::XmlNamespace] namespace
@@ -34,10 +35,20 @@ module Shale
         # @param [true, false] render_nil
         #
         # @api private
-        def initialize(name:, attribute:, methods:, group:, namespace:, cdata:, render_nil:)
+        def initialize(
+          name:,
+          attribute:,
+          receiver:,
+          methods:,
+          group:,
+          namespace:,
+          cdata:,
+          render_nil:
+        )
           super(
             name: name,
             attribute: attribute,
+            receiver: receiver,
             methods: methods,
             group: group,
             render_nil: render_nil

data/lib/shale/mapping/dict.rb

@@ -5,22 +5,32 @@ require_relative 'dict_group'
 
 module Shale
   module Mapping
-    # Mapping for dictionary serialization formats (Hash/JSON/YAML)
+    # Mapping for dictionary serialization formats (Hash/JSON/YAML/TOML/CSV)
     #
     # @api private
     class Dict < DictBase
       # Map key to attribute
       #
       # @param [String] key Document's key
-      # @param [Symbol, nil] to Object's attribute
+      # @param [Symbol, nil] to
+      # @param [Symbol, nil] receiver
       # @param [Hash, nil] using
-      # @param [true, false] render_nil
+      # @param [true, false, nil] render_nil
       #
       # @raise [IncorrectMappingArgumentsError] when arguments are incorrect
       #
       # @api private
-      def map(key, to: nil, using: nil, render_nil: false)
-        super(key, to: to, using: using, render_nil: render_nil)
+      def map(key, to: nil, receiver: nil, using: nil, render_nil: nil)
+        super(key, to: to, receiver: receiver, using: using, render_nil: render_nil)
+      end
+
+      # Set render_nil default
+      #
+      # @param [true, false] val
+      #
+      # @api private
+      def render_nil(val)
+        @render_nil_default = val
       end
 
       # Map group of keys to mapping methods

data/lib/shale/mapping/dict_base.rb

@@ -5,7 +5,7 @@ require_relative 'validator'
 
 module Shale
   module Mapping
-    # Base class for Mapping dictionary serialization formats (Hash/JSON/YAML)
+    # Base class for Mapping dictionary serialization formats (Hash/JSON/YAML/TOML/CSV)
     #
     # @api private
     class DictBase
@@ -18,31 +18,37 @@ module Shale
 
       # Initialize instance
       #
+      # @param [true, false] render_nil_default
+      #
       # @api private
-      def initialize
+      def initialize(render_nil_default: false)
         @keys = {}
         @finalized = false
+        @render_nil_default = render_nil_default
       end
 
       # Map key to attribute
       #
       # @param [String] key
       # @param [Symbol, nil] to
+      # @param [Symbol, nil] receiver
       # @param [Hash, nil] using
       # @param [String, nil] group
-      # @param [true, false] render_nil
+      # @param [true, false, nil] render_nil
       #
       # @raise [IncorrectMappingArgumentsError] when arguments are incorrect
       #
       # @api private
-      def map(key, to: nil, using: nil, group: nil, render_nil: false)
-        Validator.validate_arguments(key, to, using)
+      def map(key, to: nil, receiver: nil, using: nil, group: nil, render_nil: nil)
+        Validator.validate_arguments(key, to, receiver, using)
+
         @keys[key] = Descriptor::Dict.new(
           name: key,
           attribute: to,
+          receiver: receiver,
           methods: using,
           group: group,
-          render_nil: render_nil
+          render_nil: render_nil.nil? ? @render_nil_default : render_nil
         )
       end
 

data/lib/shale/mapping/dict_group.rb

@@ -4,7 +4,7 @@ require_relative 'dict_base'
 
 module Shale
   module Mapping
-    # Group for dictionary serialization formats (Hash/JSON/YAML)
+    # Group for dictionary serialization formats (Hash/JSON/YAML/TOML/CSV)
     #
     # @api private
     class DictGroup < DictBase

data/lib/shale/mapping/validator.rb

@@ -8,18 +8,25 @@ module Shale
       # Validate correctness of argument passed to map functions
       #
       # @param [String] key
-      # @param [Symbol] to
-      # @param [Hash] using
+      # @param [Symbol, nil] to
+      # @param [Symbol, nil] receiver
+      # @param [Hash, nil] using
       #
       # @raise [IncorrectMappingArgumentsError] when arguments are incorrect
       #
       # @api private
-      def self.validate_arguments(key, to, using)
+      def self.validate_arguments(key, to, receiver, using)
         if to.nil? && using.nil?
           msg = ":to or :using argument is required for mapping '#{key}'"
           raise IncorrectMappingArgumentsError, msg
         end
 
+        if to.nil? && !receiver.nil?
+          msg = ":receiver argument for mapping '#{key}' " \
+                'can only be used together with :to argument'
+          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