nokogireader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87f220fc018df6ddaf21b6d471b707100e9d2af2
+  data.tar.gz: eea92fe211818fdc60cd3277cd49b65573e0fed8
+SHA512:
+  metadata.gz: dc4298a3e18265e17a772250e256121a3f0533a3cb5468a0981f2d3339ac38814b1d928231e8257cc9ae6a2d8a62ca117fa8f27b7fb3ebb5eacfff71e61fc6bc
+  data.tar.gz: 058206458c75294cdb5ece611255672e465030ae6e98e1df3e86983952b6bbd1bb04bae7cb4ccfb4c50936e112c4c9819a7878ef39e5cefdaf6390fddd982bdb

data/.editorconfig

@@ -0,0 +1,7 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 bonono
+
+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,64 @@
+# Nokogireader
+
+DSL for parsing xml using Nokogiri::XML::Reader
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nokogireader'
+```
+
+## Example
+
+```rb
+class Rss2 < Nokogireader::Reader
+  element :rss, attr: [:version] do
+    element :channel do
+      elements :item do
+        element :title
+        element :link
+      end
+    end
+  end
+end
+
+data = Rss2.new.read(File.open('rss2.xml'))
+puts "Version: #{data[:rss].attributes[:version]}"
+puts "Items: #{data[:rss][:channel][:item].size}"
+data[:rss][:channel][:item].each do |item|
+  puts " > #{item[:title].text}"
+end
+```
+
+You can use ``after`` callback and ``dont_store_data`` to reduce memory usage.
+
+```rb
+class Rss2 < Nokogireader::Reader
+  element :rss, attr: [:version] do
+    element :channel do
+      elements :item do
+        dont_store_data
+        element :title
+        element :link
+
+        after do |reader, item|
+          puts "Title: #{item[:title].text}"
+        end
+      end
+    end
+  end
+end
+
+data = data = Rss2.new.read(File.open('rss2.xml'))
+puts "Items: #{data[:rss][:channel][:item].size}" # => 0. If specified "dont_store_data", data isn't stored.
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bonono/nokogireader.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/nokogireader/definition.rb

@@ -0,0 +1,46 @@
+module Nokogireader
+  class Definition
+    attr_reader :children
+    attr_accessor :read_attributes, :after_callback, 
+                  :accept_text, :multiple,
+                  :dont_store_data
+
+    def initialize
+      @read_attributes = []
+      @after_callback = nil
+      @children = {}
+      @accept_text = false
+      @multiple = false
+      @dont_store_data = false
+    end
+
+    def configure(&block)
+      return self unless block_given?
+      DSL.new(self).instance_eval(&block)
+      self
+    end
+
+    def accept?(node)
+      if node.node_type == 1
+        @children.key?(node.name)
+      elsif node.node_type == 3
+        @accept_text
+      else
+        false
+      end
+    end
+    
+    def multiple?
+      @multiple
+    end
+
+    def on_traversed(reader, data)
+      return unless @after_callback
+      if @after_callback.is_a?(Symbol)
+        reader.send(@after_callback, data)
+      else
+        @after_callback.call(reader, data)
+      end
+    end
+  end
+end

data/lib/nokogireader/dsl.rb

@@ -0,0 +1,36 @@
+module Nokogireader
+  # DSL to configure Nokogireader::Definition
+  class DSL
+    def initialize(definition)
+      @definition = definition
+    end
+    
+    def element(name, opts = {}, &block)
+      @definition.children[name.to_s] = 
+        create_child(opts, !block_given?).configure(&block)
+    end
+
+    def elements(name, opts = {}, &block)
+      child = create_child(opts, !block_given?)
+      child.multiple = true
+      @definition.children[name.to_s] = child.configure(&block)
+    end
+
+    def after(method_name = nil, &block)
+      @definition.after_callback = method_name || block
+    end
+
+    def dont_store_data
+      @definition.dont_store_data = true
+    end
+
+    private
+
+    def create_child(opts, accept_text)
+      child = Definition.new
+      child.accept_text = accept_text
+      child.read_attributes = opts[:attr] if opts[:attr]
+      child
+    end
+  end
+end

