shale 0.2.2 → 0.3.0

data/lib/shale/type/composite.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+require_relative 'value'
 
 module Shale
   module Type
@@ -8,7 +8,7 @@ module Shale
     # It serves as a base type class for @see Shale::Mapper
     #
     # @api private
-    class Composite < Base
+    class Composite < Value
       class << self
         %i[hash json yaml].each do |format|
           class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
@@ -19,7 +19,7 @@ module Shale
             # @return [Shale::Mapper]
             #
             # @api public
-            def out_of_#{format}(hash)
+            def of_#{format}(hash)
               instance = new
 
               mapping_keys = #{format}_mapping.keys
@@ -28,10 +28,10 @@ module Shale
                 mapping = mapping_keys[key]
                 next unless mapping
 
-                if mapping.is_a?(Hash)
-                  instance.send(mapping[:from], value)
+                if mapping.method_from
+                  instance.send(mapping.method_from, value)
                 else
-                  attribute = attributes[mapping]
+                  attribute = attributes[mapping.attribute]
                   next unless attribute
 
                   if value.nil?
@@ -41,11 +41,11 @@ module Shale
 
                   if attribute.collection?
                     [*value].each do |val|
-                      val = val ? attribute.type.out_of_#{format}(val) : val
+                      val = val ? attribute.type.of_#{format}(val) : val
                       instance.public_send(attribute.name) << attribute.type.cast(val)
                     end
                   else
-                    val = attribute.type.out_of_#{format}(value)
+                    val = attribute.type.of_#{format}(value)
                     instance.public_send("\#{attribute.name}=", val)
                   end
                 end
@@ -56,7 +56,7 @@ module Shale
 
             # Convert Object to Hash using Hash/JSON/YAML mapping
             #
-            # @param [Shale::Type::Base] instance Object to convert
+            # @param [Shale::Mapper] instance Object to convert
             #
             # @return [Hash]
             #
@@ -64,24 +64,26 @@ module Shale
             def as_#{format}(instance)
               hash = {}
 
-              instance.class.#{format}_mapping.keys.each do |key, attr|
-                if attr.is_a?(Hash)
-                  hash[key] = instance.send(attr[:to])
+              instance.class.#{format}_mapping.keys.each_value do |mapping|
+                if mapping.method_to
+                  hash[mapping.name] = instance.send(mapping.method_to)
                 else
-                  attribute = instance.class.attributes[attr]
+                  attribute = instance.class.attributes[mapping.attribute]
                   next unless attribute
 
                   value = instance.public_send(attribute.name)
 
                   if value.nil?
-                    hash[key] = nil
+                    hash[mapping.name] = nil
                     next
                   end
 
                   if attribute.collection?
-                    hash[key] = [*value].map { |v| v ? attribute.type.as_#{format}(v) : v }
+                    hash[mapping.name] = [*value].map do |v|
+                      v ? attribute.type.as_#{format}(v) : v
+                    end
                   else
-                    hash[key] = attribute.type.as_#{format}(value)
+                    hash[mapping.name] = attribute.type.as_#{format}(value)
                   end
                 end
               end
@@ -91,7 +93,7 @@ module Shale
           RUBY
         end
 
-        alias from_hash out_of_hash
+        alias from_hash of_hash
 
         alias to_hash as_hash
 
@@ -103,18 +105,19 @@ module Shale
         #
         # @api public
         def from_json(json)
-          out_of_json(Shale.json_adapter.load(json))
+          of_json(Shale.json_adapter.load(json))
         end
 
         # Convert Object to JSON
         #
-        # @param [Shale::Type::Base] instance Object to convert
+        # @param [Shale::Mapper] instance Object to convert
+        # @param [Array<Symbol>] options
         #
         # @return [String]
         #
         # @api public
-        def to_json(instance)
-          Shale.json_adapter.dump(as_json(instance))
+        def to_json(instance, *options)
+          Shale.json_adapter.dump(as_json(instance), *options)
         end
 
         # Convert YAML to Object
@@ -125,12 +128,12 @@ module Shale
         #
         # @api public
         def from_yaml(yaml)
-          out_of_yaml(Shale.yaml_adapter.load(yaml))
+          of_yaml(Shale.yaml_adapter.load(yaml))
         end
 
         # Convert Object to YAML
         #
-        # @param [Shale::Type::Base] instance Object to convert
+        # @param [Shale::Mapper] instance Object to convert
         #
         # @return [String]
         #
@@ -146,17 +149,17 @@ module Shale
         # @return [Shale::Mapper]
         #
         # @api public
-        def out_of_xml(element)
+        def of_xml(element)
           instance = new
 
           element.attributes.each do |key, value|
             mapping = xml_mapping.attributes[key.to_s]
             next unless mapping
 
-            if mapping.is_a?(Hash)
-              instance.send(mapping[:from], value)
+            if mapping.method_from
+              instance.send(mapping.method_from, value)
             else
-              attribute = attributes[mapping]
+              attribute = attributes[mapping.attribute]
               next unless attribute
 
               if attribute.collection?
@@ -171,7 +174,7 @@ module Shale
             attribute = attributes[xml_mapping.content]
 
             if attribute
-              instance.public_send("#{attribute.name}=", attribute.type.out_of_xml(element))
+              instance.public_send("#{attribute.name}=", attribute.type.of_xml(element))
             end
           end
 
@@ -179,17 +182,17 @@ module Shale
             mapping = xml_mapping.elements[node.name]
             next unless mapping
 
-            if mapping.is_a?(Hash)
-              instance.send(mapping[:from], node)
+            if mapping.method_from
+              instance.send(mapping.method_from, node)
             else
-              attribute = attributes[mapping]
+              attribute = attributes[mapping.attribute]
               next unless attribute
 
               if attribute.collection?
-                value = attribute.type.out_of_xml(node)
+                value = attribute.type.of_xml(node)
                 instance.public_send(attribute.name) << attribute.type.cast(value)
               else
-                instance.public_send("#{attribute.name}=", attribute.type.out_of_xml(node))
+                instance.public_send("#{attribute.name}=", attribute.type.of_xml(node))
               end
             end
           end
@@ -205,12 +208,12 @@ module Shale
         #
         # @api public
         def from_xml(xml)
-          out_of_xml(Shale.xml_adapter.load(xml))
+          of_xml(Shale.xml_adapter.load(xml))
         end
 
         # Convert Object to XML document
         #
-        # @param [Shale::Type::Base] instance Object to convert
+        # @param [Shale::Mapper] instance Object to convert
         # @param [String, nil] node_name XML node name
         # @param [Shale::Adapter::<xml adapter>::Document, nil] doc Object to convert
         #
@@ -220,23 +223,25 @@ module Shale
         def as_xml(instance, node_name = nil, doc = nil)
           unless doc
             doc = Shale.xml_adapter.create_document
-            doc.add_element(doc.doc, as_xml(instance, instance.class.xml_mapping.root, doc))
+            doc.add_element(doc.doc, as_xml(instance, xml_mapping.prefixed_root, doc))
             return doc.doc
           end
 
           element = doc.create_element(node_name)
+          doc.add_namespace(xml_mapping.default_namespace.prefix, xml_mapping.default_namespace.name)
 
-          xml_mapping.attributes.each do |xml_attr, obj_attr|
-            if obj_attr.is_a?(Hash)
-              instance.send(obj_attr[:to], element, doc)
+          xml_mapping.attributes.each_value do |mapping|
+            if mapping.method_to
+              instance.send(mapping.method_to, element, doc)
             else
-              attribute = instance.class.attributes[obj_attr]
+              attribute = instance.class.attributes[mapping.attribute]
               next unless attribute
 
               value = instance.public_send(attribute.name)
               next if value.nil?
 
-              doc.add_attribute(element, xml_attr, value)
+              doc.add_namespace(mapping.namespace.prefix, mapping.namespace.name)
+              doc.add_attribute(element, mapping.prefixed_name, value)
             end
           end
 
@@ -249,23 +254,25 @@ module Shale
             end
           end
 
-          xml_mapping.elements.each do |xml_name, obj_attr|
-            if obj_attr.is_a?(Hash)
-              instance.send(obj_attr[:to], element, doc)
+          xml_mapping.elements.each_value do |mapping|
+            if mapping.method_to
+              instance.send(mapping.method_to, element, doc)
             else
-              attribute = instance.class.attributes[obj_attr]
+              attribute = instance.class.attributes[mapping.attribute]
               next unless attribute
 
               value = instance.public_send(attribute.name)
               next if value.nil?
 
+              doc.add_namespace(mapping.namespace.prefix, mapping.namespace.name)
+
               if attribute.collection?
                 [*value].each do |v|
                   next if v.nil?
-                  doc.add_element(element, attribute.type.as_xml(v, xml_name, doc))
+                  doc.add_element(element, attribute.type.as_xml(v, mapping.prefixed_name, doc))
                 end
               else
-                doc.add_element(element, attribute.type.as_xml(value, xml_name, doc))
+                doc.add_element(element, attribute.type.as_xml(value, mapping.prefixed_name, doc))
               end
             end
           end
@@ -275,13 +282,14 @@ module Shale
 
         # Convert Object to XML
         #
-        # @param [Shale::Type::Base] instance Object to convert
+        # @param [Shale::Mapper] instance Object to convert
+        # @param [Array<Symbol>] options
         #
         # @return [String]
         #
         # @api public
-        def to_xml(instance)
-          Shale.xml_adapter.dump(as_xml(instance))
+        def to_xml(instance, *options)
+          Shale.xml_adapter.dump(as_xml(instance), *options)
         end
       end
 
@@ -296,11 +304,13 @@ module Shale
 
       # Convert Object to JSON
       #
+      # @param [Array<Symbol>] options
+      #
       # @return [String]
       #
       # @api public
-      def to_json
-        self.class.to_json(self)
+      def to_json(*options)
+        self.class.to_json(self, *options)
       end
 
       # Convert Object to YAML
@@ -314,11 +324,13 @@ module Shale
 
       # Convert Object to XML
       #
+      # @param [Array<Symbol>] options
+      #
       # @return [String]
       #
       # @api public
-      def to_xml
-        self.class.to_xml(self)
+      def to_xml(*options)
+        self.class.to_xml(self, *options)
       end
     end
   end

data/lib/shale/type/date.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require 'date'
-require_relative 'base'
+require_relative 'value'
 
 module Shale
   module Type
     # Cast value to Date
     #
     # @api public
-    class Date < Base
+    class Date < Value
       # @param [any] value Value to cast
       #
       # @return [Date, nil]
@@ -24,6 +24,39 @@ module Shale
           value
         end
       end
+
+      # Use ISO 8601 format in JSON document
+      #
+      # @param [Date] value
+      #
+      # @return [String]
+      #
+      # @api private
+      def self.as_json(value)
+        value&.iso8601
+      end
+
+      # Use ISO 8601 format in YAML document
+      #
+      # @param [Date] value
+      #
+      # @return [String]
+      #
+      # @api private
+      def self.as_yaml(value)
+        value&.iso8601
+      end
+
+      # Use ISO 8601 format in XML document
+      #
+      # @param [Date] value Value to convert to XML
+      #
+      # @return [String]
+      #
+      # @api private
+      def self.as_xml_value(value)
+        value&.iso8601
+      end
     end
   end
 end

data/lib/shale/type/float.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+require_relative 'value'
 
 module Shale
   module Type
     # Cast value to Float
     #
     # @api public
-    class Float < Base
+    class Float < Value
       # @param [#to_f, String, nil] value Value to cast
       #
       # @return [Float, nil]

data/lib/shale/type/integer.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+require_relative 'value'
 
 module Shale
   module Type
     # Cast value to Integer
     #
     # @api public
-    class Integer < Base
+    class Integer < Value
       # @param [#to_i, nil] value Value to cast
       #
       # @return [Integer, nil]

data/lib/shale/type/string.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+require_relative 'value'
 
 module Shale
   module Type
     # Cast value to String
     #
     # @api public
-    class String < Base
+    class String < Value
       # @param [#to_s, nil] value Value to cast
       #
       # @return [String, nil]

data/lib/shale/type/time.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require 'time'
-require_relative 'base'
+require_relative 'value'
 
 module Shale
   module Type
     # Cast value to Time
     #
     # @api public
-    class Time < Base
+    class Time < Value
       # @param [any] value Value to cast
       #
       # @return [Time, nil]
@@ -24,6 +24,39 @@ module Shale
           value
         end
       end
+
+      # Use ISO 8601 format in JSON document
+      #
+      # @param [Time] value
+      #
+      # @return [String]
+      #
+      # @api private
+      def self.as_json(value)
+        value&.iso8601
+      end
+
+      # Use ISO 8601 format in YAML document
+      #
+      # @param [Time] value
+      #
+      # @return [String]
+      #
+      # @api private
+      def self.as_yaml(value)
+        value&.iso8601
+      end
+
+      # Use ISO 8601 format in XML document
+      #
+      # @param [Time] value Value to convert to XML
+      #
+      # @return [String]
+      #
+      # @api private
+      def self.as_xml_value(value)
+        value&.iso8601
+      end
     end
   end
 end

data/lib/shale/type/{base.rb → value.rb}

@@ -5,12 +5,12 @@ module Shale
     # Base class for all types
     #
     # @example
-    #   class MyType < Shale::Type::Base
+    #   class MyType < Shale::Type::Value
     #     ... overwrite methods as needed
     #   end
     #
     # @api public
-    class Base
+    class Value
       class << self
         # Cast raw value to a type. Base form just returns whatever it receives
         #
@@ -30,7 +30,7 @@ module Shale
         # @return [any]
         #
         # @api private
-        def out_of_hash(value)
+        def of_hash(value)
           value
         end
 
@@ -52,7 +52,7 @@ module Shale
         # @return [any]
         #
         # @api private
-        def out_of_json(value)
+        def of_json(value)
           value
         end
 
@@ -74,7 +74,7 @@ module Shale
         # @return [any]
         #
         # @api private
-        def out_of_yaml(value)
+        def of_yaml(value)
           value
         end
 
@@ -96,20 +96,31 @@ module Shale
         # @return [String]
         #
         # @api private
-        def out_of_xml(node)
+        def of_xml(node)
           node.text
         end
 
         # Convert value to form accepted by XML document
         #
         # @param [#to_s] value Value to convert to XML
+        #
+        # @return [String]
+        #
+        # @api private
+        def as_xml_value(value)
+          value.to_s
+        end
+
+        # Convert value to XML element
+        #
+        # @param [#to_s] value Value to convert to XML
         # @param [String] name Name of the element
         # @param [Shale::Adapter::<XML adapter>::Document] doc Document
         #
         # @api private
         def as_xml(value, name, doc)
           element = doc.create_element(name)
-          doc.add_text(element, value.to_s)
+          doc.add_text(element, as_xml_value(value))
           element
         end
       end

data/lib/shale/utils.rb

@@ -11,15 +11,31 @@ module Shale
     #
     # @example
     #   Shale::Utils.underscore('FooBar') # => foo_bar
-    #   Shale::Utils.underscore('Namespace::FooBar') # => namespace:foo_bar
+    #   Shale::Utils.underscore('Namespace::FooBar') # => foo_bar
     #
     # @api private
     def self.underscore(word)
       word
-        .gsub('::', ':')
+        .split('::')
+        .last
         .gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
         .gsub(/([a-z\d])([A-Z])/, '\1_\2')
         .downcase
     end
+
+    # Return value or nil if value is empty
+    #
+    # @param [String] value
+    #
+    # @example
+    #   Shale::Utils.presence('FooBar') # => FooBar
+    #   Shale::Utils.presence('') # => nil
+    #
+    # @api private
+    def self.presence(value)
+      return nil unless value
+      return nil if value.empty?
+      value
+    end
   end
 end

data/lib/shale/version.rb

@@ -2,5 +2,5 @@
 
 module Shale
   # @api private
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/shale.rb

@@ -2,16 +2,16 @@
 
 require 'yaml'
 
-require 'shale/mapper'
-require 'shale/adapter/json'
-require 'shale/adapter/rexml'
-require 'shale/type/boolean'
-require 'shale/type/date'
-require 'shale/type/float'
-require 'shale/type/integer'
-require 'shale/type/string'
-require 'shale/type/time'
-require 'shale/version'
+require_relative 'shale/mapper'
+require_relative 'shale/adapter/json'
+require_relative 'shale/adapter/rexml'
+require_relative 'shale/type/boolean'
+require_relative 'shale/type/date'
+require_relative 'shale/type/float'
+require_relative 'shale/type/integer'
+require_relative 'shale/type/string'
+require_relative 'shale/type/time'
+require_relative 'shale/version'
 
 # Main library namespace
 #

data/shale.gemspec

@@ -10,17 +10,21 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'Ruby object mapper and serializer for XML, JSON and YAML.'
   spec.description = 'Ruby object mapper and serializer for XML, JSON and YAML.'
-  spec.homepage = 'https://github.com/kgiszczak/shale'
+  spec.homepage = 'https://shalerb.org'
   spec.license = 'MIT'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.metadata['homepage_uri'] = 'https://github.com/kgiszczak/shale'
+  spec.metadata['homepage_uri'] = 'https://shalerb.org'
   spec.metadata['source_code_uri'] = 'https://github.com/kgiszczak/shale'
   spec.metadata['changelog_uri'] = 'https://github.com/kgiszczak/shale/blob/master/CHANGELOG.md'
   spec.metadata['bug_tracker_uri'] = 'https://github.com/kgiszczak/shale/issues'
 
   spec.files = Dir['CHANGELOG.md', 'LICENSE.txt', 'README.md', 'shale.gemspec', 'lib/**/*']
   spec.require_paths = ['lib']
+
+  spec.bindir = 'exe'
+  spec.executables = 'shaleb'
+
   spec.required_ruby_version = '>= 2.6.0'
 end