xsd 1.0.0 → 2.1.0

data/lib/xsd/objects/documentation.rb

@@ -7,12 +7,12 @@ module XSD
   class Documentation < BaseObject
     # Optional. A URI reference that specifies the source of the application information
     # @!attribute source
-    # @return [String]
+    # @return String
     property :source, :string
 
     # Optional. Specifies the language used in the contents
     # @!attribute xml_lang
-    # @return [String]
+    # @return String
     property :'xml:lang', :string
   end
 end

data/lib/xsd/objects/element.rb

@@ -14,30 +14,30 @@ module XSD
 
     # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
     # @!attribute name
-    # @return [String]
+    # @return String
     property :name, :string
 
     # Optional. Specifies either the name of a built-in data type, or the name of a simpleType or complexType element
     # @!attribute type
-    # @return [String, nil]
+    # @return String, nil
     property :type, :string
 
     # Optional. Specifies the name of an element that can be substituted with this element. This attribute cannot be
     # used if the parent element is not the schema element
     # @!attribute substitution_group
-    # @return [String, nil]
+    # @return String, nil
     property :substitutionGroup, :string
 
     # Optional. Specifies a default value for the element (can only be used if the element's content is a simple type
     # or text only)
     # @!attribute default
-    # @return [String, nil]
+    # @return String, nil
     property :default, :string
 
     # Optional. Specifies a fixed value for the element (can only be used if the element's content is a simple type
     # or text only)
     # @!attribute fixed
-    # @return [String, nil]
+    # @return String, nil
     property :fixed, :string
 
     # Optional. Specifies the form for the element. "unqualified" indicates that this element is not required to be
@@ -45,21 +45,21 @@ module XSD
     # prefix. The default value is the value of the elementFormDefault attribute of the schema element. This attribute
     # cannot be used if the parent element is the schema element
     # @!attribute form
-    # @return [String]
+    # @return String
     property :form, :string
 
     # Optional. Specifies whether an explicit null value can be assigned to the element. True enables an instance of
     # the element to have the null attribute set to true. The null attribute is defined as part of the XML Schema
     # namespace for instances. Default is false
     # @!attribute nillable
-    # @return [Boolean]
+    # @return Boolean
     property :nillable, :boolean, default: false
 
     # Optional. Specifies whether the element can be used in an instance document. True indicates that the element
     # cannot appear in the instance document. Instead, another element whose substitutionGroup attribute contains the
     # qualified name (QName) of this element must appear in this element's place. Default is false
     # @!attribute abstract
-    # @return [Boolean]
+    # @return Boolean
     property :abstract, :boolean, default: false
 
     # Optional. Prevents an element with a specified type of derivation from being used in place of this element.
@@ -69,7 +69,7 @@ module XSD
     #     substitution - prevents elements derived by substitution
     #     #all         - prevents all derived elements
     # @!attribute block
-    # @return [String, nil]
+    # @return String, nil
     property :block, :string
 
     # Optional. Sets the default value of the final attribute on the element element. This attribute cannot be used if
@@ -79,50 +79,50 @@ module XSD
     #     restriction - prevents elements derived by restriction
     #     #all        - prevents all derived elements
     # @!attribute final
-    # @return [String, nil]
+    # @return String, nil
     property :final, :string
 
     # Nested unique objects
     # @!attribute unique
-    # @return [Array<Unique>]
+    # @return Array<Unique>
     child :unique, [:unique]
 
     # Determine if element is required
-    # @return [Boolean]
+    # @return Boolean
     def required?
       computed_min_occurs > 0
     end
 
     # Determine if element is optional
-    # @return [Boolean]
+    # @return Boolean
     def optional?
       !required?
     end
 
     # Determine if element may occur multiple times
-    # @return [Boolean]
+    # @return Boolean
     def multiple_allowed?
       computed_max_occurs == :unbounded || computed_max_occurs > 1
     end
 
     # Determine if element has complex content
-    # @return [Boolean]
+    # @return Boolean
     def complex?
-      complex_type && !complex_type.simple_content && all_elements.any?
+      complex_type && !complex_type.simple_content && collect_elements.any?
     end
 
     # Get elements that can appear instead of this one
