xsd 1.0.0 → 2.1.0

data/lib/xsd/objects/simple_type.rb

@@ -8,26 +8,26 @@ module XSD
   class SimpleType < BaseObject
     # 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 restriction
     # @!attribute restriction
-    # @return [Restriction, nil]
+    # @return Restriction, nil
     child :restriction, :restriction
 
     # Nested union
     # @!attribute union
-    # @return [Union, nil]
+    # @return Union, nil
     child :union, :union
 
     # Nested list
     # @!attribute list
-    # @return [List, nil]
+    # @return List, nil
     child :list, :list
 
     # Determine if this is a linked type
-    # @return [Boolean]
+    # @return Boolean
     def linked?
       !name.nil?
     end

data/lib/xsd/objects/union.rb

@@ -7,13 +7,13 @@ module XSD
   class Union < BaseObject
     # Optional. Specifies a list of built-in data types or simpleType elements defined in a schema
     # @!attribute member_types
-    # @return [Array<String>]
+    # @return Array<String>
     property :memberTypes, :array, default: [] do |union|
       union.node['memberTypes']&.split(' ')
     end
 
     # Nested simple and built-in types
-    # @return [Array<SimpleType, String>]
+    # @return Array<SimpleType, String>
     def types
       @types ||= map_children(:simpleType) + member_types.map do |name|
         object_by_name(:simpleType, name) || name

data/lib/xsd/objects/unique.rb

@@ -7,12 +7,12 @@ module XSD
   class Unique < BaseObject
     # 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/shared/attribute_container.rb

@@ -4,11 +4,11 @@ module XSD
   module AttributeContainer
     # Nested attributes
     # @!attribute attributes
-    # @return [Array<Attribute>]
+    # @return Array<Attribute>
 
     # Nested attribute groups
     # @!attribute attribute_groups
-    # @return [Array<AttributeGroup>]
+    # @return Array<AttributeGroup>
     def self.included(obj)
       obj.child :attributes, [:attribute]
       obj.child :attribute_groups, [:attributeGroup]

data/lib/xsd/shared/based.rb

@@ -5,15 +5,15 @@ module XSD
   module Based
     # Required. Specifies the name of a built-in data type, a simpleType element, or a complexType element
     # @!attribute base
-    # @return [String]
+    # @return String
 
     # Base complexType
     # @!attribute base_complex_type
-    # @return [ComplexType, nil]
+    # @return ComplexType, nil
 
     # Base simpleType
     # @!attribute base_simple_type
-    # @return [SimpleType, nil]
+    # @return SimpleType, nil
     def self.included(obj)
       obj.property :base, :string, required: true
       obj.link :base_complex_type, :complexType, property: :base
@@ -22,16 +22,16 @@ 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 = true)
-      (include_base && base_complex_type ? base_complex_type.all_elements : []) + super
+    # @return Array<Element>
+    def collect_elements(include_base = true)
+      (include_base && base_complex_type ? base_complex_type.collect_elements : []) + super
     end
 
     # Get all available attributes on the current stack level, optionally including base type attributes
     # @param [Boolean] include_base
-    # @return [Array<Attribute>]
-    def all_attributes(include_base = true)
-      (include_base && base_complex_type ? base_complex_type.all_attributes : []) + super
+    # @return Array<Attribute>
+    def collect_attributes(include_base = true)
+      (include_base && base_complex_type ? base_complex_type.collect_attributes : []) + super
     end
   end
 end

data/lib/xsd/shared/complex_typed.rb

@@ -5,7 +5,7 @@ module XSD
   module ComplexTyped
     # Child/linked complex type
     # @!attribute complex_type
-    # @return [ComplexType, nil]
+    # @return ComplexType, nil
     def self.included(obj)
       obj.child :complex_type, :complexType
       obj.link :complex_type, :complexType, property: obj::TYPE_PROPERTY
@@ -13,16 +13,16 @@ module XSD
 
     # Get all available elements on the current stack level or linked type elements
     # @param [Boolean] linked_type
-    # @return [Array<Element>]
-    def all_elements(linked_type = true)
-      (linked_type && complex_type&.linked? ? complex_type.all_elements : super)
+    # @return Array<Element>
+    def collect_elements(linked_type = true)
+      (linked_type && complex_type&.linked? ? complex_type.collect_elements : super)
     end
 
     # Get all available attributes on the current stack level or linked type attributes
     # @param [Boolean] linked_type
-    # @return [Array<Attribute>]
-    def all_attributes(linked_type = true)
-      (linked_type && complex_type&.linked? ? complex_type.all_attributes : super)
+    # @return Array<Attribute>
+    def collect_attributes(linked_type = true)
+      (linked_type && complex_type&.linked? ? complex_type.collect_attributes : super)
     end
   end
 end

data/lib/xsd/shared/element_container.rb

@@ -4,7 +4,7 @@ module XSD
   module ElementContainer
     # Nested elements
     # @!attribute elements
