xsd 2.4.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5866e8be4b81ee97f2df8d4b1df3f585d94a3edcb7408ef45d6f8fee2fb89f1e
-  data.tar.gz: 793e41c9424ca2cce3d0b9f5b26b38d9e39696c31c29910ba3f9223dd6850724
+  metadata.gz: 2a5aa03e831e5cf4e88780b18a4ef57217eff54a14e2138669672f33486ba8bd
+  data.tar.gz: b6a9ab392e47192a6a286ffa7dc97c5f624c78d9ab117bdea67e11f801c39363
 SHA512:
-  metadata.gz: 89bee39c770bb75941940911c875159b455443a97fdb10d6bb0064a3acfb557d66f106fba45701940aff51f07f2f61a5d7f44453ed7b80a81426042da76dec8e
-  data.tar.gz: 8b3f4004b78f7a5be63903514a60971a21b5107e4488882d2d2a36e260d6d6eaa6b200ab37491fe4060d50f8f00c18b0ced84aac3323819af41d02535fb7512a
+  metadata.gz: a031bc3a3947708a8f6f8e4add4040853f9f8b62cd3465de56421600d9fc2d2b7c45b163efe239c7486dce05bf0427d8f380e119673b644739f736b4598b5276
+  data.tar.gz: ad7bbd0268373292a291935599749dc9937784438b398958acf592db4e1648967106f45c1dd402c82f3cdd534f2fe0e177a1250e91f65872fc3aa9d9a8b416a5

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-## [Unreleased]
+## [2.6.0] - 2024-04-12
+
+- Fix XSD boolean attributes
+- Add support for element lookup with namespace
+- Add element (with simple content) data type calculation
+- Add element mixed type calculation
+
+## [2.4.3] - 2024-04-04
+
+- Fix detecting types and refs when namespaces are overidden per element
+- Fix documentation encoding issue with no XML declaration
 
 ## [2.4.1] - 2023-11-13
 

data/README.md

@@ -28,8 +28,13 @@ require 'xsd'
 # Load ruby-xsd
 reader = XSD::XML.open('some.xsd')
 
-# Get elements and their child elements
+# Get element by name with hash lookup 
 element = reader['NewReleaseMessage']
+
+# Get element by namespace + name with hash lookup
+element = reader['{http://ddex.net/xml/ern/36}NewReleaseMessage']
+
+# Get element child elements
 element.collect_elements.map(&:name) # => ['MessageHeader', 'UpdateIndicator', 'IsBackfill', 'CatalogTransfer', 'WorkList', 'CueSheetList', 'ResourceList', 'CollectionList', 'ReleaseList', 'DealList']
 
 # Get attributes
@@ -38,6 +43,7 @@ attribute = reader['NewReleaseMessage']['@MessageSchemaVersionId']
 # Get attribute information
 attribute.name # => 'MessageSchemaVersionId'
 attribute.type # => 'xs:string'
+attribute.data_type # => 'string'
 attribute.required? # => true
 attribute.optional? # => false
 attribute.prohibited? # => true
@@ -48,7 +54,9 @@ element.min_occurs # => 0
 element.max_occurs # => :unbounded
 element.type # => 'ern:SoundRecording'
 element.complex_type # => XSD::ComplexType
