superfeedr-sax-machine 0.0.22.1

data/README.textile

@@ -0,0 +1,87 @@
+h1. SAX Machine
+
+"http://github.com/pauldix/sax-machine/wikis":http://github.com/pauldix/sax-machine/wikis
+
+"http://github.com/pauldix/sax-machine/tree/master":http://github.com/pauldix/sax-machine/tree/master
+
+h2. Description
+
+A declarative SAX parsing library backed by Nokogiri
+
+h2. Usage
+
+<pre>
+require 'sax-machine'
+
+# Class for parsing an atom entry out of a feedburner atom feed
+class AtomEntry
+  include SAXMachine
+  element :title
+  # the :as argument makes this available through atom_entry.author instead of .name
+  element :name, :as => :author
+  element "feedburner:origLink", :as => :url
+  element :summary
+  element :content
+  element :published
+end
+
+# Class for parsing Atom feeds
+class Atom
+  include SAXMachine
+  element :title
+  # the :with argument means that you only match a link tag that has an attribute of :type => "text/html"
+  # the :value argument means that instead of setting the value to the text between the tag,
+  # it sets it to the attribute value of :href
+  element :link, :value => :href, :as => :url, :with => {:type => "text/html"}
+  element :link, :value => :href, :as => :feed_url, :with => {:type => "application/atom+xml"}
+  elements :entry, :as => :entries, :class => AtomEntry
+end
+
+# you can then parse like this
+feed = Atom.parse(xml_text)
+# then you're ready to rock
+feed.title # => whatever the title of the blog is
+feed.url # => the main url of the blog
+feed.feed_url # => goes to the feedburner feed
+ 
+feed.entries.first.title # => title of the first entry
+feed.entries.first.author # => the author of the first entry
+feed.entries.first.url # => the permalink on the blog for this entry
+# etc ...
+
+# you can also use the elements method without specifying a class like so
+class SomeServiceResponse
+  elements :message, :as => :messages
+end
+
+response = SomeServiceResponse.parse("<response><message>hi</message><message>world</message></response>")
+response.messages.first # => "hi"
+response.messages.last  # => "world"
+</pre>
+
+h2. LICENSE
+
+(The MIT License)
+ 
+Copyright (c) 2009:
+ 
+"Paul Dix":http://pauldix.net
+ 
+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/Rakefile

@@ -0,0 +1,14 @@
+require "spec"
+require "spec/rake/spectask"
+require 'lib/sax-machine.rb'
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :install do
+  rm_rf "*.gem"
+  puts `gem build sax-machine.gemspec`
+  puts `sudo gem install sax-machine-#{SAXMachine::VERSION}.gem`
+end

data/lib/sax-machine/ns_stack.rb

@@ -0,0 +1,38 @@
+module SAXMachine
+  class NSStack < Hash
+    def initialize(parent=nil, attrs=[])
+      # Initialize
+      super()
+      @parent = parent
+
+      # Parse attributes
+      attrs.each do |attr|
+        if attr.kind_of?(Array)
+          k, v = attr
+          case k
+          when 'xmlns' then self[''] = v
+          when /^xmlns:(.+)/ then self[$1] = v
+          end
+        end
+      end
+    end
+
+    # Lookup
+    def [](name)
+      if (ns = super(name.to_s))
+        # I've got it
+        ns
+      elsif @parent
+        # Parent may have it
+        @parent[name]
+      else
+        # Undefined, empty namespace
+        ''
+      end
+    end
+
+    def pop
+      @parent
+    end
+  end
+end

data/lib/sax-machine/sax_collection_config.rb

@@ -0,0 +1,56 @@
+module SAXMachine
+  class SAXConfig
+    
+    class CollectionConfig
+      attr_reader :name
+      attr_reader :default_xmlns
+      
+      def initialize(name, options)
+        @name   = name.to_s
+        @class  = options[:class]
+        @as     = options[:as].to_s
+        @xmlns  = case options[:xmlns]
+                  when Array then options[:xmlns]
+                  when String then [options[:xmlns]]
+                  else nil
+                  end
+        @default_xmlns = options[:default_xmlns]
+        if @default_xmlns && @xmlns && !@xmlns.include?('')
+          @xmlns << ''
+        end
+        @record_events = options[:events]
+      end
+      
+      def handler(nsstack)
+        if @default_xmlns && (nsstack.nil? || nsstack[''] == '')
+          nsstack = NSStack.new(nsstack, nsstack)
+          nsstack[''] = @default_xmlns
+        end
+        unless @record_events
+          SAXHandler.new(@class.new, nsstack)
+        else
+          SAXEventRecorder.new(nsstack)
+        end
+      end
+      
+      def accessor
+        as
+      end
+      
+      def xmlns_match?(ns)
+        @xmlns.nil? || @xmlns.include?(ns)
+      end
+      
+    protected
+      
+      def as
+        @as
+      end
+      
+      def class
+        @class || @name
+      end      
+    end
+    
+  end
+end

data/lib/sax-machine/sax_config.rb