-    # @return [Array<Element>]
+    # @return Array<Element>
     def self.included(obj)
       obj.child :elements, [:element]
     end

data/lib/xsd/shared/min_max_occurs.rb

@@ -5,20 +5,20 @@ module XSD
     # Optional. Specifies the minimum number of times the choice element can occur in the parent the element.
     # The value can be any number >= 0. Default value is 1
     # @!attribute min_occurs
-    # @return [Integer]
+    # @return Integer
 
     # Optional. Specifies the maximum number of times the choice element can occur in the parent element.
     # The value can be any number >= 0, or if you want to set no limit on the maximum number, use the value "unbounded".
     # Default value is 1
     # @!attribute max_occurs
-    # @return [Integer, Symbol]
+    # @return Integer, Symbol
     def self.included(obj)
       obj.property :minOccurs, :integer, default: 1
       obj.property :maxOccurs, :integer, default: 1
     end
 
     # Compute actual max_occurs accounting parents
-    # @return [Integer, Symbol]
+    # @return Integer, Symbol
     def computed_max_occurs
       @computed_max_occurs ||= if parent.is_a?(MinMaxOccurs)
                                  if max_occurs == :unbounded || parent.computed_max_occurs == :unbounded
@@ -32,7 +32,7 @@ module XSD
     end
 
     # Compute actual min_occurs accounting parents
-    # @return [Integer]
+    # @return Integer
     def computed_min_occurs
       @computed_min_occurs ||= if parent.is_a?(Choice)
                                  0

data/lib/xsd/shared/referenced.rb

@@ -5,18 +5,18 @@ module XSD
     # Optional. Specifies a reference to a named attribute. Name and ref attributes cannot both be present.
     # If ref is present, simpleType element, form, and type cannot be present
     # @!attribute ref
-    # @return [String]
+    # @return String
 
     # Reference object
     # @!attribute reference
-    # @return [BaseObject]
+    # @return BaseObject
     def self.included(obj)
       obj.property :ref, :string
       obj.link :reference, obj.mapped_name, property: :ref
     end
 
     # Is object referenced?
-    # @return [Boolean]
+    # @return Boolean
     def referenced?
       !ref.nil?
     end

data/lib/xsd/shared/simple_typed.rb

@@ -5,7 +5,7 @@ module XSD
   module SimpleTyped
     # Get child/linked simple type
     # @!attribute simple_type
-    # @return [SimpleType, nil]
+    # @return SimpleType, nil
     def self.included(obj)
       obj.child :simple_type, :simpleType
       obj.link :simple_type, :simpleType, property: obj::TYPE_PROPERTY

data/lib/xsd/validator.rb

@@ -32,7 +32,7 @@ module XSD
     private
 
     # Get Nokogiri::XML::Schema object to validate against
-    # @return [Nokogiri::XML::Schema]
+    # @return Nokogiri::XML::Schema
     def schema_validator
       return @schema_validator if @schema_validator
 

data/lib/xsd/version.rb

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

data/lib/xsd/xml.rb

@@ -1,19 +1,24 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require 'forwardable'
+require 'net/http'
 
 module XSD
   class XML
-    extend Forwardable
     include Generator
     include Validator
 
-    attr_reader :options, :object_cache, :xsd
+    attr_reader :options, :object_cache, :schemas, :namespace_prefixes
 
-    # Proxy lookup methods to schema
-    def_delegators :schema, :[], :elements, :all_elements, :attributes, :attribute_groups, :all_attributes,
-                   :complex_types, :simple_types, :groups, :imports
+    DEFAULT_RESOURCE_RESOLVER = proc do |location, namespace|
+      if location =~ /^https?:/
+        Net::HTTP.get(URI(location))
+      elsif Pathname.new(location).absolute?
+        File.read(location)
+      else
+        raise ImportError, "Failed to locate import '#{location}'#{namespace ? " for namespace '#{namespace}'" : ''}"
+      end
+    end
 
     CLASS_MAP = {
       'schema'         => Schema,
@@ -26,6 +31,7 @@ module XSD
       'complexContent' => ComplexContent,
       'extension'      => Extension,
       'import'         => Import,
+      'include'        => Include,
       'simpleType'     => SimpleType,
       'all'            => All,
       'restriction'    => Restriction,
@@ -58,54 +64,124 @@ module XSD
       'pattern'        => Facet
     }.freeze
 
-    def initialize(xsd, **options)
-      # Base input validation
-      raise Error, 'xsd is not a Pathname nor a string' unless xsd.is_a?(Pathname) || xsd.is_a?(String)
-      raise Error, 'options is not a hash' unless options.is_a?(Hash)
+    # Create reader from a file path
+    # @param [String] path
+    # @param [Hash] options
+    # @return XML
+    def self.open(path, **options)
+      reader = new(**options)
+      reader.add_schema_xml(File.read(path))
+      reader
+    end
 
-      @xsd          = xsd
-      @options      = options
-      @object_cache = {}
+    def initialize(**options)
+      @options            = options
+      @object_cache       = {}
+      @schemas            = []
+      @namespace_prefixes = {}
     end
 
     def logger
       options[:logger] || default_logger
     end
 
