ealdent-sax-machine 0.0.4 → 0.0.7

data/README.textile

@@ -0,0 +1,78 @@
+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 ...
+</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/lib/sax-machine/sax_document.rb

@@ -22,7 +22,15 @@ module SAXMachine
     def element(name, options = {})
       options[:as] ||= name
       sax_config.add_top_level_element(name, options)
-      attr_accessor options[:as]
+      
+      # we only want to insert the 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.
+      if instance_methods.include?("#{options[:as]}=")
+        attr_reader options[:as]
+      else
+        attr_accessor options[:as]
+      end
     end
     
     def elements(name, options = {})

data/lib/sax-machine/sax_handler.rb

@@ -13,10 +13,14 @@ module SAXMachine
       if parsing_collection?
         @collection_handler.characters(string)
       elsif @element_config
-        @value = string
+        @value << string
       end
     end
     
+    def cdata_block(string)
+      characters(string)
+    end
+    
     def start_element(name, attrs = [])
       @name   = name
       @attrs  = attrs
@@ -31,6 +35,7 @@ module SAXMachine
         parse_element_attribute
         
       else
+        @value = ""
         @element_config = sax_config.element_config_for_tag(@name, @attrs)
       end
     end
@@ -52,7 +57,7 @@ module SAXMachine
     end
     
     def characaters_captured?
-      !@value.nil?
+      !@value.nil? && !@value.empty?
     end
     
     def parsing_collection?

data/lib/sax-machine.rb

@@ -7,5 +7,5 @@ require "sax-machine/sax_handler"
 require "sax-machine/sax_config"
 
 module SAXMachine
-  VERSION = "0.0.4"
+  VERSION = "0.0.7"
 end

data/spec/sax-machine/sax_document_spec.rb

@@ -16,6 +16,19 @@ describe "SAXMachine" do
         document.title.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
+      
       it "should not overwrite the accessor when the element is not present" do
         document = @klass.new
         document.title = "Title"
@@ -23,7 +36,7 @@ describe "SAXMachine" do
         document.title.should == "Title"
       end
 
-      it "should overwrite the accessor when the element is present" do
+      it "should overwrite the value when the element is present" do
         document = @klass.new
         document.title = "Old title"
         document.parse("<title>New title</title>")
@@ -34,6 +47,11 @@ 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"
+      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>")

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@ 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 "sax-machine"
+require "lib/sax-machine"
 
 # Spec::Runner.configure do |config|
 # end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ealdent-sax-machine
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.7
 platform: ruby
 authors: 
 - Paul Dix
@@ -36,12 +36,12 @@ files:
 - lib/sax-machine/sax_element_config.rb
 - lib/sax-machine/sax_document.rb
 - lib/sax-machine/sax_handler.rb
-- README.rdoc
+- README.textile
 - Rakefile
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/sax-machine/sax_document_spec.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/pauldix/sax-machine
 post_install_message: 
 rdoc_options: []