saxerator 0.0.1 → 0.0.2

data/Guardfile

@@ -5,7 +5,7 @@ guard :bundler do
   watch(/^saxerator\.gemspec$/)
 end
 
-guard :rspec, :cli => '--color --format doc' do
+guard :rspec, :cli => '--color' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch(%r{^spec/fixtures/.+\.xml$}) { :spec }

data/README.md

@@ -3,31 +3,35 @@ Saxerator
 
 Saxerator is a SAX-based xml parser designed for parsing very large files into manageable chunks. Rather than
 dealing directly with SAX callback methods, Saxerator gives you Enumerable access to chunks of an xml document.
-This approach is ideal for large xml files that represent a collection of elements.
+This approach is ideal for large xml files containing a collection of elements that you can process
+independently.
+
+Each xml chunk is parsed into a JSON-like Ruby Hash structure for consumption.
 
 Examples
 --------
 
 ```ruby
-Saxerator.parser(File.new("rss.xml")).for_tag(:item).each do |item|
-    puts "#{item['title']}: #{item['author']}"
+parser = Saxerator.parser(File.new("rss.xml"))
+
+parser.for_tag(:item).each do |item|
+  # where the xml contains <item><title>...</title><author>...</author></item>
+  # item will look like {'title' => '...', 'author' => '...'}
+  puts "#{item['title']}: #{item['author']}"
 end
+
+# a String is returned here since the given element contains only character data
+puts "First title: #{parser.for_tag(:title).first}"
 ```
 
 Compatibility
 -------------
-This library is known to work with the following rubies:
+Known compatible rubies:
 
 * MRI 1.9.3-p125
 * MRI 1.9.2-p318
 * JRuby 1.6.7 (with JRUBY_OPTS=--1.9)
 
-Saxerator may work with other versions with support for Fiber.
-
-Known incompatible rubies:
-
-* MRI 1.9.2-p290 (Fiber segfaults)
-
 FAQ
 ---
 Why the name 'Saxerator'?

data/lib/saxerator/configuration.rb

@@ -7,8 +7,7 @@ module Saxerator
     end
 
     def for_tag(tag)
-      tag = tag.to_s
-      Saxerator::Parser::Nokogiri.new(self, source, tag)
+      Saxerator::Parser::Nokogiri.new(self, source, tag.to_s)
     end
   end
 end

data/lib/saxerator/parser/nokogiri.rb

@@ -1,5 +1,4 @@
 require 'nokogiri'
-require 'fiber'
 
 module Saxerator
   module Parser
@@ -13,27 +12,23 @@ module Saxerator
       end
 
       def each(&block)
-        begin
-          fiber = Fiber.new do
-            document = Document.new(@config, @tag)
-            parser = ::Nokogiri::XML::SAX::Parser.new document
-            parser.parse(@source)
-          end
-          while fiber.alive? do
-            result = fiber.resume
-            yield(result) unless result.nil?
-          end
-        rescue FiberError
-        end
+        document = Document.new(@config, @tag, block)
+        parser = ::Nokogiri::XML::SAX::Parser.new document
+
+        # Always have to start at the beginning of a File
+        @source.rewind if(@source.is_a?(File))
+
+        parser.parse(@source)
       end
 
       class Document < ::Nokogiri::XML::SAX::Document
         attr_accessor :stack
 
-        def initialize(config, tag)
+        def initialize(config, tag, block)
           @config = config
           @tag = tag
           @stack = []
+          @block = block
         end
 
         def start_element(name, attrs = [])
@@ -47,7 +42,7 @@ module Saxerator
             last = stack.pop
             stack.last.add_node last
           elsif stack.size == 1
-            Fiber.yield(stack.pop.to_hash)
+            @block.yield(stack.pop.to_hash)
           end
         end
 

data/lib/saxerator/version.rb

@@ -1,3 +1,3 @@
 module Saxerator
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/saxerator.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path('../lib', __FILE__)
 require 'saxerator/version'
-require 'rubygems/package_task'
+require 'rake' # for FileList
 
 Gem::Specification.new do |s|
   s.name        = 'saxerator'
@@ -10,9 +10,13 @@ Gem::Specification.new do |s|
   s.email       = ['bradley.schaefer@gmail.com']
   s.homepage    = 'https://github.com/soulcutter/saxerator'
   s.summary     = 'A SAX-based XML parser for parsing large files into manageable chunks'
-  s.description = 'A SAX-based XML parser for parsing large files into manageable chunks'
-
-  s.required_ruby_version = '>= 1.9.2'
+  s.description = <<-eos
+    Saxerator is a SAX-based xml parser designed for parsing very large files into manageable chunks. Rather than
+    dealing directly with SAX callback methods, Saxerator gives you Enumerable access to chunks of an xml document.
+    This approach is ideal for large xml files containing a collection of elements that you can process
+    independently.
+  eos
+  s.license     = 'MIT'
 
   s.rubyforge_project = 'saxerator'
 
@@ -35,6 +39,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'nokogiri'
 
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'guard'
   s.add_development_dependency 'guard-bundler'

data/spec/lib/saxerator_spec.rb

@@ -38,6 +38,14 @@ describe Saxerator do
         subject.for_tag(:blurb).each { |x| results << x }
         results.should == ['one', 'two', 'three']
       end
+
+      it "should allow multiple operations on the same parser" do
+        # This exposes a bug where if a File is not reset only the first
+        # Enumerable method works as expected
+        subject.for_tag(:blurb).first.should == 'one'
+        subject.for_tag(:blurb).first.should == 'one'
+      end
+
     end
 
     context "with a file with nested elements" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saxerator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-07 00:00:00.000000000 Z
+date: 2012-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70348029624860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,31 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70348029624860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70348029624300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70348029624300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70348029623840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70348029623840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70348029623320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70348029623320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70348029622860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70348029622860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70348029622300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70348029622300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ipsum
-  requirement: &70348029621880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,8 +133,17 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70348029621880
-description: A SAX-based XML parser for parsing large files into manageable chunks
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    Saxerator is a SAX-based xml parser designed for parsing very
+  large files into manageable chunks. Rather than\n    dealing directly with SAX callback
+  methods, Saxerator gives you Enumerable access to chunks of an xml document.\n    This
+  approach is ideal for large xml files containing a collection of elements that you
+  can process\n    independently.\n"
 email:
 - bradley.schaefer@gmail.com
 executables: []
@@ -116,7 +171,8 @@ files:
 - .rvmrc
 - .gitignore
 homepage: https://github.com/soulcutter/saxerator
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -126,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: saxerator
-rubygems_version: 1.8.11
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: A SAX-based XML parser for parsing large files into manageable chunks