shale 0.4.0 → 0.5.0

data/lib/shale/schema/{json_compiler/object.rb → compiler/complex.rb}

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative 'utils'
+require_relative '../../utils'
 
 module Shale
   module Schema
-    class JSONCompiler
-      # Class representing Shale's comosite type
+    module Compiler
+      # Class representing Shale's complex type
       #
       # @api private
-      class Object
+      class Complex
         # Return id
         #
         # @return [String]
@@ -18,7 +18,7 @@ module Shale
 
         # Return properties
         #
-        # @return [Array<Shale::Schema::JSONCompiler::Property>]
+        # @return [Array<Shale::Schema::Compiler::Property>]
         #
         # @api private
         attr_reader :properties
@@ -62,22 +62,25 @@ module Shale
 
         # Return references
         #
-        # @return [Array<Shale::Schema::JSONCompiler::Property>]
+        # @return [Array<Shale::Schema::Compiler::Property>]
         #
         # @api private
         def references
           @properties
             .filter { |e| e.type.is_a?(self.class) && e.type != self }
             .uniq { |e| e.type.id }
+            .sort { |a, b| a.type.file_name <=> b.type.file_name }
         end
 
         # Add property to Object
         #
-        # @param [Shale::Schema::JSONCompiler::Property] property
+        # @param [Shale::Schema::Compiler::Property] property
         #
         # @api private
         def add_property(property)
-          @properties << property
+          unless @properties.find { |e| e.mapping_name == property.mapping_name }
+            @properties << property
+          end
         end
       end
     end

data/lib/shale/schema/{json_compiler → compiler}/date.rb

@@ -2,7 +2,7 @@
 
 module Shale
   module Schema
-    class JSONCompiler
+    module Compiler
       # Class that maps Schema type to Shale Date type
       #
       # @api private

data/lib/shale/schema/{json_compiler → compiler}/float.rb

@@ -2,7 +2,7 @@
 
 module Shale
   module Schema
-    class JSONCompiler
+    module Compiler
       # Class that maps Schema type to Shale Float type
       #
       # @api private

data/lib/shale/schema/{json_compiler → compiler}/integer.rb

@@ -2,7 +2,7 @@
 
 module Shale
   module Schema
-    class JSONCompiler
+    module Compiler
       # Class that maps Schema type to Shale Integer type
       #
       # @api private

data/lib/shale/schema/{json_compiler → compiler}/property.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require_relative 'utils'
+require_relative '../../utils'
 
 module Shale
   module Schema
-    class JSONCompiler
+    module Compiler
       # Class representing Shale's property
       #
       # @api private
       class Property
-        # Return property's name
+        # Return mapping's name
         #
         # @return [String]
         #
         # @api private
-        attr_reader :property_name
+        attr_reader :mapping_name
 
         # Return attribute's name
         #
@@ -33,13 +33,13 @@ module Shale
         # Initialize Property object
         #
         # @param [String] name
-        # @param [Shale::Schema::JsonCompiler::Type] type
+        # @param [Shale::Schema::Compiler::Type] type
         # @param [true, false] collection
         # @param [Object] default
         #
         # @api private
         def initialize(name, type, collection, default)
-          @property_name = name
+          @mapping_name = name
           @attribute_name = Utils.snake_case(name)
           @type = type
           @collection = collection

data/lib/shale/schema/{json_compiler → compiler}/string.rb

@@ -2,7 +2,7 @@
 
 module Shale
   module Schema
-    class JSONCompiler
+    module Compiler
       # Class that maps Schema type to Shale String type
       #
       # @api private

data/lib/shale/schema/{json_compiler → compiler}/time.rb

@@ -2,7 +2,7 @@
 
 module Shale
   module Schema
-    class JSONCompiler
+    module Compiler
       # Class that maps Schema type to Shale Time type
       #
       # @api private

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Shale
+  module Schema
+    module Compiler
+      # Class that maps Schema type to Shale Value type
+      #
+      # @api private
+      class Value
+        # Return name of the Shale type
+        #
+        # @return [String]
+        #
+        # @api private
+        def name
+          'Shale::Type::Value'
+        end
+      end
+    end
+  end
+end