-    # @return [Array<Element>]
+    # @return Array<Element>
     def substitution_elements
       # TODO: for now we do not search in parent schemas (that imported current schema)
       # TODO: refactor for better namespace handling (use xpath with namespaces or correct comparison)
-      schema.all_elements.select do |element|
+      schema.collect_elements.select do |element|
         element.substitution_group&.split(':')&.last == name
       end
     end
 
     # Get target namespace
-    # @return [String]
+    # @return String
     def target_namespace
       schema.target_namespace
     end

data/lib/xsd/objects/extension.rb

@@ -8,7 +8,26 @@ module XSD
     TYPE_PROPERTY = nil
 
     include Based
-    include SimpleTyped
     include AttributeContainer
+
+    # Nested group
+    # @!attribute group
+    # @return Group
+    child :group, :group
+
+    # Nested all
+    # @!attribute all
+    # @return All
+    child :all, :all
+
+    # Nested choice
+    # @!attribute choice
+    # @return Choice
+    child :choice, :choice
+
+    # Nested sequence
+    # @!attribute sequence
+    # @return Sequence
+    child :sequence, :sequence
   end
 end

data/lib/xsd/objects/facet.rb

@@ -6,7 +6,7 @@ module XSD
   class Facet < BaseObject
     # Returns facet value
     # @!attribute value
-    # @return [String]
+    # @return String
     property :value, :string
   end
 end

data/lib/xsd/objects/field.rb

@@ -7,7 +7,7 @@ module XSD
   class Field < BaseObject
     # Required. Identifies a single element or attribute whose content or value is used for the constraint
     # @!attribute xpath
-    # @return [String]
+    # @return String
     property :xpath, :string, required: true
   end
 end

data/lib/xsd/objects/group.rb

@@ -11,22 +11,22 @@ module XSD
 
     # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
     # @!attribute name
-    # @return [String]
+    # @return String
     property :name, :string
 
     # Nested all object
     # @!attribute all
-    # @return [All]
+    # @return All
     child :all, :all
 
     # Nested choice object
     # @!attribute choice
-    # @return [Choice]
+    # @return Choice
     child :choice, :choice
 
     # Nested sequence object
     # @!attribute sequence
-    # @return [Sequence]
+    # @return Sequence
     child :sequence, :sequence
   end
 end

data/lib/xsd/objects/import.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'rest-client'
-
 module XSD
   # The import element is used to add multiple schemas with different target namespace to a document.
   # Parent elements: schema
@@ -9,59 +7,32 @@ module XSD
   class Import < BaseObject
     # Optional. Specifies the URI of the namespace to import
     # @!attribute namespace
-    # @return [String, nil]
+    # @return String, nil
     property :namespace, :string
 
     # Optional. Specifies the URI to the schema for the imported namespace
     # @!attribute schema_location
-    # @return [String, nil]
+    # @return String, nil
     property :schemaLocation, :string
 
