shale 0.4.0 → 0.7.0

data/lib/shale/type/value.rb

@@ -30,7 +30,7 @@ module Shale
         # @return [any]
         #
         # @api private
-        def of_hash(value)
+        def of_hash(value, **)
           value
         end
 
@@ -41,7 +41,7 @@ module Shale
         # @return [any]
         #
         # @api private
-        def as_hash(value)
+        def as_hash(value, **)
           value
         end
 
@@ -52,7 +52,7 @@ module Shale
         # @return [any]
         #
         # @api private
-        def of_json(value)
+        def of_json(value, **)
           value
         end
 
@@ -63,7 +63,7 @@ module Shale
         # @return [any]
         #
         # @api private
-        def as_json(value)
+        def as_json(value, **)
           value
         end
 
@@ -74,7 +74,7 @@ module Shale
         # @return [any]
         #
         # @api private
-        def of_yaml(value)
+        def of_yaml(value, **)
           value
         end
 
@@ -85,7 +85,29 @@ module Shale
         # @return [any]
         #
         # @api private
-        def as_yaml(value)
+        def as_yaml(value, **)
+          value
+        end
+
+        # Extract value from TOML document
+        #
+        # @param [any] value
+        #
+        # @return [any]
+        #
+        # @api private
+        def of_toml(value, **)
+          value
+        end
+
+        # Convert value to form accepted by TOML document
+        #
+        # @param [any] value
+        #
+        # @return [any]
+        #
+        # @api private
+        def as_toml(value, **)
           value
         end
 
@@ -96,7 +118,7 @@ module Shale
         # @return [String]
         #
         # @api private
-        def of_xml(node)
+        def of_xml(node, **)
           node.text
         end
 
@@ -116,11 +138,18 @@ module Shale
         # @param [#to_s] value Value to convert to XML
         # @param [String] name Name of the element
         # @param [Shale::Adapter::<XML adapter>::Document] doc Document
+        # @param [true, false] cdata
         #
         # @api private
-        def as_xml(value, name, doc)
+        def as_xml(value, name, doc, cdata = false, **)
           element = doc.create_element(name)
-          doc.add_text(element, as_xml_value(value))
+
+          if cdata
+            doc.create_cdata(as_xml_value(value), element)
+          else
+            doc.add_text(element, as_xml_value(value))
+          end
+
           element
         end
       end

data/lib/shale/utils.rb

@@ -5,6 +5,46 @@ module Shale
   #
   # @api private
   module Utils
+    # Convert string to Ruby's class naming convention
+    #
+    # @param [String] val
+    #
+    # @example
+    #   Shale::Utils.classify('foobar')
+    #   # => 'Foobar'
+    #
+    # @api private
+    def self.classify(str)
+      str = str.to_s.sub(/.*\./, '')
+
+      str = str.sub(/^[a-z\d]*/) { |match| match.capitalize || match }
+
+      str.gsub(%r{(?:_|-|(/))([a-z\d]*)}i) do
+        word = Regexp.last_match(2)
+        substituted = word.capitalize || word
+        Regexp.last_match(1) ? "::#{substituted}" : substituted
+      end
+    end
+
+    # Convert string to snake case
+    #
+    # @param [String] val
+    #
+    # @example
+    #   Shale::Utils.snake_case('FooBar')
+    #   # => 'foo_bar'
+    #
+    # @api private
+    def self.snake_case(str)
+      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
+        "#{Regexp.last_match(1) || Regexp.last_match(2)}_"
+      end
+      word = word.tr('-', '_')
+      word.downcase
+    end
+
     # Convert word to under score
     #
     # @param [String] word
@@ -14,13 +54,8 @@ module Shale
     #   Shale::Utils.underscore('Namespace::FooBar') # => foo_bar
     #
     # @api private
-    def self.underscore(word)
-      word
-        .split('::')
-        .last
-        .gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
-        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-        .downcase
+    def self.underscore(str)
+      snake_case(str).split('/').last
     end
 
     # Return value or nil if value is empty

