nokogiri-streaming-reader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65e5209b0d9be2508b66a3ec3b4930ff01f1d265
+  data.tar.gz: 50bd545822035962339aed4d83c5f0a1bf3701ef
+SHA512:
+  metadata.gz: 6795646ee413f21a40f45c8c83bbb50954cda906273f258021c3dfacc674e2a5d485bbe918512ff536582f632036bc000a4da0c99cc95475c6034ae01f4bbaee
+  data.tar.gz: f1e23979d3a5512653e4e90e833ed1c16a9b19943712895d7defadb1e3749555454cc6284a33f7e2e559a860c16dd31288bf45050d8037953446b92cd051a824

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexander Staubo
+
+MIT License
+
+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,24 @@
+# Simple streaming reader for Nokogiri
+
+This library implements a very simple streaming parser that can parse large documents with low memory overhead.
+
+When setting up the reader, one registers paths to capture:
+
+    reader.on('/path') do |e|
+      # ...
+    end
+
+Each path must be a simple XPath-like path. Unlike XPath, only path segments are currently supported, however. The path must always start at the root.
+
+Each registered handler receives the parsed element as its argument.
+
+## Example
+
+    reader = Nokogiri::Streaming::Reader.new(doc)
+    reader.on('/some/element/in/document') do |e|
+      # Handle element
+    end
+    reader.on('/some/other/element/in/document') do |e|
+      # Handle element
+    end
+    reader.run

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/nokogiri/streaming/reader.rb

@@ -0,0 +1,89 @@
+require 'nokogiri'
+
+module Nokogiri
+  module Streaming
+
+    class Reader < XML::SAX::Document
+
+      def initialize(source)
+        @source = source
+        @parser = Nokogiri::XML::SAX::Parser.new(self)
+        @stack = []
+        @triggers = {}
+      end
+
+      def run
+        @parser.parse(@source)
+      end
+
+      def on(path, &block)
+        (@triggers[path] ||= []).push(block)
+      end
+
+      def current_path
+        if @stack.any?
+          '/' + @stack.join('/')
+        else
+          ''
+        end
+      end
+
+      #
+      # The following methods are SAX callbacks from Nokogiri.
+      #
+
+      def end_document
+      end
+
+      def start_element(name, attrs = [])
+        if @current
+          element = @current.document.create_element(name)
+          attrs.each do |name, value|
+            element[name] = value
+          end
+          @current.add_child(element)
+          @current = element
+        elsif @triggers[current_path + '/' + name]
+          fragment = Nokogiri::XML::DocumentFragment.new(Nokogiri::XML::Document.new)
+
+          element = fragment.document.create_element(name)
+          attrs.each do |name, value|
+            element[name] = value
+          end
+          @current = element
+        end
+        @stack.push(name)
+      end
+
+      def end_element(name)
+        path = current_path
+
+        @stack.pop
+
+        element = @current
+        if @current
+          @current = @current.parent
+        end
+
+        triggers = @triggers[path]
+        if triggers
+          triggers.each do |proc|
+            proc.call(element)
+          end
+        end
+      end
+
+      def characters(string)
+        if @current
+          @current.add_child(string)
+        end
+      end
+
+      def cdata_block(string)
+        characters(string)
+      end
+
+    end
+
+  end
+end

data/lib/nokogiri/streaming/version.rb

@@ -0,0 +1,5 @@
+module Nokogiri
+  module Streaming
+    VERSION = '0.0.1'
+  end
+end

data/nokogiri-streaming-reader.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'nokogiri/streaming/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nokogiri-streaming-reader"
+  spec.version       = Nokogiri::Streaming::VERSION
+  spec.authors       = ["Alexander Staubo"]
+  spec.email         = ["alex@bengler.no"]
+  spec.summary       =
+  spec.description   = %q{Simple streaming reader for Nokogiri.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", ">= 1.4"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/reader_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Nokogiri::Streaming::Reader do
+
+  subject do
+    Nokogiri::Streaming::Reader
+  end
+
+  it 'parses registered paths' do
+    doc = %{
+      <root>
+        <fruit/>
+        <fruit/>
+        <vegetable id='1'><seed/></vegetable>
+        <meat><type>beef</type></meat>
+      </root>
+    }
+
+    fruits = []
+    vegetables = []
+    meats = []
+
+    reader = subject.new(doc)
+    reader.on('/root/fruit') do |e|
+      fruits.push(e.to_xml(indent: 0))
+    end
+    reader.on('/root/vegetable') do |e|
+      vegetables.push(e.to_xml(indent: 0))
+    end
+    reader.on('/root/meat/type') do |e|
+      meats.push(e.to_xml(indent: 0))
+    end
+    reader.run
+
+    expect(fruits).to eq ['<fruit/>', '<fruit/>']
+    expect(vegetables).to eq ["<vegetable id=\"1\">\n<seed/>\n</vegetable>"]
+    expect(meats).to eq ["<type>beef</type>"]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+
+require_relative '../lib/nokogiri/streaming/reader'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: nokogiri-streaming-reader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Staubo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple streaming reader for Nokogiri.
+email:
+- alex@bengler.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nokogiri/streaming/reader.rb
+- lib/nokogiri/streaming/version.rb
+- nokogiri-streaming-reader.gemspec
+- spec/reader_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple streaming reader for Nokogiri.
+test_files:
+- spec/reader_spec.rb
+- spec/spec_helper.rb
+has_rdoc: