xml_mapper 0.4.1 → 0.4.2

data/README.rdoc

@@ -22,6 +22,7 @@ Declarative mapping of XML files to ruby attributes
     <tracks>
       <track code="1234">
         <title>Fear Not of Man</title>
+        <version_title></version_title>
         <number>1</number>
         <disk>1</number>
         <explicit_lyrics />
@@ -31,8 +32,11 @@ Declarative mapping of XML files to ruby attributes
       </track>
       <track code="2345">
         <title>Hip Hop</title>
+        <version_title>Album Version</version_title>
         <number>2</number>
         <disk>1</number>
+        <performer>Mos Def</performer>
+        <producer>DJ Premier</producer>
         <not_streamable_in>
           <country>at</country>
         </not_streamable_in>
@@ -46,32 +50,36 @@ Declarative mapping of XML files to ruby attributes
   require "date"
 
   class MyMapper < XmlMapper
-    text :title, :version_title                         # 1:1 - maps xpaths title and version_title to attribute keys
-    integer :released_in                                # converts value to an integer
-    text :country, :after_map => :upcase                # calls after_map method on extracted value if value responds to the method
-    text :released_on, :after_map => :parse_date        # calls after_map method defined in Mapper class when value does not respond
-    boolean :allows_streaming                           # maps Y, y, yes, true => true, N, n, no, false => false
+    text :title, :version_title                             # 1:1 - maps xpaths title and version_title to attribute keys
+    integer :released_in                                    # converts value to an integer
+    text :country, :after_map => :upcase                    # calls after_map method on extracted value if value responds to the method
+    text :released_on, :after_map => :parse_date            # calls after_map method defined in Mapper class when value does not respond
+    boolean :allows_streaming                               # maps 1, Y, y, yes, true => true, 0, N, n, no, false => false
 
     within :artist do
-      text :name => :artist_name                        # adds mapping for xpath "artist/name"
+      text :name => :artist_name                            # adds mapping for xpath "artist/name"
       integer :id => :artist_id
     end
 
-    many "contributions/*" => :contributions do         # use the name of xml nodes for mappings
-      node_name :role                                   # map name of xml node to :role
-      inner_text :name                                  # map inner_text of xml node to :name
+    many "contributions/*" => :contributions do             # use the name of xml nodes for mappings
+      node_name :role                                       # map name of xml node to :role
+      inner_text :name                                      # map inner_text of xml node to :name
     end
 
-    many "tracks/track" => :tracks do                   # maps xpath "tracks/track" to array with key :tracks
-      attribute :code => :isrc                          # map xml attribute "code" to :isrc
+    many "tracks/track" => :tracks do                       # maps xpath "tracks/track" to array with key :tracks
+      attribute :code => :isrc                              # map xml attribute "code" to :isrc
       text :title => :track_title
+      text :version_title
       integer :number => :track_number
       integer :disk => :disk_number
-      exists :explicit_lyrics                            # checks if a node with the xpath exists
+      exists :explicit_lyrics                               # checks if a node with the xpath exists
       not_exists "not_streamable_in/country[text()='de']" => :allows_streaming
+
+      text :performer => { :contributions => :performer }   # assigns to content at xpath :performer to attributes[:contributions][:performer]
+      text :producer => { :contributions => :producer }     # assigns to content at xpath :performer to attributes[:contributions][:producer]
     end
 
-    after_map do                                        # is called after attributes are extracted, self references the extracted attributes
+    after_map do                                            # is called after attributes are extracted, self references the extracted attributes
       self[:tracks_count] = self[:tracks].length
     end
 
@@ -87,21 +95,20 @@ Declarative mapping of XML files to ruby attributes
 * MyMapper.attributes_from_xml_path(xml) (also sets :xml_path)
 
 == Output
