opinionated-xml 0.0.1

data/spec/unit/ox_integration_spec.rb

@@ -0,0 +1,124 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "OpinionatedXml" do
+  
+  before(:all) do
+    #ModsHelpers.name_("Beethoven, Ludwig van", :date=>"1770-1827", :role=>"creator")
+    class FakeOxIntegrationMods < Nokogiri::XML::Document
+      
+      include OX      
+      
+      # Could add support for multiple root declarations.  
+      #  For now, assume that any modsCollections have already been broken up and fed in as individual mods documents
+      # root :mods_collection, :path=>"modsCollection", 
+      #           :attributes=>[],
+      #           :subelements => :mods
+                     
+      root_property :mods, "mods", "http://www.loc.gov/mods/v3", :attributes=>["id", "version"], :schema=>"http://www.loc.gov/standards/mods/v3/mods-3-2.xsd"          
+                
+                
+      property :name_, :path=>"name", 
+                  :attributes=>[:xlink, :lang, "xml:lang", :script, :transliteration, {:type=>["personal", "enumerated", "corporate"]} ],
+                  :subelements=>["namePart", "displayForm", "affiliation", :role, "description"],
+                  :default_content_path => "namePart",
+                  :convenience_methods => {
+                    :date => {:path=>"namePart", :attributes=>{:type=>"date"}},
+                    :family_name => {:path=>"namePart", :attributes=>{:type=>"family"}},
+                    :given_name => {:path=>"namePart", :attributes=>{:type=>"given"}},
+                    :terms_of_address => {:path=>"namePart", :attributes=>{:type=>"termsOfAddress"}}
+                  }
+                  
+      property :person, :variant_of=>:name_, :attributes=>{:type=>"personal"}
+      
+      property :role, :path=>"role",
+                  :parents=>[:name_],
+                  :attributes=>[ { "type"=>["text", "code"] } , "authority"],
+                  :default_content_path => "roleTerm"
+                  
+                  
+    end
+        
+  end
+  
+  before(:each) do
+    @fixturemods = FakeOxIntegrationMods.parse( fixture( File.join("test_dummy_mods.xml") ) )
+  end
+  
+  after(:all) do
+    Object.send(:remove_const, :FakeOxIntegrationMods)
+  end
+  
+  describe ".property_values_append" do
+	
+  	it "looks up the parent using :parent_select, uses :parent_index to choose the parent node from the result set, uses :template to build the node(s) to be inserted, inserts the :values(s) into the node(s) and adds the node(s) to the parent" do      
+	    @fixturemods.property_values_append(
+        :parent_select => [:person, {:given_name=>"Tim", :family_name=>"Berners-Lee"}] ,
+        :parent_index => :first,
+        :template => [:person, :affiliation],
+        :values => ["my new value", "another new value"] 
+      )
+    end
+    
+    it "should accept parent_select and template [property_reference, lookup_opts] as argument arrays for generators/lookups" do
+      # this appends two affiliation nodes into the first person node whose name is Tim Berners-Lee
+      expected_result = '<ns3:name type="personal">
+      <ns3:namePart type="family">Berners-Lee</ns3:namePart>
+      <ns3:namePart type="given">Tim</ns3:namePart>
+  <ns3:affiliation>my new value</ns3:affiliation><ns3:affiliation>another new value</ns3:affiliation></ns3:name>'
+      #expected_result = Nokogiri::XML::Node.new( expected_result, @fixturemods )
+      
+	    @fixturemods.property_values_append(
+        :parent_select => [:person, {:given_name=>"Tim", :family_name=>"Berners-Lee"}] ,
+        :parent_index => :first,
+        :template => [:person, :affiliation],
+        :values => ["my new value", "another new value"] 
+      ).to_xml.should == expected_result
+      
+      @fixturemods.lookup(:person, {:given_name=>"Tim", :family_name=>"Berners-Lee"}).first.to_xml.should == expected_result
+    end
+    
+    it "should accept symbols as arguments for generators/lookups" do
+      # this appends a role of "my role" into the third "person" node in the document
+      expected_result = "<ns3:name type=\"personal\">\n      <ns3:namePart type=\"family\">Klimt</ns3:namePart>\n      <ns3:namePart type=\"given\">Gustav</ns3:namePart>\n  <ns3:role type=\"text\"><ns3:roleTerm>my role</ns3:roleTerm></ns3:role></ns3:name>"
+      
+      @fixturemods.property_values_append(
+        :parent_select => :person ,
+        :parent_index => 3,
+        :template => :role,
+        :values => "my role" 
+      ).to_xml.should == expected_result
+
+      @fixturemods.lookup(:person)[3].to_xml.should == expected_result
+    end
+    
+    it "should accept parent_select as an (xpath) string and template as a (template) string" do
+      # this uses the provided template to add a node into the first node resulting from the xpath '//oxns:name[@type="personal"]'
+      expected_result = "<ns3:name type=\"personal\">\n      <ns3:namePart type=\"family\">Berners-Lee</ns3:namePart>\n      <ns3:namePart type=\"given\">Tim</ns3:namePart>\n  <ns3:role type=\"code\" authority=\"marcrelator\"><ns3:roleTerm>creator</ns3:roleTerm></ns3:role></ns3:name>"
+      @fixturemods.property_values_append(
+        :parent_select =>'//oxns:name[@type="personal"]',
+        :parent_index => 0,
+        :template => 'xml.role( :type=>\'code\', :authority=>\'marcrelator\' ) { xml.roleTerm( \'#{builder_new_value}\' ) }',
+        :values => "creator" 
+      ).to_xml.should == expected_result
+
+      @fixturemods.lookup(:person).first.to_xml.should == expected_result
+    end
+	  
+	  it "should support more complex mixing & matching" do
+	    expected_result = "<ns3:name type=\"personal\">\n      <ns3:namePart type=\"family\">Jobs</ns3:namePart>\n      <ns3:namePart type=\"given\">Steve</ns3:namePart>\n  <ns3:role type=\"code\" authority=\"marcrelator\"><ns3:roleTerm>foo</ns3:roleTerm></ns3:role></ns3:name>"
+      
+	    @fixturemods.property_values_append(
+        :parent_select =>'//oxns:name[@type="personal"]',
+        :parent_index => 1,
+        :template => [ :person, :role, {:attributes=>{"type"=>"code", "authority"=>"marcrelator"}} ],
+        :values => "foo" 
+      ).to_xml.should == expected_result
+
+      @fixturemods.lookup(:person)[1].to_xml.should == expected_result
+	  end
+	  
+	  it "should raise exception if no node corresponds to the provided :parent_select and :parent_index"
+  	
+  end
+  
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: opinionated-xml
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Zumwalt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: facets
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: A library to help you tame sprawling XML schemas like MODS.  Wraps Nokogiri documents in objects with miscellaneous helper methods for doing things like retrieve generated xpath queries or look up properties based on a simplified DSL
+email: matt.zumwalt@yourmediashelf.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- History.textile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/opinionated-xml.rb
+- lib/opinionated-xml/ox.rb
+- lib/opinionated-xml/ox_property_values_helper.rb
+- opinionated-xml.gemspec
+- spec/fixtures/CBF_MODS/ARS0025_016.xml
+- spec/fixtures/mods-3-2.xsd
+- spec/fixtures/test_dummy_mods.xml
+- spec/helpers/ox_property_values_helper_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/unit/opinionated-xml_spec.rb
+- spec/unit/ox_integration_spec.rb
+has_rdoc: true
+homepage: http://github.com/mediashelf/opinionated-xml
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A library to help you tame sprawling XML schemas like MODS.
+test_files: 
+- spec/helpers/ox_property_values_helper_spec.rb
+- spec/spec_helper.rb
+- spec/unit/opinionated-xml_spec.rb
+- spec/unit/ox_integration_spec.rb