data/lib/shale/schema/compiler/xml_complex.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'complex'
+
+module Shale
+  module Schema
+    module Compiler
+      # Class representing Shale's XML complex type
+      #
+      # @api private
+      class XMLComplex < Complex
+        # Accessor for root attribute
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_accessor :root
+
+        # Return namespace prefix
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :prefix
+
+        # Return namespace URI
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :namespace
+
+        # Initialize object
+        #
+        # @param [String] id
+        # @param [String] name
+        # @param [String] prefix
+        # @param [String] namespace
+        #
+        # @api private
+        def initialize(id, name, prefix, namespace)
+          super(id, name)
+          @root = name
+          @prefix = prefix
+          @namespace = namespace
+        end
+      end
+    end
+  end
+end

data/lib/shale/schema/compiler/xml_property.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'property'
+
+module Shale
+  module Schema
+    module Compiler
+      # Class representing Shale's property
+      #
+      # @api private
+      class XMLProperty < Property
+        # Return namespace URI
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :namespace
+
+        # Return namespace prefix
+        #
+        # @return [String]
+        #
+        # @api private
+        attr_reader :prefix
+
+        # Initialize object
+        #
+        # @param [String] name
+        # @param [Shale::Schema::Compiler::Type] type
+        # @param [true, false] collection
+        # @param [Object] default
+        # @param [String] prefix
+        # @param [String] namespace
+        # @param [Symbol] category
+        #
+        # @api private
+        def initialize(name:, type:, collection:, default:, prefix:, namespace:, category:)
+          super(name, type, collection, default)
+          @prefix = prefix
+          @namespace = namespace
+          @category = category
+        end
+
+        # Check if property's category is content
+        #
+        # @return [true, false]
+        #
+        # @api private
+        def content?
+          @category == :content
+        end
+
+        # Check if property's category is attribute
+        #
+        # @return [true, false]
+        #
+        # @api private
+        def attribute?
+          @category == :attribute
+        end
+
+        # Check if property's category is element
+        #
+        # @return [true, false]
+        #
+        # @api private
+        def element?
+          @category == :element
+        end
+      end
+    end
+  end
+end

data/lib/shale/schema/json_compiler.rb

@@ -4,15 +4,15 @@ require 'erb'
 require 'uri'
 
 require_relative '../../shale'
-require_relative 'json_compiler/boolean'
-require_relative 'json_compiler/date'
-require_relative 'json_compiler/float'
-require_relative 'json_compiler/integer'
-require_relative 'json_compiler/object'
-require_relative 'json_compiler/property'
-require_relative 'json_compiler/string'
-require_relative 'json_compiler/time'
-require_relative 'json_compiler/value'
+require_relative 'compiler/boolean'
+require_relative 'compiler/complex'
+require_relative 'compiler/date'
+require_relative 'compiler/float'
+require_relative 'compiler/integer'
+require_relative 'compiler/property'
+require_relative 'compiler/string'
+require_relative 'compiler/time'
+require_relative 'compiler/value'
 
 module Shale
   module Schema
@@ -44,20 +44,20 @@ module Shale
 
           json do
             <%- type.properties.each do |property| -%>
-            map '<%= property.property_name %>', to: :<%= property.attribute_name %>
+            map '<%= property.mapping_name %>', to: :<%= property.attribute_name %>
             <%- end -%>
           end
         end
       TEMPLATE
 
-      # Generate Shale models from JSON Schema and return them as a Ruby Array od objects
+      # Generate Shale models from JSON Schema and return them as a Ruby Array of objects
       #
       # @param [Array<String>] schemas
       # @param [String, nil] root_name
       #
-      # @raise [JSONSchemaError] when JSON Schema has errors
+      # @raise [SchemaError] when JSON Schema has errors
       #
-      # @return [Array<Shale::Schema::JSONCompiler::Object>]
+      # @return [Array<Shale::Schema::Compiler::Complex>]
       #
       # @example
       #   Shale::Schema::JSONCompiler.new.as_models([schema1, schema2])
@@ -81,7 +81,6 @@ module Shale
         total_duplicates = Hash.new(0)
         duplicates = Hash.new(0)
 
-        # rubocop:disable Style/CombinableLoops
         @types.each do |type|
           total_duplicates[type.name] += 1
         end
@@ -93,7 +92,6 @@ module Shale
             type.name = format("#{type.name}%d", duplicates[type.name])
           end
         end
-        # rubocop:enable Style/CombinableLoops
 
         @types.reverse
       end
@@ -103,7 +101,7 @@ module Shale
       # @param [Array<String>] schemas
       # @param [String, nil] root_name
       #
