nokogiri-happymapper 0.5.3 → 0.5.4

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.5.4/ 2012-09-25
+
+* #wrap method allows you to better model xml content that is buried deep
+  within the xml. This implementation addresses issues with calling #to_xml
+  with content that was parsed from an xpath. (zrob)
+
+* Parent HappyMapper classes may dictate the name of the tag for the child
+  HappyMapper instances. (zrob)
+
+## 0.5.3/ 2012-09-23
+
+* String is the default type for parsed fields. (crv)
+* Update the attributes of an existing HappyMapper instance with new XML (benoist)

data/lib/happymapper.rb

@@ -7,12 +7,15 @@ class XmlContent; end
 
 module HappyMapper
 
+  VERSION = "0.5.4"
+
   DEFAULT_NS = "happymapper"
 
   def self.included(base)
     base.instance_variable_set("@attributes", {})
     base.instance_variable_set("@elements", {})
     base.instance_variable_set("@registered_namespaces", {})
+    base.instance_variable_set("@wrapper_anonymous_classes", {})
 
     base.extend ClassMethods
   end
@@ -196,6 +199,38 @@ module HappyMapper
     def tag_name
       @tag_name ||= to_s.split('::')[-1].downcase
     end
+    
+    # There is an XML tag that needs to be known for parsing and should be generated
+    # during a to_xml.  But it doesn't need to be a class and the contained elements should
+    # be made available on the parent class
+    #
+    # @param [String] name the name of the element that is just a place holder
+    # @param [Proc] blk the element definitions inside the place holder tag
+    #
+    def wrap(name, &blk)      
+      # Get an anonymous HappyMapper that has 'name' as its tag and defined
+      # in '&blk'.  Then save that to a class instance variable for later use
+      wrapper = AnonymousWrapperClassFactory.get(name, &blk)
+      @wrapper_anonymous_classes[wrapper.inspect] = wrapper
+
+      # Create getter/setter for each element and attribute defined on the anonymous HappyMapper
+      # onto this class. They get/set the value by passing thru to the anonymous class.
+      passthrus = wrapper.attributes + wrapper.elements  
+      passthrus.each do |item|   
+        class_eval %{
+          def #{item.method_name}
+            @#{name} ||= self.class.instance_variable_get('@wrapper_anonymous_classes')['#{wrapper.inspect}'].new
+            @#{name}.#{item.method_name}
+          end
+          def #{item.method_name}=(value)
+            @#{name} ||= self.class.instance_variable_get('@wrapper_anonymous_classes')['#{wrapper.inspect}'].new
+            @#{name}.#{item.method_name} = value
+          end
+        }     
+      end     
+
+      has_one name, wrapper
+    end
 
     #
     # @param [Nokogiri::XML::Node,Nokogiri:XML::Document,String] xml the XML 
@@ -389,13 +424,17 @@ module HappyMapper
   #     is being used when called recursively.
   # @param [String] default_namespace the name of the namespace which is the
   #     default for the xml being produced; this is specified by the element
-  #     declaration when calling #to_xml recursively.
+  #     declaration when calling #to_xml recursively. 
+  # @param [String] tag_from_parent the xml tag to use on the element when being
+  #     called recursively.  This lets the parent doc define its own structure.
+  #     Otherwise the element uses the tag it has defined for itself.  Should only
+  #     apply when calling a child HappyMapper element.
   #
   # @return [String,Nokogiri::XML::Builder] return XML representation of the
   #      HappyMapper object; when called recursively this is going to return
   #      and Nokogiri::XML::Builder object.
   #
-  def to_xml(builder = nil,default_namespace = nil)
+  def to_xml(builder = nil,default_namespace = nil,tag_from_parent = nil)
     
     #
     # If to_xml has been called without a passed in builder instance that
@@ -454,12 +493,13 @@ module HappyMapper
     end.flatten
     
     attributes = Hash[ *attributes ]
-
+                      
     #
-    # Create a tag in the builder that matches the class's tag name and append
+    # Create a tag in the builder that matches the class's tag name unless a tag was passed
+    # in a recursive call from the parent doc.  Then append
     # any attributes to the element that were defined above.
     #
-    builder.send("#{self.class.tag_name}_",attributes) do |xml|
+    builder.send("#{tag_from_parent || self.class.tag_name}_",attributes) do |xml|
       
       #
       # Add all the registered namespaces to the root element.
@@ -575,7 +615,7 @@ module HappyMapper
               # process should have their contents retrieved and attached
               # to the builder structure
               #
-              item.to_xml(xml,element.options[:namespace])
+              item.to_xml(xml,element.options[:namespace],element.options[:tag] || nil)
 
             elsif item
             
@@ -624,11 +664,24 @@ module HappyMapper
   # Params and return are the same as the class parse() method above.
   def parse(xml, options = {})
     self.class.parse(xml, options.merge!(:update => self))