-element.complex? # => true
+element.complex_content? # => true
+element.simple_content? # => false
+element.mixed_content? # => false
 element.multiple_allowed? # => true
 element.required? # => false
 ```

data/lib/xsd/base_object.rb

@@ -34,7 +34,7 @@ module XSD
 
     def initialize(options = {})
       @options = options
-      @cache   = {}
+      @cache = {}
 
       raise Error, "#{self.class}.new expects a hash parameter" unless @options.is_a?(Hash)
     end
@@ -76,12 +76,16 @@ module XSD
     # @param [String, nil] ns_or_prefix
     # @return Array<Schema>
     def schemas_for_namespace(ns_or_prefix)
-      if schema.targets_namespace?(ns_or_prefix)
+      # resolve namespace for current node if prefix was provided
+      prefix = node.namespaces["xmlns:#{ns_or_prefix}"]
+      ns = prefix || ns_or_prefix
+
+      if schema.targets_namespace?(ns)
         [schema, *schema.includes.map(&:imported_schema)]
-      elsif (import = schema.import_by_namespace(ns_or_prefix))
+      elsif (import = schema.import_by_namespace(ns))
         [import.imported_schema]
       else
-        raise Error, "Schema not found for namespace '#{ns_or_prefix}' in '#{schema.id || schema.target_namespace}'"
+        raise Error, "Schema not found for namespace '#{ns}' in '#{schema.id || schema.target_namespace}'"
       end
     end
 
@@ -96,9 +100,9 @@ module XSD
         curname = curname.to_s
 
         if curname[0] == '@'
-          result = result.collect_attributes.find { |attr| attr.name == curname[1..-1] }
+          result = result.collect_attributes.find { |attr| definition_match?(attr, curname[1..]) }
         else
-          result = result.collect_elements.find { |elem| elem.name == curname }
+          result = result.collect_elements.find { |elem| definition_match?(elem, curname) }
         end
       end
 
@@ -112,7 +116,7 @@ module XSD
     def object_by_name(node_name, name)
       # get prefix and local name
       name_prefix = get_prefix(name)
-      name_local  = strip_prefix(name)
+      name_local = strip_prefix(name)
 
       # do not search for built-in types
       return nil if schema.namespace_prefix == name_prefix
@@ -122,7 +126,7 @@ module XSD
 
       # find element in target schema
       search_schemas.each do |s|
-        node = s.node.xpath("./xs:#{node_name}[@name=\"#{name_local}\"]", { 'xs' => XML_SCHEMA }).first
+        node = s.node.at_xpath("./xs:#{node_name}[@name=\"#{name_local}\"]", { 'xs' => XML_SCHEMA })
         return s.node_to_object(node) if node
       end
 
@@ -134,7 +138,6 @@ module XSD
     # @return BaseObject
     def node_to_object(node)
       # check object in cache first
-      # TODO: проверить работу!
       return reader.object_cache[node.object_id] if reader.object_cache[node.object_id]
 
       klass = XML::CLASS_MAP[node.name]
@@ -199,43 +202,49 @@ module XSD
     # Get all available elements on the current stack level
     # @return Array<Element>
     def collect_elements(*)
-      # exclude element that can not have elements
-      return [] if NO_ELEMENTS_CONTAINER.include?(self.class.mapped_name)
+      return @collect_elements if @collect_elements
 
-      if is_a?(Referenced) && ref
-        reference.collect_elements
-      else
-        # map children recursive
-        map_children(:*).map do |obj|
-          if obj.is_a?(Element)
-            obj
+      r = if NO_ELEMENTS_CONTAINER.include?(self.class.mapped_name)
+            []
+          elsif is_a?(Referenced) && ref
+            reference.collect_elements
           else
-            # get elements considering references
-            (obj.is_a?(Referenced) && obj.ref ? obj.reference : obj).collect_elements
+            # map children recursive
+            map_children(:*).map do |obj|
+              if obj.is_a?(Element)
+                obj
+              else
+                # get elements considering references
+                (obj.is_a?(Referenced) && obj.ref ? obj.reference : obj).collect_elements
+              end
+            end.flatten
           end
-        end.flatten
-      end
+
+      @collect_elements = r
     end
 
     # Get all available attributes on the current stack level
     # @return Array<Attribute>
     def collect_attributes(*)
-      # exclude element that can not have elements
-      return [] if NO_ATTRIBUTES_CONTAINER.include?(self.class.mapped_name)
+      return @collect_attributes if @collect_attributes
 
-      if is_a?(Referenced) && ref
-        reference.collect_attributes
-      else
-        # map children recursive
-        map_children(:*).map do |obj|
-          if obj.is_a?(Attribute)
-            obj
+      r = if NO_ATTRIBUTES_CONTAINER.include?(self.class.mapped_name)
+            []
+          elsif is_a?(Referenced) && ref
+            reference.collect_attributes
           else
-            # get attributes considering references
-            (obj.is_a?(Referenced) && obj.ref ? obj.reference : obj).collect_attributes
+            # map children recursive
+            map_children(:*).map do |obj|
+              if obj.is_a?(Attribute)
+                obj
+              else
+                # get attributes considering references
+                (obj.is_a?(Referenced) && obj.ref ? obj.reference : obj).collect_attributes
+              end
+            end.flatten
           end
-        end.flatten
-      end
+
+      @collect_attributes = r
     end
 
     # Get reader instance
@@ -256,8 +265,8 @@ module XSD
     # @param [Hash] options
     def self.property(name, type, options = {}, &block)
       properties[to_underscore(name)] = {
-        name:    name,
-        type:    type,
+        name: name,
+        type: type,
         resolve: block,
         **options
       }
@@ -294,7 +303,7 @@ module XSD
 
       # check for property first
       if (property = self.class.properties[method])
-        value  = property[:resolve] ? property[:resolve].call(self) : node[property[:name].to_s]
+        value = property[:resolve] ? property[:resolve].call(self) : node[property[:name].to_s]
         result = if value.nil?
                    # if object has reference - search property in referenced object
                    node['ref'] ? reference.send(method, *args) : property[:default]
@@ -303,7 +312,7 @@ module XSD
                    when :integer
                      property[:name] == :maxOccurs && value == 'unbounded' ? :unbounded : value.to_i
                    when :boolean
-                     !!value
+                     value == 'true'
                    else
                      value
                    end
@@ -350,10 +359,10 @@ module XSD
     def self.mapped_name
       # @mapped_name ||= XML::CLASS_MAP.each { |k, v| return k.to_sym if v == self }
       @mapped_name ||= begin
-        name    = self.name.split('::').last
-        name[0] = name[0].downcase
-        name.to_sym
-      end
+                         name = self.name.split('::').last
+                         name[0] = name[0].downcase
+                         name.to_sym
+                       end
     end
 
     # Return string if it is not empty, or nil otherwise
@@ -362,5 +371,24 @@ module XSD
     def nil_if_empty(string)
       string&.empty? ? nil : string
     end
+
+    private
+
+    def definition_match?(definition, query)
+      actual_definition = definition.referenced? ? definition.reference : definition
+
+      if query.start_with?('{')
+        parts = query[1..].split('}')
+        raise Error, "Invalid element/attribute query: #{query}" if parts.size != 2
+
+        namespace, name = parts
+
+        return false if namespace != actual_definition.namespace
+      else
+        name = query
+      end
+
+      name == '*' || actual_definition.name == name
+    end
   end
 end

data/lib/xsd/objects/attribute.rb

@@ -10,10 +10,11 @@ module XSD
 
     include SimpleTyped
     include Referenced
+    include Named
 
     # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
     # @!attribute name
-    # @return String
+    # @return String, nil
     property :name, :string
 
     # Optional. Specifies a default value for the attribute. Default and fixed attributes cannot both be present
@@ -34,7 +35,7 @@ module XSD
     #                 matched against the (NCName) of the attribute
     # @!attribute form
     # @return String, nil
-    # TODO: поддержка default значения с вычислением родителя
+    # TODO: support default value from parent
     property :form, :string
 
     # Optional. Specifies a built-in data type or a simple type. The type attribute can only be present when the
@@ -68,5 +69,15 @@ module XSD
     def prohibited?
       use == 'prohibited'
     end
+
+    # Get base data type
+    # @return String, nil
+    def data_type
+      if simple_type
+        simple_type.data_type
+      else
+        strip_prefix(type)
+      end
+    end
   end
 end

data/lib/xsd/objects/attribute_group.rb

@@ -9,10 +9,11 @@ module XSD
   class AttributeGroup < BaseObject
     include Referenced
     include AttributeContainer
+    include Named
 
-    # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
+    # Optional. Specifies the name of the attribute group. Name and ref attributes cannot both be present
     # @!attribute name
-    # @return String
+    # @return String, nil
     property :name, :string
   end
 end

data/lib/xsd/objects/complex_type.rb

@@ -7,8 +7,9 @@ module XSD
   # https://www.w3schools.com/xml/el_complextype.asp
   class ComplexType < BaseObject
     include AttributeContainer
+    include Named
 
-    # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
+    # Optional. Specifies a name for the element
     # @!attribute name
     # @return String
     property :name, :string
@@ -78,5 +79,55 @@ module XSD
     def linked?
       !name.nil?
     end
+
+    # Determine if this type has mixed content definition
+    # @return Boolean
+    def mixed_content?
+      return true if mixed
+
+      if complex_content
+        return true if complex_content.mixed
+
+        return (complex_content.extension || complex_content.restriction).base_complex_type&.mixed_content?
+      end
+
+      false
+    end
+
+    # Determine if this type has complex content definition
+    # @return Boolean
+    def complex_content?
+      if simple_content
+        false
+      elsif complex_content
+        true
+      else
+        group || all || choice || sequence
+      end
+    end
+
+    # Determine if this type has simple content definition
+    # @return Boolean
+    def simple_content?
+      !!simple_content
+    end
+
+    # Get simple content data type
+    # @return String, nil
+    def data_type
+      return nil unless simple_content
+
+      restriction = simple_content.restriction
+      if restriction
+        if restriction.base
+          restriction.base_simple_type&.data_type || strip_prefix(restriction.base)
+        else
+          restriction.simple_type&.data_type
+        end
+      else
+        extension = simple_content.extension
+        extension.base_simple_type&.data_type || strip_prefix(extension.base)
+      end
+    end
   end
 end

data/lib/xsd/objects/element.rb

@@ -11,10 +11,11 @@ module XSD
     include SimpleTyped
     include ComplexTyped
     include Referenced
+    include Named
 
-    # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
+    # Optional. Specifies a name for the element. This attribute is required if the parent element is the schema element
     # @!attribute name
-    # @return String
+    # @return String, nil
     property :name, :string
 
     # Optional. Specifies either the name of a built-in data type, or the name of a simpleType or complexType element
@@ -107,8 +108,32 @@ module XSD
 
     # Determine if element has complex content
     # @return Boolean
-    def complex?
-      complex_type && !complex_type.simple_content && collect_elements.any?
+    def complex_content?
+      # this is not an opposite to simple_content?, element may have neither
+      complex_type&.complex_content? || false
+    end
+
+    # Determine if element has simple content
+    # @return Boolean
+    def simple_content?
+      # this is not an opposite to complex_content?, element may have neither
+      if complex_type
+        complex_type.simple_content?
+      else
+        true
+      end
+    end
+
+    # Determine if element has attributes
+    # @return Boolean
+    def attributes?
+      complex_type && collect_attributes.any?
+    end
+
+    # Determine if element has mixed content
+    # @return Boolean
+    def mixed_content?
+      complex_type&.mixed_content? || false
     end
 
     # Get elements that can appear instead of this one
@@ -117,14 +142,20 @@ module XSD
       # 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.collect_elements.select do |element|
-        element.substitution_group&.split(':')&.last == name
+        strip_prefix(element.substitution_group) == name
       end
     end
 
-    # Get target namespace
-    # @return String
-    def target_namespace
-      schema.target_namespace
+    # Get base data type
+    # @return String, nil
+    def data_type
+      if complex_type
+        complex_type.data_type
+      elsif simple_type
+        simple_type.data_type
+      else
+        strip_prefix(type)
+      end
     end
   end
 end

data/lib/xsd/objects/simple_type.rb

@@ -6,9 +6,12 @@ module XSD
   # Parent elements: attribute, element, list, restriction, schema, union
   # https://www.w3schools.com/xml/el_simpletype.asp
   class SimpleType < BaseObject
-    # Optional. Specifies the name of the attribute. Name and ref attributes cannot both be present
+    include Named
+
+    # Specifies a name for the element. This attribute is required if the simpleType element is a child of the
+    # schema element, otherwise it is not allowed
     # @!attribute name
-    # @return String
+    # @return String, nil
     property :name, :string
 
     # Nested restriction
@@ -31,5 +34,23 @@ module XSD
     def linked?
       !name.nil?
     end
+
+    # Get base data type
+    # @return String, nil
+    def data_type
+      if restriction
+        if restriction.base
+          restriction.base_simple_type&.data_type || strip_prefix(restriction.base)
+        else
+          restriction.simple_type&.data_type
+        end
+      elsif union
+        types = union.types.map { |type| type.is_a?(String) ? strip_prefix(type) : type.data_type }.uniq
+        types.size == 1 ? types.first : types
+      else
+        # list is always a sting
+        'string'
+      end
+    end
   end
 end

data/lib/xsd/shared/named.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module XSD
+  module Named
+    # Get definition namespace
+    # @return String
+    def namespace
+      schema.target_namespace
+    end
+
+    # Get absolute definition name
+    # @return String
+    def absolute_name
+      name ? "{#{namespace}}#{name}" : nil
+    end
+  end
+end

data/lib/xsd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module XSD
-  VERSION = '2.4.2'
+  VERSION = '2.6.0'
 end

data/lib/xsd/xml.rb

@@ -5,8 +5,6 @@ require 'net/http'
 
 module XSD
   class XML
-    include Generator
-
     attr_reader :options, :object_cache, :schemas
 
     DEFAULT_RESOURCE_RESOLVER = proc do |location, namespace|

data/lib/xsd.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'xsd/base_object'
+require 'xsd/shared/named'
 require 'xsd/shared/min_max_occurs'
 require 'xsd/shared/referenced'
 require 'xsd/shared/attribute_container'
@@ -37,6 +38,5 @@ require 'xsd/objects/appinfo'
 require 'xsd/objects/any_attribute'
 require 'xsd/objects/key'
 require 'xsd/objects/keyref'
-require 'xsd/generator'
 require 'xsd/exceptions'
 require 'xsd/xml'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xsd
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.6.0
 platform: ruby
 authors:
 - d.arkhipov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -72,7 +72,6 @@ files:
 - lib/xsd.rb
 - lib/xsd/base_object.rb
 - lib/xsd/exceptions.rb
-- lib/xsd/generator.rb
 - lib/xsd/objects/all.rb
 - lib/xsd/objects/annotation.rb
 - lib/xsd/objects/any.rb
@@ -107,6 +106,7 @@ files:
 - lib/xsd/shared/complex_typed.rb
 - lib/xsd/shared/element_container.rb
 - lib/xsd/shared/min_max_occurs.rb
+- lib/xsd/shared/named.rb
 - lib/xsd/shared/referenced.rb
 - lib/xsd/shared/simple_typed.rb
 - lib/xsd/version.rb

data/lib/xsd/generator.rb

@@ -1,146 +0,0 @@
-# frozen_string_literal: true
-
-require 'builder'
-
-module XSD
-  module Generator
-    # Generate XML from provided data
-    # @param [Hash] data
-    # @param [String, Array<String>] element
-    # @param [Builder::XmlMarkup] builder
-    # @return Builder::XmlMarkup
-    def generate(data, element = nil, builder = nil)
-      # find root element
-      root = find_root_element(element)
-
-      # create builder
-      builder ||= default_builder
-
-      # build element tree
-      @namespace_index = 0
-      build_element(builder, root, data)
-
-      builder
-    end
-
-    private
-
-    # Build element tree
-    # @param [Builder::XmlMarkup] xml
-    # @param [Element] element
-    # @param [Hash] data
-    # @param [Hash] namespaces
-    def build_element(xml, element, data, namespaces = {})
-      # get item data
-      elements         = (element.abstract ? [] : [element]) + element.substitution_elements
-      provided_element = elements.find { |elem| !data[elem.name].nil? }
-
-      if element.required? && provided_element.nil?
-        raise Error, "Element #{element.name} is required, but no data in provided for it"
-      end
-      return unless provided_element
-
-      element = provided_element
-      data    = data[element.name]
-
-      # handle repeated items
-      if element.multiple_allowed?
-        unless data.is_a?(Array)
-          raise Error, "Element #{element.name} is allowed to occur multiple times, but non-array is provided"
-        end
-      else
-        if data.is_a?(Array)
-          raise Error, "Element #{element.name} is not allowed to occur multiple times, but an array is provided"
-        end
-
-        data = [data]
-      end
-
-      # configure namespaces
-      # TODO: попытаться использовать collect_namespaces?
-      attributes = {}
-      all_attributes = element.collect_attributes
-      if element.complex?
-        all_elements = element.collect_elements
-
-        # get namespaces for current element and it's children
-        prefix = nil
-        [*all_elements, element].each do |elem|
-          prefix = get_namespace_prefix(elem, attributes, namespaces)
-        end
-      else
-        prefix = get_namespace_prefix(element, attributes, namespaces)
-      end
-
-      # iterate through each item
-      data.each do |item|
-        # prepare attributes
-        all_attributes.each do |attribute|
-          value = item["@#{attribute.name}"]
-          if !value.nil?
-            attributes[attribute.name] = value
-          elsif attribute.required?
-            raise Error, "Attribute #{attribute.name} is required, but no data in provided for it" if attribute.fixed.nil?
-
-            attributes[attribute.name] = attribute.fixed
-          else
-            attributes.delete(attribute.name)
-          end
-        end
-
-        # generate element
-        if element.complex?
-          # generate tag recursively
-          xml.tag!("#{prefix}:#{element.name}", attributes) do
-            all_elements.each do |elem|
-              build_element(xml, elem, item, namespaces.dup)
-            end
-          end
-        else
-          has_text = item.is_a?(Hash)
-          if has_text && element.complex_type&.nodes(:any, true)&.any?
-            xml.tag!("#{prefix}:#{element.name}", attributes) { |res| res << item['#text'].to_s }
-          else
-            value = has_text ? item['#text'] : item
-            xml.tag!("#{prefix}:#{element.name}", attributes, (value == '' ? nil : value))
-          end
-        end
-      end
-    end
-
-    # Get namespace prefix for element
-    # @param [Element] element
-    # @param [Hash] attributes
-    # @param [Hash] namespaces
-    # @return String
-    def get_namespace_prefix(element, attributes, namespaces)
-      namespace = (element.referenced? ? element.reference : element).target_namespace
-      prefix    = namespaces.key(namespace)
-      unless prefix
-        prefix             = "n#{@namespace_index += 1}"
-        namespaces[prefix] = attributes["xmlns:#{prefix}"] = namespace
-      end
-
-      prefix
-    end
-
-    # Find root element with provided lookup
-    # @param [String, Array<String>, nil] lookup
-    def find_root_element(lookup)
-      if lookup
-        element = self[*lookup]
-        raise Error, "Cant find start element #{lookup}" unless element.is_a?(Element)
-
-        element
-      else
-        raise Error, 'XSD contains more that one root element. Please, specify starting element' if elements.size > 1
-
-        elements.first
-      end
-    end
-
-    def default_builder
-      Builder::XmlMarkup.new
-    end
-  end
-end