xml_active 0.0.5 → 0.0.6

data/lib/xml_active.rb

@@ -11,7 +11,7 @@ module XmlActive
     end while self.class.exists?(name => self[name])
   end
 
-  VALID_FROM_XML_OPTIONS = [:sync, :create, :update, :destroy]
+  VALID_FROM_XML_OPTIONS = [:sync, :create, :update, :destroy, :fail_on_invalid]
 
   module ClassMethods
     def many_from_xml(source_xml, options = [])
@@ -19,84 +19,6 @@ module XmlActive
       many_from root_node_in source_xml
     end
 
-    def many_from(current_node)
-      case
-        when self.name.pluralize.underscore.eql?(current_node.name.underscore)
-          many_from_rails_xml current_node
-
-        when (current_node.name.eql?('dataroot') \
-          and current_node.namespace_definitions.map { |ns| ns.href }.include?('urn:schemas-microsoft-com:officedata'))
-          # Identified as data generated from Microsoft Access
-          many_from_ms_xml current_node
-
-        when self.name.underscore.eql?(current_node.name.underscore)
-          raise "The supplied XML (#{current_node.name}) is a single instance of '#{self.name}'. Please use one_from_xml"
-
-        else
-          raise "The supplied XML (#{current_node.name}) cannot be mapped to this class (#{self.name})"
-
-      end
-    end
-
-    def many_from_ms_xml(current_node)
-      records = []
-      recorded_ids = []
-
-      current_node.element_children.each do |node|
-        if self.name.underscore.eql?(node.name.underscore)
-          record = self.one_from_xml(node, @data_active_options)
-          if record
-            recorded_ids << record[primary_key.to_sym]
-            records << record
-          end
-        end
-      end
-
-      remove_records_not_in recorded_ids
-
-      records
-    end
-
-    def many_from_rails_xml(current_node)
-      records = []
-      recorded_ids = []
-
-      current_node.element_children.each do |node|
-        record = self.one_from_xml(node, @data_active_options)
-        if record
-          recorded_ids << record[primary_key.to_sym]
-          records << record
-        end
-      end
-
-      remove_records_not_in recorded_ids
-
-      records
-    end
-
-    def remove_records_not_in(recorded_ids)
-      if @data_active_options.include?(:sync)
-        if recorded_ids.length > 0
-          self.destroy_all [self.primary_key.to_s + " not in (?)", recorded_ids.collect]
-        end
-      elsif @data_active_options.include?(:destroy)
-        if recorded_ids.length > 0
-          self.destroy_all [self.primary_key.to_s + " not in (?)", recorded_ids.collect]
-        else
-          self.destroy_all
-        end
-      end
-    end
-
-    def root_node_in(source_xml)
-      if source_xml.is_a?(String)
-        doc = Nokogiri::XML(source_xml)
-        doc.children.first
-      else
-        source_xml
-      end
-    end
-
     def one_from_xml(source_xml, options = [])
       @data_active_options = options
 
@@ -108,21 +30,14 @@ module XmlActive
 
         active_record = find_record_based_on(pk_node)
 
-
         unless active_record.nil?
           # Process the attributes
           if options.include? :update or options.include? :sync or options.include? :create
             assign_attributes_from current_node, :to => active_record
-          end
-
-          # Save the record
-          if options.include? :sync
-            # Doing complete synchronisation with XML
-            active_record.save
-          elsif options.include?(:create) and active_record.new_record?
-            active_record.save
-          elsif options.include?(:update) and not active_record.new_record?
-            active_record.save
+            if options.include? :fail_on_invalid and !active_record.valid?
+              messages = active_record.errors.messages.map {|attribute, messages| "#{attribute} #{messages.map{|message| message }.join(', ')}"}.join(', ')
+              raise "Found an invalid #{active_record.class.name} with the following errors: #{messages}. Source: #{current_node.to_s}"
+            end
           end
 
           # Check through associations and apply sync appropriately
@@ -199,6 +114,16 @@ module XmlActive
                 raise "unsupported association #{association.macro} for #{association.name  } on #{self.name}"
             end
           end
+
+          # Save the record
+          if options.include? :sync
+            # Doing complete synchronisation with XML
+            active_record.save
+          elsif options.include?(:create) and active_record.new_record?
+            active_record.save
+          elsif options.include?(:update) and not active_record.new_record?
+            active_record.save
+          end
         end
 
         active_record
@@ -207,17 +132,50 @@ module XmlActive
       end
     end
 
-    def foreign_key_from(association)
-      if ActiveRecord::Reflection::AssociationReflection.method_defined? :foreign_key
-        # Support for Rails 3.1 and later
-        foreign_key = association.foreign_key
-      elsif ActiveRecord::Reflection::AssociationReflection.method_defined? :primary_key_name
-        # Support for Rails earlier than 3.1
-        foreign_key = association.primary_key_name
+    private
+    def xml_node_matches_class(xml_node)
+      if xml_node.attributes['type'].blank?
+        xml_node.name.underscore == self.name.underscore
       else
-        raise "Unsupported version of ActiveRecord. Unable to identify the foreign key."
+        xml_node.attributes['type'].value.underscore == self.name.underscore
+      end
+    end
+
+    def find_record_based_on(pk_node)
+      ar = nil
+      if pk_node
+        begin
+          ar = find pk_node.text
+        rescue
+          # No record exists, create a new one
+          if @data_active_options.include?(:sync) or @data_active_options.include?(:create)
+            ar = self.new
+          end
+        end
+      else
+        # No primary key value, must be a new record
+        if @data_active_options.include?(:sync) or @data_active_options.include?(:create)
+          ar = self.new
+        end
+      end
+      ar
+    end
+
+    def assign_attributes_from(current_node, options)
+      record = options[:to]
+
+      record.attributes.each do |name, value|
+        attribute_nodes = current_node.xpath name.to_s
+        if attribute_nodes.count == 1
+          if attribute_nodes[0].attributes['nil'].try(:value)
+            record[name] = nil
+          else
+            record[name] = attribute_nodes[0].text
+          end
+        elsif attribute_nodes.count > 1
+          raise "Found duplicate elements in xml for active record attribute '#{name}'"
+        end
       end
