sax-machine 0.0.20 → 0.1.0

data/README.textile

@@ -13,6 +13,15 @@ h2. Usage
 <pre>
 require 'sax-machine'
 
+# Class for information associated with content parts in a feed.
+#  Ex: <content type="text">sample</content>
+#  instance.type will be "text", instance.text will be "sample"
+class AtomContent
+  include SAXMachine
+  attribute :type
+  value :text
+end
+
 # Class for parsing an atom entry out of a feedburner atom feed
 class AtomEntry
   include SAXMachine
@@ -21,9 +30,9 @@ class AtomEntry
   element :name, :as => :author
   element "feedburner:origLink", :as => :url
   element :summary
-  element :content
+  element :content, :class => AtomContent
   element :published
-  parent :parent
+  ancestor :ancestor
 end
 
 # Class for parsing Atom feeds
@@ -48,11 +57,12 @@ 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
-feed.entries.first.parent # => the Atom parent
+feed.entries.first.ancestor # => the Atom ancestor
 # etc ...
 
 # you can also use the elements method without specifying a class like so
 class SomeServiceResponse
+  include SAXMachine
   elements :message, :as => :messages
 end
 
@@ -61,6 +71,17 @@ response.messages.first # => "hi"
 response.messages.last  # => "world"
 </pre>
 
+# To limit conflicts in the class used for mappping, you can use the alternate SAXMachine.configure syntax
+
+class X < ActiveRecord::Base
+
+  # this way no element, elements or ancestor method will be added to X
+  SAXMachine.configure(X) do |c|
+    c.element :title
+  end
+
+end
+
 h2. LICENSE
 
 (The MIT License)

data/lib/sax-machine.rb

@@ -3,6 +3,7 @@ require "rubygems"
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 
 require "sax-machine/sax_document"
+require "sax-machine/sax_configure"
 require "sax-machine/sax_handler"
 require "sax-machine/sax_config"
 

data/lib/sax-machine/{sax_parent_config.rb → sax_ancestor_config.rb}

@@ -1,7 +1,7 @@
 module SAXMachine
   class SAXConfig
 
-    class ParentConfig
+    class AncestorConfig
       attr_reader :name, :setter
 
       def initialize(name, options)

data/lib/sax-machine/sax_config.rb

@@ -2,12 +2,12 @@ require "sax-machine/sax_attribute_config"
 require "sax-machine/sax_element_value_config"
 require "sax-machine/sax_element_config"
 require "sax-machine/sax_collection_config"
-require "sax-machine/sax_parent_config"
+require "sax-machine/sax_ancestor_config"
 
 module SAXMachine
   class SAXConfig
 
-    attr_accessor :top_level_elements, :top_level_attributes, :top_level_element_value, :collection_elements, :parents
+    attr_accessor :top_level_elements, :top_level_attributes, :top_level_element_value, :collection_elements, :ancestors
 
     def initialize
       # Default value is an empty array
@@ -15,7 +15,7 @@ module SAXMachine
       @top_level_attributes  = []
       @top_level_element_value = []
       @collection_elements = Hash.new { |hash, key| hash[key] = [] }
-      @parents = []
+      @ancestors = []
     end
 
     def columns
@@ -28,7 +28,7 @@ module SAXMachine
       @top_level_attributes = sax_config.top_level_attributes.clone
       @top_level_element_value = sax_config.top_level_element_value.clone
       @collection_elements = sax_config.collection_elements.clone
-      @parents = sax_config.parents.clone
+      @ancestors = sax_config.ancestors.clone
     end
 
     def add_top_level_element(name, options)
@@ -47,8 +47,8 @@ module SAXMachine
       @collection_elements[name.to_s] << CollectionConfig.new(name, options)
     end
 
-    def add_parent(name, options)
-      @parents << ParentConfig.new(name, options)
+    def add_ancestor(name, options)
+      @ancestors << AncestorConfig.new(name, options)
     end
 
     def collection_config(name, attrs)

data/lib/sax-machine/sax_configure.rb

@@ -0,0 +1,38 @@
+module SAXMachine
+
+  def self.configure(clazz)
+    extended_clazz = Class.new(clazz)
+    extended_clazz.send(:include, SAXMachine)
+
+    # override create_attr to create attributes on the original class
+    def extended_clazz.create_attr real_name
+      superclass.send(:attr_reader, real_name) unless superclass.method_defined?(real_name)
+      superclass.send(:attr_writer, real_name) unless superclass.method_defined?("#{real_name}=")
+    end
+
+    yield(extended_clazz)
+
+    clazz.extend LightWeightSaxMachine
+    clazz.sax_config = extended_clazz.sax_config
+
+    (class << clazz;self;end).send(:define_method, :parse) do |xml_text|
+      extended_clazz.parse(xml_text)
+    end
+
+  end
+
+  module LightWeightSaxMachine
+
+    attr_writer :sax_config
+
+    def sax_config
+      @sax_config ||= SAXConfig.new
+    end
+
+    def inherited(subclass)
+      subclass.sax_config.send(:initialize_copy, self.sax_config)
+    end
+
+  end
+
+end

data/lib/sax-machine/sax_document.rb

@@ -41,9 +41,9 @@ module SAXMachine
       create_attr real_name
     end
 
