Contents

# nokogiri-ext

[![CI](https://github.com/postmodern/nokogiri-ext/actions/workflows/ruby.yml/badge.svg)](https://github.com/postmodern/nokogiri-ext/actions/workflows/ruby.yml)
[![Gem Version](https://badge.fury.io/rb/fake_io.svg)](https://badge.fury.io/rb/fake_io)

* [Source](https://github.com/postmodern/nokogiri-ext)
* [Issues](https://github.com/postmodern/nokogiri-ext/issues)
* [Documentation](http://rubydoc.info/gems/fake_io/frames)

## Description

nokogiri-ext is a collection of useful extensions to the [nokogiri] gem.

## Features

* Adds an `==` method to {Nokogiri::XML::Element}, {Nokogiri::XML::Attr},
  {Nokogiri::XML::Text}, {Nokogiri::XML::Node}.
* Adds a `traverse_count` method to {Nokogiri::XML::Document} and
  {Nokogiri::XML::Node}.
* Adds the {Nokogiri::XML::Node#traverse_text} method.

## Requirements

* [Ruby] >= 2.6.0
* [nokogiri] ~> 1.0

## Install

```shell
$ gem install nokogiri-ext
```

### gemspec

```ruby
gem.add_dependency 'nokogiri-ext', '~> 1.0'
```

### Gemfile

```ruby
gem 'nokogiri-ext', '~> 1.0'
```

## Examples

### equality

Compare the contents of two XML/HTML elements:

```ruby
require 'nokogiri/ext/equality'

doc1.at('//node') == doc2.at('//node')
```

Comparing the contents of two XML/HTML documents:

```ruby
doc1 == doc2
```

### traverse_count

Count the total number of elements under a XML/HTML element:

```ruby
require 'nokogiri/ext/traverse_count'

doc.at('//node').traverse_count
# => 7
```

Count the total number of elements within a XML/HTML document:

```ruby
doc.traverse_count
# => 42
```

### traverse_text

Traverses all text nodes in a XML/HTML document or node:

```ruby
require 'nokogiri/ext/traverse_text'

doc.traverse_text do |text|
  puts text
end
```

## License

See {file:LICENSE.txt} for details.

[Ruby]: https://www.ruby-lang.org/
[nokogiri]: https://github.com/sparklemotion/nokogiri#readme

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
nokogiri-ext-0.1.1	README.md