xsd 1.0.0

data/lib/xsd/objects/attribute_group.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module XSD
+  # The attributeGroup element is used to group a set of attribute declarations so that they can be incorporated as a
+  # group into complex type definitions.
+  # Parent elements: attributeGroup, complexType, schema, restriction (both simpleContent and complexContent),
+  # extension (both simpleContent and complexContent
+  # https://www.w3schools.com/xml/el_attributegroup.asp
+  class AttributeGroup < BaseObject
+    include Referenced
+    include AttributeContainer
+
+    # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
+    # @!attribute name
+    # @return [String]
+    property :name, :string
+  end
+end

data/lib/xsd/objects/choice.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module XSD
+  # XML Schema choice element allows only one of the elements contained in the <choice> declaration to be present
+  # within the containing element.
+  # Parent elements: group, choice, sequence, complexType, restriction (both simpleContent and complexContent),
+  # extension (both simpleContent and complexContent)
+  # https://www.w3schools.com/xml/el_choice.asp
+  class Choice < BaseObject
+    include MinMaxOccurs
+    include ElementContainer
+
+    # Nested groups
+    # @!attribute groups
+    # @return [Array<Group>]
+    child :groups, [:group]
+
+    # Nested choices
+    # @!attribute choices
+    # @return [Array<Choice>]
+    child :choices, [:choice]
+
+    # Nested sequences
+    # @!attribute sequences
+    # @return [Array<Sequence>]
+    child :sequences, [:sequence]
+
+    # Nested anys
+    # @!attribute anys
+    # @return [Array<Any>]
+    child :anys, [:any]
+  end
+end

data/lib/xsd/objects/complex_content.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module XSD
+  # The complexContent element defines extensions or restrictions
+  # on a complex type that contains mixed content or elements only.
+  # Parent elements: complexType
+  # https://www.w3schools.com/xml/el_complexcontent.asp
+  class ComplexContent < BaseObject
+    # Optional. Specifies whether character data is allowed to appear between the child elements of this complexType
+    # element. Default is false
+    # @!attribute mixed
+    # @return [Boolean]
+    property :mixed, :boolean, default: false
+
+    # Get nested extension
+    # @!attribute extension
+    # @return [Extension, nil]
+    child :extension, :extension
+
+    # Get nested restriction
+    # @!attribute restriction
+    # @return [Restriction, nil]
+    child :restriction, :restriction
+  end
+end

data/lib/xsd/objects/complex_type.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module XSD
+  # The complexType element defines a complex type. A complex type element is an XML element that contains other
+  # elements and/or attributes.
+  # Parent elements: element, redefine, schema
+  # https://www.w3schools.com/xml/el_complextype.asp
+  class ComplexType < BaseObject
+    include AttributeContainer
+
+    # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
+    # @!attribute name
+    # @return [String]
+    property :name, :string
+
+    # Optional. Specifies whether the complex type can be used in an instance document. True indicates that an element
+    # cannot use this complex type directly but must use a complex type derived from this complex type. Default is false
+    # @!attribute abstract
+    # @return [Boolean]
+    property :abstract, :boolean, default: false
+
+    # Optional. Specifies whether character data is allowed to appear between the child elements of this complexType
+    # element. Default is false. If a simpleContent element is a child element, the mixed attribute is not allowed!
+    # @!attribute mixed
+    # @return [Boolean]
+    property :mixed, :boolean, default: false
+
+    # Optional. Prevents a complex type that has a specified type of derivation from being used in place of this
+    # complex type. This value can contain #all or a list that is a subset of extension or restriction:
+    #   extension - prevents complex types derived by extension
+    #   restriction - prevents complex types derived by restriction
+    #   #all - prevents all derived complex types
+    # @!attribute block
+    # @return [String, nil]
+    property :block, :string
+
+    # Optional. Prevents a specified type of derivation of this complex type element. Can contain #all or a list
+    # that is a subset of extension or restriction.
+    #   extension - prevents derivation by extension
+    #   restriction - prevents derivation by restriction
+    #   #all - prevents all derivation
+    # @!attribute final
+    # @return [String, nil]
+    property :final, :string
+
+    # Simple content object
+    # @!attribute simple_content
+    # @return [SimpleContent]
+    child :simple_content, :simpleContent
+
+    # Complex content object
+    # @!attribute complex_content
+    # @return [ComplexContent]
+    child :complex_content, :complexContent
+
+    # 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
+
+    # Determine if this is a linked type
+    # @return [Boolean]
+    def linked?
+      !name.nil?
+    end
+  end
+end