data/lib/nokogireader/read_data.rb

@@ -0,0 +1,44 @@
+module Nokogireader
+  class ReadData
+    attr_accessor :text
+    attr_reader :parent
+
+    def initialize(parent_data, definition, node)
+      @parent = parent_data
+      @definition = definition
+      @definition.read_attributes.each do |a|
+        attributes[a] = node.attribute(a.to_s)
+      end
+    end
+
+    def attributes
+      @attributes ||= {}
+    end
+
+    def children
+      @children ||= {}
+    end
+
+    def add_child(definition, node)
+      child = self.class.new(self, definition, node)
+      if definition.multiple?
+        (children[node.name] ||= []) << child
+      else
+        children[node.name] = child
+      end
+      child
+    end
+
+    def clear_child_for(node)
+      if children[node.name].is_a?(Array)
+        children[node.name].pop
+      else
+        children.delete(node.name)
+      end
+    end
+
+    def [](child_name)
+      children[child_name.to_s]
+    end
+  end
+end

data/lib/nokogireader/reader.rb

@@ -0,0 +1,55 @@
+module Nokogireader
+  class Reader
+    def self.root_definition
+      @root ||= Definition.new
+    end
+
+    def self.element(name, opts = {}, &block)
+      root_definition.configure do
+        element(name, opts, &block)
+      end
+    end
+
+    def self.elements(name, opts = {}, &block)
+      root_definition.configure do
+        elements(name, opts, &block)
+      end
+    end
+
+    def read(xml)
+      root = self.class.root_definition
+      defstack = []
+      data = ReadData.new(nil, root, nil)
+
+      build_xml_reader(xml).each do |n|
+        if n.node_type == 1
+          d = defstack.last || root
+          defstack << (d.accept?(n) ? d.children[n.name] : nil)
+          data = data.add_child(defstack.last, n) if defstack.last
+        elsif n.node_type == 3
+          data.text = n.value if defstack.last && defstack.last.accept?(n)
+        end
+
+        if (n.node_type == 15 || n.self_closing?) && (old_def = defstack.pop)
+          old_def.on_traversed(self, data)
+          data = data.parent 
+          data.clear_child_for(n) if old_def.dont_store_data
+        end
+      end
+
+      data
+    end
+
+    private
+
+    def build_xml_reader(source)
+      method_name = if source.kind_of?(IO) || source.kind_of?(StringIO)
+                      :from_io
+                    else
+                      :from_memory
+                    end
+
+      ::Nokogiri::XML::Reader.send(method_name, source)
+    end
+  end
+end

data/lib/nokogireader/version.rb

@@ -0,0 +1,3 @@
+module Nokogireader
+  VERSION = "0.1.0"
+end

data/lib/nokogireader.rb

@@ -0,0 +1,6 @@
+require 'nokogireader/version'
+require 'nokogiri'
+require 'nokogireader/dsl'
+require 'nokogireader/definition'
+require 'nokogireader/read_data'
+require 'nokogireader/reader'

data/nokogireader.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nokogireader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nokogireader"
+  spec.version       = Nokogireader::VERSION
+  spec.authors       = ["bonono"]
+  spec.email         = ["bonono.jp@gmail.com"]
+
+  spec.summary       = %q{DSL for parsing xml using Nokogiri::XML::Reader}
+  spec.homepage      = "https://github.com/bonono/nokogireader"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'nokogiri', '~> 1.6'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 1.0"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: nokogireader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bonono
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: 
+email:
+- bonono.jp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nokogireader.rb
+- lib/nokogireader/definition.rb
+- lib/nokogireader/dsl.rb
+- lib/nokogireader/read_data.rb
+- lib/nokogireader/reader.rb
+- lib/nokogireader/version.rb
+- nokogireader.gemspec
+homepage: https://github.com/bonono/nokogireader
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: DSL for parsing xml using Nokogiri::XML::Reader
+test_files: []