data/lib/shale/version.rb

@@ -2,5 +2,5 @@
 
 module Shale
   # @api private
-  VERSION = '0.4.0'
+  VERSION = '0.7.0'
 end

data/lib/shale.rb

@@ -4,7 +4,6 @@ require 'yaml'
 
 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'
@@ -73,15 +72,34 @@ module Shale
     # @api public
     attr_writer :yaml_adapter
 
-    # Set XML adapter
+    # TOML adapter accessor.
+    #
+    # @param [@see Shale::Adapter::TomlRB] adapter
+    #
+    # @example setting adapter
+    #   Shale.toml_adapter = Shale::Adapter::TomlRB
+    #
+    # @example getting adapter
+    #   Shale.toml_adapter
+    #   # => Shale::Adapter::TomlRB
+    #
+    # @api public
+    attr_accessor :toml_adapter
+
+    # XML adapter accessor. Available adapters are Shale::Adapter::REXML,
+    # Shale::Adapter::Nokogiri and Shale::Adapter::Ox
     #
     # @param [@see Shale::Adapter::REXML] adapter
     #
-    # @example
+    # @example setting adapter
     #   Shale.xml_adapter = Shale::Adapter::REXML
     #
+    # @example getting adapter
+    #   Shale.xml_adapter
+    #   # => Shale::Adapter::REXML
+    #
     # @api public
-    attr_writer :xml_adapter
+    attr_accessor :xml_adapter
 
     # Return JSON adapter. By default Shale::Adapter::JSON is used
     #
@@ -108,20 +126,5 @@ module Shale
     def yaml_adapter
       @yaml_adapter || YAML
     end
-
-    # Return XML adapter. By default Shale::Adapter::REXML is used.
-    # Available adapters are Shale::Adapter::REXML,
-    # Shale::Adapter::Nokogiri and Shale::Adapter::Ox
-    #
-    # @return [@see Shale::Adapter::REXML]
-    #
-    # @example
-    #   Shale.xml_adapter
-    #   # => Shale::Adapter::REXML
-    #
-    # @api public
-    def xml_adapter
-      @xml_adapter || Adapter::REXML
-    end
   end
 end

data/shale.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ['Kamil Giszczak']
   spec.email = ['beerkg@gmail.com']
 
-  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.summary = 'Ruby object mapper and serializer for XML, JSON, TOML and YAML.'
+  spec.description = 'Ruby object mapper and serializer for XML, JSON, TOML and YAML.'
   spec.homepage = 'https://shalerb.org'
   spec.license = 'MIT'
 
@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = 'shaleb'
 
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 2.7.0'
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: shale
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Kamil Giszczak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-30 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies: []
-description: Ruby object mapper and serializer for XML, JSON and YAML.
+description: Ruby object mapper and serializer for XML, JSON, TOML and YAML.
 email:
 - beerkg@gmail.com
 executables:
@@ -25,8 +25,15 @@ files:
 - lib/shale.rb
 - lib/shale/adapter/json.rb
 - lib/shale/adapter/nokogiri.rb
+- lib/shale/adapter/nokogiri/document.rb
+- lib/shale/adapter/nokogiri/node.rb
 - lib/shale/adapter/ox.rb
+- lib/shale/adapter/ox/document.rb
+- lib/shale/adapter/ox/node.rb
 - lib/shale/adapter/rexml.rb
+- lib/shale/adapter/rexml/document.rb
+- lib/shale/adapter/rexml/node.rb
+- lib/shale/adapter/toml_rb.rb
 - lib/shale/attribute.rb
 - lib/shale/error.rb
 - lib/shale/mapper.rb
@@ -37,17 +44,18 @@ files:
 - lib/shale/mapping/validator.rb
 - lib/shale/mapping/xml.rb
 - lib/shale/schema.rb
