om 0.1.4 → 0.1.5

data/History.textile

@@ -1,3 +1,9 @@
+0.1.5
+
+* root_property now inserts an entry into the properties hash
+* added .generate method for building new instances of declared properties
+* refinements to accessor_xpath
+
 0.1.4
 
 *  made attribute_xpath idempotent

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/lib/om/xml/accessors.rb

@@ -83,7 +83,11 @@ module OM::XML::Accessors
         # key_index = keys.index(k)
         pointer_index = pointers.index(pointer)
         # accessor_info = accessor_info(*keys[0..key_index])
-        accessor_info = accessor_info(*keys)        
+        accessor_info = accessor_info(*keys)  
+        
+        # Return nil if there is no accessor info to work with
+        if accessor_info.nil? then return nil end
+                
         relative_path = accessor_info[:relative_xpath]
         
         if relative_path.kind_of?(Hash)

data/lib/om/xml/generator.rb

@@ -0,0 +1,26 @@
+module OM::XML::Generator
+  
+  attr_accessor :ng_xml
+  
+  # Class Methods -- These methods will be available on classes that include this Module 
+  
+  module ClassMethods
+    
+    def generate(property_ref, builder_new_value, opts={})
+      template = builder_template(property_ref, opts)
+      builder_call_body = eval('"' + template + '"')
+      builder = Nokogiri::XML::Builder.new do |xml|
+        eval( builder_call_body )
+      end
+      
+      return builder.doc
+    end
+    
+  end
+  
+  # Instance Methods -- These methods will be available on instances of classes that include this module
+  
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+end

data/lib/om/xml/properties.rb

@@ -9,7 +9,7 @@ module OM::XML::Properties
     attr_reader :properties
     
     def root_property( property_ref, path, namespace, opts={})
-      # property property_ref, path, opts.merge({:path=>path, :ref=>property_ref})
+      property property_ref, opts.merge({:path=>path, :ref=>property_ref})
       @root_config = opts.merge({:namespace=>namespace, :path=>path, :ref=>property_ref})
       @root_property_ref = property_ref
       @ox_namespaces = {'oxns'=>root_config[:namespace]}
@@ -69,7 +69,7 @@ module OM::XML::Properties
         end
       end
       
-      if properties[:unresolved].has_key?(prop_hash[:ref])
+      if properties.fetch(:unresolved, {}).has_key?(prop_hash[:ref])
         ref = prop_hash[:ref]
         properties[:unresolved][ref].each do |parent_prop_hash|
           logger.debug "Resolving #{ref} subelement for #{parent_prop_hash[:ref]} property"
@@ -276,6 +276,8 @@ module OM::XML::Properties
     # Builder Support
     #
     
+    # @property_ref reference to the property you want to generate a builder template for
+    # @opts
     def builder_template(property_ref, opts={})
       property_info = property_info_for(property_ref)
 

data/lib/om/xml.rb

@@ -3,6 +3,7 @@ require "om/xml/accessors"
 require "om/xml/validation"
 require "om/xml/properties"
 require "om/xml/property_value_operators"
+require "om/xml/generator"
 
 module OM::XML
   
@@ -16,6 +17,7 @@ module OM::XML
     klass.send(:include, OM::XML::Validation)
     klass.send(:include, OM::XML::Properties)
     klass.send(:include, OM::XML::PropertyValueOperators)
+    klass.send(:include, OM::XML::Generator)
 
     # klass.send(:include, OM::XML::Schema)
   end

