UnderpantsGnome-sax-machine 0.0.13 → 0.0.14

data/lib/sax-machine/sax_collection_config.rb

@@ -5,9 +5,9 @@ module SAXMachine
       attr_reader :name
       
       def initialize(name, options)
-        @name   = name.to_s
-        @class  = options[:class]
-        @as     = options[:as].to_s
+        @name  = name.to_s
+        @class = options[:class]
+        @as    = options[:as].to_s
       end
       
       def handler
@@ -30,4 +30,4 @@ module SAXMachine
     end
     
   end
-end
+end

data/lib/sax-machine/sax_config.rb

@@ -5,6 +5,7 @@ module SAXMachine
   class SAXConfig
     def initialize
       @top_level_elements  = []
+      @complex_elements = []
       @collection_elements = []
     end
 
@@ -12,10 +13,18 @@ module SAXMachine
       @top_level_elements << ElementConfig.new(name, options)
     end
 
+    def add_complex_element(name, options)
+      @complex_elements << ElementConfig.new(name, options)
+    end
+
     def add_collection_element(name, options)
       @collection_elements << CollectionConfig.new(name, options)
     end
 
+    def complex_config(name)
+      @complex_elements.detect { |ce| ce.name.to_s == name.to_s }
+    end
+
     def collection_config(name)
       @collection_elements.detect { |ce| ce.name.to_s == name.to_s }
     end
@@ -33,6 +42,5 @@ module SAXMachine
         element_config.attrs_match?(attrs)
       end
     end
-
   end
-end
+end

data/lib/sax-machine/sax_document.rb

@@ -1,37 +1,44 @@
 require "nokogiri"
 
 module SAXMachine
-  
   def self.included(base)
     base.extend ClassMethods
   end
-  
+
   def parse(xml_text)
     sax_handler = SAXHandler.new(self)
     parser = Nokogiri::XML::SAX::Parser.new(sax_handler)
     parser.parse(xml_text)
     self
   end
-  
-  module ClassMethods
 
+  module ClassMethods
     def parse(xml_text)
       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 options[:as] unless instance_methods.include?("#{options[:as]}=")
+
+      unless options[:class]
+        sax_config.add_top_level_element(name, options)
+      else
+        sax_config.add_complex_element(name, options)
+      end
+
+      # We only want to insert the getter and setter if they haven't been
+      # defined 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. However, if the getter or setter is defined by a superclass,
+      # we go ahead and overwrite it. This allows use to still access elements
+      # with names like "id".
+      attr_reader options[:as] unless instance_methods(false).include?(options[:as].to_s)
+      attr_writer options[:as] unless instance_methods(false).include?("#{options[:as]}=")
     end
-    
+
     def elements(name, options = {})
       options[:as] ||= name
+
       if options[:class]
         sax_config.add_collection_element(name, options)
       else
@@ -40,23 +47,23 @@ module SAXMachine
             #{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
+        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
   end
-  
-end
+end

data/lib/sax-machine/sax_element_config.rb

@@ -1,28 +1,28 @@
 module SAXMachine
   class SAXConfig
-    
     class ElementConfig
       attr_reader :name, :setter
-      
+
       def initialize(name, options)
-        @name = name.to_s
-        
+        @name  = name.to_s
+        @class = options[:class]
+
         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
@@ -33,7 +33,7 @@ module SAXMachine
       def value_from_attrs(attrs)
         attrs.index(@value) ? attrs[attrs.index(@value) + 1] : nil
       end
-      
+
       def attrs_match?(attrs)
         if @with
           @with == (@with & attrs)
@@ -41,15 +41,18 @@ module SAXMachine
           true
         end
       end
-      
+
       def has_value_and_attrs_match?(attrs)
         !@value.nil? && attrs_match?(attrs)
       end
-      
+
       def collection?
         @collection
       end
+
+      def handler
+        SAXHandler.new(@class.new) if @class
+      end
     end
-    
   end
-end
+end

data/lib/sax-machine/sax_handler.rb

@@ -7,10 +7,13 @@ module SAXMachine
     def initialize(object)
       @object = object
       @parsed_configs = {}
+      @parsed_complex_configs = {}
     end
 
     def characters(string)
-      if parsing_collection?
+      if parsing_complex?
+        @complex_handler.characters(string)
+      elsif parsing_collection?
         @collection_handler.characters(string)
       elsif @element_config
         @value << string
@@ -25,9 +28,16 @@ module SAXMachine
       @name   = name
       @attrs  = attrs
 
-      if parsing_collection?
+      if parsing_complex?
+        @complex_handler.start_element(@name, @attrs)
+
+      elsif parsing_collection?
         @collection_handler.start_element(@name, @attrs)
 
+      elsif @complex_config = sax_config.complex_config(@name)
+        @complex_handler = @complex_config.handler
+        @complex_handler.start_element(@name, @attrs)
+
       elsif @collection_config = sax_config.collection_config(@name)
         @collection_handler = @collection_config.handler
         @collection_handler.start_element(@name, @attrs)
@@ -42,7 +52,15 @@ module SAXMachine
     end
 
     def end_element(name)
