shale 0.9.0 → 1.1.0

data/lib/shale/type/complex.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../error'
+require_relative '../mapping/delegates'
 require_relative '../mapping/group/dict_grouping'
 require_relative '../mapping/group/xml_grouping'
 require_relative 'value'
@@ -47,6 +48,7 @@ module Shale
 
               mapping_keys = #{format}_mapping.keys
               grouping = Shale::Mapping::Group::DictGrouping.new
+              delegates = Shale::Mapping::Delegates.new
 
               only = to_partial_render_attributes(only)
               except = to_partial_render_attributes(except)
@@ -66,7 +68,8 @@ module Shale
                     mapper.send(mapping.method_from, instance, value)
                   end
                 else
-                  attribute = attributes[mapping.attribute]
+                  receiver_attributes = get_receiver_attributes(mapping)
+                  attribute = receiver_attributes[mapping.attribute]
                   next unless attribute
 
                   if only
@@ -79,20 +82,22 @@ module Shale
                     next if except.key?(attribute.name) && attribute_except.nil?
                   end
 
+                  casted_value = nil
+
                   if value.nil?
-                    instance.send(attribute.setter, nil)
+                    casted_value = nil
                   elsif attribute.collection?
-                    [*value].each do |val|
-                      if val
+                    casted_value = (value.is_a?(Array) ? value : [value]).map do |val|
+                      unless val.nil?
                         val = attribute.type.of_#{format}(
                           val,
                           only: attribute_only,
                           except: attribute_except,
                           context: context
                         )
-                      end
 
-                      instance.send(attribute.name) << attribute.type.cast(val)
+                        attribute.type.cast(val)
+                      end
                     end
                   else
                     val = attribute.type.of_#{format}(
@@ -101,11 +106,23 @@ module Shale
                       except: attribute_except,
                       context: context
                     )
-                    instance.send(attribute.setter, attribute.type.cast(val))
+
+                    casted_value = attribute.type.cast(val)
+                  end
+
+                  if mapping.receiver
+                    delegates.add(attributes[mapping.receiver], attribute.setter, casted_value)
+                  else
+                    instance.send(attribute.setter, casted_value)
                   end
                 end
               end
 
+              delegates.each do |delegate|
+                receiver = get_receiver(instance, delegate.receiver_attribute)
+                receiver.send(delegate.setter, delegate.value)
+              end
+
               grouping.each do |group|
                 mapper = new
 
@@ -167,7 +184,14 @@ module Shale
                     mapper.send(mapping.method_to, instance, hash)
                   end
                 else
-                  attribute = attributes[mapping.attribute]
+                  if mapping.receiver
+                    receiver = instance.send(mapping.receiver)
+                  else
+                    receiver = instance
+                  end
+
+                  receiver_attributes = get_receiver_attributes(mapping)
+                  attribute = receiver_attributes[mapping.attribute]
                   next unless attribute
 
                   if only
@@ -180,7 +204,7 @@ module Shale
                     next if except.key?(attribute.name) && attribute_except.nil?
                   end
 
-                  value = instance.send(attribute.name)
+                  value = receiver.send(attribute.name) if receiver
 
                   if value.nil?
                     hash[mapping.name] = nil if mapping.render_nil?
@@ -349,6 +373,7 @@ module Shale
         #
         # @api public
         def from_csv(csv, only: nil, except: nil, context: nil, headers: false, **csv_options)
+          validate_csv_adapter
           data = Shale.csv_adapter.load(csv, **csv_options.merge(headers: csv_mapping.keys.keys))
 
           data.shift if headers
@@ -374,6 +399,7 @@ module Shale
         #
         # @api public
         def to_csv(instance, only: nil, except: nil, context: nil, headers: false, **csv_options)
+          validate_csv_adapter
           data = as_csv([*instance], only: only, except: except, context: context)
 
           cols = csv_mapping.keys.values
@@ -414,6 +440,7 @@ module Shale
             .each { |attr| instance.send(attr.setter, attr.default.call) }
 
           grouping = Shale::Mapping::Group::XmlGrouping.new
+          delegates = Shale::Mapping::Delegates.new
 
           only = to_partial_render_attributes(only)
           except = to_partial_render_attributes(except)
@@ -433,16 +460,29 @@ module Shale
                 mapper.send(mapping.method_from, instance, value)
               end
             else