-      foreign_key
     end
 
     def instances_for(association, options)
@@ -234,7 +192,7 @@ module XmlActive
       #   </book>
       # </books>
       if active_record.new_record?
-        results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{current_node.xpath(self.primary_key.to_s).text}]/#{association.name}")
+        results = current_node.xpath("#{association.name}")
       else
         results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{active_record.attributes[self.primary_key.to_s]}]/#{association.name}")
       end
@@ -246,7 +204,7 @@ module XmlActive
         #   ...
         # </book>
         if active_record.new_record?
-          results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{current_node.xpath(self.primary_key.to_s).text}]/#{association.name.to_s.singularize}")
+          results = current_node.xpath("#{association.name.to_s.singularize}")
         else
           results = current_node.xpath("//#{self.name.underscore}[#{self.primary_key}=#{active_record.attributes[self.primary_key.to_s]}]/#{association.name.to_s.singularize}")
         end
@@ -257,48 +215,94 @@ module XmlActive
       results
     end
 
-    def assign_attributes_from(current_node, options)
-      record = options[:to]
+    def foreign_key_from(association)
+      if ActiveRecord::Reflection::AssociationReflection.method_defined? :foreign_key
+        # Support for Rails 3.1 and later
+        foreign_key = association.foreign_key
+      elsif ActiveRecord::Reflection::AssociationReflection.method_defined? :primary_key_name
+        # Support for Rails earlier than 3.1
+        foreign_key = association.primary_key_name
+      else
+        raise "Unsupported version of ActiveRecord. Unable to identify the foreign key."
+      end
+      foreign_key
+    end
 
-      record.attributes.each do |name, value|
-        attribute_nodes = current_node.xpath name.to_s
-        if attribute_nodes.count == 1
-          if attribute_nodes[0].attributes['nil'].try(:value)
-            record[name] = nil
-          else
-            record[name] = attribute_nodes[0].text
-          end
-        elsif attribute_nodes.count > 1
-          raise "Found duplicate elements in xml for active record attribute '#{name}'"
+    def root_node_in(source_xml)
+      if source_xml.is_a?(String)
+        doc = Nokogiri::XML(source_xml)
+        doc.children.first
+      else
+        source_xml
+      end
+    end
+
+    def remove_records_not_in(recorded_ids)
+      if @data_active_options.include?(:sync)
+        if recorded_ids.length > 0
+          self.destroy_all [self.primary_key.to_s + " not in (?)", recorded_ids.collect]
+        end
+      elsif @data_active_options.include?(:destroy)
+        if recorded_ids.length > 0
+          self.destroy_all [self.primary_key.to_s + " not in (?)", recorded_ids.collect]
+        else
+          self.destroy_all
         end
       end
     end
 
-    def find_record_based_on(pk_node)
-      ar = nil
-      if pk_node
-        begin
-          ar = find pk_node.text
-        rescue
-          # No record exists, create a new one
-          if @data_active_options.include?(:sync) or @data_active_options.include?(:create)
-            ar = self.new
-          end
+    def many_from_rails_xml(current_node)
+      records = []
+      recorded_ids = []
+
+      current_node.element_children.each do |node|
+        record = self.one_from_xml(node, @data_active_options)
+        if record
+          recorded_ids << record[primary_key.to_sym]
+          records << record
         end
-      else
-        # No primary key value, must be a new record
-        if @data_active_options.include?(:sync) or @data_active_options.include?(:create)
-          ar = self.new
+      end
+
+      remove_records_not_in recorded_ids
+
+      records
+    end
+
+    def many_from_ms_xml(current_node)
+      records = []
+      recorded_ids = []
+
+      current_node.element_children.each do |node|
+        if self.name.underscore.eql?(node.name.underscore)
+          record = self.one_from_xml(node, @data_active_options)
+          if record
+            recorded_ids << record[primary_key.to_sym]
+            records << record
+          end
         end
       end
-      ar
+
+      remove_records_not_in recorded_ids
+
+      records
     end
 
-    def xml_node_matches_class(xml_node)
-      if xml_node.attributes['type'].blank?
-        xml_node.name.underscore == self.name.underscore
-      else
-        xml_node.attributes['type'].value.underscore == self.name.underscore
+    def many_from(current_node)
+      case
+        when self.name.pluralize.underscore.eql?(current_node.name.underscore)
+          many_from_rails_xml current_node
+
+        when (current_node.name.eql?('dataroot') \
+          and current_node.namespace_definitions.map { |ns| ns.href }.include?('urn:schemas-microsoft-com:officedata'))
+          # Identified as data generated from Microsoft Access
+          many_from_ms_xml current_node
+
+        when self.name.underscore.eql?(current_node.name.underscore)
+          raise "The supplied XML (#{current_node.name}) is a single instance of '#{self.name}'. Please use one_from_xml"
+
+        else
+          raise "The supplied XML (#{current_node.name}) cannot be mapped to this class (#{self.name})"
+
       end
     end
   end

data/lib/xml_active/version.rb

@@ -1,3 +1,3 @@
 module XmlActive
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xml_active
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-15 00:00:00.000000000 Z
+date: 2012-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -97,5 +97,5 @@ rubyforge_project: xml_active
 rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
-summary: xml_active 0.0.5
+summary: xml_active 0.0.6
 test_files: []