-      if parsing_collection? && @collection_config.name == name
+      if parsing_complex? && @complex_config.name == name && !parsed_complex_config?
+        complex_mark_as_parsed
+        @object.send(@complex_config.setter, @complex_handler.object)
+        reset_current_complex
+
+      elsif parsing_complex? && !parsed_complex_config?
+        @complex_handler.end_element(name)
+
+      elsif parsing_collection? && @collection_config.name == name
         @object.send(@collection_config.accessor) << @collection_handler.object
         reset_current_collection
 
@@ -61,6 +79,10 @@ module SAXMachine
       !@value.nil? && !@value.empty?
     end
 
+    def parsing_complex?
+      !@complex_handler.nil?
+    end
+
     def parsing_collection?
       !@collection_handler.nil?
     end
@@ -97,15 +119,28 @@ module SAXMachine
       @parsed_configs[element_config]
     end
 
+    def complex_mark_as_parsed
+      @parsed_complex_configs[@complex_config] = true
+    end
+
+    def parsed_complex_config?
+      @parsed_complex_configs[@complex_config]
+    end
+
     def reset_current_collection
       @collection_handler = nil
       @collection_config  = nil
     end
 
+    def reset_current_complex
+      @complex_handler = nil
+      @complex_config  = nil
+    end
+
     def reset_current_tag
-      @name   = nil
-      @attrs  = nil
-      @value  = nil
+      @name  = nil
+      @attrs = nil
+      @value = nil
       @element_config = nil
     end
 
@@ -113,4 +148,4 @@ module SAXMachine
       @object.class.sax_config
     end
   end
-end
+end

data/spec/sax-machine/sax_document_spec.rb

@@ -28,7 +28,7 @@ describe "SAXMachine" do
         document.title = "Title"
         document.title.should == "Title **"
       end
-      
+
       it "should not overwrite the accessor when the element is not present" do
         document = @klass.new
         document.title = "Title"
@@ -47,7 +47,7 @@ describe "SAXMachine" 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"
@@ -60,7 +60,7 @@ describe "SAXMachine" do
 
       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"    
+        document.title.should == "My Title"
       end
     end
 
@@ -100,7 +100,7 @@ describe "SAXMachine" do
           document.summary.should == "here is a description"
         end
       end
-      
+
       describe "using the :with option" do
         describe "and the :value option" do
           before :each do
@@ -109,17 +109,17 @@ describe "SAXMachine" do
               element :link, :value => :href, :with => {:foo => "bar"}
             end
           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
@@ -128,15 +128,15 @@ describe "SAXMachine" do
                 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
         end
-        
+
         describe "with only one element" do
           before :each do
             @klass = Class.new do
@@ -157,15 +157,15 @@ describe "SAXMachine" do
 
           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"          
+            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
@@ -174,19 +174,19 @@ describe "SAXMachine" do
               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
@@ -194,22 +194,22 @@ describe "SAXMachine" do
             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
@@ -220,7 +220,7 @@ describe "SAXMachine" do
           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
@@ -232,7 +232,7 @@ describe "SAXMachine" do
           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
@@ -250,10 +250,47 @@ describe "SAXMachine" do
           document.link_bar.should == 'test2'
         end
       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
+          element :entry, :class => Foo
+        end
+      end
+
+      it "should parse a single element with children" do
+        document = @klass.parse("<entry><title>a title</title></entry>")
+        document.entry.title.should == "a title"
+      end
+
+      it "should use the first element when there are multiple of the same element" do
+        document = @klass.parse("<xml><entry><title>title 1</title></entry><entry><title>title 2</title></entry></xml>")
+        document.entry.title.should == "title 1"
+      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.entry.title.should == "correct title"
+      end
+
+      it "should parse out an attribute value from the tag that starts the element" 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.entry.title.should == "paul"
+        document.entry.url.should == "http://pauldix.net"
+      end
     end
   end
-  
+
   describe "elements" do
     describe "when parsing multiple elements" do
       before :each do
@@ -262,23 +299,23 @@ describe "SAXMachine" do
           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
@@ -288,9 +325,10 @@ describe "SAXMachine" do
         doc.entries.should == ["asdf", "jkl"]
       end
     end
-    
+
     describe "when using the class option" do
       before :each do
+        Object.send(:remove_const, :Foo)
         class Foo
           include SAXMachine
           element :title
@@ -300,26 +338,26 @@ describe "SAXMachine" do
           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
@@ -329,9 +367,9 @@ describe "SAXMachine" do
         document.entries.first.title.should == "paul"
         document.entries.first.url.should == "http://pauldix.net"
       end
-    end    
+    end
   end
-  
+
   describe "full example" do
     before :each do
       @xml = File.read('spec/sax-machine/atom.xml')
@@ -344,7 +382,7 @@ describe "SAXMachine" do
         element :content
         element :published
       end
-        
+
       class Atom
         include SAXMachine
         element :title
@@ -353,7 +391,7 @@ describe "SAXMachine" do
         elements :entry, :as => :entries, :class => AtomEntry
       end
     end # before
-    
+
     it "should parse the url" do
       f = Atom.parse(@xml)
       f.url.should == "http://www.pauldix.net/"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: UnderpantsGnome-sax-machine
 version: !ruby/object:Gem::Version 
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors: 
 - Paul Dix