@@ -0,0 +1,53 @@
+require "sax-machine/sax_element_config"
+require "sax-machine/sax_collection_config"
+
+module SAXMachine
+  class SAXConfig
+    attr_reader :top_level_elements, :collection_elements
+
+    def initialize
+      @top_level_elements  = {}
+      @collection_elements = {}
+    end
+
+    def add_top_level_element(name, options)
+      @top_level_elements[name.to_s] ||= []
+      @top_level_elements[name.to_s] << ElementConfig.new(name, options)
+    end
+
+    def add_collection_element(name, options)
+      @collection_elements[name.to_s] ||= []
+      @collection_elements[name.to_s] << CollectionConfig.new(name, options)
+    end
+
+    def collection_config(name, nsstack)
+      prefix, name = name.split(':', 2)
+      prefix, name = nil, prefix unless name  # No prefix
+      namespace = nsstack[prefix]
+
+      (@collection_elements[name.to_s] || []).detect { |ce|
+        ce.name.to_s == name.to_s &&
+        ce.xmlns_match?(namespace)
+      }
+    end
+
+    def element_configs_for_attribute(name, attrs)
+      name = name.split(':', 2).last
+      (@top_level_elements[name.to_s] || []).select do |element_config|
+        element_config.has_value_and_attrs_match?(attrs)
+      end
+    end
+
+    def element_config_for_tag(name, attrs, nsstack)
+      prefix, name = name.split(':', 2)
+      prefix, name = nil, prefix unless name  # No prefix
+      namespace = nsstack[prefix]
+
+      (@top_level_elements[name.to_s] || []).detect do |element_config|
+        element_config.xmlns_match?(namespace) &&
+        element_config.attrs_match?(attrs)
+      end
+    end
+
+  end
+end

data/lib/sax-machine/sax_document.rb

@@ -0,0 +1,107 @@
+require "nokogiri"
+
+module SAXMachine
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  def parse(xml_text)
+    unless @parser
+      sax_handler = SAXHandler.new(self)
+      @parser = Nokogiri::XML::SAX::PushParser.new(sax_handler)
+      @parser.options |= Nokogiri::XML::ParseOptions::RECOVER if @parser.respond_to?(:options)
+    end
+    @parser << xml_text
+    self
+  end
+
+  def parse_finish
+    if @parser
+      @parser.finish
+    end
+    self
+  end
+  
+  module ClassMethods
+
+    def parse(xml_text)
+      # It might be cleaner to aditionally call parse_finish here, but
+      # then Nokogiri/libxml2 barfs on incomplete documents. Desired
+      # behaviour?
+      new.parse(xml_text)
+    end
+    
+    def element(name, options = {})
+      options[:as] ||= name
+      sax_config.add_top_level_element(name, options)
+      
+      # we only want to insert the getter and setter if they haven't defined it from elsewhere.
+      # this is how we allow custom parsing behavior. So you could define the setter
+      # and have it parse the string into a date or whatever.
+      attr_reader options[:as] unless instance_methods.include?(options[:as].to_s)
+      attr_writer_once options[:as] unless instance_methods.include?("#{options[:as]}=")
+    end
+
+    def columns
+      r = []
+      sax_config.top_level_elements.each do |name, ecs|
+        r += ecs
+      end
+      r
+    end
+
+    def column(sym)
+      (sax_config.top_level_elements[sym.to_s] || []).first
+    end
+
+    def data_class(sym)
+      column(sym).data_class
+    end
+
+    def required?(sym)
+      column(sym).required?
+    end
+
+    def column_names
+      columns.map{|e| e.column}
+    end
+    
+    def elements(name, options = {})
+      options[:as] ||= name
+      if options[:class] || options[:events]
+        sax_config.add_collection_element(name, options)
+      else
+        class_eval <<-SRC
+          def add_#{options[:as]}(value)
+            #{options[:as]} << value
+          end
+        SRC
+        sax_config.add_top_level_element(name, options.merge(:collection => true))
+      end
+      
+      if !instance_methods.include?(options[:as].to_s)
+      class_eval <<-SRC
+          def #{options[:as]}
+            @#{options[:as]} ||= []
+          end
+        SRC
+      end
+      
+      attr_writer options[:as] unless instance_methods.include?("#{options[:as]}=")
+    end
+    
+    def sax_config
+      @sax_config ||= SAXConfig.new
+    end
+
+    def attr_writer_once(attr)
+      class_eval <<-SRC
+          def #{attr}=(val)
+            @#{attr} ||= val
+          end
+        SRC
+    end
+  end
+  
+end

data/lib/sax-machine/sax_element_config.rb

