shale 0.3.1 → 0.6.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