data/lib/xsd/objects/documentation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module XSD
+  # The documentation element is used to enter text comments in a schema.
+  # Parent elements: annotation
+  # https://www.w3schools.com/xml/el_documentation.asp
+  class Documentation < BaseObject
+    # Optional. A URI reference that specifies the source of the application information
+    # @!attribute source
+    # @return [String]
+    property :source, :string
+
+    # Optional. Specifies the language used in the contents
+    # @!attribute xml_lang
+    # @return [String]
+    property :'xml:lang', :string
+  end
+end

data/lib/xsd/objects/element.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module XSD
+  # The element element defines an element.
+  # Parent elements: schema, choice, all, sequence, group
+  # https://www.w3schools.com/xml/el_element.asp
+  class Element < BaseObject
+    TYPE_PROPERTY = :type
+
+    include MinMaxOccurs
+    include SimpleTyped
+    include ComplexTyped
+    include Referenced
+
+    # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
+    # @!attribute name
+    # @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]
+    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]
+    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]
+    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]
+    property :fixed, :string
+
+    # Optional. Specifies the form for the element. "unqualified" indicates that this element is not required to be
+    # qualified with the namespace prefix. "qualified" indicates that this element must be qualified with the namespace
+    # 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]
+    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]
+    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]
+    property :abstract, :boolean, default: false
+
+    # Optional. Prevents an element with a specified type of derivation from being used in place of this element.
+    # This value can contain #all or a list that is a subset of extension, restriction, or equivClass:
+    #     extension    - prevents elements derived by extension
+    #     restriction  - prevents elements derived by restriction
+    #     substitution - prevents elements derived by substitution
+    #     #all         - prevents all derived elements
+    # @!attribute block
+    # @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
+    # the parent element is not the schema element. This value can contain #all or a list that is a subset of extension
+    # or restriction:
+    #     extension   - prevents elements derived by extension
+    #     restriction - prevents elements derived by restriction
+    #     #all        - prevents all derived elements
+    # @!attribute final
+    # @return [String, nil]
+    property :final, :string
+
+    # Nested unique objects
+    # @!attribute unique
+    # @return [Array<Unique>]
+    child :unique, [:unique]
+
+    # Determine if element is required
+    # @return [Boolean]
+    def required?
+      computed_min_occurs > 0
+    end
+
+    # Determine if element is optional
+    # @return [Boolean]
+    def optional?
+      !required?
+    end
+
+    # Determine if element may occur multiple times
+    # @return [Boolean]
+    def multiple_allowed?
+      computed_max_occurs == :unbounded || computed_max_occurs > 1
+    end
+
+    # Determine if element has complex content
+    # @return [Boolean]
+    def complex?
+      complex_type && !complex_type.simple_content && all_elements.any?
+    end
+
+    # Get elements that can appear instead of this one
+    # @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|
+        element.substitution_group&.split(':')&.last == name
+      end
+    end
+
+    # Get target namespace
+    # @return [String]
+    def target_namespace
+      schema.target_namespace
+    end
+  end
+end

data/lib/xsd/objects/extension.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module XSD
+  # The extension element extends an existing simpleType or complexType element.
+  # Parent elements: simpleContent, complexContent
+  # https://www.w3schools.com/xml/el_extension.asp
+  class Extension < BaseObject
+    TYPE_PROPERTY = nil
+
+    include Based
+    include SimpleTyped
+    include AttributeContainer
+  end
+end

data/lib/xsd/objects/facet.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module XSD
+  # Virtual object for all restriction facets
+  # Parent elements: restriction
+  class Facet < BaseObject
+    # Returns facet value
+    # @!attribute value
+    # @return [String]
+    property :value, :string
+  end
+end

data/lib/xsd/objects/field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module XSD
+  # The field element specifies an XPath expression that specifies the value used to define an identity constraint.
+  # Parent elements: key, keyref, unique
+  # https://www.w3schools.com/xml/el_field.asp
+  class Field < BaseObject
+    # Required. Identifies a single element or attribute whose content or value is used for the constraint
+    # @!attribute xpath
+    # @return [String]
+    property :xpath, :string, required: true
+  end
+end