@@ -0,0 +1,75 @@
+module SAXMachine
+  class SAXConfig
+    
+    class ElementConfig
+      attr_reader :name, :setter, :data_class
+      
+      def initialize(name, options)
+        @name = name.to_s
+        
+        if options.has_key?(:with)
+          # for faster comparisons later
+          @with = options[:with].to_a.flatten.collect {|o| o.to_s}
+        else
+          @with = nil
+        end
+        
+        if options.has_key?(:value)
+          @value = options[:value].to_s
+        else
+          @value = nil
+        end
+        
+        @as = options[:as]
+        @collection = options[:collection]
+        
+        if @collection
+          @setter = "add_#{options[:as]}"
+        else
+          @setter = "#{@as}="
+        end
+        @data_class = options[:class]
+        @required = options[:required]
+
+        @xmlns = case options[:xmlns]
+                 when Array then options[:xmlns]
+                 when String then [options[:xmlns]]
+                 else nil
+                 end
+      end
+
+      def column
+        @as || @name.to_sym
+      end
+
+      def required?
+        @required
+      end
+
+      def value_from_attrs(attrs)
+        attrs.index(@value) ? attrs[attrs.index(@value) + 1] : nil
+      end
+      
+      def attrs_match?(attrs)
+        if @with
+          @with == (@with & attrs)
+        else
+          true
+        end
+      end
+      
+      def has_value_and_attrs_match?(attrs)
+        !@value.nil? && attrs_match?(attrs)
+      end
+
+      def xmlns_match?(ns)
+        @xmlns.nil? || @xmlns.include?(ns)
+      end
+      
+      def collection?
+        @collection
+      end
+    end
+    
+  end
+end

data/lib/sax-machine/sax_event_recorder.rb

@@ -0,0 +1,35 @@
+module SAXMachine
+  class SAXEventRecorder < SAXHandler
+    def initialize(nsstack)
+      super(nil, nsstack)
+      @events = []
+    end
+
+    def object
+      # First and last belong to the parent element
+      @events[1..-2]
+    end
+
+    def start_element(name, attrs = [])
+      @nsstack = NSStack.new(@nsstack, attrs)
+      prefix, name = name.split(':', 2)
+      prefix, name = nil, prefix unless name
+      @events << [:start_element, @nsstack[prefix], name, attrs]
+    end
+
+    def end_element(name)
+      prefix, name = name.split(':', 2)
+      prefix, name = nil, prefix unless name
+      @events << [:end_element, @nsstack[prefix], name]
+      @nsstack = @nsstack.pop
+    end
+
+    def characters(string)
+      @events << [:chars, string]
+    end
+
+    def sax_config
+      raise
+    end
+  end
+end

data/lib/sax-machine/sax_handler.rb

@@ -0,0 +1,124 @@
+require "nokogiri"
+require "sax-machine/ns_stack"
+
+module SAXMachine
+  class SAXHandler < Nokogiri::XML::SAX::Document
+    attr_reader :object
+
+    def initialize(object, nsstack=nil)
+      @object = object
+      @nsstack = nsstack || NSStack.new
+    end
+
+    def characters(string)
+      if parsing_collection?
+        @collection_handler.characters(string)
+      elsif @element_config
+        @value << string
+      end
+    end
+
+    def cdata_block(string)
+      characters(string)
+    end
+
+    def start_element(name, attrs = [])
+
+      @name   = name
+      @attrs  = attrs.map { |a| SAXHandler.decode_xml(a) }
+      @nsstack  = NSStack.new(@nsstack, @attrs)
+
+      if parsing_collection?
+        @collection_handler.start_element(@name, @attrs)
+
+      elsif @collection_config = sax_config.collection_config(@name, @nsstack)
+        @collection_handler = @collection_config.handler(@nsstack)
+        if @object.class != @collection_handler.object.class
+          @collection_handler.start_element(@name, @attrs)
+        end
+      elsif (element_configs = sax_config.element_configs_for_attribute(@name, @attrs)).any?
+        parse_element_attributes(element_configs)
+        set_element_config_for_element_value
+
+      else
+        set_element_config_for_element_value
+      end
+    end
+
+    def end_element(name)
+      if parsing_collection? && @collection_config.name == name.split(':').last
+        @collection_handler.end_element(name)
+        @object.send(@collection_config.accessor) << @collection_handler.object
+        reset_current_collection
+
+      elsif parsing_collection?
+        @collection_handler.end_element(name)
+
+      elsif characaters_captured?
+        @object.send(@element_config.setter, @value)
+      end
+
+      reset_current_tag
+      @nsstack = @nsstack.pop
+    end
+
+    def characaters_captured?
+      !@value.nil? && !@value.empty?
+    end
+
+    def parsing_collection?
+      !@collection_handler.nil?
+    end
+
+    def parse_collection_instance_attributes
+      instance = @collection_handler.object
+      @attrs.each_with_index do |attr_name,index|
+        instance.send("#{attr_name}=", @attrs[index + 1]) if index % 2 == 0 && instance.methods.include?("#{attr_name}=")
+      end
+    end
+
+    def parse_element_attributes(element_configs)
+      element_configs.each do |ec|
+        @object.send(ec.setter, ec.value_from_attrs(@attrs))
+      end
+      @element_config = nil
+    end
+
+    def set_element_config_for_element_value
+      @value = ""
+      @element_config = sax_config.element_config_for_tag(@name, @attrs, @nsstack)
+    end
+
+    def reset_current_collection
+      @collection_handler = nil
+      @collection_config  = nil
+    end
+
+    def reset_current_tag
+      @name   = nil
+      @attrs  = nil
+      @value  = nil
+      @element_config = nil
+    end
+
+    def sax_config
+      @object.class.sax_config
+    end
+  
+    ##
+    # Decodes XML special characters.
+    def self.decode_xml(str)
+      return str.map &method(:decode_xml) if str.kind_of?(Array)
+
+      # entities = {
+      #         '#38'   => '&amp;',
+      #         '#13'   => "\r",
+      #       } 
+      #       entities.keys.inject(str) { |string, key|
+      #         string.gsub(/&#{key};/, entities[key])
+      #       } 
+      CGI.unescapeHTML(str)
+    end
+  
+  end
+end

