opinionated-xml 0.0.1

data/opinionated-xml.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{opinionated-xml}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Zumwalt"]
+  s.date = %q{2010-05-16}
+  s.description = %q{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}
+  s.email = %q{matt.zumwalt@yourmediashelf.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.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"
+  ]
+  s.homepage = %q{http://github.com/mediashelf/opinionated-xml}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A library to help you tame sprawling XML schemas like MODS.}
+  s.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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<facets>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<facets>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<facets>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+  end
+end
+

data/spec/fixtures/CBF_MODS/ARS0025_016.xml

@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<ns3:mods xsi:schemaLocation="http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-2.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns3="http://www.loc.gov/mods/v3" xmlns:ns2="http://www.w3.org/1999/xlink">
+    <ns3:titleInfo>
+        <ns3:title>Brandenburg concerto no. 1 in F major</ns3:title>
+    </ns3:titleInfo>
+    <ns3:language>
+        <ns3:languageTerm type="code" authority="iso639-2b">No_linguistic_content</ns3:languageTerm>
+        <ns3:languageTerm type="text">No linguistic content</ns3:languageTerm>
+    </ns3:language>
+    <ns3:typeOfResource>sound recording-musical</ns3:typeOfResource>
+    <ns3:originInfo>
+        <ns3:dateCreated>07/23/1962</ns3:dateCreated>
+    </ns3:originInfo>
+    <ns3:name type="personal" authority="ingest">
+        <ns3:role>
+            <ns3:roleTerm type="text" authority="marcrelator">creator</ns3:roleTerm>
+            <ns3:roleTerm type="code" authority="marcrelator">cre</ns3:roleTerm>
+        </ns3:role>
+        <ns3:namePart type="family">Bach, Johann Sebastian, 1685-1750</ns3:namePart>
+        <ns3:displayForm>Bach, Johann Sebastian, 1685-1750</ns3:displayForm>
+    </ns3:name>
+    <ns3:name type="personal" authority="ingest">
+        <ns3:role>
+            <ns3:roleTerm type="text" authority="marcrelator">creator</ns3:roleTerm>
+            <ns3:roleTerm type="code" authority="marcrelator">cre</ns3:roleTerm>
+        </ns3:role>
+        <ns3:namePart type="family">Bergstone, Fred</ns3:namePart>
+        <ns3:displayForm>Bergstone, Fred</ns3:displayForm>
+    </ns3:name>
+    <ns3:name type="personal" authority="ingest">
+        <ns3:role>
+            <ns3:roleTerm type="text" authority="marcrelator">creator</ns3:roleTerm>
+            <ns3:roleTerm type="code" authority="marcrelator">cre</ns3:roleTerm>
+        </ns3:role>
+        <ns3:namePart type="family">Dust\u00E9, Raymond</ns3:namePart>
+        <ns3:displayForm>Dust\u00E9, Raymond</ns3:displayForm>
+    </ns3:name>
+    <ns3:name type="personal" authority="ingest">
+        <ns3:role>
+            <ns3:roleTerm type="text" authority="marcrelator">creator</ns3:roleTerm>
+            <ns3:roleTerm type="code" authority="marcrelator">cre</ns3:roleTerm>
+        </ns3:role>
+        <ns3:namePart type="family">Kates, Philip</ns3:namePart>
+        <ns3:displayForm>Kates, Philip</ns3:displayForm>
+    </ns3:name>
+    <ns3:name type="personal" authority="ingest">
+        <ns3:role>
+            <ns3:roleTerm type="text" authority="marcrelator">creator</ns3:roleTerm>
+            <ns3:roleTerm type="code" authority="marcrelator">cre</ns3:roleTerm>
+        </ns3:role>
+        <ns3:namePart type="family">Price, Charles Gower, 1939-</ns3:namePart>
+        <ns3:displayForm>Price, Charles Gower, 1939-</ns3:displayForm>
+    </ns3:name>
+    <ns3:name type="personal" authority="ingest">
+        <ns3:role>
+            <ns3:roleTerm type="text" authority="marcrelator">creator</ns3:roleTerm>
+            <ns3:roleTerm type="code" authority="marcrelator">cre</ns3:roleTerm>
+        </ns3:role>
+        <ns3:namePart type="family">Taylor, Ross, arranger</ns3:namePart>
+        <ns3:displayForm>Taylor, Ross, arranger</ns3:displayForm>
+    </ns3:name>
+    <ns3:name type="personal" authority="ingest">
+        <ns3:role>
+            <ns3:roleTerm type="text" authority="marcrelator">creator</ns3:roleTerm>
+            <ns3:roleTerm type="code" authority="marcrelator">cre</ns3:roleTerm>
+        </ns3:role>
+        <ns3:namePart type="family">Waller, Rosemary</ns3:namePart>
+        <ns3:displayForm>Waller, Rosemary</ns3:displayForm>
+    </ns3:name>
+    <ns3:subject authority="lcsh">
+        <ns3:topic>Concerti grossi</ns3:topic>
+    </ns3:subject>
+    <ns3:note displayLabel="Uniform title">Bach, Johann Sebastian, 1685-1750. Brandenburgische Konzerte. Nr. 1
+
+</ns3:note>
+    <ns3:physicalDescription>
+        <ns3:note displayLabel="General Physical Description note">1 7 in. open reel audio tape</ns3:note>
+    </ns3:physicalDescription>
+    <ns3:relatedItem type="host">
+        <ns3:titleInfo>
+            <ns3:title>Carmel Bach Festival Tape Collection</ns3:title>
+        </ns3:titleInfo>
+        <ns3:originInfo>
+            <ns3:dateCreated>1962-1982</ns3:dateCreated>
+            <ns3:dateCreated point="start">1962</ns3:dateCreated>
+            <ns3:dateCreated point="end">1982</ns3:dateCreated>
+        </ns3:originInfo>
+        <ns3:identifier type="local">ARS.0025</ns3:identifier>
+    </ns3:relatedItem>
+    <ns3:note displayLabel="Digital object made available by ">Archive of Recorded Sound, Braun Music Center, 541 Lasuen Mall, Stanford University, Stanford, California, 94305-3076, USA, (http://library.stanford.edu/depts/ars)</ns3:note>
+    <ns3:identifier displayLabel="Audio-Streaming">ARS0025_016_a_sl.mp3</ns3:identifier>
+    <ns3:identifier displayLabel="Audio-Service">ARS0025_016_a_sh.wav</ns3:identifier>
+    <ns3:identifier displayLabel="Audio-Master">ARS0025_016_a_pm.wav</ns3:identifier>
+</ns3:mods>

data/spec/fixtures/mods-3-2.xsd

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?>
    Tentative plan for 4.0 is to make it an element instead of an attribute, 
    and  wrap <url> and <urlNote> together. Can't do that in 3.2 
    because it would not be compatible with 3.1. 
    but had not been explicitly typed, are now typed. 
    http://www.loc.gov/standards/xlink.xsd. 
   (It was previously http://www.loc.gov/standards/mods/xlink.xsd. 
   The schema now resides in both places so that earlier versions 
    will not be affected, but it is now intended that the new copy 
    be referenced, outside of the mods directory, 
   so that other projects, e.g. mets, may reference it.)
 (1) a single MODS record:  
     record definintion, and also relatedItem. 
   Difference is that mods requires at least one element 
   and relatedItem does not.
-->
-->
 
 ********** titleInfoType definition **********
 -->
 **********  nameType definition  **********   		
-->
-->
-->
 </xsd:documentation>
-->
 -->
-->
 ********** originInfoType definition  ********** 
-->
-->
-->
 -->
 -->
 -->
 -->
 -->
 ********** subjectType definition  **********  	 	
-->
-->
-->
-->
-->
-->
 -->
  
 -->
 -->
-->
-->
-->
-->
-->
-->
-->
 ********** language attribute group definition  **********  	                       	  
-->
   ********** definition of codeOrText type used by type attribute 
   for elements that distinguish code from text  **********  	                       	  
 -->
    ********** definition of placeAuthority type used by authority attribute
      for  placeType and geographic  **********  	                       	  
 -->
    ********** definition of nameTypeAttribute used by name attribute
      "type"  **********  	                       	  
 -->

data/spec/fixtures/test_dummy_mods.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<ns3:mods xsi:schemaLocation="http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-2.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns3="http://www.loc.gov/mods/v3" xmlns:ns2="http://www.w3.org/1999/xlink">
+  <ns3:name type="personal">
+      <ns3:namePart type="family">Berners-Lee</ns3:namePart>
+      <ns3:namePart type="given">Tim</ns3:namePart>
+  </ns3:name>
+  <ns3:name type="personal">
+      <ns3:namePart type="family">Jobs</ns3:namePart>
+      <ns3:namePart type="given">Steve</ns3:namePart>
+  </ns3:name>
+  <ns3:name type="personal">
+      <ns3:namePart type="family">Wozniak</ns3:namePart>
+      <ns3:namePart type="given">The Woz</ns3:namePart>
+  </ns3:name>
+  <ns3:name type="personal">
+      <ns3:namePart type="family">Klimt</ns3:namePart>
+      <ns3:namePart type="given">Gustav</ns3:namePart>
+  </ns3:name>
+</ns3:mods>

data/spec/helpers/ox_property_values_helper_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class FakePVHClass
+  include OX::PropertyValuesHelper
+end
+
+def helper
+  @fake_includer
+end
+
+describe "OX::PropertyValuesHelper" do
+  
+  before(:all) do
+    @fake_includer = FakePVHClass.new
+  end
+    
+  describe ".property_values" do
+
+    it "should call .lookup and then build an array of values from the returned nodeset (using default_node, etc as nessesary)" do
+      lookup_opts = "insert args here"
+      mock_node = mock("node")
+      mock_node.expects(:text).returns("sample value").times(3)
+      mock_nodeset = [mock_node, mock_node, mock_node]
+      helper.expects(:lookup).with(lookup_opts).returns(mock_nodeset)
+      
+      helper.property_values(lookup_opts).should == ["sample value","sample value","sample value"]
+    end
+  
+  end
+
+  describe ".property_values_append" do
+	
+	  # see ../unit/ox_integration_spec.rb
+  	
+  end
+
+  describe ".property_value_set" do
+	
+  	  it "should " do
+  	    pending "in progress..."
+  	    @fixturemods.property_value_set('//oxns:name[@type="personal"]',1,"foo")
+  	    @fixturemods.property_value_set([ [:person,:role], "donor"], 5, "special donor")
+  	  end
+      
+      it "could support alternative notation" do
+        pending "this would be for the sake of consistency with the method signature of property_values_append"
+        # @fixturemods.property_value_set(
+        #           :node_select =>'//oxns:name[@type="personal"]',
+        #           :node_index => 1,
+        #           :values => "foo" 
+        #         ).to_xml.should == expected_result
+      end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'opinionated-xml'
+require 'spec'
+require 'spec/autorun'
+require 'ruby-debug'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+def fixture(file)
+  File.new(File.join(File.dirname(__FILE__), 'fixtures', file))
+end

data/spec/unit/opinionated-xml_spec.rb

@@ -0,0 +1,300 @@
+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 FakeOxMods < 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
+    
+    class FakeOtherOx < Nokogiri::XML::Document
+      
+      include OX
+      extend OX::ClassMethods
+      
+      root_property :other, "other", "http://www.foo.com"        
+      
+    end
+        
+  end
+  
+  before(:each) do
+    @fixturemods = FakeOxMods.parse( fixture( File.join("CBF_MODS", "ARS0025_016.xml") ) )
+  end
+  
+  after(:all) do
+    Object.send(:remove_const, :FakeOxMods)
+  end
+  
+  describe "#new" do
+    it "should set up namespaces" do
+      @fixturemods.ox_namespaces.should == {"oxns"=>"http://www.loc.gov/mods/v3", "xmlns:ns2"=>"http://www.w3.org/1999/xlink", "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance", "xmlns:ns3"=>"http://www.loc.gov/mods/v3"}
+    end
+  end
+  
+  describe "#root_property" do
+    it "should initialize root_property class attributes without attributes bleeding over to other OX classes" do
+      FakeOxMods.root_property_ref.should == :mods
+      FakeOxMods.root_config.should == {:ref=>:mods, :path=>"mods", :namespace=>"http://www.loc.gov/mods/v3", :attributes=>["id", "version"], :schema=>"http://www.loc.gov/standards/mods/v3/mods-3-2.xsd"}
+      FakeOxMods.ox_namespaces.should == {"oxns"=>"http://www.loc.gov/mods/v3"}
+      FakeOxMods.schema_url.should == "http://www.loc.gov/standards/mods/v3/mods-3-2.xsd"
+      
+      FakeOtherOx.root_property_ref.should == :other
+      FakeOtherOx.root_config.should == {:namespace=>"http://www.foo.com", :path=>"other", :ref=>:other}
+    end
+  end
+  
+  describe "#property" do
+    
+    it "fails gracefully if you try to look up nodes for an undefined property" do
+      @fixturemods.lookup(:nobody_home).should == []
+    end
+  
+    it "constructs xpath queries for finding properties" do
+      FakeOxMods.properties[:name_][:xpath].should == '//oxns:name'   
+      FakeOxMods.properties[:name_][:xpath_relative].should == 'oxns:name'               
+                  
+      FakeOxMods.properties[:person][:xpath].should == '//oxns:name[@type="personal"]'
+      FakeOxMods.properties[:person][:xpath_relative].should == 'oxns:name[@type="personal"]'
+    end
+    
+    it "constructs templates for value-driven searches" do
+      FakeOxMods.properties[:name_][:xpath_constrained].should == '//oxns:name[contains(oxns:namePart, "#{constraint_value}")]'.gsub('"', '\"')
+      FakeOxMods.properties[:person][:xpath_constrained].should == '//oxns:name[@type="personal" and contains(oxns:namePart, "#{constraint_value}")]'.gsub('"', '\"')
+      
+      # Example of how you could use these templates:
+      constraint_value = "SAMPLE CONSTRAINT VALUE"
+      constrained_query = eval( '"' + FakeOxMods.properties[:person][:xpath_constrained] + '"' )
+      constrained_query.should == '//oxns:name[@type="personal" and contains(oxns:namePart, "SAMPLE CONSTRAINT VALUE")]'
+    end
+    
+    it "constructs xpath queries & templates for convenience methods" do
+      FakeOxMods.properties[:name_][:convenience_methods][:date][:xpath].should == '//oxns:name/oxns:namePart[@type="date"]'
+      FakeOxMods.properties[:name_][:convenience_methods][:date][:xpath_relative].should == 'oxns:namePart[@type="date"]'
+      FakeOxMods.properties[:name_][:convenience_methods][:date][:xpath_constrained].should == '//oxns:name[contains(oxns:namePart[@type="date"], "#{constraint_value}")]'.gsub('"', '\"')      
+            
+      FakeOxMods.properties[:person][:convenience_methods][:date][:xpath].should == '//oxns:name[@type="personal"]/oxns:namePart[@type="date"]'
+      FakeOxMods.properties[:person][:convenience_methods][:date][:xpath_relative].should == 'oxns:namePart[@type="date"]'      
+      FakeOxMods.properties[:person][:convenience_methods][:date][:xpath_constrained].should == '//oxns:name[@type="personal" and contains(oxns:namePart[@type="date"], "#{constraint_value}")]'.gsub('"', '\"')
+          
+    end
+    
+    it "constructs xpath queries & templates for subelements too" do
+      FakeOxMods.properties[:person][:convenience_methods][:displayForm][:xpath].should == '//oxns:name[@type="personal"]/oxns:displayForm'
+      FakeOxMods.properties[:person][:convenience_methods][:displayForm][:xpath_relative].should == 'oxns:displayForm'      
+      FakeOxMods.properties[:person][:convenience_methods][:displayForm][:xpath_constrained].should == '//oxns:name[@type="personal" and contains(oxns:displayForm, "#{constraint_value}")]'.gsub('"', '\"')
+    end
+    
+    it "supports subelements that are specified as separate properties" do
+      FakeOxMods.properties[:name_][:convenience_methods][:role][:xpath].should == '//oxns:name/oxns:role'
+      FakeOxMods.properties[:name_][:convenience_methods][:role][:xpath_relative].should == 'oxns:role'
+      FakeOxMods.properties[:name_][:convenience_methods][:role][:xpath_constrained].should == '//oxns:name[contains(oxns:role/oxns:roleTerm, "#{constraint_value}")]'.gsub('"', '\"')
+    end
+    
+    it "should not overwrite default property info when adding a variant property" do
+      FakeOxMods.properties[:name_].should_not equal(FakeOxMods.properties[:person])
+      FakeOxMods.properties[:name_][:convenience_methods].should_not equal(FakeOxMods.properties[:person][:convenience_methods])
+
+      FakeOxMods.properties[:name_][:xpath].should_not == FakeOxMods.properties[:person][:xpath]
+      FakeOxMods.properties[:name_][:convenience_methods][:date][:xpath_constrained].should_not == FakeOxMods.properties[:person][:convenience_methods][:date][:xpath_constrained]
+    end
+  
+  end
+  
+  describe ".lookup"  do
+    
+    it "uses the generated xpath queries" do
+      @fixturemods.expects(:xpath).with('//oxns:name[@type="personal"]', @fixturemods.ox_namespaces)
+      @fixturemods.lookup(:person)
+      
+      @fixturemods.expects(:xpath).with('//oxns:name[@type="personal" and contains(oxns:namePart, "Beethoven, Ludwig van")]', @fixturemods.ox_namespaces)
+      @fixturemods.lookup(:person, "Beethoven, Ludwig van")
+      
+      @fixturemods.expects(:xpath).with('//oxns:name[@type="personal" and contains(oxns:namePart[@type="date"], "2010")]', @fixturemods.ox_namespaces)
+      @fixturemods.lookup(:person, :date=>"2010")
+      
+      @fixturemods.expects(:xpath).with('//oxns:name[@type="personal" and contains(oxns:role/oxns:roleTerm, "donor")]', @fixturemods.ox_namespaces)
+      @fixturemods.lookup(:person, :role=>"donor")
+      
+      # @fixturemods.expects(:xpath).with('//oxns:name[@type="personal"]/oxns:namePart[@type="date"]', @fixturemods.ox_namespaces)
+      # @fixturemods.lookup([:person,:date])
+      
+      # @fixturemods.expects(:xpath).with('//oxns:name[contains(oxns:namePart[@type="date"], "2010")]', @fixturemods.ox_namespaces)
+      # @fixturemods.lookup([:person,:date], "2010")
+    end
+  
+  end
+  
+  describe ".xpath_query_for" do
+
+    it "retrieves the generated xpath query to match your desires" do    
+      @fixturemods.xpath_query_for(:person).should == '//oxns:name[@type="personal"]'
+          
+      @fixturemods.xpath_query_for(:person, "Beethoven, Ludwig van").should == '//oxns:name[@type="personal" and contains(oxns:namePart, "Beethoven, Ludwig van")]'
+          
+      @fixturemods.xpath_query_for(:person, :date=>"2010").should == '//oxns:name[@type="personal" and contains(oxns:namePart[@type="date"], "2010")]'
+          
+      @fixturemods.xpath_query_for(:person, :role=>"donor").should == '//oxns:name[@type="personal" and contains(oxns:role/oxns:roleTerm, "donor")]'
+          
+      @fixturemods.xpath_query_for([:person,:date]).should == '//oxns:name[@type="personal"]/oxns:namePart[@type="date"]'
+          
+      @fixturemods.xpath_query_for([:person,:date], "2010").should == '//oxns:name[@type="personal" and contains(oxns:namePart[@type="date"], "2010")]'
+    end
+    
+    it "parrots any strings back to you (in case you already have an xpath query)" do
+      @fixturemods.xpath_query_for('//oxns:name[@type="personal"]/oxns:namePart[@type="date"]').should == '//oxns:name[@type="personal"]/oxns:namePart[@type="date"]'
+    end
+    
+  end
+  
+  describe "#generate_xpath" do
+    it "should generate an xpath query from the options in the provided hash and should support generating xpaths with constraint values" do
+      opts1 = {:path=>"name", :default_content_path=>"namePart"}
+      opts2 = {:path=>"originInfo"}
+      opts3 = {:path=>["name", "namePart"]}
+      FakeOxMods.generate_xpath( opts1 ).should == '//oxns:name'
+      FakeOxMods.generate_xpath( opts1, :constraints=>:default ).should == '//oxns:name[contains(oxns:namePart, "#{constraint_value}")]'
+      FakeOxMods.generate_xpath( opts2, :constraints=>:default ).should == '//oxns:originInfo[contains("#{constraint_value}")]'
+
+      FakeOxMods.generate_xpath( opts1, :variations=>{:attributes=>{:type=>"personal"}} ).should == '//oxns:name[@type="personal"]'
+      FakeOxMods.generate_xpath( opts1, :variations=>{:attributes=>{:type=>"personal"}}, :constraints=>:default ).should == '//oxns:name[@type="personal" and contains(oxns:namePart, "#{constraint_value}")]'
+             
+      FakeOxMods.generate_xpath( opts1, :constraints=>{:path=>"namePart", :attributes=>{:type=>"date"}} ).should == '//oxns:name[contains(oxns:namePart[@type="date"], "#{constraint_value}")]'
+      FakeOxMods.generate_xpath( opts1, :constraints=>{:path=>"namePart", :attributes=>{:type=>"date"}}, :variations=>{:attributes=>{:type=>"personal"}} ).should == '//oxns:name[@type="personal" and contains(oxns:namePart[@type="date"], "#{constraint_value}")]'
+      FakeOxMods.generate_xpath(FakeOxMods.properties[:person], :variations=>{:attributes=>{:type=>"personal"}}, :constraints=>{:path=>"role", :default_content_path=>"roleTerm"}, :subelement_of=>":person").should == '//oxns:name[@type="personal" and contains(oxns:role/oxns:roleTerm, "#{constraint_value}")]'
+      
+      FakeOxMods.generate_xpath(opts1,  :variations=>{:attributes=>{:type=>"personal"}, :subelement_path=>"displayForm" } ).should == '//oxns:name[@type="personal"]/oxns:displayForm'
+      FakeOxMods.generate_xpath(opts1,  :variations=>{:attributes=>{:type=>"personal"}}, :constraints=>{:path=>"displayForm"} ).should == '//oxns:name[@type="personal" and contains(oxns:displayForm, "#{constraint_value}")]'
+      FakeOxMods.generate_xpath(opts1,  :variations=>{:attributes=>{:type=>"personal"}, :subelement_path=>["role", "roleTerm"] } ).should == '//oxns:name[@type="personal"]/oxns:role/oxns:roleTerm'
+      
+      FakeOxMods.generate_xpath( opts3, :variations=>{:attributes=>{:type=>"date"}} ).should == '//oxns:name/oxns:namePart[@type="date"]'
+    end
+    
+    it "should support relative paths" do
+      relative_opts = {:path=>"namePart"}
+      FakeOxMods.generate_xpath( relative_opts, :variations=>{:attributes=>{:type=>"date"}}, :relative=>true).should == 'oxns:namePart[@type="date"]'
+    end
+    
+    it "should work with real properties hashes" do
+      FakeOxMods.generate_xpath(FakeOxMods.properties[:person], :variations=>FakeOxMods.properties[:person]).should == "//oxns:name[@type=\"personal\"]"
+      FakeOxMods.generate_xpath(FakeOxMods.properties[:person], :variations=>FakeOxMods.properties[:person], :constraints=>{:path=>"role", :default_content_path=>"roleTerm"}, :subelement_of=>":person").should == '//oxns:name[@type="personal" and contains(oxns:role/oxns:roleTerm, "#{constraint_value}")]'
+      date_hash = FakeOxMods.properties[:person][:convenience_methods][:date]
+      FakeOxMods.generate_xpath( date_hash, :variations=>date_hash, :relative=>true ).should == 'oxns:namePart[@type="date"]'
+    end
+    
+    it "should support custom templates" do
+      opts = {:path=>"name", :default_content_path=>"namePart"}
+      FakeOxMods.generate_xpath( opts, :template=>'/#{prefix}:sampleNode/#{prefix}:#{path}[contains(#{default_content_path}, \":::constraint_value:::\")]' ).should == '/oxns:sampleNode/oxns:name[contains(namePart, "#{constraint_value}")]'      
+    end
+  end
+  
+  describe "#builder_template" do
+    
+    it "should generate a template call for passing into the builder block (assumes 'xml' as the argument for the block)" do
+      FakeOxMods.builder_template([:person,:date]).should == 'xml.namePart( \'#{builder_new_value}\', :type=>\'date\' )'
+      FakeOxMods.builder_template([:name_,:affiliation]).should == 'xml.affiliation( \'#{builder_new_value}\' )'
+      
+      simple_role_builder_template = 'xml.role( :type=>\'text\' ) { xml.roleTerm( \'#{builder_new_value}\' ) }'  
+      FakeOxMods.builder_template([:role]).should == simple_role_builder_template
+      FakeOxMods.builder_template([:person,:role]).should == simple_role_builder_template
+      
+      marcrelator_role_builder_template = 'xml.role( :type=>\'code\', :authority=>\'marcrelator\' ) { xml.roleTerm( \'#{builder_new_value}\' ) }'  
+      FakeOxMods.builder_template([:role], {:attributes=>{"type"=>"code", "authority"=>"marcrelator"}} ).should == marcrelator_role_builder_template
+      FakeOxMods.builder_template([:person,:role], {:attributes=>{"type"=>"code", "authority"=>"marcrelator"}} ).should == marcrelator_role_builder_template
+    end
+    
+  end
+  
+  describe "#applicable_attributes" do
+    it "returns a Hash where all of the values are strings" do
+      FakeOxMods.send(:applicable_attributes, {:type=>"date"} ).should == {:type=>"date"} 
+      FakeOxMods.send(:applicable_attributes, ["authority", {:type=>["text","code"]}] ).should == {:type=>"text"} 
+    end
+  end
+  
+  ## Validation Support 
+  # Some of these tests fail when you don't have an internet connection because the mods schema includes other xsd schemas by URL reference.
+  
+  describe "#schema" do
+    it "should return an instance of Nokogiri::XML::Schema loaded from the schema url -- fails if no internet connection" do
+      FakeOxMods.schema.should be_kind_of Nokogiri::XML::Schema
+    end
+  end
+  
+  describe "#validate" do
+    it "should validate the provided document against the schema provided in class definition  -- fails if no internet connection" do
+      FakeOxMods.schema.expects(:validate).with(@fixturemods).returns([])
+      FakeOxMods.validate(@fixturemods)
+    end
+  end
+  
+  describe ".validate" do
+    it "should rely on class validate method" do
+      FakeOxMods.expects(:validate).with(@fixturemods)
+      @fixturemods.validate
+    end
+  end
+  
+  describe "#schema_file" do
+    before(:all) do
+      FakeOxMods.schema_file = nil
+    end
+    
+    after(:all) do
+      FakeOxMods.schema_file = fixture("mods-3-2.xsd")
+    end
+    
+    it "should lazy load the schema file from the @schema_url" do
+      FakeOxMods.instance_variable_get(:@schema_file).should be_nil
+      FakeOxMods.expects(:file_from_url).with(FakeOxMods.schema_url).returns("fake file").once
+      FakeOxMods.schema_file
+      FakeOxMods.instance_variable_get(:@schema_file).should == "fake file"
+      FakeOxMods.schema_file.should == "fake file"
+    end
+  end
+  
+  describe "#file_from_url" do
+    it "should retrieve a file from the provided url over HTTP" do
+      FakeOxMods.send(:file_from_url, "http://google.com")
+    end
+    it "should raise an error if the url is invalid" do
+      lambda {FakeOxMods.send(:file_from_url, "")}.should raise_error(RuntimeError, "Could not retrieve file from . Error: No such file or directory - ")
+      lambda {FakeOxMods.send(:file_from_url, "foo")}.should raise_error(RuntimeError, "Could not retrieve file from foo. Error: No such file or directory - foo")
+    end
+    it "should raise an error if file retrieval fails" do
+      lambda {FakeOxMods.send(:file_from_url, "http://fedora-commons.org/nonexistent_file")}.should raise_error(RuntimeError, "Could not retrieve file from http://fedora-commons.org/nonexistent_file. Error: 404 Not Found")  
+    end
+  end
+   
+end