xml_mapper 0.4.2 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/lib/xml_mapper.rb

@@ -1,4 +1,5 @@
 require "nokogiri"
+require "xml_mapper_hash"
 
 class XmlMapper
   attr_accessor :mappings, :after_map_block, :within_xpath
@@ -118,12 +119,12 @@ class XmlMapper
   
   def attributes_from_xml(xml_or_doc, xml_path = nil)
     if xml_or_doc.is_a?(Array)
-      xml_or_doc.map { |doc| attributes_from_xml(doc) } 
+      xml_or_doc.map { |doc| attributes_from_xml(doc, xml_path) } 
     else
       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|
-        if (value = value_from_doc_and_mapping(doc, mapping)) != :not_found
+      atts = self.mappings.inject(XmlMapperHash.from_path_and_node(xml_path, doc)) do |hash, mapping|
+        if (value = value_from_doc_and_mapping(doc, mapping, xml_path)) != :not_found
           add_value_to_hash(hash, mapping[:key], value)
         end
       end
@@ -142,9 +143,9 @@ class XmlMapper
     hash
   end
   
-  def value_from_doc_and_mapping(doc, mapping)
+  def value_from_doc_and_mapping(doc, mapping, xml_path = nil)
     if mapping[:type] == :many
-      mapping[:options][:mapper].attributes_from_xml(doc.search(mapping[:xpath]).to_a)
+      mapping[:options][:mapper].attributes_from_xml(doc.search(mapping[:xpath]).to_a, xml_path)
     else
       node = mapping[:xpath].length == 0 ? doc : doc.xpath(mapping[:xpath]).first
       if mapping[:type] == :exists

data/lib/xml_mapper_hash.rb

@@ -0,0 +1,24 @@
+class XmlMapper
+  class XmlMapperHash < Hash
+    attr_accessor :xml_path, :node
+
+    def self.from_path_and_node(new_path, new_node)
+      hash = self.new
+      hash.xml_path = new_path
+      hash.node = new_node
+      hash
+    end
+    
+    def clone_attributes_into!(to_be_cloned_attributes, into_keys)
+      hashes_from_into_keys(into_keys).each do |sub_attributes|
+        [to_be_cloned_attributes].flatten.each do |clone_key, clone_value|
+          sub_attributes[clone_key.to_sym] ||= self[clone_key.to_sym] if self.has_key?(clone_key.to_sym)
+        end
+      end
+    end
+    
+    def hashes_from_into_keys(into_keys)
+      [into_keys].flatten.map { |key| self[key] }.flatten.compact
+    end
+  end
+end