data/lib/xsd/objects/group.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module XSD
+  # The group element is used to define a group of elements to be used in complex type definitions.
+  # Parent elements: schema, choice, sequence, complexType, restriction (both simpleContent and complexContent),
+  # extension (both simpleContent and complexContent)
+  # https://www.w3schools.com/xml/el_group.asp
+  class Group < BaseObject
+    include MinMaxOccurs
+    include Referenced
+
+    # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
+    # @!attribute name
+    # @return [String]
+    property :name, :string
+
+    # Nested all object
+    # @!attribute all
+    # @return [All]
+    child :all, :all
+
+    # Nested choice object
+    # @!attribute choice
+    # @return [Choice]
+    child :choice, :choice
+
+    # Nested sequence object
+    # @!attribute sequence
+    # @return [Sequence]
+    child :sequence, :sequence
+  end
+end

data/lib/xsd/objects/import.rb

@@ -0,0 +1,67 @@
+# 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
+  # https://www.w3schools.com/xml/el_import.asp
+  class Import < BaseObject
+    # Optional. Specifies the URI of the namespace to import
+    # @!attribute namespace
+    # @return [String, nil]
+    property :namespace, :string
+
+    # Optional. Specifies the URI to the schema for the imported namespace
+    # @!attribute schema_location
+    # @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
+
+    private
+
+    def download_uri(uri)
+      reader.logger.debug(XSD) { "Downloading import schema for namespace '#{namespace}' from '#{uri}'" }
+
+      begin
+        response = RestClient.get(uri)
+      rescue RestClient::Exception => e
+        raise ImportError, e.message
+      end
+
+      response.body
+    end
+  end
+end

data/lib/xsd/objects/key.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module XSD
+  # The unique element defines that an element or an attribute value must be unique within the scope.
+  # Parent elements: element
+  # https://www.w3schools.com/xml/el_unique.asp
+  class Key < BaseObject
+    # The name of the key element.
+    # 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]
+    property :name, :string, required: true
+
+    # Get nested selector object
+    # @!attribute selector
+    # @return [Selector]
+    child :selector, :selector
+
+    # Get nested field objects
+    # @!attribute fields
+    # @return [Array<Field>]
+    child :fields, [:field]
+  end
+end

data/lib/xsd/objects/keyref.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module XSD
+  # The unique element defines that an element or an attribute value must be unique within the scope.
+  # Parent elements: element
+  # https://www.w3schools.com/xml/el_unique.asp
+  class Keyref < BaseObject
+    # The name of the keyref element.
+    # 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]
+    property :name, :string, required: true
+
+    # The name of a key or unique element defined in this schema
+    # (or another schema indicated by the specified namespace).
+    # The refer value must be a qualified name (QName).
+    # The type can include a namespace prefix. Required.
+    # @!attribute refer
+    # @return [String]
+    property :refer, :string, required: true
+
+    # Get nested selector object
+    # @!attribute selector
+    # @return [Selector]
+    child :selector, :selector
+
+    # Get nested field objects
+    # @!attribute fields
+    # @return [Array<Field>]
+    child :fields, [:field]
+  end
+end

data/lib/xsd/objects/list.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module XSD
+  # The list element defines a simple type element as a list of values of a specified data type.
+  # Parent elements: simpleType
+  # https://www.w3schools.com/xml/el_list.asp
+  class List < BaseObject
+    TYPE_PROPERTY = :itemType
+
+    include SimpleTyped
+
+    # 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]
+    property :itemType, :string
+  end
+end

data/lib/xsd/objects/restriction.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module XSD
+  # The restriction element defines restrictions on a simpleType, simpleContent, or complexContent definition.
+  # Parent elements: simpleType, simpleContent, complexContent
+  # https://www.w3schools.com/xml/el_restriction.asp
+  class Restriction < BaseObject
+    TYPE_PROPERTY = nil
+
+    include Based
+    include SimpleTyped
+    include AttributeContainer
+
+    FACET_ELEMENTS = %w[
+      minExclusive minInclusive maxExclusive maxInclusive totalDigits
+      fractionDigits length minLength maxLength enumeration whiteSpace pattern
+    ].freeze
+
+    # Get restriction facets
+    # @return [Hash]
+    def facets
+      nodes.inject({}) do |hash, node|
+        if FACET_ELEMENTS.include?(node.name)
+          key   = node.name
+          value = node['value']
+
+          if key == 'enumeration'
+            hash[key]        ||= {}
+            hash[key][value] = documentation_for(node)
+          elsif key == 'pattern'
+            hash[key] ||= []
+            hash[key].push(value)
+          else
+            hash[key] = value
+          end
+        end
+        hash
+      end
+    end
+
+    # 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)
+      # By default we do not include base element for complex restrictions
+      super
+    end
+  end
+end