shale 0.4.0 → 0.5.0

data/lib/shale/schema/xml_generator.rb

@@ -94,12 +94,12 @@ module Shale
         )
         schemas[default_namespace.name].add_child(root_element)
 
-        composites = []
-        collect_composite_types(composites, klass, klass.xml_mapping.default_namespace.name)
+        complexes = []
+        collect_complex_types(complexes, klass, klass.xml_mapping.default_namespace.name)
 
-        composites.each do |composite|
-          type = composite[:type]
-          namespace = composite[:namespace]
+        complexes.each do |complex|
+          type = complex[:type]
+          namespace = complex[:namespace]
           children = []
 
           type.xml_mapping.elements.values.each do |mapping|
@@ -252,7 +252,7 @@ module Shale
       # @param [String, nil] namespace
       #
       # @api private
-      def collect_composite_types(types, type, namespace)
+      def collect_complex_types(types, type, namespace)
         types << { type: type, namespace: namespace }
 
         type.xml_mapping.elements.values.each do |mapping|
@@ -263,7 +263,7 @@ module Shale
           is_included = types.include?({ type: attribute.type, namespace: namespace })
 
           if is_mapper && !is_included
-            collect_composite_types(types, attribute.type, mapping.namespace.name)
+            collect_complex_types(types, attribute.type, mapping.namespace.name)
           end
         end
       end

data/lib/shale/schema.rb

@@ -3,6 +3,7 @@
 require_relative 'schema/json_generator'
 require_relative 'schema/json_compiler'
 require_relative 'schema/xml_generator'
+require_relative 'schema/xml_compiler'
 
 module Shale
   # Module for handling JSON and XML schema
@@ -66,5 +67,20 @@ module Shale
     def self.to_xml(klass, base_name = nil, pretty: false, declaration: false)
       XMLGenerator.new.to_schemas(klass, base_name, pretty: pretty, declaration: declaration)
     end
+
+    # Generate Shale model from XML Schema
+    #
+    # @param [Array<String>] schemas
+    #
+    # @return [Array<String>]
+    #
+    # @example
+    #   Shale::Schema.from_xml([xml_schema1, xml_schema2])
+    #   # => [model1, model2, model3]
+    #
+    # @api public
+    def self.from_xml(schemas)
+      XMLCompiler.new.to_models(schemas)
+    end
   end
 end

data/lib/shale/type/{composite.rb → complex.rb}

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
+require_relative '../error'
 require_relative 'value'
 
 module Shale
   module Type
-    # Build composite object. Don't use it directly.
+    # Build complex object. Don't use it directly.
     # It serves as a base type class for @see Shale::Mapper
     #
     # @api private
-    class Composite < Value
+    class Complex < Value
       class << self
         %i[hash json yaml].each do |format|
           class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
@@ -198,10 +199,13 @@ module Shale
         #
         # @param [String] xml XML to convert
         #
+        # @raise [AdapterError]
+        #
         # @return [Shale::Mapper]
         #
         # @api public
         def from_xml(xml)
+          validate_xml_adapter
           of_xml(Shale.xml_adapter.load(xml))
         end
 
@@ -279,12 +283,26 @@ module Shale
         # @param [Shale::Mapper] instance Object to convert
         # @param [Array<Symbol>] options
         #
+        # @raise [AdapterError]
+        #
         # @return [String]
         #
         # @api public
         def to_xml(instance, *options)
+          validate_xml_adapter
           Shale.xml_adapter.dump(as_xml(instance), *options)
         end
+
+        private
+
+        # Validate XML adapter
+        #
+        # @raise [AdapterError]
+        #
+        # @api private
+        def validate_xml_adapter
+          raise AdapterError, ADAPTER_NOT_SET_MESSAGE unless Shale.xml_adapter
+        end
       end
 
       # Convert Object to Hash

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.5.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,20 @@ module Shale
     # @api public
     attr_writer :yaml_adapter
 
-    # Set XML 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 +112,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

@@ -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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shale
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kamil Giszczak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-30 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies: []
 description: Ruby object mapper and serializer for XML, JSON and YAML.
 email:
@@ -25,8 +25,14 @@ 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/attribute.rb
 - lib/shale/error.rb
 - lib/shale/mapper.rb
@@ -37,17 +43,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 +68,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 +80,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,14 +107,14 @@ 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.

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