om 1.2.5 → 1.3.0

data/lib/om/samples/mods_article.rb

@@ -3,11 +3,15 @@ class OM::Samples::ModsArticle
     include OM::XML::Document
     
     set_terminology do |t|
-      t.root(:path=>"mods", :xmlns=>"http://www.loc.gov/mods/v3", :schema=>"http://www.loc.gov/standards/mods/v3/mods-3-2.xsd")
+      t.root(:path=>"mods", :xmlns=>"http://www.loc.gov/mods/v3", :schema=>"http://www.loc.gov/standards/mods/v3/mods-3-2.xsd", "xmlns:foo"=>"http://my.custom.namespace")
 
 
       t.title_info(:path=>"titleInfo") {
-        t.main_title(:index_as=>[:facetable],:path=>"title", :label=>"title")
+        t.main_title(:index_as=>[:facetable],:path=>"title", :label=>"title") {
+          t.main_title_lang(:path=>{:attribute=> "xml:lang"})
+        }
+        t.french_title(:ref=>[:title_info,:main_title], :attributes=>{"xml:lang"=>"fre"})
+        
         t.language(:index_as=>[:facetable],:path=>{:attribute=>"lang"})
       } 
       t.language{
@@ -71,8 +75,7 @@ class OM::Samples::ModsArticle
         t.url(:path=>"url")
       }
       t.publication_url(:proxy=>[:location,:url])
-      t.peer_reviewed(:proxy=>[:journal,:origin_info,:issuance], :index_as=>[:facetable])
-      t.title(:proxy=>[:mods,:title_info, :main_title])
+      t.title(:proxy=>[:title_info, :main_title])
       t.journal_title(:proxy=>[:journal, :title_info, :main_title])
     end
     

data/lib/om/version.rb

@@ -1,3 +1,3 @@
 module Om
-  VERSION = "1.2.5"
+  VERSION = "1.3.0"
 end

data/lib/om/xml/document.rb

@@ -57,8 +57,10 @@ module OM::XML::Document
   
 
   # +term_pointer+ Variable length array of values in format [:accessor_name, :accessor_name ...] or [{:accessor_name=>index}, :accessor_name ...]
-  # example: {:person => 1}, :first_name
-  # example: [:person, 1, :first_name]
+  # @example: 
+  #   find_by_terms( {:person => 1}, :first_name )
+  # @example
+  #   find_by_terms( [:person, 1, :first_name] )
   # Currently, indexes must be integers.
   def find_by_terms(*term_pointer)
     xpath = self.class.terminology.xpath_with_indexes(*term_pointer)   
@@ -68,6 +70,12 @@ module OM::XML::Document
       return ng_xml.xpath(xpath, ox_namespaces) 
     end   
   end
+  
+  # Test whether the document has a node corresponding to the given term_pointer
+  # @param [Array] term_pointer to test
+  def node_exists?(*term_pointer)
+    !find_by_terms(*term_pointer).empty?
+  end
 
   # Access the class's template registry
   def template_registry

data/lib/om/xml/named_term_proxy.rb

@@ -23,9 +23,14 @@ class OM::XML::NamedTermProxy
   
   def proxied_term
     if self.parent.nil?
-      self.terminology.retrieve_term(*self.proxy_pointer)
+      pt = self.terminology.retrieve_term(*self.proxy_pointer)
     else
-      self.parent.retrieve_term(*self.proxy_pointer)
+      pt = self.parent.retrieve_term(*self.proxy_pointer)
+    end
+    if pt.nil?
+      raise OM::XML::Terminology::BadPointerError "The #{name} proxy term points to #{proxy_pointer.inspect} but that term doesn't exist."
+    else
+      return pt
     end
   end
   

data/lib/om/xml/term.rb

@@ -1,5 +1,6 @@
-# Special options: data_type, attributes, index_as
-# is_root_term
+# Special options: 
+# data_type, index_as, attributes, 
+# is_root_term, required
 #
 class OM::XML::Term
   
@@ -38,12 +39,7 @@ class OM::XML::Term
         if self.terminology_builder.nil?
           raise "Cannot perform lookup_ref for the #{self.name} builder.  It doesn't have a reference to any terminology builder"
         end
-        begin
-          target = self.terminology_builder.retrieve_term_builder(*@settings[:ref])
-        rescue OM::XML::Terminology::BadPointerError
-          # Clarify message on BadPointerErrors
-          raise OM::XML::Terminology::BadPointerError, "#{self.name} refers to a Term Builder that doesn't exist.  The bad pointer is #{@settings[:ref].inspect}"
-        end
+        target = self.terminology_builder.retrieve_term_builder(*@settings[:ref])
         
         # Fail on circular references and return an intelligible error message
         if nodes_visited.include?(target)