-    # Get imported reader
-    # @return [XSD:XML]
-    def imported_reader
-      return @imported_reader if @imported_reader
-
-      xml = if reader.imported_xsd[namespace]
-              # check in imported xsd by namespace
-              reader.imported_xsd[namespace]
-            elsif schema_location =~ /^https?:/
-              # check http(s) schema location
-              download_uri(schema_location)
-            elsif (path = local_path)
-              # check local relative path
-              path
-            elsif namespace =~ /^https?:/
-              # check http(s) namespace
-              # TODO: investigate spec conformance
-              download_uri(namespace.gsub(/#{File.basename(schema_location, '.*')}$/, '').to_s + schema_location)
-            else
-              raise ImportError, "Failed to locate import '#{schema_location}' for namespace '#{namespace}'"
-            end
-
-      # TODO: pass all provided options
-      @imported_reader = XSD::XML.new(xml, imported_xsd: reader.imported_xsd, logger: reader.logger)
-    end
-
-    def local_path
-      return unless reader.xsd.is_a?(Pathname)
-
-      path = reader.xsd.dirname.join(schema_location)
-      path.file? ? path : nil
-    end
+    # Get imported schema
+    # @return Schema
+    def imported_schema
+      known_schemas = reader.schemas_for_namespace(namespace)
+      return known_schemas.first if known_schemas.any?
 
-    private
+      unless schema_location
+        raise ImportError, "Schema location not provided for namespace '#{namespace}', use add_schema_xml()/add_schema_node()"
+      end
 
-    def download_uri(uri)
-      reader.logger.debug(XSD) { "Downloading import schema for namespace '#{namespace}' from '#{uri}'" }
+      xml = reader.resource_resolver.call(schema_location, namespace)
+      new_schema = reader.add_schema_xml(xml)
 
-      begin
-        response = RestClient.get(uri)
-      rescue RestClient::Exception => e
-        raise ImportError, e.message
+      unless namespace == new_schema.target_namespace
+        raise ImportError, 'Import namespace does not match imported schema targetNamespace'
       end
 
-      response.body
+      new_schema
     end
   end
 end

data/lib/xsd/objects/include.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module XSD
+  # The include element is used to add multiple schemas with the same target namespace to a document.
+  # Parent elements: schema
+  # https://www.w3schools.com/xml/el_include.asp
+  class Include < BaseObject
+    # Required. Specifies the URI to the schema to include in the target namespace of the containing schema
+    # @!attribute schema_location
+    # @return String
+    property :schemaLocation, :string
+
+    # Get imported schema
+    # @return Schema
+    def imported_schema
+      # cache included schema locally as it has no unique namespace to check in global registry
+      return @imported_schema if @imported_schema
+
+      xml = reader.resource_resolver.call(schema_location)
+      new_schema = reader.add_schema_xml(xml)
+
+      unless schema.target_namespace == new_schema.target_namespace
+        raise ImportError, 'Schema targetNamespace does not match included schema targetNamespace'
+      end
+
+      @imported_schema = new_schema
+    end
+  end
+end

data/lib/xsd/objects/key.rb

@@ -9,17 +9,17 @@ module XSD
     # The name must be a no-colon-name (NCName) as defined in the XML Namespaces specification.
     # The name must be unique within an identity constraint set. Required.
     # @!attribute name
-    # @return [String]
+    # @return String
     property :name, :string, required: true
 
     # Get nested selector object
     # @!attribute selector
-    # @return [Selector]
+    # @return Selector
     child :selector, :selector
 
     # Get nested field objects
     # @!attribute fields
-    # @return [Array<Field>]
+    # @return Array<Field>
     child :fields, [:field]
   end
 end

data/lib/xsd/objects/keyref.rb

@@ -9,7 +9,7 @@ module XSD
     # The name must be a no-colon-name (NCName) as defined in the XML Namespaces specification.
     # The name must be unique within an identity constraint set. Required.
     # @!attribute name
-    # @return [String]
+    # @return String
     property :name, :string, required: true
 
     # The name of a key or unique element defined in this schema
@@ -17,17 +17,17 @@ module XSD
     # The refer value must be a qualified name (QName).
     # The type can include a namespace prefix. Required.
     # @!attribute refer
-    # @return [String]
+    # @return String
     property :refer, :string, required: true
 
     # Get nested selector object
     # @!attribute selector
-    # @return [Selector]
+    # @return Selector
     child :selector, :selector
 
     # Get nested field objects
     # @!attribute fields
-    # @return [Array<Field>]
+    # @return Array<Field>
     child :fields, [:field]
   end
 end

data/lib/xsd/objects/list.rb

@@ -12,7 +12,7 @@ module XSD
     # Specifies the name of a built-in data type or simpleType element defined in this or another schema.
     # This attribute is not allowed if the content contains a simpleType element, otherwise it is required
     # @!attribute item_type
-    # @return [String, nil]
+    # @return String, nil
     property :itemType, :string
   end
 end

data/lib/xsd/objects/restriction.rb

@@ -16,8 +16,28 @@ module XSD
       fractionDigits length minLength maxLength enumeration whiteSpace pattern
     ].freeze
 
+    # Nested group
+    # @!attribute group
+    # @return Group
+    child :group, :group
+
+    # Nested all
+    # @!attribute all
+    # @return All
+    child :all, :all
+
+    # Nested choice
+    # @!attribute choice
+    # @return Choice
+    child :choice, :choice
+
+    # Nested sequence
+    # @!attribute sequence
+    # @return Sequence
+    child :sequence, :sequence
+
     # Get restriction facets
-    # @return [Hash]
+    # @return Hash
     def facets
       nodes.inject({}) do |hash, node|
         if FACET_ELEMENTS.include?(node.name)
@@ -40,8 +60,8 @@ module XSD
 
     # Get all available elements on the current stack level, optionally including base type elements
     # @param [Boolean] include_base
-    # @return [Array<Element>]
-    def all_elements(include_base = false)
+    # @return Array<Element>
+    def collect_elements(include_base = false)
       # By default we do not include base element for complex restrictions
       super
     end

data/lib/xsd/objects/schema.rb

@@ -13,7 +13,7 @@ module XSD
     # are not required to be qualified with the namespace prefix. "qualified" indicates that attributes from the target
     # namespace must be qualified with the namespace prefix
     # @!attribute attribute_form_default
-    # @return [String]
+    # @return String
     property :attributeFormDefault, :string, default: 'unqualified'
 
     # Optional. The form for elements declared in the target namespace of this schema. The value must be "qualified"
@@ -21,7 +21,7 @@ module XSD
     # not required to be qualified with the namespace prefix. "qualified" indicates that elements from the target
     # namespace must be qualified with the namespace prefix
     # @!attribute element_form_default
-    # @return [String]
+    # @return String
     property :elementFormDefault, :string, default: 'unqualified'
 
     # Optional. Specifies the default value of the block attribute on element and complexType elements in the target
@@ -33,7 +33,7 @@ module XSD
     #   substitution - prevents substitution of elements
     #   #all - prevents all derived complex types
     # @!attribute block_default
-    # @return [String]
+    # @return String
     property :blockDefault, :string
 
     # Optional. Specifies the default value of the final attribute on element, simpleType, and complexType elements in
@@ -46,109 +46,115 @@ module XSD
     #   union - prevents derivation by union
     #   #all - prevents all derivation
     # @!attribute final_default
-    # @return [String]
+    # @return String
     property :finalDefault, :string
 
     # Optional. A URI reference of the namespace of this schema
     # @!attribute target_namespace
-    # @return [String]
+    # @return String
     property :targetNamespace, :string
 
     # Optional. Specifies the version of the schema
     # @!attribute version
-    # @return [String]
+    # @return String
     property :version, :string
 
     # A URI reference that specifies one or more namespaces for use in this schema. If no prefix is assigned, the schema
     # components of the namespace can be used with unqualified references
     # @!attribute xmlns
-    # @return [String]
+    # @return String
     property :xmlns, :string
 
     # Global complex types
     # @!attribute complex_types
-    # @return [Array<ComplexType>]
+    # @return Array<ComplexType>
     child :complex_types, [:complexType]
 
     # Global simple types
     # @!attribute simple_types
-    # @return [Array<SimpleType>]
+    # @return Array<SimpleType>
     child :simple_types, [:simpleType]
 
     # Global groups
     # @!attribute groups
-    # @return [Array<Group>]
+    # @return Array<Group>
     child :groups, [:group]
 
-    # Get nested groups
+    # Schema imports
     # @!attribute imports
-    # @return [Array<Import>]
+    # @return Array<Import>
     child :imports, [:import]
 
+    # Schema includes
+    # @!attribute includes
+    # @return Array<Include>
+    child :includes, [:include]
+
     # Get current schema object
-    # @return [Schema]
+    # @return Schema
     def schema
       self
     end
 
-    # Get all available root elements. Overrides base implementation for better speed
-    # @return [Array<Element>]
-    def all_elements(*)
+    # Get all available elements on the current stack level, for schema same as elements
+    # @return Array<Element>
+    def collect_elements(*)
       elements
     end
 
-    # Get all available root attributes. Overrides base implementation for better speed
-    # @return [Array<Attribute>]
-    def all_attributes(*)
+    # Get all available attributes on the current stack level, for schema same as attributes
+    # @return Array<Attribute>
+    def collect_attributes(*)
       attributes
     end
 
     # Get target namespace prefix. There may be more than one prefix, but we return only first defined
-    # @return [String]
+    # @return String
     def target_namespace_prefix
       @target_namespace_prefix ||= namespaces.key(target_namespace)&.sub(/^xmlns:?/, '') || ''
     end
 
     # Get schema namespace prefix
-    # @return [String]
+    # @return String
     def namespace_prefix
       @namespace_prefix ||= namespaces.key(XML_SCHEMA).sub(/^xmlns:?/, '')
     end
 
     # Check if namespace is a target namespace
-    # @param [String] prefix
-    # @return [Boolean]
-    def targets_namespace?(prefix)
-      namespaces[prefix.empty? ? 'xmlns' : "xmlns:#{prefix}"] == target_namespace
+    # @param [String, nil] namespace
+    # @return Boolean
+    def targets_namespace?(namespace)
+      namespace == target_namespace || namespaces[namespace.empty? ? 'xmlns' : "xmlns:#{namespace}"] == target_namespace
     end
 
-    # Override map_children on schema to get objects from all imported schemas
+    # Override map_children on schema to get objects from all loaded schemas
     # @param [Symbol] name
-    # @return [Array<BaseObject>]
+    # @return Array<BaseObject>
     def map_children(name, cache = {})
       super(name) + import_map_children(name, cache)
     end
 
-    # Get children from all imported schemas
+    # Get children from all loaded schemas
     # @param [Symbol] name
-    # @return [Array<BaseObject>]
-    # TODO: better recursion handling, may be refactor needed 1 reader for all schemas with centralized cache
+    # @return Array<BaseObject>
     def import_map_children(name, cache)
-      return [] if name.to_sym == :import
+      return [] if %i[import include].include?(name.to_sym)
 
-      imports.map do |import|
-        if cache[import.namespace]
-          reader.logger.debug(XSD) { "Schema '#{import.namespace}' already parsed, skiping" }
+      (includes + imports).map do |import|
+        key = import.respond_to?(:namespace) && import.namespace ? import.namespace : import.schema_location
+        if cache.key?(key)
           nil
         else
-          cache[import.namespace] = true
-          import.imported_reader.schema.map_children(name, cache)
+          cache[key] = true
+          import.imported_schema.map_children(name, cache)
         end
       end.compact.flatten
     end
 
+    # Get import by namespace
+    # @return Import
     def import_by_namespace(ns)
-      aliases = [ns, namespaces["xmlns:#{(ns || '').gsub(/^xmlns:/, '')}"]].compact
+      aliases = [ns, namespaces["xmlns:#{(ns || '').gsub(/^xmlns:/, '')}"], reader.namespace_prefixes[ns]].compact
       imports.find { |import| aliases.include?(import.namespace) }
     end
   end

data/lib/xsd/objects/selector.rb

@@ -9,7 +9,7 @@ module XSD
     # Required. Specifies an XPath expression, relative to the element being declared, that identifies the child
     # elements to which the identity constraint applies
     # @!attribute xpath
-    # @return [String]
+    # @return String
     property :xpath, :string, required: true
   end
 end

data/lib/xsd/objects/sequence.rb

@@ -12,22 +12,22 @@ module XSD
 
     # Nested groups
     # @!attribute groups
-    # @return [Array<Group>]
+    # @return Array<Group>
     child :groups, [:group]
 
     # Nested choices
     # @!attribute choices
-    # @return [Array<Choice>]
+    # @return Array<Choice>
     child :choices, [:choice]
 
     # Nested sequences
     # @!attribute sequences
-    # @return [Array<Sequence>]
+    # @return Array<Sequence>
     child :sequences, [:sequence]
 
     # Nested anys
     # @!attribute anys
-    # @return [Array<Any>]
+    # @return Array<Any>
     child :anys, [:any]
   end
 end

data/lib/xsd/objects/simple_content.rb

@@ -8,12 +8,12 @@ module XSD
   class SimpleContent < BaseObject
     # Nested extension
     # @!attribute extension
-    # @return [Extension, nil]
+    # @return Extension, nil
     child :extension, :extension
 
     # Nested restriction
     # @!attribute restriction
-    # @return [Restriction, nil]
+    # @return Restriction, nil
     child :restriction, :restriction
   end
 end