https://github.com/ekzo-dev/ruby-xsd
Ruby XSD spec implementation
https://github.com/ekzo-dev/ruby-xsd
Last synced: 5 months ago
JSON representation
Ruby XSD spec implementation
- Host: GitHub
- URL: https://github.com/ekzo-dev/ruby-xsd
- Owner: ekzo-dev
- License: mit
- Created: 2023-04-24T09:31:20.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T09:14:00.000Z (about 2 years ago)
- Last Synced: 2024-04-26T21:49:08.535Z (about 2 years ago)
- Language: Ruby
- Size: 545 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# XSD
[][gem]
[][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
flexible access to XSD information.
## Installation
Install as a gem
$ gem install xsd
Or add it to your Gemfile
```ruby
gem 'xsd'
```
## Usage
```ruby
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
```
## 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](https://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](https://github.com/[USERNAME]/ruby-xsd/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## 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](https://github.com/[USERNAME]/ruby-xsd/blob/main/CODE_OF_CONDUCT.md).