om 1.6.1 → 1.7.0.rc1

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    om (1.6.0)
+    om (1.6.2)
+      activemodel
+      activesupport
       mediashelf-loggable
       nokogiri (>= 1.4.2)
 
@@ -9,36 +11,45 @@ GEM
   remote: http://rubygems.org/
   specs:
     RedCloth (4.2.9)
-    columnize (0.3.5)
-    debugger (1.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    awesome_print (1.0.2)
+    builder (3.0.0)
+    columnize (0.3.6)
+    debugger (1.2.0)
       columnize (>= 0.3.1)
       debugger-linecache (~> 1.1.1)
-      debugger-ruby_core_source (~> 1.1.2)
-    debugger-linecache (1.1.1)
+      debugger-ruby_core_source (~> 1.1.3)
+    debugger-linecache (1.1.2)
       debugger-ruby_core_source (>= 1.1.1)
     debugger-ruby_core_source (1.1.3)
     diff-lcs (1.1.3)
-    equivalent-xml (0.2.8)
+    equivalent-xml (0.2.9)
       nokogiri (>= 1.4.3)
+    i18n (0.6.0)
     linecache (0.46)
       rbx-require-relative (> 0.0.4)
     mediashelf-loggable (0.4.9)
     metaclass (0.0.1)
-    mocha (0.10.0)
+    mocha (0.12.3)
       metaclass (~> 0.0.1)
     multi_json (1.3.6)
-    nokogiri (1.5.0)
+    nokogiri (1.5.5)
     rake (0.9.2.2)
-    rbx-require-relative (0.0.5)
-    rcov (0.9.11)
-    rspec (2.7.0)
-      rspec-core (~> 2.7.0)
-      rspec-expectations (~> 2.7.0)
-      rspec-mocks (~> 2.7.0)
-    rspec-core (2.7.1)
-    rspec-expectations (2.7.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.7.0)
+    rbx-require-relative (0.0.9)
+    rcov (1.0.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.4.0)
@@ -50,13 +61,14 @@ GEM
     simplecov-html (0.5.3)
     simplecov-rcov (0.2.3)
       simplecov (>= 0.4.1)
-    yard (0.7.4)
+    yard (0.8.2.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   RedCloth (~> 4.2.9)
+  awesome_print
   debugger
   equivalent-xml (>= 0.2.4)
   mocha (>= 0.9.8)

data/History.textile

@@ -1,3 +1,6 @@
+h3. 1.7.0
+  Add casting to dates and integers when you specify the :type attribute on a terminology node
+
 h3. 1.6.1
   Integration spec to illustrate selective querying.
   Add #use_terminology and #extend_terminology methods to extend existing OM terminologies

data/devel/notes.txt

@@ -0,0 +1,12 @@
+Purposes of OM (based on notes from conversation with Matt Zumwalt):
+
+1. Provide convenient names to access information in an XML document --
+   essentially a declarative mechanism to define methods that will issue
+   xpath queries against an XML document.
+
+2. Provides a convient way to create new, empty XML documents (or fragments),
+   with implied parent nodes (if any) and default attribute values (if any).
+   This is done by overriding the class method xml_template() in your XML
+   document class.
+
+3. Provides a way to map your OM terminology into SOLR.

data/lib/om.rb

@@ -1,4 +1,6 @@
 require 'rubygems'
+require 'active_support/concern'
+require 'active_model/dirty'
 
 require 'nokogiri'
 

data/lib/om/version.rb

@@ -1,3 +1,3 @@
 module Om
-  VERSION = "1.6.1"
+  VERSION = "1.7.0.rc1"
 end

data/lib/om/xml/container.rb

@@ -1,4 +1,5 @@
 module OM::XML::Container
+  extend ActiveSupport::Concern
   
   attr_accessor :ng_xml
   
@@ -11,7 +12,7 @@ module OM::XML::Container
     # Careful! If you call this from a constructor, be sure to provide something 'ie. self' as the @tmpl. Otherwise, you will get an infinite loop!
     def from_xml(xml=nil, tmpl=self.new) # :nodoc:
       if xml.nil?
-        tmpl.ng_xml = self.xml_template
+        # noop: handled in #ng_xml accessor..  tmpl.ng_xml = self.xml_template
       elsif xml.kind_of? Nokogiri::XML::Node
         tmpl.ng_xml = xml
       else
@@ -30,12 +31,12 @@ module OM::XML::Container
     
   end
   
+  def ng_xml
+    @ng_xml ||= self.class.xml_template
+  end
+
   # Instance Methods -- These methods will be available on instances of classes that include this module
   
-  def self.included(klass)
-    klass.extend(ClassMethods)
-  end
-    
   def to_xml(xml = ng_xml)
     if xml == ng_xml
       return xml.to_xml
@@ -52,4 +53,4 @@ module OM::XML::Container
     end
   end
   
-end
+end

data/lib/om/xml/document.rb

@@ -1,5 +1,5 @@
 module OM::XML::Document
-
+  extend ActiveSupport::Concern
 
   # Class Methods -- These methods will be available on classes that include this Module
 
@@ -7,24 +7,39 @@ module OM::XML::Document
 
     attr_accessor :terminology, :terminology_builder, :template_registry
 
+    def terminology
+      @terminology ||= terminology_builder.build
+    end
+
+    def terminology_builder
+      @terminology_builder ||= OM::XML::Terminology::Builder.new
+    end
+
+    def template_registry
+      @template_registry ||= OM::XML::TemplateRegistry.new
+    end
+
+    def rebuild_terminology!
+      @terminology = @terminology_builder.build
+    end
+
     # Sets the OM::XML::Terminology for the Document
     # Expects +&block+ that will be passed into OM::XML::Terminology::Builder.new
     def set_terminology &block
-      @terminology_builder = OM::XML::Terminology::Builder.new( &block )
-      
-      @terminology = @terminology_builder.build
+      @terminology_builder = OM::XML::Terminology::Builder.new(&block)
+      rebuild_terminology!
     end
 
     # Update the OM::XML::Terminology with additional terms
     def extend_terminology &block
-      @terminology_builder.extend_terminology(&block)
-      @terminology = @terminology_builder.build
+      self.terminology_builder.extend_terminology(&block)
+      rebuild_terminology!
     end
-
+    
     # (Explicitly) inherit terminology from upstream classes
     def use_terminology klass
-      @terminology_builder = klass.terminology_builder.dup
-      @terminology = @terminology_builder.build
+      self.terminology_builder = klass.terminology_builder.dup
+      rebuild_terminology!
     end
 
     # Define a new node template with the OM::XML::TemplateRegistry.
@@ -32,31 +47,38 @@ module OM::XML::Document
     # * The +block+ does the work of creating the new node, and will receive
     #   a Nokogiri::XML::Builder and any other args passed to one of the node instantiation methods.
     def define_template name, &block
-      @template_registry ||= OM::XML::TemplateRegistry.new
-      @template_registry.define name, &block
+      self.template_registry.define name, &block
     end
 
     # Returns any namespaces defined by the Class' Terminology
     def ox_namespaces
-      if @terminology.nil?
-        return {}
-      else
-        return @terminology.namespaces
-      end
+      self.terminology.namespaces
     end
-
   end
 
   # Instance Methods -- These methods will be available on instances of classes that include this module
 
   attr_accessor :ox_namespaces
 
-  def self.included(klass)
-    klass.extend(ClassMethods)
+  included do
+    include OM::XML::Container
+    include OM::XML::TermValueOperators
+    include OM::XML::Validation
+    include ActiveModel::Dirty
+
+  end
+
+  def ng_xml_will_change!
+    if self.respond_to?(:dirty=)
+      self.dirty = true
+    end
 
-    klass.send(:include, OM::XML::Container)
-    klass.send(:include, OM::XML::TermValueOperators)
-    klass.send(:include, OM::XML::Validation)
+    # throw away older version.
+    changed_attributes['ng_xml'] = nil
+  end
+
+  def ng_xml_changed?
+    changed.include?('ng_xml')
   end
 
   def method_missing(name, *args)
@@ -77,20 +99,13 @@ module OM::XML::Document
         super
       end
     end
-
-
   end
 
 
   def find_by_xpath(xpath)
-    if ox_namespaces.values.compact.empty?
-      ng_xml.xpath(xpath)
-    else
-      ng_xml.xpath(xpath, ox_namespaces)
-    end
+    ng_xml.xpath(xpath, ox_namespaces)
   end
 
-
   # Applies the property's corresponding xpath query, returning the result Nokogiri::XML::NodeSet
   def find_by_terms_and_value(*term_pointer)
     xpath = self.class.terminology.xpath_for(*term_pointer)
@@ -176,7 +191,7 @@ module OM::XML::Document
   # Returns a hash combining the current documents namespaces (provided by nokogiri) and any namespaces that have been set up by your Terminology.
   # Most importantly, this matches the 'oxns' namespace to the namespace you provided in your Terminology's root term config
   def ox_namespaces
-    @ox_namespaces ||= ng_xml.namespaces.merge(self.class.ox_namespaces)
+    @ox_namespaces ||= ng_xml.namespaces.merge(self.class.ox_namespaces).reject { |k,v| v.nil? || v.empty? }
   end
 
   private
@@ -185,6 +200,7 @@ module OM::XML::Document
       target = self.find_by_terms(*target)
     end
     raise "You must call define_template before calling #{method}" if template_registry.nil?
+    ng_xml_will_change!
     template_registry.send(method, target, *args, &block)
   end
 end

data/lib/om/xml/dynamic_node.rb

@@ -68,6 +68,7 @@ module OM
       end
 
       def val=(args)
+        @document.ng_xml_will_change!
         new_values = sanitize_new_values(args.first)
         new_values.keys.sort { |a,b| a.to_i <=> b.to_i }.each do |y|
           z = new_values[y]
@@ -79,21 +80,19 @@ module OM
             @document.term_value_update(xpath, y.to_i, z)
           end
         end
-        if @document.respond_to?(:dirty=)
-          @document.dirty = true
-        end
       end
 
       def sanitize_new_values(new_values)
           # Sanitize new_values to always be a hash with indexes
           case new_values
           when Hash
+            new_values.each {|k, v|  v = serialize(v) }
           when Array
             nv = new_values.dup
             new_values = {}
-            nv.each {|v| new_values[nv.index(v).to_s] = v}
+            nv.each {|v| new_values[nv.index(v).to_s] = serialize(v)}
           else
-            new_values = {"0"=>new_values}
+            new_values = {"0"=>serialize(new_values)}
           end
           new_values
       end
@@ -109,7 +108,34 @@ module OM
       def val 
         query = xpath
         trim_text = !query.index("text()").nil?
-        return @document.find_by_xpath(query).collect {|node| (trim_text ? node.text.strip : node.text) }
+        val = @document.find_by_xpath(query).collect {|node| (trim_text ? node.text.strip : node.text) }
+        deserialize(val)
+      end
+
+      # @param string
+      # @return [String,Date,Integer]
+      def deserialize(val)
+        case term.type
+        when :date
+          val.map { |v| Date.parse(v)}
+        when :integer
+          val.map { |v| v.to_i}
+        else 
+          val
+        end
+      end
+
+      # @param val [String,Date,Integer]
+      def serialize (val)
+        case term.type
+        when :date
+          val.to_s
+        when :integer
+          val.to_s
+        else 
+          val
+        end
+
       end
       
       def nodeset
@@ -117,6 +143,10 @@ module OM
         trim_text = !query.index("text()").nil?
         return @document.find_by_xpath(query)
       end
+
+      def delete
+        nodeset.delete
+      end
       
       def inspect
         val.inspect

data/lib/om/xml/named_term_proxy.rb

@@ -13,7 +13,7 @@ class OM::XML::NamedTermProxy
   # @param [Hash] opts additional Term options
   def initialize(name, proxy_pointer, terminology, opts={})
     opts = {:namespace_prefix=>"oxns", :ancestors=>[], :children=>{}}.merge(opts)
-    [:children, :ancestors].each do |accessor_name|
+    [:children, :ancestors, :index_as].each do |accessor_name|
       instance_variable_set("@#{accessor_name}", opts.fetch(accessor_name, nil) )     
     end
     @terminology = terminology
@@ -45,7 +45,14 @@ class OM::XML::NamedTermProxy
     return false
   end
   
-  def method_missing
+  ##
+  # Always co-erce :index_as attributes into an Array
+  def index_as
+    if @index_as
+      Array(@index_as)
+    else
+      self.proxied_term.index_as
+    end
   end
   
   # Any unknown method calls will be proxied to the proxied term

data/lib/om/xml/term.rb

@@ -135,6 +135,9 @@ class OM::XML::Term
   attr_accessor :name, :xpath, :xpath_constrained, :xpath_relative, :path, :index_as, :required, :data_type, :variant_of, :path, :default_content_path, :is_root_term
   attr_accessor :children, :internal_xml, :terminology
 
+  # the data type for this node
+  attr_accessor :type
+
   # Any XML attributes that qualify the Term.
   #
   # @example Declare a Term that has a given attribute (ie. //title[@xml:lang='eng'])
@@ -170,11 +173,22 @@ class OM::XML::Term
   # If you want to specify which namespace a term is using, use:
   #   namspace_prefix => "bar"
   # This value defaults to nil, in which case if a default namespace is set in the termnology, that namespace will be used.
+  #
+  # @param name [Symbol] the name to refer to this term by
+  # @param opts [Hash]
+  # @options opts [Array]  :index_as a list of indexing hints provided to to_solr
+  # @options opts [String] :path partial xpath that points to the node.  
+  # @options opts [Hash]   :attributes xml attributes to match in the selector 
+  # @options opts [String] :namespace_prefix xml namespace for this node 
+  # @options opts [Symbol] :type one of :string, :date, :integer. Defaults to :string
   def initialize(name, opts={}, terminology=nil)
     opts = {:ancestors=>[], :children=>{}}.merge(opts)
-    [:children, :ancestors,:path, :index_as, :required, :type, :variant_of, :path, :attributes, :default_content_path, :namespace_prefix].each do |accessor_name|
+    [:children, :ancestors,:path, :index_as, :required, :variant_of, :path, :attributes, :default_content_path, :namespace_prefix].each do |accessor_name|
       instance_variable_set("@#{accessor_name}", opts.fetch(accessor_name, nil) )
     end
+
+    self.type = opts[:type] || :string
+
     unless terminology.nil?
       if opts[:namespace_prefix].nil?
         unless terminology.namespaces["xmlns"].nil?
@@ -188,6 +202,7 @@ class OM::XML::Term
     end
   end
 
+
   def self.from_node(mapper_xml)
     name = mapper_xml.attribute("name").text.to_sym
     attributes = {}
@@ -211,6 +226,12 @@ class OM::XML::Term
     return new_mapper
   end
 
+  ##
+  # Always co-erce :index_as attributes into an Array
+  def index_as
+    Array(@index_as)
+  end
+
   # crawl down into mapper's children hash to find the desired mapper
   # ie. @test_mapper.retrieve_mapper(:conference, :role, :text)
   def retrieve_term(*pointers)