A generic swappable back-end for XML parsing
$ [sudo] gem install multi_xml
Lots of Ruby libraries utilize XML parsing in some form, and everyone has their favorite XML library. In order to best support multiple XML parsers and libraries, multi_xml is a general-purpose swappable XML backend library. You use it like so:
require 'multi_xml' MultiXml.parser = :libxml MultiXml.parser = MultiXml::Parsers::Libxml # Same as above MultiXml.parse('<tag>This is the contents</tag>') # Parsed using LibXML MultiXml.parser = :nokogiri MultiXml.parser = MultiXml::Parsers::Nokogiri # Same as above MultiXml.parse('<tag>This is the contents</tag>') # Parsed using Nokogiri MultiXml.parser = :rexml MultiXml.parser = MultiXml::Parsers::Rexml # Same as above MultiXml.parse('<tag>This is the contents</tag>') # Parsed using REXML
The parser setter takes either a symbol or a class (to allow for custom XML parsers) that responds to .parse at the class level.
MultiXML tries to have intelligent defaulting. That is, if you have any of the supported parsers already loaded, it will utilize them before attempting to load any. When loading, libraries are ordered by speed: first LibXML, then Nokogiri, then REXML.
In the spirit of free software, everyone is encouraged to help improve this project.
Here are some ways you can contribute:
- by using alpha, beta, and prerelease versions
- by reporting bugs
- by suggesting new features
- by writing or editing documentation
- by writing specifications
- by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
- by refactoring code
- by resolving issues
- by reviewing patches
Submitting an Issue
We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issuse by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.
Submitting a Pull Request
- Fork the project.
- Create a topic branch.
- Implement your feature or bug fix.
- Add documentation for your feature or bug fix.
- Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4.
- Add specs for your feature or bug fix.
- Run bundle exec rake spec. If your changes are not 100% covered, go back to step 6.
- Commit and push your changes.
- Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
MultiXML was inspired by MultiJSON.
Copyright (c) 2010 Erik Michaels-Ober. See LICENSE for details.