nokogiri-ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae753cd9a2d54f2efbe4d3fb749b082a7d697b679d182dfcd402629ffb47037b
+  data.tar.gz: b502556e6d5e95c25094b76641093bd955d88d2e514f72237a11c6c051e4f47d
+SHA512:
+  metadata.gz: 16e7b8ec620e311170ad0dd2e3e9879d84f5ab9f375ad6888e8eb329a646e98ef823acaeebca266b3d417733ba1fa904d91e1f01543393135fffbeb7f29ceffe
+  data.tar.gz: '092d85d344cee2e9b1839882432042bb21523268fd944847bf0424f5bdb3e64a1446ce5d25e1cb21971170be18d2035257c8b47b3582b067d3676b241bd28433'

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.*
+LICENSE.txt

data/.github/workflows/ruby.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.6
+          - 2.7
+          - '3.0'
+          - 3.1
+          - jruby
+          - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,5 @@
+/Gemfile.lock
+/coverage
+/doc/
+/pkg/
+/vendor/bundle/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "nokogiri-ext Documentation" --protected --quiet

data/ChangeLog.md

@@ -0,0 +1,15 @@
+### 0.1.0 / 2022-01-28
+
+* Initial release:
+  * Requires [Ruby] >= 2.6.0
+  * Requires [nokogiri] ~> 1.0
+  * Added `nokogiri/ext/equality` which adds a `==` operator to
+    {Nokogiri::XML::Element}, {Nokogiri::XML::Attr}, {Nokogiri::XML::Text},
+    {Nokogiri::XML::Node}.
+  * Added `nokogiri/ext/traverse_count` which adds a `traverse_count` method to
+    {Nokogiri::XML::Document} and {Nokogiri::XML::Node}.
+  * Added `nokogiri/ext/traverse_text` which adds the
+    {Nokogiri::XML::Node#traverse_text} method.
+
+[Ruby]: https://www.ruby-lang.org/
+[nokogiri]: https://github.com/sparklemotion/nokogiri#readme

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.2'
+
+  gem 'rspec',          '~> 3.0'
+  gem 'simplecov',      '~> 0.20'
+
+  gem 'redcarpet',      platform: :mri
+  gem 'kramdown'
+  gem 'yard',           '~> 0.9'
+  gem 'yard-spellcheck', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2022 Hal Brodigan
+
+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.

data/README.md

@@ -0,0 +1,100 @@
+# 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 [nokogiri].
+
+## 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
+```
+
+## Copyright
+
+Copyright (c) 2009-2022 Hal Brodigan
+
+See {file:LICENSE.txt} for details.
+
+[Ruby]: https://www.ruby-lang.org/
+[nokogiri]: https://github.com/sparklemotion/nokogiri#readme

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard

data/gemspec.yml

@@ -0,0 +1,23 @@
+name: nokogiri-ext
+summary: Useful extensions to nokogiri
+description: A collection of useful extensions to nokogiri.
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: https://github.com/postmodern/nokogiri-ext#readme
+has_yard: true
+
+metadata:
+  documentation_uri: https://rubydoc.info/gems/fake_io
+  source_code_uri:   https://github.com/postmodern/nokogiri-ext
+  bug_tracker_uri:   https://github.com/postmodern/nokogiri-ext/issues
+  changelog_uri:     https://github.com/postmodern/nokogiri-ext/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
+required_ruby_version: ">= 2.6.0"
+
+dependencies:
+  nokogiri: ~> 1.0
+
+development_dependencies:
+  bundler: ~> 2.0

data/lib/nokogiri/ext/equality/attr.rb

@@ -0,0 +1,25 @@
+require 'nokogiri'
+
+module Nokogiri
+  module XML
+    class Attr < Node
+
+      #
+      # Determines if the attribute is similar to another attribute.
+      #
+      # @param [Nokogiri::XML::Attr] other
+      #   The other attribute.
+      #
+      # @return [Boolean]
+      #   Specifies if the attribute is similar, in identity or value,
+      #   to the other attribute.
+      #
+      # @api public
+      #
+      def ==(other)
+        super(other) && (self.value == other.value)
+      end
+
+    end
+  end
+end

data/lib/nokogiri/ext/equality/element.rb

@@ -0,0 +1,35 @@
+require 'nokogiri'
+
+module Nokogiri
+  module XML
+    class Element < Node
+
+      #
+      # Determines if the element is similar to another element.
+      #
+      # @param [Nokogiri::XML::Element] other
+      #   The other element.
+      #
+      # @return [Boolean]
+      #   Specifies whether the element is equal, in identity or value, to
+      #   another element.
+      #
+      # @api public
+      #
+      def ==(other)
+        return false unless super(other)
+        return false unless attribute_nodes.length == other.attribute_nodes.length
+
+        (0...attribute_nodes.length).each do |index|
+          attr1 = attribute_nodes[index]
+          attr2 = other.attribute_nodes[index]
+
+          return false unless attr1.similar?(attr2)
+        end
+
+        return true
+      end
+
+    end
+  end
+end

data/lib/nokogiri/ext/equality/node.rb

@@ -0,0 +1,24 @@
+require 'nokogiri'
+
+module Nokogiri
+  module XML
+    class Node
+
+      #
+      # Determines if the node is similar to another node.
+      #
+      # @return [Boolean]
+      #   Specifies whether the node is equal, in identity or value, to
+      #   another node.
+      #
+      # @api public
+      #
+      def ==(other)
+        return false unless other
+
+        (self.type == other.type) && (self.name == other.name)
+      end
+
+    end
+  end
+end

data/lib/nokogiri/ext/equality/text.rb

@@ -0,0 +1,25 @@
+require 'nokogiri'
+
+module Nokogiri
+  module XML
+    class Text < CharacterData
+
+      #
+      # Determines if the text node is similar to another text node.
+      #
+      # @param [Nokogiri::XML::Text] other
+      #   The other text node.
+      #
+      # @return [Boolean]
+      #   Specifies if the text node is similar, in identity or value,
+      #   to the other text node.
+      #
+      # @api public
+      #
+      def ==(other)
+        super(other) && (self.content == other.content)
+      end
+
+    end
+  end
+end

data/lib/nokogiri/ext/equality.rb

@@ -0,0 +1,4 @@
+require 'nokogiri/ext/equality/node'
+require 'nokogiri/ext/equality/text'
+require 'nokogiri/ext/equality/attr'
+require 'nokogiri/ext/equality/element'

data/lib/nokogiri/ext/traverse_count/document.rb

@@ -0,0 +1,26 @@
+require 'nokogiri'
+
+module Nokogiri
+  module XML
+    class Document < Node
+
+      #
+      # Calculates the sum of all sub-children of the document.
+      #
+      # @return [Integer]
+      #   The total number of children and sub-children of the document.
+      #   Returns `0` if the document has no root element.
+      #
+      # @api public
+      #
+      def traverse_count
+        if root
+          1 + root.traverse_count
+        else
+          0
+        end
+      end
+
+    end
+  end
+end

data/lib/nokogiri/ext/traverse_count/node.rb

@@ -0,0 +1,25 @@
+require 'nokogiri'
+
+module Nokogiri
+  module XML
+    class Node
+
+      #
+      # Calculates the sum of all children of the node.
+      #
+      # @return [Integer]
+      #   The total number of children of the node.
+      #
+      # @api public
+      #
+      def traverse_count
+        count = 0
+
+        traverse { |node| count += 1 }
+
+        return count - 1
+      end
+
+    end
+  end
+end

data/lib/nokogiri/ext/traverse_count.rb

@@ -0,0 +1,2 @@
+require 'nokogiri/ext/traverse_count/node'
+require 'nokogiri/ext/traverse_count/document'

data/lib/nokogiri/ext/traverse_text.rb

@@ -0,0 +1,33 @@
+require 'nokogiri'
+
+module Nokogiri
+  module XML
+    class Node
+
+      #
+      # Traverses all text nodes which are children of the node.
+      #
+      # @yield [node]
+      #   A block will be passed each text node.
+      #
+      # @yieldparam [Nokogiri::XML::Text] node
+      #   A text node.
+      #
+      # @return [Enumerator]
+      #   If no block is given, an Enumerator object will be returned.
+      #
+      # @api public
+      #
+      def traverse_text
+        return enum_for(:traverse_text) unless block_given?
+
+        yield self if text?
+
+        traverse do |node|
+          yield node if node.text?
+        end
+      end
+
+    end
+  end
+end

data/lib/nokogiri/ext/version.rb

@@ -0,0 +1,6 @@
+module Nokogiri
+  module Ext
+    # nokogiri-ext version
+    VERSION = '0.1.0'
+  end
+end

data/lib/nokogiri/ext/xml.rb

@@ -0,0 +1,5 @@
+require 'nokogiri/ext/xml/node'
+require 'nokogiri/ext/xml/text'
+require 'nokogiri/ext/xml/attr'
+require 'nokogiri/ext/xml/element'
+require 'nokogiri/ext/xml/document'

data/lib/nokogiri/ext.rb

@@ -0,0 +1,4 @@
+require 'nokogiri/ext/equality'
+require 'nokogiri/ext/traverse_count'
+require 'nokogiri/ext/traverse_text'
+require 'nokogiri/ext/version'

data/nokogiri-ext.gemspec

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'nokogiri/ext/version'
+                  Nokogiri::Ext::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/spec/equality_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'nokogiri/ext/equality'
+
+describe "nokogiri/ext/equality" do
+  before(:all) do
+    @doc = Nokogiri::HTML(%{<html><head><title>test</title></head><body><p><b>This is a test</b> html <i>page</i>.</p></body></html>})
+
+    @edited_doc = Nokogiri::HTML(%{<html><head><title>test</title></head><body><p><b>This is a test</b> html page.</p></body></html>})
+  end
+
+  it "should be able to test if two elements are equal" do
+    elem1 = @doc.at('b')
+    elem2 = @edited_doc.at('b')
+
+    expect(elem1).to eq(elem2)
+  end
+
+  it "should be able to test if two elements are not equal" do
+    elem1 = @doc.at('p').children.last
+    elem2 = @edited_doc.at('b')
+
+    expect(elem1).not_to eq(elem2)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'simplecov'
+
+SimpleCov.start

data/spec/traverse_count_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'nokogiri/ext/traverse_count'
+
+describe "nokogiri/ext/traverse_count" do
+  before(:all) do
+    @doc = Nokogiri::HTML(%{<html><head><title>test</title></head><body><p><b>This is a test</b> html <i>page</i>.</p></body></html>})
+
+    @edited_doc = Nokogiri::HTML(%{<html><head><title>test</title></head><body><p><b>This is a test</b> html page.</p></body></html>})
+  end
+
+  it "should provide a count of all sub-children" do
+    expect(@doc.traverse_count).to eq(12)
+  end
+end

data/spec/traverse_text_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'nokogiri/ext/traverse_text'
+
+describe "nokogiri/ext/traverse_text" do
+  before(:all) do
+    @doc = Nokogiri::HTML(%{<html><head><title>test</title></head><body><p><b>This is a test</b> html <i>page</i>.</p></body></html>})
+
+    @edited_doc = Nokogiri::HTML(%{<html><head><title>test</title></head><body><p><b>This is a test</b> html page.</p></body></html>})
+  end
+
+  it "should be able to traverse over every text node" do
+    text = []
+
+    @doc.traverse_text { |node| text << node.content }
+
+    expect(text).to eq(['test', 'This is a test', ' html ', 'page', '.'])
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: nokogiri-ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Postmodern
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A collection of useful extensions to nokogiri.
+email: postmodern.mod3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/nokogiri/ext.rb
+- lib/nokogiri/ext/equality.rb
+- lib/nokogiri/ext/equality/attr.rb
+- lib/nokogiri/ext/equality/element.rb
+- lib/nokogiri/ext/equality/node.rb
+- lib/nokogiri/ext/equality/text.rb
+- lib/nokogiri/ext/traverse_count.rb
+- lib/nokogiri/ext/traverse_count/document.rb
+- lib/nokogiri/ext/traverse_count/node.rb
+- lib/nokogiri/ext/traverse_text.rb
+- lib/nokogiri/ext/version.rb
+- lib/nokogiri/ext/xml.rb
+- nokogiri-ext.gemspec
+- spec/equality_spec.rb
+- spec/spec_helper.rb
+- spec/traverse_count_spec.rb
+- spec/traverse_text_spec.rb
+homepage: https://github.com/postmodern/nokogiri-ext#readme
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://rubydoc.info/gems/fake_io
+  source_code_uri: https://github.com/postmodern/nokogiri-ext
+  bug_tracker_uri: https://github.com/postmodern/nokogiri-ext/issues
+  changelog_uri: https://github.com/postmodern/nokogiri-ext/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Useful extensions to nokogiri
+test_files: []