-              attribute = attributes[mapping.attribute]
+              receiver_attributes = get_receiver_attributes(mapping)
+              attribute = receiver_attributes[mapping.attribute]
               next unless attribute
 
               next if only && !only.key?(attribute.name)
               next if except&.key?(attribute.name)
 
+              casted_value = attribute.type.cast(value)
+
               if attribute.collection?
-                instance.send(attribute.name) << attribute.type.cast(value)
+                if mapping.receiver
+                  delegates.add_collection(
+                    attributes[mapping.receiver],
+                    attribute.setter,
+                    casted_value
+                  )
+                else
+                  instance.send(attribute.name) << casted_value
+                end
+              elsif mapping.receiver
+                delegates.add(attributes[mapping.receiver], attribute.setter, casted_value)
               else
-                instance.send(attribute.setter, attribute.type.cast(value))
+                instance.send(attribute.setter, casted_value)
               end
             end
           end
@@ -461,7 +501,8 @@ module Shale
                 mapper.send(content_mapping.method_from, instance, element)
               end
             else
-              attribute = attributes[content_mapping.attribute]
+              receiver_attributes = get_receiver_attributes(content_mapping)
+              attribute = receiver_attributes[content_mapping.attribute]
 
               if attribute
                 skip = false
@@ -471,8 +512,13 @@ module Shale
                 skip = true if except&.key?(attribute.name)
 
                 unless skip
-                  value = attribute.type.of_xml(element)
-                  instance.send(attribute.setter, attribute.type.cast(value))
+                  value = attribute.type.cast(attribute.type.of_xml(element))
+
+                  if content_mapping.receiver
+                    delegates.add(attributes[content_mapping.receiver], attribute.setter, value)
+                  else
+                    instance.send(attribute.setter, value)
+                  end
                 end
                 # rubocop:enable Metrics/BlockNesting
               end
@@ -494,7 +540,8 @@ module Shale
                 mapper.send(mapping.method_from, instance, node)
               end
             else
-              attribute = attributes[mapping.attribute]
+              receiver_attributes = get_receiver_attributes(mapping)
+              attribute = receiver_attributes[mapping.attribute]
               next unless attribute
 
               if only
@@ -514,14 +561,31 @@ module Shale
                 context: context
               )
 
+              casted_value = attribute.type.cast(value)
+
               if attribute.collection?
-                instance.send(attribute.name) << attribute.type.cast(value)
+                if mapping.receiver
+                  delegates.add_collection(
+                    attributes[mapping.receiver],
+                    attribute.setter,
+                    casted_value
+                  )
+                else
+                  instance.send(attribute.name) << casted_value
+                end
+              elsif mapping.receiver
+                delegates.add(attributes[mapping.receiver], attribute.setter, casted_value)
               else
-                instance.send(attribute.setter, attribute.type.cast(value))
+                instance.send(attribute.setter, casted_value)
               end
             end
           end
 
+          delegates.each do |delegate|
+            receiver = get_receiver(instance, delegate.receiver_attribute)
+            receiver.send(delegate.setter, delegate.value)
+          end
+
           grouping.each do |group|
             mapper = new
 
@@ -626,13 +690,20 @@ module Shale
                 mapper.send(mapping.method_to, instance, element, doc)
               end
             else
-              attribute = attributes[mapping.attribute]
+              if mapping.receiver
+                receiver = instance.send(mapping.receiver)
+              else
+                receiver = instance
+              end
+
+              receiver_attributes = get_receiver_attributes(mapping)
+              attribute = receiver_attributes[mapping.attribute]
               next unless attribute
 
               next if only && !only.key?(attribute.name)
               next if except&.key?(attribute.name)
 
-              value = instance.send(attribute.name)
+              value = receiver.send(attribute.name) if receiver
 
               if mapping.render_nil? || !value.nil?
                 doc.add_namespace(mapping.namespace.prefix, mapping.namespace.name)
@@ -655,7 +726,14 @@ module Shale
                 mapper.send(content_mapping.method_to, instance, element, doc)
               end
             else
-              attribute = attributes[content_mapping.attribute]
+              if content_mapping.receiver
+                receiver = instance.send(content_mapping.receiver)
+              else
+                receiver = instance
+              end
+
+              receiver_attributes = get_receiver_attributes(content_mapping)
+              attribute = receiver_attributes[content_mapping.attribute]
 
               if attribute
                 skip = false
