julien51-sax-machine 0.0.16 → 0.0.22

data/lib/sax-machine/sax_collection_config.rb

@@ -3,21 +3,44 @@ module SAXMachine
     
     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
-        SAXHandler.new(@class.new)
+      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
@@ -30,4 +53,4 @@ module SAXMachine
     end
     
   end
-end
+end

data/lib/sax-machine/sax_config.rb

@@ -6,25 +6,34 @@ module SAXMachine
     attr_reader :top_level_elements, :collection_elements
 
     def initialize
-      @top_level_elements  = []
-      @collection_elements = []
+      @top_level_elements  = {}
+      @collection_elements = {}
     end
 
     def add_top_level_element(name, options)
-      @top_level_elements << ElementConfig.new(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 << CollectionConfig.new(name, options)
+      @collection_elements[name.to_s] ||= []
+      @collection_elements[name.to_s] << CollectionConfig.new(name, options)
     end
 
-    def collection_config(name)
-      @collection_elements.detect { |ce| ce.name.to_s == name.to_s }
+    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)
-      @top_level_elements.select do |element_config|
-        element_config.name == name &&
+      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
@@ -34,8 +43,7 @@ module SAXMachine
       prefix, name = nil, prefix unless name  # No prefix
       namespace = nsstack[prefix]
 
-      @top_level_elements.detect do |element_config|
-        element_config.name == name &&
+      (@top_level_elements[name.to_s] || []).detect do |element_config|
         element_config.xmlns_match?(namespace) &&
         element_config.attrs_match?(attrs)
       end

data/lib/sax-machine/sax_document.rb

@@ -10,6 +10,7 @@ module SAXMachine
     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
@@ -43,11 +44,15 @@ module SAXMachine
     end
 
     def columns
-      sax_config.top_level_elements
+      r = []
+      sax_config.top_level_elements.each do |name, ecs|
+        r += ecs
+      end
+      r
     end
 
     def column(sym)
-      columns.select{|c| c.column == sym}[0]
+      (sax_config.top_level_elements[sym.to_s] || []).first
     end
 
     def data_class(sym)
@@ -64,7 +69,7 @@ module SAXMachine
     
     def elements(name, options = {})
       options[:as] ||= name
-      if options[:class]
+      if options[:class] || options[:events]
         sax_config.add_collection_element(name, options)
       else
         class_eval <<-SRC

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

@@ -5,9 +5,9 @@ module SAXMachine
   class SAXHandler < Nokogiri::XML::SAX::Document
     attr_reader :object
 
-    def initialize(object)
+    def initialize(object, nsstack=nil)
       @object = object
-      @nsstack = nil
+      @nsstack = nsstack || NSStack.new
     end
 
     def characters(string)
@@ -23,7 +23,7 @@ module SAXMachine
     end
 
     def start_element(name, attrs = [])
-      
+
       @name   = name
       @attrs  = attrs.map { |a| SAXHandler.decode_xml(a) }
       @nsstack  = NSStack.new(@nsstack, @attrs)
@@ -31,10 +31,11 @@ module SAXMachine
       if parsing_collection?
         @collection_handler.start_element(@name, @attrs)
 
-      elsif @collection_config = sax_config.collection_config(@name)
-        @collection_handler = @collection_config.handler
-        @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
@@ -45,7 +46,8 @@ module SAXMachine
     end
 
     def end_element(name)
-      if parsing_collection? && @collection_config.name == 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
 

data/lib/sax-machine.rb

@@ -5,7 +5,8 @@ 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.16"
-end
+  VERSION = "0.0.21"
+end

data/spec/sax-machine/sax_document_spec.rb

@@ -326,6 +326,46 @@ describe "SAXMachine" do
           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
@@ -333,7 +373,7 @@ describe "SAXMachine" do
   
   describe "elements" do
     describe "when parsing multiple elements" do
-      before :each do
+      before :all do
         @klass = Class.new do
           include SAXMachine
           elements :entry, :as => :entries
@@ -407,16 +447,63 @@ describe "SAXMachine" do
         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 "feedburner:origLink", :as => :url
+        element :origLink, :as => :orig_link, :xmlns => XMLNS_FEEDBURNER
         element :summary
         element :content
         element :published
@@ -427,7 +514,7 @@ describe "SAXMachine" do
         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
+        elements :entry, :as => :entries, :class => AtomEntry, :xmlns => XMLNS_ATOM
       end
     end # before
     
@@ -435,5 +522,136 @@ describe "SAXMachine" 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

metadata

@@ -1,10 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: julien51-sax-machine
 version: !ruby/object:Gem::Version 
-  version: 0.0.16
+  version: 0.0.22
 platform: ruby
 authors: 
 - Paul Dix
+- astro
+- julien51
+- superfeedr
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -38,14 +41,16 @@ files:
 - 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: false
-homepage: http://github.com/pauldix/sax-machine
-licenses: 
+has_rdoc: true
+homepage: http://github.com/julien51/sax-machine
+licenses: []
+
 post_install_message: 
 rdoc_options: []