saxaphone 0.5.3 → 0.6.0

data/lib/saxaphone/element.rb

@@ -9,14 +9,17 @@ module Saxaphone
 
     @element_handlers = {}
     @stored_attributes = Set.new
+    @attribute_aliases = {}
 
     class << self
       attr_accessor :element_handlers
       attr_accessor :stored_attributes
+      attr_accessor :attribute_aliases
 
       def inherited(base)
-        base.element_handlers = element_handlers.dup
-        base.stored_attributes = stored_attributes.dup
+        base.element_handlers   = element_handlers.dup
+        base.stored_attributes  = stored_attributes.dup
+        base.attribute_aliases  = attribute_aliases.dup
       end
 
       # A block can be passed to <tt>setup</tt>,
@@ -87,10 +90,12 @@ module Saxaphone
       # 
       #   element.attributes # => {"dollars" => "4.33"}
       def element_attribute(element_name, options = {})
-        converted_name = options.delete(:as)
+        if as = options.delete(:as)
+          attribute_aliases[element_name] = as
+        end
 
         has_element(element_name) do |element|
-          attributes[converted_name || element.name] = element.content
+          assign_attribute_value(element.name, element.content)
         end
       end
 
@@ -158,6 +163,29 @@ module Saxaphone
         self.stored_attributes += attribute_names.flatten.to_set
       end
 
+      # Define a white listed attribute that is extracted
+      # from the XML element and stored in the attribute hash:
+      # 
+      #   WidgetElement < Saxaphone::Element
+      #     store_attribute 'href', as: 'uri'
+      #   end
+      # 
+      #   element = WidgetElement.parse %{
+      #     <widget href="http://www.example.com" color="red" price="3.21">
+      #       ...
+      #     </widget>
+      #   }
+      # 
+      #   element.attributes # => {"uri" => "http://www.example.com"}
+      # 
+      def store_attribute(attribute_name, options = {})
+        if as = options.delete(:as)
+          attribute_aliases[attribute_name] = as
+        end
+
+        self.stored_attributes << attribute_name
+      end
+
       def handler_for(element_name)
         element_handlers[element_name] || element_handlers['*']
       end
@@ -171,7 +199,11 @@ module Saxaphone
     def initialize(name = '', content = '', attribute_array = [])
       self.name = name
       self.content = content
-      self.attributes = Hash[attribute_array.select { |(key, value)| self.class.stored_attributes.include?(key) }]
+      self.attributes = {}
+      attribute_array.each do |key, value|
+        assign_attribute_value(key, value) if self.class.stored_attributes.include?(key)
+      end
+      # self.attributes = Hash[attribute_array.select { |(key, value)| self.class.stored_attributes.include?(key) }]
       setup
     end
 
@@ -193,6 +225,10 @@ module Saxaphone
       
     end
 
+    def assign_attribute_value(key, value)
+      attributes[self.class.attribute_aliases[key] || key] = value
+    end
+
     def append_content(string)
       content << string
     end

data/test/element_test.rb

@@ -16,7 +16,27 @@ class Saxaphone::ElementTest < MiniTest::Spec
     assert_equal 'hola', element.setup_attr
   end
 
-  def test_initialize_with_attributes
+  def test_accessors_inheritence
+    parent = Class.new(Saxaphone::Element) do
+      has_element 'foo'
+      store_attributes 'faz'
+    end
+
+    child = Class.new(parent) do
+      has_element 'bar'
+      store_attribute 'baz', as: 'moo'
+    end
+
+    assert_equal ['foo'].to_set, parent.element_handlers.keys.to_set
+    assert_equal ['faz'].to_set, parent.stored_attributes
+    assert_equal({}, parent.attribute_aliases)
+
+    assert_equal ['foo', 'bar'].to_set, child.element_handlers.keys.to_set
+    assert_equal ['faz', 'baz'].to_set, child.stored_attributes
+    assert_equal({'baz' => 'moo'}, child.attribute_aliases)
+  end
+
+  def test_store_attributes
     element = Class.new(Saxaphone::Element) do
       store_attributes 'a', 'm'
     end.new('foo', 'bar', [['a', 'b'], ['m', 'n'], ['x', 'y']])
@@ -26,6 +46,14 @@ class Saxaphone::ElementTest < MiniTest::Spec
     assert_equal({'a' => 'b', 'm' => 'n'}, element.attributes)
   end
 
+  def test_store_attribute
+    element = Class.new(Saxaphone::Element) do
+      store_attribute 'm', as: 'n'
+    end.new('foo', 'bar', [['a', 'b'], ['m', 'o']])
+
+    assert_equal({'n' => 'o'}, element.attributes)
+  end
+
   def test_element_attributes
     element = define_element do
       element_attributes %w(foo bar)
@@ -122,24 +150,6 @@ class Saxaphone::ElementTest < MiniTest::Spec
     # silence?
   end
 
-  def test_attributes_inherited
-    parent = Class.new(Saxaphone::Element) do
-      has_element 'foo'
-      store_attributes 'faz'
-    end
-
-    child = Class.new(parent) do
-      has_element 'bar'
-      store_attributes 'baz'
-    end
-
-    assert_equal ['foo'].to_set, parent.element_handlers.keys.to_set
-    assert_equal ['faz'].to_set, parent.stored_attributes
-
-    assert_equal ['foo', 'bar'].to_set, child.element_handlers.keys.to_set
-    assert_equal ['faz', 'baz'].to_set, child.stored_attributes
-  end
-
   private
     def define_element(&block)
       Class.new(Saxaphone::Element, &block).new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saxaphone
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-23 00:00:00.000000000 Z
+date: 2012-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70336418925760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70336418925760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Use objects
 email: developer@matthewhiggins.com
 executables: []
@@ -59,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Object Oriented SAX Parsing