shale 0.3.0 → 0.5.0

data/lib/shale/schema/{xml → xml_generator}/attribute.rb

@@ -2,7 +2,7 @@
 
 module Shale
   module Schema
-    class XML
+    class XMLGenerator
       # Class representing XML Schema <attribute> element.
       # Serves as a base class for TypedAttribute and RefAttribute
       #

data/lib/shale/schema/{xml → xml_generator}/complex_type.rb

@@ -5,7 +5,7 @@ require_relative 'element'
 
 module Shale
   module Schema
-    class XML
+    class XMLGenerator
       # Class representing XML Schema <complexType> element
       #
       # @api private
@@ -20,7 +20,10 @@ module Shale
         # Initialize ComplexType object
         #
         # @param [String] name
-        # @param [Array<Shale::Schema::XML::Element, Shale::Schema::XML::Attribute>] children
+        # @param [Array<
+        #   Shale::Schema::XMLGenerator::Element,
+        #   Shale::Schema::XMLGenerator::Attribute
+        # >] children
         # @param [true, false] mixed
         #
         # @api private

data/lib/shale/schema/{xml → xml_generator}/element.rb

@@ -2,7 +2,7 @@
 
 module Shale
   module Schema
-    class XML
+    class XMLGenerator
       # Class representing XML Schema <element> element.
       # Serves as a base class for TypedElement and RefElement
       #

data/lib/shale/schema/{xml → xml_generator}/import.rb

@@ -2,7 +2,7 @@
 
 module Shale
   module Schema
-    class XML
+    class XMLGenerator
       # Class representing XML Schema <import> element
       #
       # @api private

data/lib/shale/schema/{xml → xml_generator}/ref_attribute.rb

@@ -4,7 +4,7 @@ require_relative 'attribute'
 
 module Shale
   module Schema
-    class XML
+    class XMLGenerator
       # Class representing XML Schema <attribute ref=""> element
       # with a reference
       #

data/lib/shale/schema/{xml → xml_generator}/ref_element.rb

@@ -4,7 +4,7 @@ require_relative 'element'
 
 module Shale
   module Schema
-    class XML
+    class XMLGenerator
       # Class representing XML Schema <element ref=""> element
       # with a reference
       #

data/lib/shale/schema/{xml → xml_generator}/schema.rb

@@ -5,7 +5,7 @@ require_relative 'complex_type'
 
 module Shale
   module Schema
-    class XML
+    class XMLGenerator
       class Schema
         # XML Schema namespace
         # @api private
@@ -43,10 +43,10 @@ module Shale
 
         # Add child element to XML Schema
         #
-        # @param [Shale::Schema::XML::Import,
-        #         Shale::Schema::XML::Element,
-        #         Shale::Schema::XML::Attribute,
-        #         Shale::Schema::XML::ComplesType] child
+        # @param [Shale::Schema::XMLGenerator::Import,
+        #         Shale::Schema::XMLGenerator::Element,
+        #         Shale::Schema::XMLGenerator::Attribute,
+        #         Shale::Schema::XMLGenerator::ComplesType] child
         #
         # @api private
         def add_child(child)

data/lib/shale/schema/{xml → xml_generator}/typed_attribute.rb

@@ -4,7 +4,7 @@ require_relative 'attribute'
 
 module Shale
   module Schema
-    class XML
+    class XMLGenerator
       # Class representing XML Schema <attribute name="" type=""> element
       # with a name and a type
       #

data/lib/shale/schema/{xml → xml_generator}/typed_element.rb

@@ -4,7 +4,7 @@ require_relative 'element'
 
 module Shale
   module Schema
-    class XML
+    class XMLGenerator
       # Class representing XML Schema <element mame="" type=""> element
       # with a name and a type
       #

data/lib/shale/schema/{xml.rb → xml_generator.rb}

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
 require_relative '../../shale'
-require_relative 'xml/complex_type'
-require_relative 'xml/import'
-require_relative 'xml/ref_attribute'
-require_relative 'xml/ref_element'
-require_relative 'xml/schema'
-require_relative 'xml/typed_attribute'
-require_relative 'xml/typed_element'
+require_relative 'xml_generator/complex_type'
+require_relative 'xml_generator/import'
+require_relative 'xml_generator/ref_attribute'
+require_relative 'xml_generator/ref_element'
+require_relative 'xml_generator/schema'
+require_relative 'xml_generator/typed_attribute'
+require_relative 'xml_generator/typed_element'
 
 module Shale
   module Schema
