model_xml 1.0.5 → 1.0.9

data/README.md

@@ -29,6 +29,8 @@ Then user.to_xml gives:
       <dob>1970-12-23</dob>
     </user>
 
+Just like ActiveRecord's to_xml method, the :only, :except, and :skip_instruct options are supported.
+
 Note that (unlike ActiveRecords's to_xml) the field names can be any method in your object, not just database columns - eg
 
     class User < ActiveRecord::Base

data/lib/model_xml/generator.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'builder'
 require 'nokogiri'
+require 'facets/string/snakecase'
 require 'model_xml/block_parser'
 
 module ModelXML
@@ -73,11 +74,14 @@ module ModelXML
       field_list = generate_field_list(options)
 
       xml = options.delete(:builder) || Builder::XmlMarkup.new(:indent => 2)
+      exceptions_list = options.delete(:except) || []
+      limit_list = options.delete(:only)
+
       unless options[:skip_instruct]
         xml.instruct!
       end
 
-      xml.tag! object.class.to_s.downcase do
+      xml.tag! object.class.to_s.snakecase do
 
         field_list.each do |field|
 
@@ -96,13 +100,19 @@ module ModelXML
            raise "ModelXML unable to parse #{field.inspect}"
           end
 
-          # if the content responds to to_xml, call it passing the current builder
-          if content.respond_to?(:to_xml)
-            content.to_xml(options.merge(:builder => xml, :skip_instruct => true, :root => tag.to_s))
-
-          # otherwise create the tag normally
+          # ignore the tag if it is on the exclude list, or if a limit list is provided and it is not on it
+          if exceptions_list.include?(tag) || (limit_list && !limit_list.include?(tag))
+            # do nothing
           else
-            xml.tag! tag, content
+
+            # if the content responds to to_xml, call it passing the current builder
+            if content.respond_to?(:to_xml)
+              content.to_xml(options.merge(:builder => xml, :skip_instruct => true, :root => tag.to_s))
+
+            # otherwise create the tag normally
+            else
+              xml.tag! tag, content
+            end
           end
         end
       end

data/model_xml.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "model_xml"
-  s.version     = '1.0.5'
+  s.version     = '1.0.9'
   s.authors     = "Rob Anderson"
   s.email       = "rob.anderson@paymentcardsolutions.co.uk"
   s.summary     = "Ruby object to xml converter"
@@ -8,6 +8,7 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/rob-anderson/model_xml"
 
   s.add_dependency 'builder', '>= 2.1.2'
+  s.add_dependency 'facets', '>= 2.9.3'
 
   s.files = `git ls-files`.split("\n")
   s.require_path = "lib"

data/test/test_model_xml.rb

@@ -32,9 +32,9 @@ class ModelXMLTest < Test::Unit::TestCase
     assert_equal [[:foo]], TestStruct.model_xml_generator.field_sets
 
     res = '<?xml version="1.0" encoding="UTF-8"?>
-<teststruct>
+<test_struct>
   <foo>1</foo>
-</teststruct>
+</test_struct>
 '
     assert_equal res, @t.to_xml
   end
@@ -51,10 +51,10 @@ class ModelXMLTest < Test::Unit::TestCase
     assert_equal [[:foo, :bar]], TestStruct.model_xml_generator.field_sets
 
     res = '<?xml version="1.0" encoding="UTF-8"?>
-<teststruct>
+<test_struct>
   <foo>1</foo>
   <bar>2</bar>
-</teststruct>
+</test_struct>
 '
     assert_equal res, @t.to_xml
   end
@@ -70,11 +70,11 @@ class ModelXMLTest < Test::Unit::TestCase
     end
 
     res = '<?xml version="1.0" encoding="UTF-8"?>
-<teststruct>
+<test_struct>
   <foo>1</foo>
   <bar>2</bar>
   <foobar>3</foobar>
-</teststruct>
+</test_struct>
 '
     assert_equal res, @t.to_xml
   end
@@ -85,10 +85,10 @@ class ModelXMLTest < Test::Unit::TestCase
       model_xml :foo, :bar
     end
 
-    res = '<teststruct>
+    res = '<test_struct>
   <foo>1</foo>
   <bar>2</bar>
-</teststruct>
+</test_struct>
 '
     assert_equal res, @t.to_xml(:skip_instruct => true)
 
@@ -117,13 +117,28 @@ class ModelXMLTest < Test::Unit::TestCase
     end
 
     res = '<?xml version="1.0" encoding="UTF-8"?>
-<teststruct>
+<test_struct>
   <id>foo</id>
-</teststruct>
+</test_struct>
 '
     assert_equal res, @t.to_xml
   end
 
+  def test_except_and_include_options
+    TestStruct.instance_eval do
+      model_xml_reset!
+      model_xml :foo, :bar
+    end
+
+    res = '<?xml version="1.0" encoding="UTF-8"?>
+<test_struct>
+  <foo>1</foo>
+</test_struct>
+'
+    assert_equal res, @t.to_xml(:except => [:bar])
+    assert_equal res, @t.to_xml(:only => [:foo])
+
+  end
 
 
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: model_xml
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 5
   prerelease: 
   segments: 
   - 1
   - 0
-  - 5
-  version: 1.0.5
+  - 9
+  version: 1.0.9
 platform: ruby
 authors: 
 - Rob Anderson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-11 00:00:00 Z
+date: 2012-04-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
@@ -33,6 +33,22 @@ dependencies:
         version: 2.1.2
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: facets
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 45
+        segments: 
+        - 2
+        - 9
+        - 3
+        version: 2.9.3
+  type: :runtime
+  version_requirements: *id002
 description: Simple replacement for ActiveRecord's default to_xml
 email: rob.anderson@paymentcardsolutions.co.uk
 executables: []