data/spec/xml_mapper_hash_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe XmlMapper::XmlMapperHash do
+  describe "#from_path_and_node" do
+    it "sets the correct xml_path" do
+      hash = XmlMapper::XmlMapperHash.from_path_and_node("/some/path.xml", nil)
+      hash.xml_path.should == "/some/path.xml"
+    end
+    
+    it "sets the correct node" do
+      node = double("node")
+      hash = XmlMapper::XmlMapperHash.from_path_and_node("/some/path.xml", node)
+      hash.node.should == node
+    end
+  end
+  
+  describe "#clone_attributes_into" do
+    it "does not break when track_attributes are nil" do
+      hash = XmlMapper::XmlMapperHash.new.merge(:upc => "1234")
+      hash.clone_attributes_into!([:upc], :tracks_attributes)
+      hash.should == { :upc => "1234" }
+    end
+    
+    it "does not change anything when album does not have selected attributes" do
+      hash = XmlMapper::XmlMapperHash.new.merge(:upc => "12343", :tracks_attributes => [:track_number => 1])
+      hash.clone_attributes_into!([:artist_name], :tracks_attributes)
+      hash.should == { 
+        :upc => "12343", :tracks_attributes => [:track_number => 1] 
+      }
+    end
+    
+    it "clones all selected attributes" do
+      hash = XmlMapper::XmlMapperHash.new.merge(:artist_name => "Mos Def", :title => "Some Title", :upc => "12343",
+        :tracks_attributes => [{ :track_number => 1 }, { :track_number => 2 }]
+      )
+      hash.clone_attributes_into!([:artist_name, :upc], :tracks_attributes)
+      hash.should == { 
+        :artist_name => "Mos Def", :title => "Some Title", :upc => "12343", 
+        :tracks_attributes => [
+          { :track_number => 1, :artist_name => "Mos Def", :upc => "12343" }, 
+          { :track_number => 2, :artist_name => "Mos Def", :upc => "12343" }
+        ]
+      }
+    end
+    
+    it "allows cloning of attributes into multiple arrays" do
+      hash = XmlMapper::XmlMapperHash.new.merge(:upc => "12343",
+        :tracks_attributes => [{ :track_number => 1 }, { :track_number => 2 }],
+        :videos_attributes => [{ :video_number => 1 }, { :video_number => 2 }]
+      )
+      hash.clone_attributes_into!(:upc, [:tracks_attributes, :videos_attributes])
+      hash.should == {
+        :upc => "12343",
+        :tracks_attributes => [{ :track_number => 1, :upc => "12343" }, { :track_number => 2, :upc => "12343" }],
+        :videos_attributes => [{ :video_number => 1, :upc => "12343" }, { :video_number => 2, :upc => "12343" }]
+      }
+    end
+    
+    it "does not overwrite already set attributes" do
+      hash = XmlMapper::XmlMapperHash.new.merge(:artist_name => "Mos Def", :title => "Some Title", :upc => "12343", 
+        :tracks_attributes => [
+          { :track_number => 1 }, { :track_number => 2, :artist_name => "Mos and Talib" }
+        ]
+      )
+      hash.clone_attributes_into!([:artist_name, :upc], :tracks_attributes)
+      hash.should == { :artist_name => "Mos Def", :title => "Some Title", :upc => "12343", :tracks_attributes => [
+          { :track_number => 1, :artist_name => "Mos Def", :upc => "12343" }, { :track_number => 2, :artist_name => "Mos and Talib", :upc => "12343" }
+        ]
+      }
+    end
+  end
+end

data/spec/xml_mapper_spec.rb

@@ -1,6 +1,16 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "XmlMapper" do
+  def create_class(base_class = "XmlMapper")
+    class_name = "TestMapping#{Time.now.to_f.to_s.gsub(".", "")}"
+    str = %(
+      class #{class_name} < #{base_class}
+      end
+    )
+    eval(str)
+    eval(class_name)
+  end
+  
   before(:each) do
     @mapper = XmlMapper.new
   end
@@ -278,12 +288,6 @@ describe "XmlMapper" do
       File.stub(:read).and_return @xml
     end
     
-    it "sets the xml_path" do
-      @mapper.attributes_from_xml_path("/some/path.xml").should == { 
-        :title => "Black on Both Sides", :xml_path => "/some/path.xml" 
-      }
-    end
-    
     it "calls File.read with correct parameters" do
       File.should_receive(:read).with("/some/path.xml").and_return @xml
       @mapper.attributes_from_xml_path("/some/path.xml")
@@ -291,7 +295,7 @@ describe "XmlMapper" do
     
     it "allows using the xml_path in after_map block" do
       @mapper.after_map do
-        self[:new_xml_path] = self[:xml_path]
+        self[:new_xml_path] = self.xml_path
       end
       @mapper.attributes_from_xml_path("/some/path.xml")[:new_xml_path].should == "/some/path.xml"
     end
@@ -324,6 +328,68 @@ describe "XmlMapper" do
         :upc => "1234"
       }
     end