+  end   
+  
+  private
+  
+  # Factory for creating anonmyous HappyMappers
+  class AnonymousWrapperClassFactory
+   def self.get(name, &blk)
+     Class.new do
+       include HappyMapper
+       tag name
+       instance_eval &blk
+     end 
+   end
   end
   
 end
 
-require 'happymapper/item'
-require 'happymapper/attribute'
-require 'happymapper/element'
-require 'happymapper/text_node'
+require File.dirname(__FILE__) + '/happymapper/item'
+require File.dirname(__FILE__) + '/happymapper/attribute'
+require File.dirname(__FILE__) + '/happymapper/element'
+require File.dirname(__FILE__) + '/happymapper/text_node'

data/spec/fixtures/wrapper.xml

@@ -0,0 +1,11 @@
+<root attr1="somevalue">
+	<name>myname</name>
+	<mywraptag>
+		<description>some description</description>
+		<subclass myattr='attrvalue'>
+			<item>item1</item>
+			<item>item2</item>
+		</subclass>
+	</mywraptag>
+	<number>12345</number>     
+</root>

data/spec/happymapper_generic_base_spec.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+           
+
+generic_class_xml = %{
+  <root>
+    <description>some description</description>
+    <blarg name='blargname1' href='http://blarg.com'/>
+    <blarg name='blargname2' href='http://blarg.com'/>
+    <jello name='jelloname' href='http://jello.com'/>
+    <subelement>
+      <jello name='subjelloname' href='http://ohnojello.com' other='othertext'/>
+    </subelement>
+  </root>      
+}
+
+module GenericBase
+  class Base
+    include HappyMapper
+    tag '*'
+    attribute :name, String
+    attribute :href, String
+    attribute :other, String
+  end
+  class Sub
+    include HappyMapper
+    tag 'subelement'
+    has_one :jello, Base, :tag => 'jello'
+  end
+  class Root
+    include HappyMapper     
+    tag 'root'
+    element :description, String
+    has_many :blargs, Base, :tag => 'blarg', :xpath => '.'
+    has_many :jellos, Base, :tag => 'jello', :xpath => '.'
+    has_many :subjellos, Base, :tag => 'jello', :xpath => 'subelement/.', :read_only => true
+    has_one :sub_element, Sub
+  end
+end
+
+
+describe HappyMapper do
+  describe "can have generic classes using tag '*'" do
+      
+    before(:all) do
+      @root = GenericBase::Root.parse(generic_class_xml)
+      @xml = Nokogiri::XML(@root.to_xml)   
+    end
+    
+    it 'should map different elements to same class' do
+      @root.blargs.should_not be_nil
+      @root.jellos.should_not be_nil
+    end
+    
+    it 'should filter on xpath appropriately' do
+      @root.blargs.should have(2).items
+      @root.jellos.should have(1).items
+      @root.subjellos.should have(1).items
+    end
+     
+    it 'should parse correct values onto generic class' do
+      @root.blargs[0].name.should == 'blargname1'
+      @root.blargs[0].href.should == 'http://blarg.com'
+      @root.blargs[0].other.should be_nil
+      @root.blargs[1].name.should == 'blargname2'
+      @root.blargs[1].href.should == 'http://blarg.com'
+      @root.blargs[1].other.should be_nil
+      @root.jellos[0].name.should == 'jelloname'
+      @root.jellos[0].href.should == 'http://jello.com'
+      @root.jellos[0].other.should be_nil
+      @root.subjellos[0].name.should == 'subjelloname'
+      @root.subjellos[0].href.should == 'http://ohnojello.com'
+      @root.subjellos[0].other.should == 'othertext'
+    end
+
+    it 'should #to_xml using parent element tag name' do      
+      @xml.xpath('/root/description').text.should == 'some description'
+      @xml.xpath('/root/blarg[1]/@name').text.should == 'blargname1'
+      @xml.xpath('/root/blarg[1]/@href').text.should == 'http://blarg.com'
+      @xml.xpath('/root/blarg[1]/@other').text.should be_empty
+      @xml.xpath('/root/blarg[2]/@name').text.should == 'blargname2'
+      @xml.xpath('/root/blarg[2]/@href').text.should == 'http://blarg.com'
+      @xml.xpath('/root/blarg[2]/@other').text.should be_empty
+      @xml.xpath('/root/jello[1]/@name').text.should == 'jelloname'
+      @xml.xpath('/root/jello[1]/@href').text.should == 'http://jello.com'
+      @xml.xpath('/root/jello[1]/@other').text.should be_empty  
+    end
+    
+    it "should properly respect child HappyMapper tags if tag isn't provided on the element defintion" do
+      @xml.xpath('root/subelement').should have(1).item
+    end
+  end                   
+end

