om 0.1.0

data/spec/unit/property_value_operators_spec.rb

@@ -0,0 +1,245 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require "om"
+
+describe "OM::XML::PropertyValueOperators" do
+  
+  before(:all) do
+    #ModsHelpers.name_("Beethoven, Ludwig van", :date=>"1770-1827", :role=>"creator")
+    class PropertiesValueOperatorsTest 
+      
+      include OM::XML::Container     
+      include OM::XML::Properties
+      include OM::XML::PropertyValueOperators      
+      
+      # 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
+    @sample = PropertiesValueOperatorsTest.from_xml( fixture( File.join("test_dummy_mods.xml") ) )
+  end
+  
+  after(:all) do
+    Object.send(:remove_const, :PropertiesValueOperatorsTest)
+  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]
+      @sample.expects(:lookup).with(lookup_opts).returns(mock_nodeset)
+      
+      @sample.property_values(lookup_opts).should == ["sample value","sample value","sample value"]
+    end
+  
+  end
+  
+  describe ".property_values_append" do
+	
+  	it "looks up the parent using :parent_select, uses :child_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      
+	    @sample.property_values_append(
+        :parent_select => [:person, {:given_name=>"Tim", :family_name=>"Berners-Lee"}] ,
+        :child_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:role>
+          <ns3:roleTerm type="text" authority="marcrelator">creator</ns3:roleTerm>
+          <ns3:roleTerm type="code" authority="marcrelator">cre</ns3:roleTerm>
+      </ns3:role>
+  <ns3:affiliation>my new value</ns3:affiliation><ns3:affiliation>another new value</ns3:affiliation></ns3:name>'
+      
+	    @sample.property_values_append(
+        :parent_select => [:person, {:given_name=>"Tim", :family_name=>"Berners-Lee"}] ,
+        :child_index => :first,
+        :template => [:person, :affiliation],
+        :values => ["my new value", "another new value"] 
+      ).to_xml.should == expected_result
+      
+      @sample.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>\n          <ns3:roleTerm type=\"text\" authority=\"marcrelator\">creator</ns3:roleTerm>\n          <ns3:roleTerm type=\"code\" authority=\"marcrelator\">cre</ns3:roleTerm>\n      </ns3:role>\n      <ns3:role>\n          <ns3:roleTerm type=\"text\" authority=\"marcrelator\">visionary</ns3:roleTerm>\n          <ns3:roleTerm type=\"code\" authority=\"marcrelator\">vry</ns3:roleTerm>\n      </ns3:role>\n  <ns3:role type=\"text\"><ns3:roleTerm>my role</ns3:roleTerm></ns3:role></ns3:name>"
+      
+      @sample.property_values_append(
+        :parent_select => :person ,
+        :child_index => 3,
+        :template => :role,
+        :values => "my role" 
+      ).to_xml.should == expected_result
+
+      @sample.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>\n          <ns3:roleTerm type=\"text\" authority=\"marcrelator\">creator</ns3:roleTerm>\n          <ns3:roleTerm type=\"code\" authority=\"marcrelator\">cre</ns3:roleTerm>\n      </ns3:role>\n  <ns3:role type=\"code\" authority=\"marcrelator\"><ns3:roleTerm>creator</ns3:roleTerm></ns3:role></ns3:name>"
+      
+      @sample.ng_xml.xpath('//oxns:name[@type="personal" and position()=1]/oxns:role', @sample.ox_namespaces).length.should == 1
+      
+      @sample.property_values_append(
+        :parent_select =>'//oxns:name[@type="personal"]',
+        :child_index => 0,
+        :template => 'xml.role { xml.roleTerm( \'#{builder_new_value}\', :type=>\'code\', :authority=>\'marcrelator\') }',
+        :values => "founder" 
+      )
+
+      @sample.ng_xml.xpath('//oxns:name[@type="personal" and position()=1]/oxns:role', @sample.ox_namespaces).length.should == 2
+      @sample.ng_xml.xpath('//oxns:name[@type="personal" and position()=1]/oxns:role[last()]/oxns:roleTerm', @sample.ox_namespaces).first.text.should == "founder"
+
+      # @sample.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:namePart type=\"date\">2004</ns3:namePart>\n      <ns3:role>\n          <ns3:roleTerm type=\"text\" authority=\"marcrelator\">creator</ns3:roleTerm>\n          <ns3:roleTerm type=\"code\" authority=\"marcrelator\">cre</ns3:roleTerm>\n      </ns3:role>\n  <ns3:role type=\"code\" authority=\"marcrelator\"><ns3:roleTerm>foo</ns3:roleTerm></ns3:role></ns3:name>"
+
+      @sample.ng_xml.xpath('//oxns:name[@type="personal" and position()=2]/oxns:role', @sample.ox_namespaces).length.should == 1
+      
+	    @sample.property_values_append(
+        :parent_select =>'//oxns:name[@type="personal"]',
+        :child_index => 1,
+        :template => [ :person, :role, {:attributes=>{"type"=>"code", "authority"=>"marcrelator"}} ],
+        :values => "foo" 
+      )
+
+      @sample.ng_xml.xpath('//oxns:name[@type="personal" and position()=2]/oxns:role', @sample.ox_namespaces).length.should == 2
+      @sample.lookup(:person)[1].search("./oxns:role[last()]/oxns:roleTerm", @sample.ox_namespaces).first.text.should == "foo"
+	  end
+	  
+	  it "should raise exception if no node corresponds to the provided :parent_select and :child_index"
+  	
+  end
+  
+  describe ".property_value_update" do
+
+    it "should accept an xpath as :parent_select" do
+	    sample_xpath = '//oxns:name[@type="personal"]/oxns:role/oxns:roleTerm[@type="text"]'
+	    @sample.property_value_update(      
+        :parent_select =>sample_xpath,
+        :child_index => 1,
+        :value => "donor"
+      )
+      @sample.ng_xml.xpath(sample_xpath, @sample.ox_namespaces)[1].text.should == "donor"
+    end
+    
+    it "if :select is provided, should update the first node provided by that xpath statement" do
+      sample_xpath = '//oxns:name[@type="personal" and position()=1]/oxns:namePart[@type="given"]'
+      @sample.property_value_update(
+        :select =>sample_xpath,
+        :value => "Timmeh"
+      )
+      @sample.ng_xml.xpath(sample_xpath, @sample.ox_namespaces).first.text.should == "Timmeh"
+    end
+    
+    it "should replace the existing node if you pass a template and values" do
+      pending
+      @sample.property_value_update(
+        :parent_select =>'//oxns:name[@type="personal"]',
+        :child_index => 1,
+        :template => [ :person, :role, {:attributes=>{"type"=>"code", "authority"=>"marcrelator"}} ],
+        :value => "foo"
+      )
+      1.should == 2
+    end
+  end
+  
+  describe ".property_value_delete" do
+    it "should accept an xpath query as :select option" do
+      generic_xpath = '//oxns:name[@type="personal" and position()=4]/oxns:role'
+      specific_xpath = '//oxns:name[@type="personal" and position()=4]/oxns:role[oxns:roleTerm="visionary"]'
+      select_xpath = '//oxns:name[@type="personal" and position()=4]/oxns:role[last()]'
+      
+      # Check that we're starting with 2 roles
+      # Check that the specific node we want to delete exists
+      @sample.lookup(generic_xpath).length.should == 2
+      @sample.lookup(specific_xpath).length.should == 1
+
+      @sample.property_value_delete(
+        :select =>select_xpath
+      )
+      # Check that we're finishing with 1 role
+      @sample.lookup(generic_xpath).length.should == 1
+      # Check that the specific node we want to delete no longer exists
+      @sample.lookup(specific_xpath).length.should == 0
+    end 
+    it "should accept :parent_select, :parent_index and :child_index options instead of a :select" do
+            
+      generic_xpath = '//oxns:name[@type="personal" and position()=4]/oxns:role/oxns:roleTerm'
+      specific_xpath = '//oxns:name[@type="personal" and position()=4]/oxns:role[oxns:roleTerm="visionary"]'
+      
+      # Check that we're starting with 2 roles
+      # Check that the specific node we want to delete exists
+      @sample.lookup(generic_xpath).length.should == 4
+      @sample.lookup(specific_xpath).length.should == 1
+
+      # this is attempting to delete the last child (in this case roleTerm) from the 3rd role in the document. 
+      @sample.property_value_delete(
+        :parent_select => [:person, :role],
+        :parent_index => 3,
+        :child_index => :last
+      )
+      
+      # Check that we're finishing with 1 role
+      @sample.lookup(generic_xpath).length.should == 3
+      # Check that the specific node we want to delete no longer exists
+      @sample.lookup(specific_xpath).length.should == 1
+    end
+    it "should work if only :parent_select and :child_index are provided" do
+      generic_xpath = '//oxns:name[@type="personal"]/oxns:role'
+      # specific_xpath = '//oxns:name[@type="personal"]/oxns:role'
+      
+      # Check that we're starting with 2 roles
+      # Check that the specific node we want to delete exists
+      @sample.lookup(generic_xpath).length.should == 4
+      # @sample.lookup(specific_xpath).length.should == 1
+
+      @sample.property_value_delete(
+        :parent_select => [:person, :role],
+        :child_index => 3
+      )
+      # Check that we're finishing with 1 role
+      @sample.lookup(generic_xpath).length.should == 3
+    end
+  end
+  
+end

data/spec/unit/validation_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require "nokogiri"
+require "om"
+
+describe "OM::XML::Validation" do
+  
+  before(:all) do
+    class ValidationTest
+      include OM::XML::Container
+      include OM::XML::Validation
+      self.schema_url = "http://www.loc.gov/standards/mods/v3/mods-3-2.xsd"
+    end
+  end
+  
+  before(:each) do
+    @sample = ValidationTest.from_xml("<foo><bar>1</bar></foo>")
+  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_url' do
+    it "should allow you to set the schema url" do
+      ValidationTest.schema_url.should == "http://www.loc.gov/standards/mods/v3/mods-3-2.xsd"
+    end
+  end
+  
+  describe "#schema" do
+    it "should return an instance of Nokogiri::XML::Schema loaded from the schema url -- fails if no internet connection" do
+      ValidationTest.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
+      ValidationTest.schema.expects(:validate).with(@sample).returns([])
+      ValidationTest.validate(@sample)
+    end
+  end
+
+  describe ".validate" do
+    it "should rely on class validate method" do
+      ValidationTest.expects(:validate).with(@sample)
+      @sample.validate
+    end
+  end
+
+  describe "#schema_file" do
+    before(:all) do
+      ValidationTest.schema_file = nil
+    end
+  
+    after(:all) do
+      ValidationTest.schema_file = fixture("mods-3-2.xsd")
+    end
+  
+    it "should lazy load the schema file from the @schema_url" do
+      ValidationTest.instance_variable_get(:@schema_file).should be_nil
+      ValidationTest.expects(:file_from_url).with(ValidationTest.schema_url).returns("fake file").once
+      ValidationTest.schema_file
+      ValidationTest.instance_variable_get(:@schema_file).should == "fake file"
+      ValidationTest.schema_file.should == "fake file"
+    end
+  end
+
+  describe "#file_from_url" do
+    it "should retrieve a file from the provided url over HTTP" do
+      ValidationTest.send(:file_from_url, "http://google.com")
+    end
+    it "should raise an error if the url is invalid" do
+      lambda {ValidationTest.send(:file_from_url, "")}.should raise_error(RuntimeError, "Could not retrieve file from . Error: No such file or directory - ")
+      lambda {ValidationTest.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 {ValidationTest.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

data/spec/unit/xml_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require "nokogiri"
+require "om"
+
+describe "OM::XML::Container" do
+  
+  before(:all) do
+    class XMLTest
+      include OM::XML
+    end
+  end
+  
+  
+  it "should automatically include the other modules" do
+    XMLTest.included_modules.should include(OM::XML::Container)
+    XMLTest.included_modules.should include(OM::XML::Accessors)
+    XMLTest.included_modules.should include(OM::XML::Validation)
+    XMLTest.included_modules.should include(OM::XML::Properties)
+    XMLTest.included_modules.should include(OM::XML::PropertyValueOperators)
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification 
+name: om
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matt Zumwalt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-20 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: facets
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        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 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        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 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: "OM (Opinionated Metadata): 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/om.rb
+- lib/om/xml.rb
+- lib/om/xml/accessors.rb
+- lib/om/xml/container.rb
+- lib/om/xml/properties.rb
+- lib/om/xml/property_value_operators.rb
+- lib/om/xml/validation.rb
+- om.gemspec
+- spec/fixtures/CBF_MODS/ARS0025_016.xml
+- spec/fixtures/RUBRIC_mods_article_template.xml
+- spec/fixtures/mods-3-2.xsd
+- spec/fixtures/mods_articles/hydrangea_article1.xml
+- spec/fixtures/test_dummy_mods.xml
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/unit/accessors_spec.rb
+- spec/unit/container_spec.rb
+- spec/unit/properties_spec.rb
+- spec/unit/property_value_operators_spec.rb
+- spec/unit/validation_spec.rb
+- spec/unit/xml_spec.rb
+has_rdoc: true
+homepage: http://github.com/mediashelf/om
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "OM (Opinionated Metadata): A library to help you tame sprawling XML schemas like MODS."
+test_files: 
+- spec/spec_helper.rb
+- spec/unit/accessors_spec.rb
+- spec/unit/container_spec.rb
+- spec/unit/properties_spec.rb
+- spec/unit/property_value_operators_spec.rb
+- spec/unit/validation_spec.rb
+- spec/unit/xml_spec.rb