-    # Class for handling XML schema
+    # Class for generating XML schema
     #
     # @api public
-    class XML
+    class XMLGenerator
       # XML Schema default name
       # @api private
       DEFAULT_SCHEMA_NAME = 'schema'
@@ -27,7 +27,7 @@ module Shale
       # @param [String] xml_type
       #
       # @example
-      #   Shale::Schema::XML.register_xml_type(Shale::Type::String, 'myType')
+      #   Shale::Schema::XMLGenerator.register_xml_type(Shale::Type::String, 'myType')
       #
       # @api public
       def self.register_xml_type(shale_type, xml_type)
@@ -41,7 +41,7 @@ module Shale
       # @return [String]
       #
       # @example
-      #   Shale::Schema::XML.get_xml_type(Shale::Type::String)
+      #   Shale::Schema::XMLGenerator.get_xml_type(Shale::Type::String)
       #   # => 'string'
       #
       # @api private
@@ -54,19 +54,20 @@ module Shale
       register_xml_type(Shale::Type::Float, 'decimal')
       register_xml_type(Shale::Type::Integer, 'integer')
       register_xml_type(Shale::Type::Time, 'dateTime')
+      register_xml_type(Shale::Type::Value, 'anyType')
 
       # Generate XML Schema from Shale model and return
-      # it as a Shale::Schema::XML::Schema array
+      # it as a Shale::Schema::XMLGenerator::Schema array
       #
       # @param [Shale::Mapper] klass
       # @param [String, nil] base_name
       #
       # @raise [NotAShaleMapperError] when attribute is not a Shale model
       #
-      # @return [Array<Shale::Schema::XML::Schema>]
+      # @return [Array<Shale::Schema::XMLGenerator::Schema>]
       #
       # @example
-      #   Shale::Schema::XML.new.as_schemas(Person)
+      #   Shale::Schema::XMLGenerator.new.as_schemas(Person)
       #
       # @api public
       def as_schemas(klass, base_name = nil)
@@ -93,11 +94,12 @@ module Shale
         )
         schemas[default_namespace.name].add_child(root_element)
 
-        composites = collect_composite_types(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|
@@ -214,7 +216,7 @@ module Shale
       # @return [Hash<String, String>]
       #
       # @example
-      #   Shale::Schema::XML.new.to_schemas(Person)
+      #   Shale::Schema::XMLGenerator.new.to_schemas(Person)
       #
       # @api public
       def to_schemas(klass, base_name = nil, pretty: false, declaration: false)
@@ -245,14 +247,13 @@ module Shale
 
       # Collect recursively Shale::Mapper types
       #
+      # @param [Array<Shale::Mapper>] types
       # @param [Shale::Mapper] type
       # @param [String, nil] namespace
       #
-      # @return [Array<Hash<Symbol, String>>]
-      #
       # @api private
-      def collect_composite_types(type, namespace)
-        types = [{ type: type, namespace: namespace }]
+      def collect_complex_types(types, type, namespace)
+        types << { type: type, namespace: namespace }
 
         type.xml_mapping.elements.values.each do |mapping|
           attribute = type.attributes[mapping.attribute]
@@ -262,11 +263,9 @@ module Shale
           is_included = types.include?({ type: attribute.type, namespace: namespace })
 
           if is_mapper && !is_included
-            types += collect_composite_types(attribute.type, mapping.namespace.name)
+            collect_complex_types(types, attribute.type, mapping.namespace.name)
           end
         end
-
-        types.uniq
       end
 
       # Convert Ruby class name to XML Schema name

data/lib/shale/schema.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'schema/json'
-require_relative 'schema/xml'
+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
@@ -22,8 +24,30 @@ module Shale
     #   # => JSON schema
     #
     # @api public
-    def self.to_json(klass, id: nil, description: nil, pretty: false)
-      JSON.new.to_schema(klass, id: id, description: description, pretty: pretty)
+    def self.to_json(klass, id: nil, title: nil, description: nil, pretty: false)
+      JSONGenerator.new.to_schema(
+        klass,
+        id: id,
+        title: title,
+        description: description,
+        pretty: pretty
+      )
+    end
+
+    # Generate Shale model from JSON Schema
+    #
+    # @param [Array<String>] schemas
+    # @param [String, nil] root_name
+    #
+    # @return [Array<String>]
+    #
+    # @example
+    #   Shale::Schema.from_json([json_schema1, json_schema2], root_name: 'foobar')
+    #   # => [model1, model2, model3]
+    #
+    # @api public
+    def self.from_json(schemas, root_name: nil)
+      JSONCompiler.new.to_models(schemas, root_name: root_name)
     end
 
     # Generate XML Schema from Shale model
@@ -41,7 +65,22 @@ module Shale
     #
     # @api public
     def self.to_xml(klass, base_name = nil, pretty: false, declaration: false)
-      XML.new.to_schemas(klass, base_name, pretty: pretty, declaration: declaration)
+      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)
@@ -35,18 +36,15 @@ module Shale
                   next unless attribute
 
                   if value.nil?
