opinionated-xml 0.0.1 → 0.1.0

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

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: opinionated-xml
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Matt Zumwalt
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-16 00:00:00 -05:00
+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"
@@ -33,9 +36,11 @@ dependencies:
   name: facets
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,9 +50,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -59,9 +66,11 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 43
         segments: 
         - 0
         - 9
@@ -73,9 +82,11 @@ dependencies:
   name: ruby-debug
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -98,18 +109,27 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- lib/opinionated-xml.rb
-- lib/opinionated-xml/ox.rb
-- lib/opinionated-xml/ox_property_values_helper.rb
+- 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
 - opinionated-xml.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/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
+- 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/opinionated-xml
 licenses: []
@@ -120,28 +140,35 @@ rdoc_options:
 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.6
+rubygems_version: 1.3.7
 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
+- 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

data/lib/opinionated-xml.rb

@@ -1,9 +0,0 @@
-require 'rubygems'
-
-require 'nokogiri'
-require "facets"
-
-module OX; end
-
-require "opinionated-xml/ox_property_values_helper"
-require File.join(File.dirname(__FILE__), 'opinionated-xml', 'ox.rb')

data/lib/opinionated-xml/ox_property_values_helper.rb

@@ -1,62 +0,0 @@
-require "open-uri"
-require "logger"
-
-class OX::ParentNodeNotFoundError < RuntimeError; end
-module OX::PropertyValuesHelper
-  
-  def property_values(lookup_args)
-    result = []
-    lookup(lookup_args).each {|node| result << node.text }
-    return result
-  end
-  
-  def property_values_append(opts={})
-    parent_select = opts[:parent_select] 
-    parent_index = opts[:parent_index]
-    template = opts[:template]
-    new_values = opts[:values]
-    
-    # If template is a string, use it as the template, otherwise use it as arguments to builder_template
-    unless template.instance_of?(String)
-      template_args = Array(template)
-      if template_args.last.kind_of?(Hash)
-        template_opts = template_args.delete_at(template_args.length - 1)
-      else
-        template_opts = {}
-      end
-      template = self.class.builder_template( template_args, template_opts )
-    end
-    
-    new_values = Array(new_values)
-    # template = self.class.builder_template(property_ref) 
-    
-    parent_select = Array(parent_select)
-    parent_nodeset = lookup(parent_select[0], parent_select[1])
-    
-    if parent_index.kind_of?(Integer)
-      parent_node = parent_nodeset[parent_index]
-    elsif parent_index.kind_of?(Symbol) && parent_nodeset.respond_to?(parent_index) 
-      parent_node = parent_nodeset.send(parent_index)
-    end
-    
-    if parent_node.nil?
-      raise OX::ParentNodeNotFoundError, "Failed to find a parent node to insert values into based on :parent_select #{parent_select.inspect} with :parent_index #{parent_index.inspect}"
-    end
-    
-    builder = Nokogiri::XML::Builder.with(parent_node) do |xml|
-      new_values.each do |builder_new_value|
-        builder_arg = eval('"'+ template + '"') # this inserts builder_new_value into the builder template
-        eval(builder_arg)
-      end
-    end
-        
-    # Nokogiri::XML::Node.new(builder.to_xml, foo)
-    
-    return parent_node
-    
-  end
-  
-  def property_value_set(property_ref, query_opts, node_index, new_value)
-  end
-  
-end

data/spec/helpers/ox_property_values_helper_spec.rb

@@ -1,55 +0,0 @@
-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/unit/ox_integration_spec.rb

@@ -1,124 +0,0 @@
-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