@@ -665,7 +743,7 @@ module Shale
                 skip = true if except&.key?(attribute.name)
 
                 unless skip
-                  value = instance.send(attribute.name)
+                  value = receiver.send(attribute.name) if receiver
 
                   if content_mapping.cdata
                     doc.create_cdata(value.to_s, element)
@@ -690,7 +768,14 @@ module Shale
                 mapper.send(mapping.method_to, instance, element, doc)
               end
             else
-              attribute = attributes[mapping.attribute]
+              if mapping.receiver
+                receiver = instance.send(mapping.receiver)
+              else
+                receiver = instance
+              end
+
+              receiver_attributes = get_receiver_attributes(mapping)
+              attribute = receiver_attributes[mapping.attribute]
               next unless attribute
 
               if only
@@ -703,7 +788,7 @@ module Shale
                 next if except.key?(attribute.name) && attribute_except.nil?
               end
 
-              value = instance.send(attribute.name)
+              value = receiver.send(attribute.name) if receiver
 
               if mapping.render_nil? || !value.nil?
                 doc.add_namespace(mapping.namespace.prefix, mapping.namespace.name)
@@ -809,6 +894,15 @@ module Shale
           raise AdapterError, XML_ADAPTER_NOT_SET_MESSAGE unless Shale.xml_adapter
         end
 
+        # Validate CSV adapter
+        #
+        # @raise [AdapterError]
+        #
+        # @api private
+        def validate_csv_adapter
+          raise AdapterError, CSV_ADAPTER_NOT_SET_MESSAGE unless Shale.csv_adapter
+        end
+
         # Convert array with attributes to a hash
         #
         # @param [Array] ary
@@ -827,6 +921,64 @@ module Shale
             end
           end.to_h
         end
+
+        # Get receiver attributes for given mapping
+        #
+        # @param [Shale::Mapping::Descriptor::Dict] mapping
+        #
+        # @raise [AttributeNotDefinedError]
+        # @raise [NotAShaleMapperError]
+        #
+        # @return [Hash<Symbol, Shale::Attribute>]
+        #
+        # @api private
+        def get_receiver_attributes(mapping)
+          return attributes unless mapping.receiver
+
+          receiver_attribute = attributes[mapping.receiver]
+
+          unless receiver_attribute
+            msg = "attribute '#{mapping.receiver}' is not defined on #{self} mapper"
+            raise AttributeNotDefinedError, msg
+          end
+
+          unless receiver_attribute.type < Mapper
+            msg = "attribute '#{mapping.receiver}' is not a descendant of Shale::Mapper type"
+            raise NotAShaleMapperError, msg
+          end
+
+          if receiver_attribute.collection?
+            msg = "attribute '#{mapping.receiver}' can't be a collection"
+            raise NotAShaleMapperError, msg
+          end
+
+          receiver_attribute.type.attributes
+        end
+
+        # Get receiver for given mapping
+        #
+        # @param [any] instance
+        # @param [Shale::Attribute] receiver_attribute
+        #
+        # @return [Array]
+        #
+        # @api private
+        def get_receiver(instance, receiver_attribute)
+          receiver = instance.send(receiver_attribute.name)
+
+          unless receiver
+            receiver = receiver_attribute.type.model.new
+
+            receiver_attribute.type.attributes
+              .values
+              .select { |attr| attr.default }
+              .each { |attr| receiver.send(attr.setter, attr.default.call) }
+
+            instance.send(receiver_attribute.setter, receiver)
+          end
+
+          receiver
+        end
       end
 
       # Convert Object to Hash

data/lib/shale/utils.rb

@@ -5,6 +5,21 @@ module Shale
   #
   # @api private
   module Utils
+    # Upcase first letter of a string
+    #
+    # @param [String] val
+    #
+    # @example
+    #   Shale::Utils.upcase_first('fooBar')
+    #   # => 'FooBar'
+    #
+    # @api private
+    def self.upcase_first(str)
+      return '' unless str
+      return '' if str.empty?
+      str[0].upcase + str[1..-1]
+    end
+
     # Convert string to Ruby's class naming convention
     #
     # @param [String] val
