Fix to allow for editing mixed text and child nodes HYDRA-355

Author: rickjohnson

lib/om/samples/mods_article.rb

@@ -24,6 +24,7 @@ class OM::Samples::ModsArticle
         t.last_name(:path=>"namePart", :attributes=>{:type=>"family"})
         t.first_name(:path=>"namePart", :attributes=>{:type=>"given"}, :label=>"first name")
         t.terms_of_address(:path=>"namePart", :attributes=>{:type=>"termsOfAddress"})
+        t.name_content(:path=>"text()")
       }
       # lookup :person, :first_name        
       t.person(:ref=>:name, :attributes=>{:type=>"personal"})
@@ -61,4 +62,4 @@ class OM::Samples::ModsArticle
     # renamed family_name => last_name
     # start_page & end_page now accessible as [:journal, :issue, :pages, :start] (etc.)
 
-end
+end

lib/om/xml/term_value_operators.rb

@@ -7,7 +7,10 @@ module OM::XML::TermValueOperators
   # Retrieves all of the nodes from the current document that match +term_pointer+ and returns an array of their values
   def term_values(*term_pointer)
     result = []
-    find_by_terms(*term_pointer).each {|node| result << node.text }
+    xpath = self.class.terminology.xpath_with_indexes(*term_pointer)
+    #if value is on line by itself sometimes does not trim leading and trailing whitespace for a text node so will detect and fix it
+    trim_text = !xpath.nil? && !xpath.index("text()").nil?
+    find_by_terms(*term_pointer).each {|node| result << (trim_text ? node.text.strip : node.text) }
     # find_by_terms(*OM.destringify(term_pointer)).each {|node| result << node.text }
     return result
   end
@@ -128,6 +131,9 @@ def insert_from_template(parent_node, new_values, template)
       template_args = OM.pointers_to_flat_array(template_args,false)
       template = self.class.terminology.xml_builder_template( *template_args )
     end
+
+    #if there is an xpath element pointing to text() need to change to just 'text' so it references the text method for the parent node
+    template.gsub!(/text\(\)/, 'text')
 
     builder = Nokogiri::XML::Builder.with(parent_node) do |xml|
       new_values.each do |builder_new_value|
@@ -240,4 +246,4 @@ def node_from_set(nodeset, index)
 
   private :node_from_set
 
-end
+end

lib/om/xml/term_xpath_generator.rb

@@ -17,10 +17,14 @@ def self.generate_relative_xpath(mapper)
         raise "#{mapper.path} is an invalid path for an OM::XML::Term.  You should provide either a string or {:attributes=>XXX}"
       end
     else
-      unless mapper.namespace_prefix.nil?
-        template << complete_prefix
+      if mapper.path == "text()"
+        base_path = "#{mapper.path}[normalize-space(.)]"
+      else
+        unless mapper.namespace_prefix.nil?
+          template << complete_prefix
+        end
+        base_path = mapper.path
       end
-      base_path = mapper.path
     end
     template << base_path
 
@@ -224,4 +228,4 @@ def self.add_predicate(xpath_query, predicate)
     return modified_query
   end
 
-end
+end

spec/fixtures/mods_articles/hydrangea_article1.xml

@@ -11,6 +11,7 @@
     </titleInfo>
 
     <name type="personal">
+        Describes a person
         <namePart type="family">FAMILY NAME</namePart>
         <namePart type="given">GIVEN NAMES</namePart>
         <namePart type="termsOfAddress">DR.</namePart>

spec/unit/term_value_operators_spec.rb

@@ -16,6 +16,10 @@
       result.length.should == expected_values.length
       expected_values.each {|v| result.should include(v)}
     end
+
+    it "should ignore whitespace elements for a term pointing to a text() node for an element that contains children" do
+      @article.term_values(:name, :name_content).should == ["Describes a person"]
+    end
 
   end
 
@@ -72,7 +76,7 @@
     end
 
     it "should destringify the field key/find_by_terms_and_value pointer" do
-      OM::Samples::ModsArticle.terminology.expects(:xpath_with_indexes).with( *[{:person=>0}, :role]).times(7).returns("//oxns:name[@type=\"personal\"][1]/oxns:role")
+      OM::Samples::ModsArticle.terminology.expects(:xpath_with_indexes).with( *[{:person=>0}, :role]).times(10).returns("//oxns:name[@type=\"personal\"][1]/oxns:role")
       OM::Samples::ModsArticle.terminology.stubs(:xpath_with_indexes).with( *[{:person=>0}]).returns("//oxns:name[@type=\"personal\"][1]")
       @article.update_values( { [{":person"=>"0"}, "role"]=>"the role" } )
       @article.update_values( { [{"person"=>"0"}, "role"]=>"the role" } )
@@ -183,6 +187,13 @@
       @article.update_values({[:journal, :title_info]=>{"0"=>:delete}})
       @article.term_values(:journal, :title_info).should == ['mork']
     end
+
+    it "should retain other child nodes when updating a text content term and shoud not append an additional text node but update text in place" do
+      @article.term_values(:name,:name_content).should == ["Describes a person"]
+      @article.update_values({[:name, :name_content]=>"Test text"})
+      @article.term_values(:name,:name_content).should == ["Test text"]
+      @article.find_by_terms(:name).children.length().should == 26
+    end
 
   end
 
@@ -406,4 +417,4 @@
     end
   end
 
-end
+end

spec/unit/term_xpath_generator_spec.rb

@@ -51,6 +51,12 @@
       @test_term.namespace_prefix = nil
       OM::XML::TermXpathGenerator.generate_relative_xpath(@test_term).should == 'namePart[@type="termsOfAddress"]'
     end
+
+    it "should not use a namespace for a path set to text() and should include normalize-space to ignore white space" do
+      text_term = OM::XML::Term.new(:title_content, :path=>"text()")
+      OM::XML::TermXpathGenerator.generate_relative_xpath(text_term).should == 'text()[normalize-space(.)]'
+    end
+
   end
 
   describe "generate_absolute_xpath" do
@@ -108,4 +114,4 @@
     OM::XML::TermXpathGenerator.generate_constrained_xpath(@test_term_with_default_path).should == '//oxns:detail[contains(oxns:number[@type="volume"], "#{constraint_value}")]'.gsub('"', '\"')  
   end
 
-end
+end