+    
+    describe "using xml_path and node" do
+      before(:each) do
+        xml = %(
+          <album>
+            <tracks>
+              <track><title>First Track</title></track>
+              <track><title>Second Track Track</title></track>
+            </tracks>
+          </album>
+        )
+        File.stub(:read).and_return xml
+      end
+      
+      it "allows accessing xml_path in after_map block" do
+        @mapper.after_map do
+          self[:new_path] = self.xml_path
+        end
+        @mapper.attributes_from_xml_path("/some/other/path.xml").should == { :new_path => "/some/other/path.xml" }
+      end
+      
+      it "allows using node in after_map block" do
+        @mapper.after_map do
+          self[:tracks_count] = self.node.search("tracks/track").count
+        end
+        @mapper.attributes_from_xml_path("/some/other/path.xml").should == { :tracks_count => 2 }
+      end
+      
+      it "allows using xml_path in subnodes" do
+        clazz = create_class
+        clazz.many "tracks/track" => :tracks do
+          after_map do
+            self[:new_path] = self.xml_path
+          end
+        end
+        clazz.attributes_from_xml_path("/some/other/path.xml").should == { :tracks => 
+          [ 
+            { :new_path => "/some/other/path.xml" }, 
+            { :new_path => "/some/other/path.xml" }
+          ] 
+        }
+      end
+      
+      it "allows using node in subnodes" do
+        clazz = create_class
+        clazz.many "tracks/track" => :tracks do
+          after_map do
+            self[:title_count] = self.node.search("title").count
+          end
+        end
+        clazz.after_map do
+          self[:title_count] = self.node.search("title").count
+        end
+        
+        clazz.attributes_from_xml_path("/some/other/path.xml").should == { :title_count => 2,
+          :tracks => [ 
+              { :title_count => 1 }, 
+              { :title_count => 1 }
+          ]
+        }
+      end
+    end
   end
   
   describe "converting strings" do
@@ -340,16 +406,6 @@ describe "XmlMapper" do
   end
   
   describe "defining a DSL" do
-    def create_class(base_class = "XmlMapper")
-      class_name = "TestMapping#{Time.now.to_f.to_s.gsub(".", "")}"
-      str = %(
-        class #{class_name} < #{base_class}
-        end
-      )
-      eval(str)
-      eval(class_name)
-    end
-    
     before(:each) do
       # so that we have a new class in each spec
       @clazz = create_class
@@ -378,8 +434,7 @@ describe "XmlMapper" do
       File.stub(:read).and_return %(<album><title>Test Title</title></album>)
       @clazz.text(:title)
       @clazz.attributes_from_xml_path("/some/path.xml").should == {
-        :title => "Test Title",
-        :xml_path => "/some/path.xml"
+        :title => "Test Title"
       }
     end
     
@@ -574,8 +629,7 @@ describe "XmlMapper" do
         File.stub!(:read).and_return xml
         subclazz.attributes_from_xml_path("/some_path/album.xml").should == {
           :artist_name => "Mos Def",
-          :title => "Black on Both Sides",
-          :xml_path => "/some_path/album.xml"
+          :title => "Black on Both Sides"
         }
       end
     end

data/xml_mapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xml_mapper}
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias Schwab"]
-  s.date = %q{2010-12-02}
+  s.date = %q{2011-01-10}
   s.description = %q{Declarative XML to Ruby mapping}
   s.email = %q{tobias.schwab@dynport.de}
   s.extra_rdoc_files = [
@@ -31,10 +31,12 @@ Gem::Specification.new do |s|
     "features/support/env.rb",
     "features/xml_mapper.feature",
     "lib/xml_mapper.rb",
+    "lib/xml_mapper_hash.rb",
     "spec/example_spec.rb",
     "spec/fixtures/base.xml",
     "spec/my_mapper.rb",
     "spec/spec_helper.rb",
+    "spec/xml_mapper_hash_spec.rb",
     "spec/xml_mapper_spec.rb",
     "xml_mapper.gemspec"
   ]
@@ -47,6 +49,7 @@ Gem::Specification.new do |s|
     "spec/example_spec.rb",
     "spec/my_mapper.rb",
     "spec/spec_helper.rb",
+    "spec/xml_mapper_hash_spec.rb",
     "spec/xml_mapper_spec.rb"
   ]
 

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Tobias Schwab
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-02 00:00:00 +01:00
+date: 2011-01-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -174,10 +174,12 @@ files:
 - features/support/env.rb
 - features/xml_mapper.feature
 - lib/xml_mapper.rb
+- lib/xml_mapper_hash.rb
 - spec/example_spec.rb
 - spec/fixtures/base.xml
 - spec/my_mapper.rb
 - spec/spec_helper.rb
+- spec/xml_mapper_hash_spec.rb
 - spec/xml_mapper_spec.rb
 - xml_mapper.gemspec
 has_rdoc: true
@@ -218,4 +220,5 @@ test_files:
 - spec/example_spec.rb
 - spec/my_mapper.rb
 - spec/spec_helper.rb
+- spec/xml_mapper_hash_spec.rb
 - spec/xml_mapper_spec.rb