@@ -15,13 +30,14 @@ module Shale
     #
     # @api private
     def self.classify(str)
-      str = str.to_s.sub(/.*\./, '')
+      # names may include a period, which will need to be stripped out
+      str = str.to_s.gsub('.', '')
 
-      str = str.sub(/^[a-z\d]*/) { |match| match.capitalize || match }
+      str = str.sub(/^[a-z\d]*/) { |match| upcase_first(match) || match }
 
-      str.gsub(%r{(?:_|-|(/))([a-z\d]*)}i) do
+      str.gsub('::', '/').gsub(%r{(?:_|-|(/))([a-z\d]*)}i) do
         word = Regexp.last_match(2)
-        substituted = word.capitalize || word
+        substituted = upcase_first(word) || word
         Regexp.last_match(1) ? "::#{substituted}" : substituted
       end
     end
@@ -36,6 +52,8 @@ module Shale
     #
     # @api private
     def self.snake_case(str)
+      # XML elements allow periods and hyphens
+      str = str.to_s.gsub('.', '_')
       return str.to_s unless /[A-Z-]|::/.match?(str)
       word = str.to_s.gsub('::', '/')
       word = word.gsub(/([A-Z]+)(?=[A-Z][a-z])|([a-z\d])(?=[A-Z])/) do

data/lib/shale/version.rb

@@ -2,5 +2,5 @@
 
 module Shale
   # @api private
-  VERSION = '0.9.0'
+  VERSION = '1.1.0'
 end

data/lib/shale.rb

@@ -3,7 +3,6 @@
 require 'yaml'
 
 require_relative 'shale/mapper'
-require_relative 'shale/adapter/csv'
 require_relative 'shale/adapter/json'
 require_relative 'shale/type/boolean'
 require_relative 'shale/type/date'
@@ -52,6 +51,12 @@ require_relative 'shale/version'
 #   Shale.xml_adapter = Shale::Adapter::Ox
 #   Shale.xml_adapter # => Shale::Adapter::Ox
 #
+# @example setting CSV adapter for handling CSV documents
+#   require 'shale/adapter/csv'
+#
+#   Shale.csv_adapter = Shale::Adapter::CSV
+#   Shale.csv_adapter # => Shale::Adapter::CSV
+#
 # @api public
 module Shale
   class << self
@@ -93,11 +98,15 @@ module Shale
     #
     # @param [.load, .dump] adapter
     #
-    # @example
+    # @example setting adapter
     #   Shale.csv_adapter = Shale::Adapter::CSV
     #
+    # @example getting adapter
+    #   Shale.csv_adapter
+    #   # => Shale::Adapter::CSV
+    #
     # @api public
-    attr_writer :csv_adapter
+    attr_accessor :csv_adapter
 
     # XML adapter accessor. Available adapters are Shale::Adapter::REXML,
     # Shale::Adapter::Nokogiri and Shale::Adapter::Ox
@@ -139,18 +148,5 @@ module Shale
     def yaml_adapter
       @yaml_adapter || YAML
     end
-
-    # Return CSV adapter. By default CSV is used
-    #
-    # @return [.load, .dump]
-    #
-    # @example
-    #   Shale.csv_adapter
-    #   # => Shale::Adapter::CSV
-    #
-    # @api public
-    def csv_adapter
-      @csv_adapter || Adapter::CSV
-    end
   end
 end

data/shale.gemspec

@@ -26,5 +26,7 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = 'shaleb'
 
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.add_runtime_dependency 'bigdecimal'
+
+  spec.required_ruby_version = '>= 3.0.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: shale
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kamil Giszczak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
-dependencies: []
+date: 2024-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby object mapper and serializer for XML, JSON, TOML, CSV and YAML.
 email:
 - beerkg@gmail.com
@@ -38,6 +52,7 @@ files:
 - lib/shale/attribute.rb
 - lib/shale/error.rb
 - lib/shale/mapper.rb
+- lib/shale/mapping/delegates.rb
 - lib/shale/mapping/descriptor/dict.rb
 - lib/shale/mapping/descriptor/xml.rb
 - lib/shale/mapping/descriptor/xml_namespace.rb
@@ -117,14 +132,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Ruby object mapper and serializer for XML, JSON, TOML, CSV and YAML.