+- lib/shale/schema/compiler/boolean.rb
+- lib/shale/schema/compiler/complex.rb
+- lib/shale/schema/compiler/date.rb
+- lib/shale/schema/compiler/float.rb
+- lib/shale/schema/compiler/integer.rb
+- lib/shale/schema/compiler/property.rb
+- lib/shale/schema/compiler/string.rb
+- lib/shale/schema/compiler/time.rb
+- lib/shale/schema/compiler/value.rb
+- lib/shale/schema/compiler/xml_complex.rb
+- lib/shale/schema/compiler/xml_property.rb
 - lib/shale/schema/json_compiler.rb
-- lib/shale/schema/json_compiler/boolean.rb
-- lib/shale/schema/json_compiler/date.rb
-- lib/shale/schema/json_compiler/float.rb
-- lib/shale/schema/json_compiler/integer.rb
-- lib/shale/schema/json_compiler/object.rb
-- lib/shale/schema/json_compiler/property.rb
-- lib/shale/schema/json_compiler/string.rb
-- lib/shale/schema/json_compiler/time.rb
-- lib/shale/schema/json_compiler/utils.rb
-- lib/shale/schema/json_compiler/value.rb
 - lib/shale/schema/json_generator.rb
 - lib/shale/schema/json_generator/base.rb
 - lib/shale/schema/json_generator/boolean.rb
@@ -61,6 +69,7 @@ files:
 - lib/shale/schema/json_generator/string.rb
 - lib/shale/schema/json_generator/time.rb
 - lib/shale/schema/json_generator/value.rb
+- lib/shale/schema/xml_compiler.rb
 - lib/shale/schema/xml_generator.rb
 - lib/shale/schema/xml_generator/attribute.rb
 - lib/shale/schema/xml_generator/complex_type.rb
@@ -72,7 +81,7 @@ files:
 - lib/shale/schema/xml_generator/typed_attribute.rb
 - lib/shale/schema/xml_generator/typed_element.rb
 - lib/shale/type/boolean.rb
-- lib/shale/type/composite.rb
+- lib/shale/type/complex.rb
 - lib/shale/type/date.rb
 - lib/shale/type/float.rb
 - lib/shale/type/integer.rb
@@ -99,15 +108,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Ruby object mapper and serializer for XML, JSON and YAML.
+summary: Ruby object mapper and serializer for XML, JSON, TOML and YAML.
 test_files: []

data/lib/shale/schema/json_compiler/utils.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Shale
-  module Schema
-    class JSONCompiler
-      # Module with utility functions
-      #
-      # @api private
-      module Utils
-        # Convert string to Ruby's class naming convention
-        #
-        # @param [String] val
-        #
-        # @example
-        #   Shale::Schema::JSONCompiler.classify('foobar')
-        #   # => 'Foobar'
-        #
-        # @api private
-        def self.classify(str)
-          str = str.to_s.sub(/.*\./, '')
-
-          str = str.sub(/^[a-z\d]*/) { |match| match.capitalize || match }
-
-          str.gsub(%r{(?:_|(/))([a-z\d]*)}i) do
-            word = Regexp.last_match(2)
-            substituted = word.capitalize || word
-            Regexp.last_match(1) ? "::#{substituted}" : substituted
-          end
-        end
-
-        # Convert string to snake case
-        #
-        # @param [String] val
-        #
-        # @example
-        #   Shale::Schema::JSONCompiler.snake_case('FooBar')
-        #   # => 'foo_bar'
-        #
-        # @api private
-        def self.snake_case(str)
-          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
-            "#{Regexp.last_match(1) || Regexp.last_match(2)}_"
-          end
-          word = word.tr('-', '_')
-          word.downcase
-        end
-      end
-    end
-  end
-end

data/lib/shale/schema/json_compiler/value.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Shale
-  module Schema
-    class JSONCompiler
-      class Value
-        def name
-          'Shale::Type::Value'
-        end
-      end
-    end
-  end
-end