data/lib/sax-machine.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "cgi"
+
+require "sax-machine/sax_document"
+require "sax-machine/sax_handler"
+require "sax-machine/sax_config"
+require "sax-machine/sax_event_recorder"
+
+module SAXMachine
+  VERSION = "0.0.21"
+end

data/spec/sax-machine/sax_document_spec.rb

@@ -0,0 +1,657 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "SAXMachine" do
+  describe "element" do
+    describe "when parsing a single element" do
+      before :each do
+        @klass = Class.new do
+          include SAXMachine
+          element :title
+        end
+      end
+
+      it "should provide an accessor" do
+        document = @klass.new
+        document.title = "Title"
+        document.title.should == "Title"
+      end
+      
+      it "should allow introspection of the elements" do
+        @klass.column_names.should =~ [:title]
+      end
+
+      it "should not overwrite the setter if there is already one present" do
+        @klass = Class.new do
+          def title=(val)
+            @title = "#{val} **"
+          end
+          include SAXMachine
+          element :title
+        end
+        document = @klass.new
+        document.title = "Title"
+        document.title.should == "Title **"
+      end
+      describe "the class attribute" do
+        before(:each) do
+          @klass = Class.new do
+            include SAXMachine
+            element :date, :class => DateTime
+          end
+          @document = @klass.new
+          @document.date = DateTime.now.to_s
+        end
+        it "should be available" do
+          @klass.data_class(:date).should == DateTime
+        end
+      end
+      describe "the required attribute" do
+        it "should be available" do
+          @klass = Class.new do
+            include SAXMachine
+            element :date, :required => true
+          end
+          @klass.required?(:date).should be_true
+        end
+      end
+      
+      it "should not overwrite the accessor when the element is not present" do
+        document = @klass.new
+        document.title = "Title"
+        document.parse("<foo></foo>")
+        document.title.should == "Title"
+      end
+
+      it "should *not* overwrite the value when the element is present (new behaviour!)" do
+        document = @klass.new
+        document.title = "Old title"
+        document.parse("<title>New title</title>")
+        document.title.should == "Old title"
+      end
+
+      it "should save the element text into an accessor" do
+        document = @klass.parse("<title>My Title</title>")
+        document.title.should == "My Title"
+      end
+      
+      it "should save cdata into an accessor" do
+        document = @klass.parse("<title><![CDATA[A Title]]></title>")
+        document.title.should == "A Title"
+      end
+
+      it "should save the element text into an accessor when there are multiple elements" do
+        document = @klass.parse("<xml><title>My Title</title><foo>bar</foo></xml>")
+        document.title.should == "My Title"
+      end
+
+      it "should save the first element text when there are multiple of the same element" do
+        document = @klass.parse("<xml><title>My Title</title><title>bar</title></xml>")
+        document.title.should == "My Title"    
+      end
+    end
+
+    describe "when parsing multiple elements" do
+      before :each do
+        @klass = Class.new do
+          include SAXMachine
+          element :title
+          element :name
+        end
+      end
+
+      it "should save the element text for a second tag" do
+        document = @klass.parse("<xml><title>My Title</title><name>Paul</name></xml>")
+        document.name.should == "Paul"
+        document.title.should == "My Title"
+      end
+    end
+
+    describe "when using options for parsing elements" do
+      describe "using the 'as' option" do
+        before :each do
+          @klass = Class.new do
+            include SAXMachine
+            element :description, :as => :summary
+          end
+        end
+
+        it "should provide an accessor using the 'as' name" do
+          document = @klass.new
+          document.summary = "a small summary"
+          document.summary.should == "a small summary"
+        end
+
+        it "should save the element text into the 'as' accessor" do
+          document = @klass.parse("<description>here is a description</description>")
+          document.summary.should == "here is a description"
+        end
+      end
+      
+      describe "using the :with option" do
+        describe "and the :value option" do
+          before :each do
+            @klass = Class.new do
+              include SAXMachine
+              element :link, :value => :href, :with => {:foo => "bar"}
+            end
+          end
+          
+          it "should escape correctly the ampersand" do
+            document = @klass.parse("<link href='http://api.flickr.com/services/feeds/photos_public.gne?id=49724566@N00&amp;lang=en-us&amp;format=atom' foo='bar'>asdf</link>")
+            document.link.should == "http://api.flickr.com/services/feeds/photos_public.gne?id=49724566@N00&lang=en-us&format=atom"
+          end
+          
+          it "should save the value of a matching element" do
+            document = @klass.parse("<link href='test' foo='bar'>asdf</link>")
+            document.link.should == "test"
+          end
+          
+          it "should save the value of the first matching element" do
+            document = @klass.parse("<xml><link href='first' foo='bar' /><link href='second' foo='bar' /></xml>")
+            document.link.should == "first"
+          end
+          
+          describe "and the :as option" do
+            before :each do
+              @klass = Class.new do
+                include SAXMachine
+                element :link, :value => :href, :as => :url, :with => {:foo => "bar"}
+                element :link, :value => :href, :as => :second_url, :with => {:asdf => "jkl"}
+              end
+            end
+            
+            it "should save the value of the first matching element" do
+              document = @klass.parse("<xml><link href='first' foo='bar' /><link href='second' asdf='jkl' /><link href='second' foo='bar' /></xml>")
+              document.url.should == "first"
+              document.second_url.should == "second"
+            end            
+          end
+        end
+        
+        describe "with only one element" do
+          before :each do
+            @klass = Class.new do
+              include SAXMachine
+              element :link, :with => {:foo => "bar"}
+            end
+          end
+
+          it "should save the text of an element that has matching attributes" do
+            document = @klass.parse("<link foo=\"bar\">match</link>")
+            document.link.should == "match"
+          end
+
+          it "should not save the text of an element that doesn't have matching attributes" do
+            document = @klass.parse("<link>no match</link>")
+            document.link.should be_nil
+          end
+
+          it "should save the text of an element that has matching attributes when it is the second of that type" do
+            document = @klass.parse("<xml><link>no match</link><link foo=\"bar\">match</link></xml>")
+            document.link.should == "match"          
+          end
+          
+          it "should save the text of an element that has matching attributes plus a few more" do
+            document = @klass.parse("<xml><link>no match</link><link asdf='jkl' foo='bar'>match</link>")
+            document.link.should == "match"
+          end
+        end
+        
+        describe "with multiple elements of same tag" do
+          before :each do
+            @klass = Class.new do
+              include SAXMachine
+              element :link, :as => :first, :with => {:foo => "bar"}
+              element :link, :as => :second, :with => {:asdf => "jkl"}
+            end
+          end
+          
+          it "should match the first element" do
+            document = @klass.parse("<xml><link>no match</link><link foo=\"bar\">first match</link><link>no match</link></xml>")
+            document.first.should == "first match"
+          end
+          
+          it "should match the second element" do
+            document = @klass.parse("<xml><link>no match</link><link foo='bar'>first match</link><link asdf='jkl'>second match</link><link>hi</link></xml>")
+            document.second.should == "second match"
+          end
+        end
+      end # using the 'with' option
+      
+      describe "using the 'value' option" do
+        before :each do
+          @klass = Class.new do
+            include SAXMachine
+            element :link, :value => :foo
+          end
+        end
+        
+        it "should save the attribute value" do
+          document = @klass.parse("<link foo='test'>hello</link>")
+          document.link.should == 'test'
+        end
+        
+        it "should save the attribute value when there is no text enclosed by the tag" do
+          document = @klass.parse("<link foo='test'></link>")
+          document.link.should == 'test'
+        end
+        
+        it "should save the attribute value when the tag close is in the open" do
+          document = @klass.parse("<link foo='test'/>")
+          document.link.should == 'test'
+        end
+        
+        it "should save two different attribute values on a single tag" do
+          @klass = Class.new do
+            include SAXMachine
+            element :link, :value => :foo, :as => :first
+            element :link, :value => :bar, :as => :second
+          end
+          document = @klass.parse("<link foo='foo value' bar='bar value'></link>")
+          document.first.should == "foo value"
+          document.second.should == "bar value"
+        end
+        
+        it "should not fail if one of the attribute hasn't been defined" do
+          @klass = Class.new do
+            include SAXMachine
+            element :link, :value => :foo, :as => :first
+            element :link, :value => :bar, :as => :second
+          end
+          document = @klass.parse("<link foo='foo value'></link>")
+          document.first.should == "foo value"
+          document.second.should be_nil
+        end
+      end
+      
+      describe "when desiring both the content and attributes of an element" do
+        before :each do
+          @klass = Class.new do
+            include SAXMachine
+            element :link
+            element :link, :value => :foo, :as => :link_foo
+            element :link, :value => :bar, :as => :link_bar
+          end
+        end
+
+        it "should parse the element and attribute values" do
+          document = @klass.parse("<link foo='test1' bar='test2'>hello</link>")
+          document.link.should == 'hello'
+          document.link_foo.should == 'test1'
+          document.link_bar.should == 'test2'
+        end
+      end
+
+      describe "when specifying namespaces" do
+        before :all do
+          @klass = Class.new do
+            include SAXMachine
+            element :a, :xmlns => 'urn:test'
+            element :b, :xmlns => ['', 'urn:test']
+          end
+        end
+
+        it "should get the element with the xmlns" do
+          document = @klass.parse("<a xmlns='urn:test'>hello</a>")
+          document.a.should == 'hello'
+        end
+
+        it "shouldn't get the element without the xmlns" do
+          document = @klass.parse("<a>hello</a>")
+          document.a.should be_nil
+        end
+
+        it "shouldn't get the element with the wrong xmlns" do
+          document = @klass.parse("<a xmlns='urn:test2'>hello</a>")
+          document.a.should be_nil
+        end
+
+        it "should get an element without xmlns if the empty namespace is desired" do
+          document = @klass.parse("<b>hello</b>")
+          document.b.should == 'hello'
+        end
+
+        it "should get an element with the right prefix" do
+          document = @klass.parse("<p:a xmlns:p='urn:test'>hello</p:a>")
+          document.a.should == 'hello'
+        end
+
+        it "should not get an element with the wrong prefix" do
+          document = @klass.parse("<x:a xmlns:p='urn:test' xmlns:x='urn:test2'>hello</x:a>")
+          document.a.should be_nil
+        end
+
+        it "should get a prefixed element without xmlns if the empty namespace is desired" do
+          pending "this needs a less pickier nokogiri push parser"
+          document = @klass.parse("<x:b>hello</x:b>")
+          document.b.should == 'hello'
+        end
+
+        it "should get the namespaced element even it's not first" do
+          document = @klass.parse("<root xmlns:a='urn:test'><a>foo</a><a>foo</a><a:a>bar</a:a></root>")
+          document.a.should == 'bar'
+        end
+
+        it "should parse multiple namespaces" do
+          klass = Class.new do
+            include SAXMachine
+            element :a, :xmlns => 'urn:test'
+            element :b, :xmlns => 'urn:test2'
+          end
+          document = klass.parse("<root xmlns='urn:test' xmlns:b='urn:test2'><b:b>bar</b:b><a>foo</a></root>")
+          document.a.should == 'foo'
+          document.b.should == 'bar'
+        end
+
+        context "when passing a default namespace" do
+          before :all do
+            @xmlns = 'urn:test'
+            class Inner
+              include SAXMachine
+              element :a, :xmlns => @xmlns
+            end
+            @outer = Class.new do
+              include SAXMachine
+              elements :root, :default_xmlns => @xmlns, :class => Inner
+            end
+          end
+
+          it "should replace the empty namespace with a default" do
+            document = @outer.parse("<root><a>Hello</a></root>")
+            document.root[0].a.should == 'Hello'
+          end
+
+          it "should not replace another namespace" do
+            document = @outer.parse("<root xmlns='urn:test2'><a>Hello</a></root>")
+            document.root[0].a.should == 'Hello'
+          end
+        end
+      end
+      
+    end
+  end
+  
+  describe "elements" do
+    describe "when parsing multiple elements" do
+      before :all do
+        @klass = Class.new do
+          include SAXMachine
+          elements :entry, :as => :entries
+        end
+      end
+      
+      it "should provide a collection accessor" do
+        document = @klass.new
+        document.entries << :foo
+        document.entries.should == [:foo]
+      end
+      
+      it "should parse a single element" do
+        document = @klass.parse("<entry>hello</entry>")
+        document.entries.should == ["hello"]
+      end
+      
+      it "should parse multiple elements" do
+        document = @klass.parse("<xml><entry>hello</entry><entry>world</entry></xml>")
+        document.entries.should == ["hello", "world"]
+      end
+      
+      it "should parse multiple elements when taking an attribute value" do
+        attribute_klass = Class.new do
+          include SAXMachine
+          elements :entry, :as => :entries, :value => :foo
+        end
+        doc = attribute_klass.parse("<xml><entry foo='asdf' /><entry foo='jkl' /></xml>")
+        doc.entries.should == ["asdf", "jkl"]
+      end
+    end
+    
+    describe "when using the class option" do
+      before :each do
+        class Foo
+          include SAXMachine
+          element :title
+        end
+        @klass = Class.new do
+          include SAXMachine
+          elements :entry, :as => :entries, :class => Foo
+        end
+      end
+      
+      it "should parse a single element with children" do
+        document = @klass.parse("<entry><title>a title</title></entry>")
+        document.entries.size.should == 1
+        document.entries.first.title.should == "a title"
+      end
+      
+      it "should parse multiple elements with children" do
+        document = @klass.parse("<xml><entry><title>title 1</title></entry><entry><title>title 2</title></entry></xml>")
+        document.entries.size.should == 2
+        document.entries.first.title.should == "title 1"
+        document.entries.last.title.should == "title 2"
+      end
+      
+      it "should not parse a top level element that is specified only in a child" do
+        document = @klass.parse("<xml><title>no parse</title><entry><title>correct title</title></entry></xml>")
+        document.entries.size.should == 1
+        document.entries.first.title.should == "correct title"
+      end
+      
+      it "should parse out an attribute value from the tag that starts the collection" do
+        class Foo
+          element :entry, :value => :href, :as => :url
+        end
+        document = @klass.parse("<xml><entry href='http://pauldix.net'><title>paul</title></entry></xml>")
+        document.entries.size.should == 1
+        document.entries.first.title.should == "paul"
+        document.entries.first.url.should == "http://pauldix.net"
+      end
+    end    
+
+    describe "when desiring sax events" do
+      XHTML_XMLNS = "http://www.w3.org/1999/xhtml"
+
+      before :all do
+        @klass = Class.new do
+          include SAXMachine
+          elements :body, :events => true
+        end
+      end
+
+      it "should parse a simple child" do
+        document = @klass.parse("<body><p/></body>")
+        document.body[0].should == [[:start_element, "", "p", []],
+                                    [:end_element, "", "p"]]
+      end
+      it "should parse a simple child with text" do
+        document = @klass.parse("<body><p>Hello</p></body>")
+        document.body[0].should == [[:start_element, "", "p", []],
+                                    [:chars, "Hello"],
+                                    [:end_element, "", "p"]]
+      end
+      it "should parse nested children" do
+        document = @klass.parse("<body><p><span/></p></body>")
+        document.body[0].should == [[:start_element, "", "p", []],
+                                    [:start_element, "", "span", []],
+                                    [:end_element, "", "span"],
+                                    [:end_element, "", "p"]]
+      end
+      it "should parse multiple children" do
+        document = @klass.parse("<body><p>Hello</p><p>World</p></body>")
+        document.body[0].should == [[:start_element, "", "p", []],
+                                    [:chars, "Hello"],
+                                    [:end_element, "", "p"],
+                                    [:start_element, "", "p", []],
+                                    [:chars, "World"],
+                                    [:end_element, "", "p"]]
+      end
+      it "should pass namespaces" do
+        document = @klass.parse("<body xmlns='#{XHTML_XMLNS}'><p/></body>")
+        document.body[0].should == [[:start_element, XHTML_XMLNS, "p", []],
+                                    [:end_element, XHTML_XMLNS, "p"]]
+      end
+    end
+  end
+  
+  describe "full example" do
+    XMLNS_ATOM = "http://www.w3.org/2005/Atom"
+    XMLNS_FEEDBURNER = "http://rssnamespace.org/feedburner/ext/1.0"
+
+    before :each do
+      @xml = File.read('spec/sax-machine/atom.xml')
+      class AtomEntry
+        include SAXMachine
+        element :title
+        element :name, :as => :author
+        element :origLink, :as => :orig_link, :xmlns => XMLNS_FEEDBURNER
+        element :summary
+        element :content
+        element :published
+      end
+        
+      class Atom
+        include SAXMachine
+        element :title
+        element :link, :value => :href, :as => :url, :with => {:type => "text/html"}
+        element :link, :value => :href, :as => :feed_url, :with => {:type => "application/atom+xml"}
+        elements :entry, :as => :entries, :class => AtomEntry, :xmlns => XMLNS_ATOM
+      end
+    end # before
+    
+    it "should parse the url" do
+      f = Atom.parse(@xml)
+      f.url.should == "http://www.pauldix.net/"
+    end
+
+    it "should parse all entries" do
+      f = Atom.parse(@xml)
+      f.entries.length.should == 5
+    end
+
+    it "should parse the feedburner:origLink" do
+      f = Atom.parse(@xml)
+      f.entries[0].orig_link.should == 'http://www.pauldix.net/2008/09/marshal-data-to.html'
+    end
+  end
+
+  describe "another full example" do
+
+    RSS_XMLNS = 'http://purl.org/rss/1.0/'
+    ATOM_XMLNS = 'http://www.w3.org/2005/Atom'
+    class Entry
+      include SAXMachine
+      element :title, :xmlns => RSS_XMLNS
+      element :title, :xmlns => ATOM_XMLNS
+      element :link, :xmlns => RSS_XMLNS
+      element :link, :xmlns => ATOM_XMLNS, :value => 'href'
+    end
+    class Channel
+      include SAXMachine
+      element :title, :xmlns => RSS_XMLNS
+      element :title, :xmlns => ATOM_XMLNS
+      element :link, :xmlns => RSS_XMLNS
+      element :link, :xmlns => ATOM_XMLNS, :value => 'href'
+      elements :entry, :as => :entries, :class => Entry
+      elements :item, :as => :entries, :class => Entry
+    end
+    class Root
+      include SAXMachine
+      elements :rss, :as => :channels, :default_xmlns => RSS_XMLNS, :class => Channel
+      elements :feed, :as => :channels, :default_xmlns => ATOM_XMLNS, :class => Channel
+    end
+
+    context "when parsing a complex example" do
+      before :all do
+        @document = Root.parse(<<-eoxml).channels[0]
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" 
+                   xmlns:content="http://purl.org/rss/1.0/modules/content/"
+                   xmlns:wfw="http://wellformedweb.org/CommentAPI/"
+                   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+                   xmlns:dc="http://purl.org/dc/elements/1.1/"
+                   xmlns:cc="http://web.resource.org/cc/">
+  <channel>
+    <title>Delicious/tag/pubsubhubbub</title>
+    <atom:link rel="self" type="application/rss+xml" href="http://feeds.delicious.com/v2/rss/tag/pubsubhubbub?count=15"/>
+    <link>http://delicious.com/tag/pubsubhubbub</link>
+    <description>recent bookmarks tagged pubsubhubbub</description>
+  </channel>
+</rss>
+eoxml
+      end
+      it "should parse the title" do
+        @document.title.should == 'Delicious/tag/pubsubhubbub'
+      end
+      it "should parse the link" do
+        @document.link.should == 'http://feeds.delicious.com/v2/rss/tag/pubsubhubbub?count=15'
+      end
+    end
+  end  
+  
+  describe "yet another full example" do
+  
+    context "when parsing a Twitter example" do
+      before :all do
+        
+        RSS_XMLNS = ['http://purl.org/rss/1.0/', '']
+        
+        ATOM_XMLNS = 'http://www.w3.org/2005/Atom' unless defined? ATOM_XMLNS
+        class Link
+          include SAXMachine
+        end
+        
+        class Entry
+          include SAXMachine
+          element   :title,        :xmlns => RSS_XMLNS
+          element   :link,         :xmlns => RSS_XMLNS,   :as => :entry_link
+          element   :title,        :xmlns => ATOM_XMLNS,  :as => :title
+          elements  :link,         :xmlns => ATOM_XMLNS,  :as => :links,      :class => Link
+        end
+        
+        class Feed
+          include SAXMachine
+          element   :title,        :xmlns => RSS_XMLNS,  :as => :title
+          element   :link,         :xmlns => RSS_XMLNS,  :as => :feed_link
+          elements  :item,         :xmlns => RSS_XMLNS,  :as => :entries,         :class => Entry
+          element   :title,        :xmlns => ATOM_XMLNS, :as => :title
+          elements  :link,         :xmlns => ATOM_XMLNS, :as => :links,           :class => Link
+        end
+        
+        @document = Feed.parse(<<-eoxml)
+<?xml version="1.0" encoding="UTF-8"?>
+        <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+          <channel>
+            <atom:link type="application/rss+xml" rel="self" href="http://twitter.com/statuses/user_timeline/5381582.rss"/>
+            <title>Twitter / julien51</title>
+            <link>http://twitter.com/julien51</link>
+            <description>Twitter updates from julien / julien51.</description>
+            <language>en-us</language>
+            <ttl>40</ttl>
+          <item>
+            <title>julien51: @github :  I get an error when trying to build one of my gems (julien51-sax-machine), it seems related to another gem's gemspec.</title>
+            <description>julien51: @github :  I get an error when trying to build one of my gems (julien51-sax-machine), it seems related to another gem's gemspec.</description>
+            <pubDate>Thu, 30 Jul 2009 01:00:30 +0000</pubDate>
+            <guid>http://twitter.com/julien51/statuses/2920716033</guid>
+            <link>http://twitter.com/julien51/statuses/2920716033</link>
+          </item>
+          <item>
+            <title>julien51: Hum, San Francisco's summer are delightful. http://bit.ly/VeXt4</title>
+            <description>julien51: Hum, San Francisco's summer are delightful. http://bit.ly/VeXt4</description>
+            <pubDate>Wed, 29 Jul 2009 23:07:32 +0000</pubDate>
+            <guid>http://twitter.com/julien51/statuses/2918869948</guid>
+            <link>http://twitter.com/julien51/statuses/2918869948</link>
+          </item>
+          </channel>
+        </rss>
+eoxml
+      end
+      it "should parse the title" do
+        @document.title.should == 'Twitter / julien51'
+      end
+      
+      it "should find an entry" do
+        @document.entries.length.should == 2
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--diff
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "rubygems"
+require "spec"
+
+# gem install redgreen for colored test output
+begin require "redgreen" unless ENV['TM_CURRENT_LINE']; rescue LoadError; end
+
+path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+
+require "lib/sax-machine"
+
+# Spec::Runner.configure do |config|
+# end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: superfeedr-sax-machine
+version: !ruby/object:Gem::Version 
+  version: 0.0.22.1
+platform: ruby
+authors: 
+- Paul Dix
+- Stephan Maka
+- julien51
+- superfeedr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: 
+email: paul@pauldix.net stephan@spaceboyz.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/sax-machine.rb
+- lib/sax-machine/sax_config.rb
+- lib/sax-machine/sax_collection_config.rb
+- lib/sax-machine/sax_element_config.rb
+- lib/sax-machine/sax_document.rb
+- lib/sax-machine/sax_handler.rb
+- lib/sax-machine/ns_stack.rb
+- lib/sax-machine/sax_event_recorder.rb
+- README.textile
+- Rakefile
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/sax-machine/sax_document_spec.rb
+has_rdoc: true
+homepage: http://github.com/pauldix/sax-machine
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Declarative SAX Parsing with Nokogiri
+test_files: []
+