-    def parent(name, options = {})
+    def ancestor(name, options = {})
       real_name = (options[:as] ||= name).to_s
-      sax_config.add_parent(name, options)
+      sax_config.add_ancestor(name, options)
       create_attr(real_name)
     end
 

data/lib/sax-machine/sax_handler.rb

@@ -72,11 +72,11 @@ module SAXMachine
           mark_as_parsed(object, config)
         end
 
-        # try to set the parent
+        # try to set the ancestor
         sax_config = element.class.respond_to?(:sax_config) ? element.class.sax_config : nil
         if sax_config
-          sax_config.parents.each do |parent|
-            element.send(parent.setter, object)
+          sax_config.ancestors.each do |ancestor|
+            element.send(ancestor.setter, object)
           end
         end
       end

data/spec/sax-machine/configure_sax_machine_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+class A
+
+  SAXMachine.configure(A) do |c|
+    c.element :title
+  end
+
+end
+
+class B < A
+
+  SAXMachine.configure(B) do |c|
+    c.element :b
+  end
+
+end
+
+class C < B
+
+  SAXMachine.configure(C) do |c|
+    c.element :c
+  end
+
+end
+
+describe "SAXMachine configure" do
+  before do
+    xml = "<top><title>Test</title><b>Matched!</b><c>And Again</c></top>"
+    @a = A.new
+    @a.parse xml
+    @b = B.new
+    @b.parse xml
+    @c = C.new
+    @c.parse xml
+  end
+  it { @a.should be_a(A) }
+  it { @a.should_not be_a(B) }
+  it { @a.should be_a(SAXMachine) }
+  it { @a.title.should == "Test" }
+  it { @b.should be_a(A) }
+  it { @b.should be_a(B) }
+  it { @b.should be_a(SAXMachine) }
+  it { @b.title.should == "Test" }
+  it { @b.b.should == "Matched!" }
+  it { @c.should be_a(A) }
+  it { @c.should be_a(B) }
+  it { @c.should be_a(C) }
+  it { @c.should be_a(SAXMachine) }
+  it { @c.title.should == "Test" }
+  it { @c.b.should == "Matched!" }
+  it { @c.c.should == "And Again" }
+end

data/spec/sax-machine/include_sax_machine_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+class A
+  include SAXMachine
+  element :title
+end
+
+class B < A
+  element :b
+end
+
+class C < B
+  element :c
+end
+
+describe "SAXMachine inheritance" do
+  before do
+    xml = "<top><title>Test</title><b>Matched!</b><c>And Again</c></top>"
+    @a = A.new
+    @a.parse xml
+    @b = B.new
+    @b.parse xml
+    @c = C.new
+    @c.parse xml
+  end
+  it { @a.should be_a(A) }
+  it { @a.should_not be_a(B) }
+  it { @a.should be_a(SAXMachine) }
+  it { @a.title.should == "Test" }
+  it { @b.should be_a(A) }
+  it { @b.should be_a(B) }
+  it { @b.should be_a(SAXMachine) }
+  it { @b.title.should == "Test" }
+  it { @b.b.should == "Matched!" }
+  it { @c.should be_a(A) }
+  it { @c.should be_a(B) }
+  it { @c.should be_a(C) }
+  it { @c.should be_a(SAXMachine) }
+  it { @c.title.should == "Test" }
+  it { @c.b.should == "Matched!" }
+  it { @c.c.should == "And Again" }
+end

data/spec/sax-machine/sax_document_spec.rb

@@ -506,7 +506,7 @@ describe "SAXMachine" do
         element :category, :value => :id, :as => :id
         element :title
         element :categories, :as => :collection, :class => CategoryCollection
-        parent :parent
+        ancestor :ancestor
       end
       class CategoryCollection
         include SAXMachine
@@ -518,7 +518,7 @@ describe "SAXMachine" do
     it "should parse the first category" do
       @collection.categories.first.id.should == "1"
       @collection.categories.first.title.should == "First"
-      @collection.categories.first.parent.should == @collection
+      @collection.categories.first.ancestor.should == @collection
     end
 
     it "should parse the nested category" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sax-machine
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 20
-  version: 0.0.20
+  version: 0.1.0
 platform: ruby
 authors: 
 - Paul Dix
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-20 00:00:00 Z
+date: 2011-09-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -44,18 +44,21 @@ extra_rdoc_files: []
 
 files: 
 - lib/sax-machine.rb
+- lib/sax-machine/sax_ancestor_config.rb
 - lib/sax-machine/sax_attribute_config.rb
 - lib/sax-machine/sax_config.rb
+- lib/sax-machine/sax_configure.rb
 - lib/sax-machine/sax_document.rb
 - lib/sax-machine/sax_collection_config.rb
 - lib/sax-machine/sax_element_config.rb
 - lib/sax-machine/sax_element_value_config.rb
 - lib/sax-machine/sax_handler.rb
-- lib/sax-machine/sax_parent_config.rb
 - README.textile
 - Rakefile
 - Gemfile
 - spec/spec_helper.rb
+- spec/sax-machine/configure_sax_machine_spec.rb
+- spec/sax-machine/include_sax_machine_spec.rb
 - spec/sax-machine/sax_document_spec.rb
 homepage: http://github.com/pauldix/sax-machine
 licenses: []