-    def default_logger
-      @default_logger ||= Logger.new($stdout).tap do |logger|
-        logger.level = Logger::WARN
+    def resource_resolver
+      @options[:resource_resolver] || DEFAULT_RESOURCE_RESOLVER
+    end
+
+    def tmp_dir
+      @tmp_dir ||= options[:tmp_dir]
+    end
+
+    def read_document(xml)
+      Nokogiri::XML(xml)
+    end
+
+    # Add schema xml to reader instance
+    # @return Schema
+    def add_schema_xml(xml)
+      doc = read_document(xml)
+      raise Error, 'Schema node not found, xml does not seem to be a valid XSD' unless doc.root&.name == 'schema'
+
+      add_schema_node(doc.root)
+    end
+
+    # Add schema node to reader instance
+    # @return Schema
+    def add_schema_node(node)
+      raise Error, 'Added schema must be of type Nokogiri::XML::Node' unless node.is_a?(Nokogiri::XML::Node)
+
+      new_schema = Schema.new(options.merge(node: node, reader: self))
+      schemas.push(new_schema)
+      new_schema
+    end
+
+    # Add prefixes defined outside of processed schemas, for example in WSDL document
+    # @param [String] prefix
+    # @param [String] namespace
+    def add_namespace_prefix(prefix, namespace)
+      @namespace_prefixes[prefix] = namespace
+    end
+
+    # Get first added (considered primary) schema
+    # @return Schema, nil
+    def schema
+      schemas.first
+    end
+
+    # Get schema by namespace or namespace prefix
+    # @param [String, nil] namespace
+    # @return Array<Schema>
+    def schemas_for_namespace(namespace)
+      namespace = namespace_prefixes[namespace] if namespace_prefixes.key?(namespace)
+      schemas.select { |schema| schema.target_namespace == namespace }
+    end
+
+    def [](*args)
+      schemas.each do |schema|
+        item = schema[*args]
+        return item if item
       end
+
+      nil
     end
 
-    def xml
-      @xsd_xml ||= xsd.is_a?(Pathname) ? File.read(xsd) : xsd
+    def elements(*args)
+      collect(:elements, *args)
     end
 
-    def imported_xsd
-      @imported_xsd ||= options[:imported_xsd] || {}
+    def attributes(*args)
+      collect(:attributes, *args)
     end
 
-    def tmp_dir
-      @tmp_dir ||= options[:tmp_dir]
+    def attribute_groups
+      collect(:attribute_groups)
     end
 
-    def doc
-      @doc ||= Nokogiri::XML(xml)
+    def complex_types
+      collect(:complex_types)
     end
 
-    def schema_node
-      raise Error, 'Document root not found, provided document does not seem to be a valid XSD' unless doc.root
+    def simple_types
+      collect(:simple_types)
+    end
 
-      doc.root.name == 'schema' ? doc.root : nil
+    def groups
+      collect(:groups)
     end
 
-    def schema
-      @schema ||= Schema.new(self.options.merge(node: schema_node, reader: self))
+    private
+
+    def collect(name, *args)
+      result = Set.new
+      schemas.each { |schema| result.merge(schema.send(name, *args)) }
+      result.to_a
     end
 
-    def schema_for_namespace(_ns)
-      schema.schema_for_namespace(_ns)
+    def default_logger
+      @default_logger ||= Logger.new($stdout).tap do |logger|
+        logger.level = Logger::WARN
+      end
     end
   end
 end

data/lib/xsd.rb

@@ -18,6 +18,7 @@ require 'xsd/objects/simple_content'
 require 'xsd/objects/complex_content'
 require 'xsd/objects/extension'
 require 'xsd/objects/import'
+require 'xsd/objects/include'
 require 'xsd/objects/restriction'
 require 'xsd/objects/group'
 require 'xsd/objects/all'

data/xsd.gemspec

@@ -34,12 +34,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'builder', '~> 3.2'
   spec.add_dependency 'nokogiri', '~> 1.11'
   spec.add_dependency 'rake', '~> 13.0'
-  spec.add_dependency 'rest-client', '~> 2.1'
-
-  spec.add_development_dependency 'logger', '~> 1.5'
-  spec.add_development_dependency 'rspec', '~> 3.12'
-  spec.add_development_dependency 'rubocop', '~> 1.50'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.17'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xsd
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - d.arkhipov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -52,104 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.50'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.50'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
 description: The Ruby XSD library is an XML Schema implementation for Ruby.Provides
   easy and flexible access to XSD information
 email:
@@ -188,6 +90,7 @@ files:
 - lib/xsd/objects/field.rb
 - lib/xsd/objects/group.rb
 - lib/xsd/objects/import.rb
+- lib/xsd/objects/include.rb
 - lib/xsd/objects/key.rb
 - lib/xsd/objects/keyref.rb
 - lib/xsd/objects/list.rb