data/om.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{om}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Zumwalt"]
-  s.date = %q{2010-06-21}
+  s.date = %q{2010-06-23}
   s.description = %q{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}
   s.email = %q{matt.zumwalt@yourmediashelf.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "lib/om/xml.rb",
      "lib/om/xml/accessors.rb",
      "lib/om/xml/container.rb",
+     "lib/om/xml/generator.rb",
      "lib/om/xml/properties.rb",
      "lib/om/xml/property_value_operators.rb",
      "lib/om/xml/validation.rb",
@@ -41,6 +42,7 @@ Gem::Specification.new do |s|
      "spec/spec_helper.rb",
      "spec/unit/accessors_spec.rb",
      "spec/unit/container_spec.rb",
+     "spec/unit/generator_spec.rb",
      "spec/unit/properties_spec.rb",
      "spec/unit/property_value_operators_spec.rb",
      "spec/unit/validation_spec.rb",
@@ -55,6 +57,7 @@ Gem::Specification.new do |s|
     "spec/spec_helper.rb",
      "spec/unit/accessors_spec.rb",
      "spec/unit/container_spec.rb",
+     "spec/unit/generator_spec.rb",
      "spec/unit/properties_spec.rb",
      "spec/unit/property_value_operators_spec.rb",
      "spec/unit/validation_spec.rb",

data/spec/unit/accessors_spec.rb

@@ -132,6 +132,9 @@ describe "OM::XML::Accessors" do
     it "should prepend the xpath for any parent nodes, inserting calls to xpath:position() function where necessary" do
       AccessorTest.accessor_xpath( {:conference=>0}, {:role=>1}, :text ).should == '//oxns:name[@type="conference" and position()=1]/oxns:role[position()=2]/oxns:roleTerm[@type="text"]'
     end
+    it "should return nil if no accessor_info is available" do
+      AccessorTest.accessor_xpath( :sample_undeclared_accessor ).should == nil
+    end
     it "should be idempotent" do
       AccessorTest.accessor_xpath( *[{:title_info=>2}, :main_title] ).should == "//oxns:titleInfo[position()=3]/oxns:title"
       AccessorTest.accessor_xpath( *[{:title_info=>2}, :main_title] ).should == "//oxns:titleInfo[position()=3]/oxns:title"

data/spec/unit/generator_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require "om"
+
+describe "OM::XML::Generator" do
+  
+  before(:all) do
+    #ModsHelpers.name_("Beethoven, Ludwig van", :date=>"1770-1827", :role=>"creator")
+    class GeneratorTest 
+      
+      include OM::XML::Container     
+      include OM::XML::Properties
+      include OM::XML::Generator      
+      
+      # 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 = GeneratorTest.from_xml( fixture( File.join("test_dummy_mods.xml") ) )
+  end
+  
+  after(:all) do
+    Object.send(:remove_const, :GeneratorTest)
+  end
+  
+  describe '#generate' do
+    it "should use the corresponding builder template(s) to generate the node" do
+      GeneratorTest.generate(:mods, "foo").root.to_xml.should == "<mods>foo</mods>"
+      GeneratorTest.generate([:person,:role], "creator", {:attributes=>{"type"=>"code", "authority"=>"marcrelator"}}).root.to_xml.should == "<role type=\"code\" authority=\"marcrelator\">\n  <roleTerm>creator</roleTerm>\n</role>"
+    end
+    it "should return Nokogiri Documents" do
+      GeneratorTest.generate(:mods, "foo").class.should == Nokogiri::XML::Document
+    end
+  end
+  
+end

data/spec/unit/properties_spec.rb

@@ -74,6 +74,10 @@ describe "OM::XML::Properties" do
       FakeOtherOx.root_property_ref.should == :other
       FakeOtherOx.root_config.should == {:namespace=>"http://www.foo.com", :path=>"other", :ref=>:other}
     end
+    it "should add a corresponding entry into the properties hash" do
+      FakeOxMods.property_info_for(FakeOxMods.root_property_ref).should == {:schema=>"http://www.loc.gov/standards/mods/v3/mods-3-2.xsd", :xpath_relative=>"oxns:mods", :path=>"mods", :xpath_constrained=>"//oxns:mods[contains(\\\"\#{constraint_value}\\\")]", :xpath=>"//oxns:mods", :ref=>:mods, :convenience_methods=>{}, :attributes=>["id", "version"]}
+      FakeOxMods.builder_template(FakeOxMods.root_property_ref).should == "xml.mods( '\#{builder_new_value}' )"
+    end
   end
   
   describe "#property" do
@@ -123,6 +127,16 @@ describe "OM::XML::Properties" do
       FakeOxMods.properties[:name_][:convenience_methods][:role][:xpath_constrained].should == '//oxns:name[contains(oxns:role/oxns:roleTerm, "#{constraint_value}")]'.gsub('"', '\"')
     end
     
+    it "should create an accessor for the created property" do
+      pending
+      FakeOXMods.accessors.should have_key(:name_)
+    end
+    
+    it "should create accessors for subelements" do
+      pending
+      FakeOXMods.accessors[:name_][:children][:role][:children].should have_key(:family_name)
+    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])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: om
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Matt Zumwalt
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-21 00:00:00 -05:00
+date: 2010-06-23 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -113,6 +113,7 @@ files:
 - lib/om/xml.rb
 - lib/om/xml/accessors.rb
 - lib/om/xml/container.rb
+- lib/om/xml/generator.rb
 - lib/om/xml/properties.rb
 - lib/om/xml/property_value_operators.rb
 - lib/om/xml/validation.rb
@@ -126,6 +127,7 @@ files:
 - spec/spec_helper.rb
 - spec/unit/accessors_spec.rb
 - spec/unit/container_spec.rb
+- spec/unit/generator_spec.rb
 - spec/unit/properties_spec.rb
 - spec/unit/property_value_operators_spec.rb
 - spec/unit/validation_spec.rb
@@ -168,6 +170,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/accessors_spec.rb
 - spec/unit/container_spec.rb
+- spec/unit/generator_spec.rb
 - spec/unit/properties_spec.rb
 - spec/unit/property_value_operators_spec.rb
 - spec/unit/validation_spec.rb