-                    instance.public_send("\#{attribute.name}=", nil)
-                    next
-                  end
-
-                  if attribute.collection?
+                    instance.send(attribute.setter, nil)
+                  elsif attribute.collection?
                     [*value].each do |val|
                       val = val ? attribute.type.of_#{format}(val) : val
-                      instance.public_send(attribute.name) << attribute.type.cast(val)
+                      instance.send(attribute.name) << attribute.type.cast(val)
                     end
                   else
                     val = attribute.type.of_#{format}(value)
-                    instance.public_send("\#{attribute.name}=", val)
+                    instance.send(attribute.setter, val)
                   end
                 end
               end
@@ -71,14 +69,11 @@ module Shale
                   attribute = instance.class.attributes[mapping.attribute]
                   next unless attribute
 
-                  value = instance.public_send(attribute.name)
+                  value = instance.send(attribute.name)
 
                   if value.nil?
                     hash[mapping.name] = nil
-                    next
-                  end
-
-                  if attribute.collection?
+                  elsif attribute.collection?
                     hash[mapping.name] = [*value].map do |v|
                       v ? attribute.type.as_#{format}(v) : v
                     end
@@ -163,9 +158,9 @@ module Shale
               next unless attribute
 
               if attribute.collection?
-                instance.public_send(attribute.name) << attribute.type.cast(value)
+                instance.send(attribute.name) << attribute.type.cast(value)
               else
-                instance.public_send("#{attribute.name}=", value)
+                instance.send(attribute.setter, value)
               end
             end
           end
@@ -174,7 +169,7 @@ module Shale
             attribute = attributes[xml_mapping.content]
 
             if attribute
-              instance.public_send("#{attribute.name}=", attribute.type.of_xml(element))
+              instance.send(attribute.setter, attribute.type.of_xml(element))
             end
           end
 
@@ -190,9 +185,9 @@ module Shale
 
               if attribute.collection?
                 value = attribute.type.of_xml(node)
-                instance.public_send(attribute.name) << attribute.type.cast(value)
+                instance.send(attribute.name) << attribute.type.cast(value)
               else
-                instance.public_send("#{attribute.name}=", attribute.type.of_xml(node))
+                instance.send(attribute.setter, attribute.type.of_xml(node))
               end
             end
           end
@@ -204,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
 
@@ -237,7 +235,7 @@ module Shale
               attribute = instance.class.attributes[mapping.attribute]
               next unless attribute
 
-              value = instance.public_send(attribute.name)
+              value = instance.send(attribute.name)
               next if value.nil?
 
               doc.add_namespace(mapping.namespace.prefix, mapping.namespace.name)
@@ -249,7 +247,7 @@ module Shale
             attribute = instance.class.attributes[xml_mapping.content]
 
             if attribute
-              value = instance.public_send(attribute.name)
+              value = instance.send(attribute.name)
               doc.add_text(element, value.to_s) if value
             end
           end
@@ -261,7 +259,7 @@ module Shale
               attribute = instance.class.attributes[mapping.attribute]
               next unless attribute
 
-              value = instance.public_send(attribute.name)
+              value = instance.send(attribute.name)
               next if value.nil?
 
               doc.add_namespace(mapping.namespace.prefix, mapping.namespace.name)
@@ -285,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.3.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