@@ -216,7 +212,7 @@ class OM::XML::Term
     end
     if !self.attributes.nil?
       self.attributes.merge(extra_attributes).each_pair do |k,v|
-        node_options << ":#{k}=>\'#{v}\'"
+        node_options << "\'#{k}\'=>\'#{v}\'"
       end
     end
     template = "xml.#{self.path}( #{OM::XML.delimited_list(node_options)} )" + node_child_template
@@ -233,6 +229,60 @@ class OM::XML::Term
     return self
   end
   
+  # Return an XML representation of the Term
+  # @param [Hash] options, the term will be added to it. If :children=>false, skips rendering child Terms
+  # @param [Nokogiri::XML::Document] (optional) document to insert the term xml into
+  # @return [Nokogiri::XML::Document]
+  # @example If :children=>false, skips rendering child Terms
+  #   term.to_xml(:children=>false)
+  # @example You can provide your own Nokogiri document to insert the xml into
+  #   doc = Nokogiri::XML::Document.new
+  #   term.to_xml({}, document=doc)
+  def to_xml(options={}, document=Nokogiri::XML::Document.new)
+    builder = Nokogiri::XML::Builder.with(document) do |xml|
+      xml.term(:name=>name) {
+        if is_root_term?
+          xml.is_root_term("true")
+        end
+        xml.path path
+        xml.namespace_prefix namespace_prefix
+        unless attributes.nil? || attributes.empty?
+          xml.attributes {
+            attributes.each_pair do |attribute_name, attribute_value|
+              xml.send("#{attribute_name}_".to_sym, attribute_value)
+            end
+          }
+        end
+        xml.index_as {
+          unless index_as.nil?
+            index_as.each  { |index_type| xml.index_type }
+          end
+        }
+        xml.required required
+        xml.data_type data_type
+        unless variant_of.nil?
+          xml.variant_of variant_of
+        end
+        unless default_content_path.nil?
+          xml.default_content_path default_content_path
+        end
+        xml.xpath {
+          xml.relative xpath_relative
+          xml.absolute xpath
+          xml.constrained xpath_constrained
+        }
+        if options.fetch(:children, true)
+          xml.children 
+        end
+      }
+    end
+    doc = builder.doc
+    if options.fetch(:children, true)
+      children.values.each {|child| child.to_xml(options, doc.xpath("//term[@name=\"#{name}\"]/children").first)}
+    end
+    return doc
+  end
+  
   # private :update_xpath_values
   
 end

data/lib/om/xml/term_value_operators.rb

@@ -161,6 +161,9 @@ module OM::XML::TermValueOperators
     until !starting_point.empty?
       to_build = [parent_select.pop] + to_build
       starting_point = find_by_terms(*parent_select)
+      if starting_point.empty? && parent_select.empty? 
+        raise OM::XML::TemplateMissingException, "Cannot insert nodes into the document because it is empty."
+      end
     end
     to_build.each do |term_pointer|      
       parent_select << term_pointer

data/lib/om/xml/terminology.rb

@@ -220,6 +220,35 @@ class OM::XML::Terminology
     terms.values.select {|term| term.is_root_term? }
   end
   
+  # Return an XML representation of the Terminology and its terms
+  # @param [Hash] options, the term will be added to it. If :children=>false, skips rendering child Terms
+  # @param [Nokogiri::XML::Document] (optional) document to insert the term xml into
+  # @return [Nokogiri::XML::Document]
+  # @example If :children=>false, skips rendering child Terms
+  #   terminology.to_xml(:children=>false)
+  # @example You can provide your own Nokogiri document to insert the xml into
+  #   doc = Nokogiri::XML::Document.new
+  #   terminology.to_xml({}, document=doc)
+  def to_xml(options={}, document=Nokogiri::XML::Document.new)
+    builder = Nokogiri::XML::Builder.with(document) do |xml|
+      xml.terminology {
+        xml.schema schema
+        xml.namespaces {
+          namespaces.each_pair do |ns_name, ns_value|
+            xml.namespace {
+              xml.name ns_name
+              xml.identifier ns_value
+            }
+          end
+        }
+        xml.terms 
+      }
+    end
+    document = builder.doc
+    terms.values.each {|term| term.to_xml(options,document.xpath("//terms").first)}
+    return document
+  end
+  
   def self.term_generic_name(*pointers)
     pointers_to_flat_array(pointers, false).join("_")
   end

data/lib/om/xml.rb

@@ -13,6 +13,9 @@ require "om/xml/template_registry"
 
 module OM::XML
   
+  # Raised when the XML document or XML template can't be found during an operation
+  class TemplateMissingException < StandardError; end
+  
   attr_accessor :ng_xml
   
   # Module Methods -- These methods can be called directly on the Module itself