XSD

The Ruby XSD library is an XML Schema implementation for Ruby. Provides easy and flexible access to XSD information.

Installation

Install as a gem

$ gem install xsd

Or add it to your Gemfile

gem 'xsd'

Usage

require 'xsd'

# Load ruby-xsd
reader = XSD::XML.open('some.xsd')

# 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
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

# Get element information
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_content? # => true
element.simple_content? # => false
element.mixed_content? # => false
element.multiple_allowed? # => true
element.required? # => false

Imports and the absent namespace

XML Schema leaves it to the processor whether every <xs:import> of a namespace is read or only the first (a schemaLocation is a hint); libxml2, and so Nokogiri's validator, reads the first. This reader reads them all, and resolves a name within the include tree of the schema the name is written in. That is what a set of schemas with no target namespace needs when one schema imports them all: every document a schema of its own, with its own copies of common types that may differ from one copy to another. Put together into one schema they break the rule that names are unique within a namespace, so a validator assembling one schema of them (Schema#validate_xml, which validates through Nokogiri) sees only the first of them.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby-xsd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Ruby::Xsd project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.