data/spec/happymapper_wrap_spec.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'       
+
+module Wrap
+  class SubClass
+    include HappyMapper    
+    tag 'subclass'
+    attribute :myattr, String
+    has_many :items, String, :tag => 'item'
+  end
+  class Root
+    include HappyMapper    
+    tag 'root'
+    attribute :attr1, String
+    element :name, String
+    wrap 'mywraptag' do
+      element :description, String
+      has_one :subclass, SubClass
+    end
+    element :number, Integer
+  end  
+end
+
+describe HappyMapper do
+  describe "can parse and #to_xml taking into account a holder tag that won't be defined as a HappyMapper class" do
+    
+    it 'should parse xml' do
+      root = Wrap::Root.parse(fixture_file('wrapper.xml'))        
+      root.attr1.should == 'somevalue'
+      root.name.should == 'myname'
+      root.description.should == 'some description'
+      root.subclass.myattr.should == 'attrvalue'
+      root.subclass.items.should have(2).items
+      root.subclass.items[0].should == 'item1'
+      root.subclass.items[1].should == 'item2'
+      root.number.should == 12345      
+    end
+    
+    it "should initialize anonymous classes so nil class values don't occur" do
+      root = Wrap::Root.new
+      lambda { root.description = 'anything' }.should_not raise_error
+    end
+    
+    it 'should #to_xml with wrapped tag' do
+      root = Wrap::Root.new
+      root.attr1 = 'somevalue'
+      root.name = 'myname'
+      root.description = 'some description'
+      root.number = 12345
+      
+      subclass = Wrap::SubClass.new
+      subclass.myattr = 'attrvalue'
+      subclass.items = []
+      subclass.items << 'item1'
+      subclass.items << 'item2'
+      
+      root.subclass = subclass
+                
+      xml = Nokogiri::XML(root.to_xml)
+      xml.xpath('/root/@attr1').text.should == 'somevalue'
+      xml.xpath('/root/name').text.should == 'myname'
+      xml.xpath('/root/mywraptag/description').text.should == 'some description'
+      xml.xpath('/root/mywraptag/subclass/@myattr').text.should == 'attrvalue'
+      xml.xpath('/root/mywraptag/subclass/item').should have(2).items
+      xml.xpath('/root/mywraptag/subclass/item[1]').text.should == 'item1'
+      xml.xpath('/root/mywraptag/subclass/item[2]').text.should == 'item2'
+      xml.xpath('/root/number').text.should == '12345'
+    end    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nokogiri-happymapper
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-23 00:00:00.000000000 Z
+date: 2011-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -50,11 +50,12 @@ dependencies:
         version: '2.8'
 description: Object to XML Mapping Library, using Nokogiri (fork from John Nunemaker's
   Happymapper)
-email: 
+email: franklin.webber@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- CHANGELOG.md
 - TODO
 files:
 - lib/happymapper.rb
@@ -63,6 +64,7 @@ files:
 - lib/happymapper/item.rb
 - lib/happymapper/text_node.rb
 - README.md
+- CHANGELOG.md
 - TODO
 - spec/fixtures/address.xml
 - spec/fixtures/ambigous_items.xml
@@ -88,20 +90,28 @@ files:
 - spec/fixtures/radar.xml
 - spec/fixtures/statuses.xml
 - spec/fixtures/subclass_namespace.xml
+- spec/fixtures/wrapper.xml
 - spec/happymapper_attribute_spec.rb
 - spec/happymapper_element_spec.rb
+- spec/happymapper_generic_base_spec.rb
 - spec/happymapper_item_spec.rb
 - spec/happymapper_spec.rb
 - spec/happymapper_text_node_spec.rb
 - spec/happymapper_to_xml_namespaces_spec.rb
 - spec/happymapper_to_xml_spec.rb
+- spec/happymapper_wrap_spec.rb
 - spec/ignay_spec.rb
 - spec/parse_instance_spec.rb
 - spec/spec_helper.rb
 - spec/xpath_spec.rb
 homepage: http://github.com/dam5s/happymapper
 licenses: []
-post_install_message: 
+post_install_message: ! "\n  Thank you for installing nokogiri-happymapper 0.5.4 /
+  2012-09-25.\n  \n  Changes:\n    \n  * #wrap method allows you to better model xml
+  content that is buried deep\n    within the xml. This implementation addresses issues
+  with calling #to_xml\n    with content that was parsed from an xpath. (zrob)\n  \n
+  \ * Parent HappyMapper classes may dictate the name of the tag for the child\n    HappyMapper
+  instances. (zrob)\n  \n\n\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -148,13 +158,16 @@ test_files:
 - spec/fixtures/radar.xml
 - spec/fixtures/statuses.xml
 - spec/fixtures/subclass_namespace.xml
+- spec/fixtures/wrapper.xml
 - spec/happymapper_attribute_spec.rb
 - spec/happymapper_element_spec.rb
+- spec/happymapper_generic_base_spec.rb
 - spec/happymapper_item_spec.rb
 - spec/happymapper_spec.rb
 - spec/happymapper_text_node_spec.rb
 - spec/happymapper_to_xml_namespaces_spec.rb
 - spec/happymapper_to_xml_spec.rb
+- spec/happymapper_wrap_spec.rb
 - spec/ignay_spec.rb
 - spec/parse_instance_spec.rb
 - spec/spec_helper.rb