xsd 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9808a3d7cd5e73e6646222be452a476e4fc5f27997e3bc17e3016bc27c4ebda1
-  data.tar.gz: 4a1fd4f0877002b60b1274f5b9c2cde51b5ac8c3c1872964feb8bef5fddd7972
+  metadata.gz: d3b12830c536c37e72b109727f470d45de29b6c852e62476cd3aa5578dd3b9c7
+  data.tar.gz: 248b65a3794a6c83a6aca695b0d565d55b971991272fd5f7f0a8a841fb8847ec
 SHA512:
-  metadata.gz: '02650138ed60e27ad29e606b0a39fd7e7443de91f249486e178d39c40f7e59da556448fc8af5e52696a353345744ecc98639163a8a01cb48a54ff416f01a92a4'
-  data.tar.gz: 8d246d14bdcba114e6d72b878f187c89480a8571b8e6ea57753a06507d37a6526a9c9aeb000669bfb78b248cad1cbea1c74a6dd8cacab8aa4fbb20c18786ed93
+  metadata.gz: ac15d2c2c163bd70f007fd76b5c007fbc786ed09d5609a2d6dba5aa8836144917a5159a32c1b7f47aa250bd18034d8339f445180fc4cd330745138ec60283e32
+  data.tar.gz: 7db0b9ac2ba0c97aab16d84db5145b4a8a18c901f3c24c8fd13a73b96a1998083a41cff38c3b0f7098dc53457b693e0ee5d3d941ceb1712f38a54924d32ce544

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [2.1.0] - 2023-07-10
+
+- Add support for <xs:include> element
+- Changed method "schema_for_namespace(namespace) -> XSD::Schema" signature to "schemas_for_namespace(namespace) -> Array<XSD::Schema>"
+
+## [2.0.0] - 2023-07-07
+
+- Change XSD::XML.new(file, **options) -> XSD::XML.open(file, **options)
+- Add ability to construct empty reader (reader = XSD::XML.new(**options)) and manually add schemas to it (reader.add_schema_xml(xml))
+- Add ability to configure import resources resolver via options
+
 ## [1.0.0] - 2023-04-25
 
 - Initial release

data/Gemfile

@@ -4,3 +4,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in xsd_to_json.gemspec
 gemspec
+
+group :development do
+  gem 'logger', '~> 1.5'
+  gem 'rspec', '~> 3.12'
+  gem 'rubocop', '~> 1.50'
+  gem 'rubocop-performance', '~> 1.17'
+  gem 'rubocop-rake', '~> 0.6'
+  gem 'rubocop-rspec', '~> 2.10'
+end

data/README.md

@@ -1,7 +1,8 @@
 # XSD