-      # @raise [JSONSchemaError] when JSON Schema has errors
+      # @raise [SchemaError] when JSON Schema has errors
       #
       # @return [Hash<String, String>]
       #
@@ -159,7 +157,7 @@ module Shale
       # @param [String, nil] base_id
       # @param [String, nil] ref
       #
-      # @raise [JSONSchemaError] when ref can't be resolved
+      # @raise [SchemaError] when ref can't be resolved
       #
       # @return [Hash, true, false]
       #
@@ -172,7 +170,7 @@ module Shale
         entry = @schema_repository[key]
 
         unless entry
-          raise JSONSchemaError, "can't resolve reference '#{key}'"
+          raise SchemaError, "can't resolve reference '#{key}'"
         end
 
         if entry[:schema].key?('$ref')
@@ -188,12 +186,12 @@ module Shale
       # @param [String] id
       # @param [String] name
       #
-      # @return [Shale::Schema::JSONCompiler::Type]
+      # @return [Shale::Schema::Compiler::Type]
       #
       # @api private
       def infer_type(schema, id, name)
         return unless schema
-        return Value.new if schema == true
+        return Compiler::Value.new if schema == true
 
         type = schema['type']
         format = schema['format']
@@ -202,28 +200,28 @@ module Shale
           type -= ['null']
 
           if type.length > 1
-            return Value.new
+            return Compiler::Value.new
           else
             type = type[0]
           end
         end
 
         if type == 'object'
-          Object.new(id, name)
+          Compiler::Complex.new(id, name)
         elsif type == 'string' && format == 'date'
-          Date.new
+          Compiler::Date.new
         elsif type == 'string' && format == 'date-time'
-          Time.new
+          Compiler::Time.new
         elsif type == 'string'
-          String.new
+          Compiler::String.new
         elsif type == 'number'
-          Float.new
+          Compiler::Float.new
         elsif type == 'integer'
-          Integer.new
+          Compiler::Integer.new
         elsif type == 'boolean'
-          Boolean.new
+          Compiler::Boolean.new
         else
-          Value.new
+          Compiler::Value.new
         end
       end
 
@@ -233,7 +231,7 @@ module Shale
       # @param [Array<String>] fragment
       # @param [String] base_id
       #
-      # @raise [JSONSchemaError] when there are problems with JSON schema
+      # @raise [SchemaError] when there are problems with JSON schema
       #
       # @api private
       def disassemble_schema(schema, fragment = [], base_id = '')
@@ -249,7 +247,7 @@ module Shale
         pointer = build_pointer(id, fragment)
 
         if @schema_repository.key?(pointer)
-          raise JSONSchemaError, "schema with id '#{pointer}' already exists"
+          raise SchemaError, "schema with id '#{pointer}' already exists"
         else
           @schema_repository[pointer] = {
             id: pointer,
@@ -274,7 +272,7 @@ module Shale
       # @param [String] base_id
       # @param [Array<String>] fragment
       #
-      # @return [Shale::Schema::JSONCompiler::Property, nil]
+      # @return [Shale::Schema::Compiler::Property, nil]
       #
       # @api private
       def compile(schema, is_root, base_id = '', fragment = [])
@@ -317,7 +315,7 @@ module Shale
           default = schema['default']
         end
 
-        if type.is_a?(Object) && !@types.include?(type)
+        if type.is_a?(Compiler::Complex) && !@types.include?(type)
           @types << type
 
           (schema['properties'] || {}).each do |subschema_key, subschema|
@@ -326,7 +324,7 @@ module Shale
           end
         end
 
-        Property.new(key, type, collection, default) if type
+        Compiler::Property.new(key, type, collection, default) if type
       end
     end
   end

data/lib/shale/schema/json_generator.rb

@@ -76,7 +76,7 @@ module Shale
         end
 
         types = []
-        collect_composite_types(types, klass)
+        collect_complex_types(types, klass)
         objects = []
 
         types.each do |type|
@@ -148,7 +148,7 @@ module Shale
       # @param [Shale::Mapper] type
       #
       # @api private
-      def collect_composite_types(types, type)
+      def collect_complex_types(types, type)
         types << type
 
         type.json_mapping.keys.values.each do |mapping|
@@ -156,7 +156,7 @@ module Shale
           next unless attribute
 
           if mapper_type?(attribute.type) && !types.include?(attribute.type)
-            collect_composite_types(types, attribute.type)
+            collect_complex_types(types, attribute.type)
           end
         end
       end