A simple DSL for getting data from Nokogiri documents
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
features
lib
spec
.autotest
.gitignore
.rspec
.travis.yml
CI
Gemfile
README.markdown
Rakefile
dozuki.gemspec

README.markdown

Dozuki

A Nokogiri wrapper that simplifies commonly occurring tasks.

Build Status

What does it do?

Dozuki removes the repetitive tasks from parsing XML documents with XPaths such as:

  • extracting ints, floats, strings, dates etc.
  • accessing single nodes
  • checking whether an element exists
  • iterating through nodes
  • iterating nodes and extracting ints, floats, booleans and strings etc.

It's mainly sugar for reducing the amount of chaining on calls like:

doc.xpath('/my/xpath').first.to_i

to:

doc.int('/my/xpath')

How do I use it?

The parse method supports all input parameters supported by Nokogiri's parse method:

# simple usage
doc = Dozuki::XML.parse(string_or_io)

# HTML
html = Dozuki::HTML.parse(string_or_io)

# or the full parameter list
doc = Dozuki::XML.parse(string_or_io, url = nil, encoding = nil, options = ParseOptions::DEFAULT_XML)
doc = Dozuki::HTML.parse(string_or_io, url = nil, encoding = nil, options = ParseOptions::DEFAULT_XML)

# or using the quick methods
doc  = Dozuki::XML(string_or_io, ...)
html = Dozuki::HTML(string_or_io, ...)

This documents supports the Dozuki extensions for:

Extracting a single node

The get methods takes an xpath and returns the first node that matches the xpath:

doc.get('/my/xpath')

If the node can't be found then an exception is raised.

Extracting and parsing the value of a single node

The following methods take the first node that matches the xpath and returns the formatted result:

doc.string('/my/xpath') # surrounding whitespace stripped
doc.float('/my/xpath')
doc.int('/my/xpath')
doc.date('/my/xpath') # format yyyy-mm-dd
doc.boolean('/my/xpath') # format true/false or 1/0

These functions are to replace calls using plain Nokogiri such as:

doc.xpath('/my/xpath').first.to_i

Checking whether an element exists

doc.exists?('/my/xpath')

Iterating through nodes

Dozuki also provides a slightly more succinct way to 'each' an xpath:

doc.each('/my/xpath') do |node|
  # do something
end

Iterating through node text and parsing

There are also simple ways to extract formatted text of a series of nodes with an each

doc.each('/my/xpath').as_string do |node|
  # string with surrounding whitespace stripped
end

doc.each('/my/xpath').as_int do |int|
  # int
end

doc.each('/my/xpath').as_float do |float|
  # float
end

doc.each('/my/xpath').as_date do |date|
  # date
end

doc.each('/my/xpath').as_boolean do |boolean|
  # boolean
end

Playing nicely with Nokogiri

Dozuki will proxy any calls not recognised onto the underlying Nokogiri structure, including responds_to?, allowing you to treat it like any other Nokogiri document.

More documentation

More features are described in the.. features

Contributing to Dozuki

  • Fork the project.
  • Add tests that cover the new feature or bug fix.
  • Make your feature addition or bug fix.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

LICENSE:

(The MIT License)

Copyright (c) 2010:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.