-
+[![Gem Version](https://badge.fury.io/rb/xsd.svg)][gem]
 [![Ruby](https://github.com/ekzo-dev/ruby-xsd/actions/workflows/main.yml/badge.svg)][githubactions]
 
+[gem]: https://badge.fury.io/rb/xsd
 [githubactions]: https://github.com/omniauth/omniauth/actions/workflows/main.yml
 
 The Ruby XSD library is an [XML Schema](https://www.w3.org/2001/XMLSchema) implementation for Ruby. Provides easy and
@@ -25,22 +26,31 @@ gem 'xsd'
 require 'xsd'
 
 # Load ruby-xsd
-reader = XSD::XML.new(:xsd_file => 'some.xsd')
+reader = XSD::XML.open('some.xsd')
+
+# Get elements and their child elements
+element = reader['NewReleaseMessage']
+element.collect_elements.map(&:name) # => ['MessageHeader', 'UpdateIndicator', 'IsBackfill', 'CatalogTransfer', 'WorkList', 'CueSheetList', 'ResourceList', 'CollectionList', 'ReleaseList', 'DealList']
 
 # Get attributes
 attribute = reader['NewReleaseMessage']['@MessageSchemaVersionId']
 
-# Get atrribute information
+# Get attribute information
 attribute.name # => 'MessageSchemaVersionId'
 attribute.type # => 'xs:string'
 attribute.required? # => true
+attribute.optional? # => false
+attribute.prohibited? # => true
 
 # Get element information
-element = reader['NewReleaseMessage']['ResourceList']['SoundRecording']
+element = reader['NewReleaseMessage']['ResourceList']['SoundRecording'] # => XSD::Element
 element.min_occurs # => 0
 element.max_occurs # => :unbounded
 element.type # => 'ern:SoundRecording'
 element.complex_type # => XSD::ComplexType
+element.complex? # => true
+element.multiple_allowed? # => true
+element.required? # => false
 ```
 
 ## Development

data/lib/xsd/base_object.rb

@@ -34,7 +34,7 @@ module XSD
 
     # Optional. Specifies a unique ID for the element
     # @!attribute id
-    # @return [String]
+    # @return String
     # property :id, :string
     def id
       node['id']
@@ -48,39 +48,39 @@ module XSD
     end
 
     # Get current XML node
-    # @return [Nokogiri::XML::Node]
+    # @return Nokogiri::XML::Node
     def node
       options[:node]
     end
 
     # Get current namespaces
-    # @return [Hash]
+    # @return Hash
     def namespaces
       node.namespaces || {}
     end
 
     # Get child nodes
     # @param [Symbol] name
-    # @return [Nokogiri::XML::NodeSet]
+    # @return Nokogiri::XML::NodeSet
     def nodes(name = :*)
       node.xpath("./xs:#{name}", { 'xs' => XML_SCHEMA })
     end
 
-    # Get schema object for specified namespace prefix
-    # @param [String] prefix
-    # @return [Schema]
-    def schema_for_namespace(prefix)
-      if schema.targets_namespace?(prefix)
-        schema
-      elsif (import = schema.import_by_namespace(prefix))
-        import.imported_reader.schema
+    # Get schema by namespace or namespace prefix
+    # @param [String, nil] namespace
+    # @return Array<Schema>
+    def schemas_for_namespace(namespace)
+      if schema.targets_namespace?(namespace)
+        [schema, *schema.includes.map(&:imported_schema)]
+      elsif (import = schema.import_by_namespace(namespace))
+        [import.imported_schema]
       else
-        raise Error, "Schema not found for namespace '#{prefix}' in '#{schema.id || schema.target_namespace}'"
+        raise Error, "Schema not found for namespace '#{namespace}' in '#{schema.id || schema.target_namespace}'"
       end
     end
 
     # Get element or attribute by path
-    # @return [Element, Attribute, nil]
+    # @return Element, Attribute, nil
     def [](*args)
       result = self
 
@@ -90,9 +90,9 @@ module XSD
         curname = curname.to_s
 
         if curname[0] == '@'
-          result = result.all_attributes.find { |attr| attr.name == curname[1..-1] }
+          result = result.collect_attributes.find { |attr| attr.name == curname[1..-1] }
         else
-          result = result.all_elements.find { |elem| elem.name == curname }
+          result = result.collect_elements.find { |elem| elem.name == curname }
         end
       end
 
@@ -102,7 +102,7 @@ module XSD
     # Search node by name in all available schemas and return its object
     # @param [Symbol] node_name
     # @param [String] name
-    # @return [BaseObject, nil]
+    # @return BaseObject, nil
     def object_by_name(node_name, name)
       # get prefix and local name
       name_prefix = get_prefix(name)
@@ -112,17 +112,20 @@ module XSD
       return nil if schema.namespace_prefix == name_prefix
 
       # determine schema for namespace
-      search_schema = schema_for_namespace(name_prefix)
+      search_schemas = schemas_for_namespace(name_prefix)
 
       # find element in target schema
-      result = search_schema.node.xpath("./xs:#{node_name}[@name=\"#{name_local}\"]", { 'xs' => XML_SCHEMA }).first
+      search_schemas.each do |s|
+        node = s.node.xpath("./xs:#{node_name}[@name=\"#{name_local}\"]", { 'xs' => XML_SCHEMA }).first
+        return s.node_to_object(node) if node
+      end
 
-      result ? search_schema.node_to_object(result) : nil
+      nil
     end
 
     # Get reader object for node
     # @param [Nokogiri::XML::Node]
-    # @return [BaseObject]
+    # @return BaseObject
     def node_to_object(node)
       # check object in cache first
       # TODO: проверить работу!
@@ -135,66 +138,66 @@ module XSD
     end
 
     # Get xml parent object
-    # @return [BaseObject, nil]
+    # @return BaseObject, nil
     def parent
       node.respond_to?(:parent) && node.parent ? node_to_object(node.parent) : nil
     end
 
     # Get current schema object
-    # @return [Schema]
+    # @return Schema
     def schema
       options[:schema]
     end
 
     # Get child objects
     # @param [Symbol] name
-    # @return [Array<BaseObject>]
+    # @return Array<BaseObject>
     def map_children(name)
       nodes(name).map { |node| node_to_object(node) }
     end
 
     # Get child object
     # @param [Symbol] name
-    # @return [BaseObject, nil]
+    # @return BaseObject, nil
     def map_child(name)
       map_children(name).first
     end
 
     # Strip namespace prefix from node name
     # @param [String, nil] name Name to strip from
-    # @return [String, nil]
+    # @return String, nil
     def strip_prefix(name)
       name&.include?(':') ? name.split(':').last : name
     end
 
     # Get namespace prefix from node name
     # @param [String, nil] name Name to strip from
-    # @return [String]
+    # @return String, nil
     def get_prefix(name)
-      name&.include?(':') ? name.split(':').first : ''
+      name&.include?(':') ? name.split(':').first : nil
     end
 
     # Return element documentation
-    # @return [Array<String>]
+    # @return Array<String>
     def documentation
       documentation_for(node)
     end
 
     # Return documentation for specified node
     # @param [Nokogiri::XML::Node] node
-    # @return [Array<String>]
+    # @return Array<String>
     def documentation_for(node)
       node.xpath('./xs:annotation/xs:documentation/text()', { 'xs' => XML_SCHEMA }).map(&:to_s).map(&:strip)
     end
 
     # Get all available elements on the current stack level
-    # @return [Array<Element>]
-    def all_elements(*)
+    # @return Array<Element>
+    def collect_elements(*)
       # exclude element that can not have elements
       return [] if NO_ELEMENTS_CONTAINER.include?(self.class.mapped_name)
 
       if is_a?(Referenced) && ref
-        reference.all_elements
+        reference.collect_elements
       else
         # map children recursive
         map_children(:*).map do |obj|
@@ -202,20 +205,20 @@ module XSD
             obj
           else
             # get elements considering references
-            (obj.is_a?(Referenced) && obj.ref ? obj.reference : obj).all_elements
+            (obj.is_a?(Referenced) && obj.ref ? obj.reference : obj).collect_elements
           end
         end.flatten
       end
     end
 
     # Get all available attributes on the current stack level
-    # @return [Array<Attribute>]
-    def all_attributes(*)
+    # @return Array<Attribute>
+    def collect_attributes(*)
       # exclude element that can not have elements
       return [] if NO_ATTRIBUTES_CONTAINER.include?(self.class.mapped_name)
 
       if is_a?(Referenced) && ref
-        reference.all_attributes
+        reference.collect_attributes
       else
         # map children recursive
         map_children(:*).map do |obj|
@@ -223,14 +226,14 @@ module XSD
             obj
           else
             # get attributes considering references
-            (obj.is_a?(Referenced) && obj.ref ? obj.reference : obj).all_attributes
+            (obj.is_a?(Referenced) && obj.ref ? obj.reference : obj).collect_attributes
           end
         end.flatten
       end
     end
 
     # Get reader instance
-    # @return [XML]
+    # @return XML
     def reader
       options[:reader]
     end
@@ -334,7 +337,7 @@ module XSD
     end
 
     # Get mapped element name
-    # @return [Symbol]
+    # @return Symbol
     def self.mapped_name
       # @mapped_name ||= XML::CLASS_MAP.each { |k, v| return k.to_sym if v == self }
       @mapped_name ||= begin

data/lib/xsd/generator.rb

@@ -8,7 +8,7 @@ module XSD
     # @param [Hash] data
     # @param [String, Array<String>] element
     # @param [Builder::XmlMarkup] builder
-    # @return [Builder::XmlMarkup]
+    # @return Builder::XmlMarkup
     def generate(data, element = nil, builder = nil)
       # find root element
       root = find_root_element(element)
@@ -59,13 +59,13 @@ module XSD
       # configure namespaces
       # TODO: попытаться использовать collect_namespaces?
       attributes = {}
-      all_attributes = element.all_attributes
+      collect_attributes = element.collect_attributes
       if element.complex?
-        all_elements = element.all_elements
+        collect_elements = element.collect_elements
 
         # get namespaces for current element and it's children
         prefix = nil
-        [*all_elements, element].each do |elem|
+        [*collect_elements, element].each do |elem|
           prefix = get_namespace_prefix(elem, attributes, namespaces)
         end
       else
@@ -75,7 +75,7 @@ module XSD
       # iterate through each item
       data.each do |item|
         # prepare attributes
-        all_attributes.each do |attribute|
+        collect_attributes.each do |attribute|
           value = item["@#{attribute.name}"]
           if value
             attributes[attribute.name] = value
@@ -88,7 +88,7 @@ module XSD
         if element.complex?
           # generate tag recursively
           xml.tag!("#{prefix}:#{element.name}", attributes) do
-            all_elements.each do |elem|
+            collect_elements.each do |elem|
               build_element(xml, elem, item, namespaces.dup)
             end
           end
@@ -103,7 +103,7 @@ module XSD
     # @param [Element] element
     # @param [Hash] attributes
     # @param [Hash] namespaces
-    # @return [String]
+    # @return String
     def get_namespace_prefix(element, attributes, namespaces)
       namespace = (element.referenced? ? element.reference : element).target_namespace
       prefix    = namespaces.key(namespace)

data/lib/xsd/objects/all.rb

@@ -11,12 +11,12 @@ module XSD
 
     # Optional. Specifies the minimum number of times the element can occur. The value can be 0 or 1. Default value is 1
     # @!attribute min_occurs
-    # @return [Integer]
+    # @return Integer
     property :minOccurs, :integer, default: 1
 
     # Optional. Specifies the maximum number of times the element can occur. The value must be 1.
     # @!attribute max_occurs
-    # @return [Integer]
+    # @return Integer
     property :maxOccurs, :integer, default: 1
   end
 end

data/lib/xsd/objects/annotation.rb

@@ -8,12 +8,12 @@ module XSD
   class Annotation < BaseObject
     # Nested appinfos
     # @!attribute appinfos
-    # @return [Array<Appinfo>]
+    # @return Array<Appinfo>
     child :appinfos, [:appinfo]
 
     # Nested documentations
     # @!attribute documentations
-    # @return [Array<Documentation>]
+    # @return Array<Documentation>
     child :documentations, [:documentation]
   end
 end

data/lib/xsd/objects/any.rb

@@ -15,7 +15,7 @@ module XSD
     #     List of {URI references of namespaces, ##targetNamespace, ##local} - elements from a space-delimited list of
     #     the namespaces can be present
     # @!attribute namespace
-    # @return [String]
+    # @return String
     property :namespace, :string, default: '##any'
 
     # Optional. Specifies how the XML processor should handle validation against the elements specified by this any
@@ -25,7 +25,7 @@ module XSD
     #   lax - same as strict but; if the schema cannot be obtained, no errors will occur
     #   skip - The XML processor does not attempt to validate any elements from the specified namespaces
     # @!attribute process_contents
-    # @return [String, nil]
+    # @return String, nil
     property :processContents, :string, default: 'strict'
   end
 end

data/lib/xsd/objects/any_attribute.rb

@@ -14,7 +14,7 @@ module XSD
     #     List of {URI references of namespaces, ##targetNamespace, ##local} - attributes from a space-delimited list
     #                        of the namespaces can be present
     # @!attribute namespace
-    # @return [String]
+    # @return String
     property :namespace, :string, default: '##any'
 
     # Optional. Specifies how the XML processor should handle validation against the elements specified by this any
@@ -24,7 +24,7 @@ module XSD
     #   lax    - same as strict but; if the schema cannot be obtained, no errors will occur
     #   skip   - The XML processor does not attempt to validate any elements from the specified namespaces
     # @!attribute process_contents
-    # @return [String, nil]
+    # @return String, nil
     property :processContents, :string, default: 'strict'
   end
 end

data/lib/xsd/objects/appinfo.rb

@@ -7,7 +7,7 @@ module XSD
   class Appinfo < BaseObject
     # Optional. A URI reference that specifies the source of the application information
     # @!attribute source
-    # @return [String]
+    # @return String
     property :source, :string
   end
 end

data/lib/xsd/objects/attribute.rb

@@ -13,17 +13,17 @@ 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 a default value for the attribute. Default and fixed attributes cannot both be present
     # @!attribute default
-    # @return [String, nil]
+    # @return String, nil
     property :default, :string
 
     # Optional. Specifies a fixed value for the attribute. Default and fixed attributes cannot both be present
     # @!attribute fixed
-    # @return [String, nil]
+    # @return String, nil
     property :fixed, :string
 
     # Optional. Specifies the form for the attribute. The default value is the value of the attributeFormDefault
@@ -33,14 +33,14 @@ module XSD
     #   unqualified - indicates that this attribute is not required to be qualified with the namespace prefix and is
     #                 matched against the (NCName) of the attribute
     # @!attribute form
-    # @return [String, nil]
+    # @return String, nil
     # TODO: поддержка default значения с вычислением родителя
     property :form, :string
 
     # Optional. Specifies a built-in data type or a simple type. The type attribute can only be present when the
     # content does not contain a simpleType element
     # @!attribute type
-    # @return [String, nil]
+    # @return String, nil
     property :type, :string
 
     # Optional. Specifies how the attribute is used. Can be one of the following values:
@@ -48,23 +48,23 @@ module XSD
     #   prohibited - the attribute cannot be used
     #   required   - the attribute is required
     # @!attribute use
-    # @return [String]
+    # @return String
     property :use, :string, default: 'optional'
 
     # Determine if attribute is required
-    # @return [Boolean]
+    # @return Boolean
     def required?
       use == 'required'
     end
 
     # Determine if attribute is optional
-    # @return [Boolean]
+    # @return Boolean
     def optional?
       use == 'optional'
     end
 
     # Determine if attribute is prohibited
-    # @return [Boolean]
+    # @return Boolean
     def prohibited?
       use == 'prohibited'
     end

data/lib/xsd/objects/attribute_group.rb

@@ -12,7 +12,7 @@ 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
   end
 end

data/lib/xsd/objects/choice.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/complex_content.rb

@@ -9,17 +9,17 @@ module XSD
     # Optional. Specifies whether character data is allowed to appear between the child elements of this complexType
     # element. Default is false
     # @!attribute mixed
-    # @return [Boolean]
+    # @return Boolean
     property :mixed, :boolean, default: false
 
     # Get nested extension
     # @!attribute extension
-    # @return [Extension, nil]
+    # @return Extension, nil
     child :extension, :extension
 
     # Get nested restriction
     # @!attribute restriction
-    # @return [Restriction, nil]
+    # @return Restriction, nil
     child :restriction, :restriction
   end
 end

data/lib/xsd/objects/complex_type.rb

@@ -10,19 +10,19 @@ 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 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]
+    # @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]
+    # @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
@@ -31,7 +31,7 @@ module XSD
     #   restriction - prevents complex types derived by restriction
     #   #all - prevents all derived complex types
     # @!attribute block
-    # @return [String, nil]
+    # @return String, nil
     property :block, :string
 
     # Optional. Prevents a specified type of derivation of this complex type element. Can contain #all or a list
@@ -40,41 +40,41 @@ module XSD
     #   restriction - prevents derivation by restriction
     #   #all - prevents all derivation
     # @!attribute final
-    # @return [String, nil]
+    # @return String, nil
     property :final, :string
 
     # Simple content object
     # @!attribute simple_content
-    # @return [SimpleContent]
+    # @return SimpleContent
     child :simple_content, :simpleContent
 
     # Complex content object
     # @!attribute complex_content
-    # @return [ComplexContent]
+    # @return ComplexContent
     child :complex_content, :complexContent
 
     # Nested group
     # @!attribute group
-    # @return [Group]
+    # @return Group
     child :group, :group
 
     # Nested all
     # @!attribute all
-    # @return [All]
+    # @return All
     child :all, :all
 
     # Nested choice
     # @!attribute choice
-    # @return [Choice]
+    # @return Choice
     child :choice, :choice
 
     # Nested sequence
     # @!attribute sequence
-    # @return [Sequence]
+    # @return Sequence
     child :sequence, :sequence
 
     # Determine if this is a linked type
-    # @return [Boolean]
+    # @return Boolean
     def linked?
       !name.nil?
     end