Project

xml2hash

0.0
No commit activity in last 3 years
No release in over 3 years
Small gem intended to parse any-size XML stream (or string) using SAX
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.10
~> 10.0
>= 0
 Project Readme

Xml2Hash

This is a tiny gem allowing you to parse XML stream (or string) into Ruby hash via available SAX parser. Supported parsers are: (Ox)[https://github.com/ohler55/ox], (Nokogiri)[https://github.com/sparklemotion/nokogiri].

Note that the functionality of this gem is very limited. It completely ignores attributes and namespaces currently and was intended to speed things up when you need to parse simple mid-size XML for basic in-memory manipulation. And you run on Heroku. Inside of Sidekiq 😱.

Installation

Add this line to your application's Gemfile:

gem 'xml2hash'

Make sure this lines goes afer one of the following:

gem 'ox'       # This gem is recommended to lower memory consumption and imrove speed
gem 'nokogiri' # Fallback when Ox isn't available (e.g. you are using JRuby)

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install xml2hash

## Usage

```ruby
hash = Xml2Hash.parse('<xml></xml>')
hash = Xml2Hash.parse(File.open 'file.xml', 'r')

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/inossidabile/xml2hash.

License

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