-  { :title=>"Black on Both Sides", :allows_streaming=>true, :version_title=>"Extended Edition", 
-    :xml_path=>"/Users/tobias/Projects/xml_mapper/spec/fixtures/base.xml", :tracks_count=>2, :released_in=>1999, 
-    :released_on=>#<Date: 4902927/2,0,2299161>, :artist_name=>"Mos Def", 
-    :contributions=>[
-      {:name=>"Mos Def", :role=>"artist"}, {:name=>"DJ Premier", :role=>"producer"}
-    ], 
-    :artist_id=>1212, :country=>"DE", 
+  {
+    :title=>"Black on Both Sides", :allows_streaming=>true, :version_title=>"Extended Edition", 
     :tracks=>[
-      { :track_title=>"Fear Not of Man", :allows_streaming=>false, :track_number=>1, :disk_number=>1, 
-        :explicit_lyrics=>true, :isrc=>"1234"
+      { :track_title=>"Fear Not of Man", :allows_streaming=>false, :track_number=>1, :version_title=>nil, :disk_number=>1, 
+        :explicit_lyrics=>true, :contributions=>{:performer=>nil, :producer=>nil}, :isrc=>"1234"
       }, 
-      { :track_title=>"Hip Hop", :allows_streaming=>true, :track_number=>2, :disk_number=>1, 
-        :explicit_lyrics=>false, :isrc=>"2345"
+      { :track_title=>"Hip Hop", :allows_streaming=>true, :track_number=>2, :version_title=>"Album Version", :disk_number=>1, 
+        :explicit_lyrics=>false, :contributions=>{:performer=>"Mos Def", :producer=>"DJ Premier"}, :isrc=>"2345"
       }
-    ]
+    ], 
+    :tracks_count=>2, :released_in=>1999, :xml_path=>"/Users/tobias/Projects/xml_mapper/spec/fixtures/base.xml", 
+    :released_on=>#<Date: 4902927/2,0,2299161>, :artist_name=>"Mos Def", 
+    :contributions=>[ {:name=>"Mos Def", :role=>"artist"}, {:name=>"DJ Premier", :role=>"producer"} ]
+    :artist_id=>1212, :country=>"DE"
   }
 
 == Contributing to xml_mapper

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/lib/xml_mapper.rb

@@ -123,13 +123,25 @@ class XmlMapper
       doc = xml_or_doc.is_a?(Nokogiri::XML::Node) ? xml_or_doc : Nokogiri::XML(xml_or_doc)
       doc = doc.root if doc.respond_to?(:root)
       atts = self.mappings.inject(xml_path.nil? ? {} : { :xml_path => xml_path }) do |hash, mapping|
-        hash.merge(mapping[:key] => value_from_doc_and_mapping(doc, mapping))
+        if (value = value_from_doc_and_mapping(doc, mapping)) != :not_found
+          add_value_to_hash(hash, mapping[:key], value)
+        end
       end
       atts.instance_eval(&self.after_map_block) if self.after_map_block
       atts
     end
   end
   
+  def add_value_to_hash(hash, key_or_hash, value)
+    if key_or_hash.is_a?(Hash)
+      hash[key_or_hash.keys.first] ||= Hash.new
+      add_value_to_hash(hash[key_or_hash.keys.first], key_or_hash.values.first, value)
+    else
+      hash.merge!(key_or_hash => value)
+    end
+    hash
+  end
+  
   def value_from_doc_and_mapping(doc, mapping)
     if mapping[:type] == :many
       mapping[:options][:mapper].attributes_from_xml(doc.search(mapping[:xpath]).to_a)
@@ -170,7 +182,9 @@ class XmlMapper
   end
   
   def inner_text_for_node(node)
-    node.inner_text if node
+    if node
+      node.inner_text.length == 0 ? nil : node.inner_text
+    end
   end
   
   MAPPINGS = {

data/spec/example_spec.rb

@@ -22,8 +22,16 @@ describe "ExampleSpec" do
     end
     
     [
-      { :track_title => "Fear Not of Man", :track_number => 1, :disk_number => 1, :explicit_lyrics => true, :isrc => "1234" },
-      { :track_title => "Hip Hop", :track_number => 2, :disk_number => 1, :explicit_lyrics => false, :isrc => "2345" },
+      { 
+        :track_title => "Fear Not of Man", :track_number => 1, :disk_number => 1, :explicit_lyrics => true, :isrc => "1234",
+        :version_title => nil
+      },
+      { 
+        :track_title => "Hip Hop", :track_number => 2, :disk_number => 1, :explicit_lyrics => false, :isrc => "2345",
+        :version_title => "Album Version", :contributions => {
+          :producer => "DJ Premier", :performer => "Mos Def"
+        }
+      },
     ].each_with_index do |hash, offset|
       hash.each do |key, value|
         it "extracts #{value.inspect} for #{key} for track with offset #{offset}" do

data/spec/fixtures/base.xml

@@ -16,6 +16,7 @@
   <tracks>
     <track code="1234">
       <title>Fear Not of Man</title>
+      <version_title></version_title>
       <number>1</number>
       <disk>1</number>
       <explicit_lyrics />
@@ -25,8 +26,11 @@
     </track>
     <track code="2345">
       <title>Hip Hop</title>
+      <version_title>Album Version</version_title>
       <number>2</number>
       <disk>1</number>
+      <performer>Mos Def</performer>
+      <producer>DJ Premier</producer>
       <not_streamable_in>
         <country>at</country>
       </not_streamable_in>

data/spec/my_mapper.rb

@@ -6,7 +6,7 @@ class MyMapper < XmlMapper
   integer :released_in                                # converts value to an integer
   text :country, :after_map => :upcase                # calls after_map method on extracted value if value responds to the method
   text :released_on, :after_map => :parse_date        # calls after_map method defined in Mapper class when value does not respond
-  boolean :allows_streaming                           # maps Y, y, yes, true => true, N, n, no, false => false
+  boolean :allows_streaming                           # maps 1, Y, y, yes, true => true, 0, N, n, no, false => false
   
   within :artist do
     text :name => :artist_name                        # adds mapping for xpath "artist/name"
@@ -21,10 +21,14 @@ class MyMapper < XmlMapper
   many "tracks/track" => :tracks do                   # maps xpath "tracks/track" to array with key :tracks
     attribute :code => :isrc                          # map xml attribute "code" to :isrc
     text :title => :track_title
+    text :version_title
     integer :number => :track_number
     integer :disk => :disk_number
     exists :explicit_lyrics                            # checks if a node with the xpath exists
     not_exists "not_streamable_in/country[text()='de']" => :allows_streaming
+    
+    text :performer => { :contributions => :performer }
+    text :producer => { :contributions => :producer }
   end
   
   after_map do                                        # is called after attributes are extracted, self references the extracted attributes

data/spec/xml_mapper_spec.rb

@@ -72,6 +72,22 @@ describe "XmlMapper" do
       @mapper.attributes_from_xml(@xml).should == { :title => "Black on Both Sides", :artist_name => "Mos Def" }
     end
     
+    it "sets value to nil when value was empty string" do
+      @mapper.add_mapping(:text, :artist_name)
+      @mapper.attributes_from_xml("<album><artist_name></artist_name></album>").should == { :artist_name => nil }
+    end
+    
+    it "assigns found keys to nested attributes" do
+      @mapper.add_mapping(:text, :artist_name => { :meta => :artist_name })
+      @mapper.add_mapping(:text, :title => { :meta => :title })
+      @mapper.attributes_from_xml(@xml).should == {
+        :meta => {
+          :artist_name => "Mos Def",
+          :title => "Black on Both Sides"
+        }
+      }
+    end
+    
     describe "#exists" do
       it "returns true when node exists" do
         xml = %(<album><title>Black on Both Sides</title><rights><country>DE</country></rights></album>)

data/xml_mapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xml_mapper}
-  s.version = "0.4.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias Schwab"]
-  s.date = %q{2010-12-01}
+  s.date = %q{2010-12-02}
   s.description = %q{Declarative XML to Ruby mapping}
   s.email = %q{tobias.schwab@dynport.de}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xml_mapper
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Tobias Schwab
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-01 00:00:00 +01:00
+date: 2010-12-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency