roxml 3.1.1 → 3.1.2

data/History.txt

@@ -1,3 +1,15 @@
+== 3.1.2 (October 18, 2009)
+
+* minor enhancements
+
+  * Retain whitespace in element contents, but still default on blank (rather than entirely empty) elements
+
+* bug fixes
+
+  * Include namespaces in xml output
+  * Fix that auto-wrapped collections weren't output with their wrappers
+    (which requires introducing the roxml_references accessor on the instance)
+
 == 3.1.1 (October 17, 2009)
 
 * bug fix

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2004-2009 Ben Woosley, Zak Mandhro and Anders Engstrom
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -159,3 +159,18 @@ explicitly require one or the other, you may do the following:
   require 'roxml'
 
 For more information on available annotations, see ROXML::ClassMethods::Declarations
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add specs for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2004-2009 Ben Woosley, Zak Mandhro and Anders Engstrom. See LICENSE for details.

data/TODO

@@ -1,8 +1,6 @@
 Planned:
 
-v 3.1
-
-  * Add xml_namespaces to allow declaration of distinct prefx/url namespace pairs
+v 3.2
 
   * Consider class_inheritable_attribute rather than superclass.try stuff.
 
@@ -35,5 +33,3 @@ v 3.x
    a singular specification has multiple possible node references
 
   * Use lazy evaluation to minimize parsing time for large files
-
-

data/VERSION

@@ -1 +1 @@
-3.1.1
+3.1.2

data/lib/roxml.rb

@@ -13,15 +13,20 @@ module ROXML # :nodoc:
               ClassMethods::Declarations,
               ClassMethods::Operations
       include InstanceMethods
+
+      attr_accessor :roxml_references
     end
   end
 
   module InstanceMethods # :nodoc:
     # Returns an XML object representing this object
-    def to_xml(name = self.class.tag_name)
-      XML::Node.create(name.to_s).tap do |root|
-        self.class.roxml_attrs.each do |attr|
-          ref = attr.to_ref(self)
+    def to_xml(params = {})
+      params.reverse_merge!(:name => self.class.tag_name, :namespace => self.class.roxml_namespace)
+      XML::Node.create([params[:namespace], params[:name]].compact.join(':')).tap do |root|
+        refs = (self.roxml_references.present? \
+          ? self.roxml_references \
+          : self.class.roxml_attrs.map {|attr| attr.to_ref(self) })
+        refs.each do |ref|
           value = ref.to_xml(self)
           unless value.nil?
             ref.update_xml(root, value)
@@ -530,11 +535,13 @@ module ROXML # :nodoc:
         xml = XML::Node.from(data)
 
         new(*initialization_args).tap do |inst|
-          roxml_attrs.each do |attr|
-            value = attr.to_ref(inst).value_in(xml)
-            inst.respond_to?(attr.setter) \
-              ? inst.send(attr.setter, value) \
-              : inst.instance_variable_set(attr.instance_variable_name, value)
+          inst.roxml_references = roxml_attrs.map {|attr| attr.to_ref(inst) }
+
+          inst.roxml_references.each do |ref|
+            value = ref.value_in(xml)
+            inst.respond_to?(ref.opts.setter) \
+              ? inst.send(ref.opts.setter, value) \
+              : inst.instance_variable_set(ref.opts.instance_variable_name, value)
           end
           inst.send(:after_parse) if inst.respond_to?(:after_parse, true)
         end

data/lib/roxml/xml/references.rb

@@ -6,6 +6,7 @@ module ROXML
   # Internal base class that represents an XML - Class binding.
   #
   class XMLRef # :nodoc:
+    attr_reader :opts
     delegate :required?, :array?, :blocks, :accessor, :default, :wrapper, :to => :opts
 
     def initialize(opts, instance)
@@ -41,8 +42,6 @@ module ROXML
     end
 
   private
-    attr_reader :opts
-
     def conventionize(what)
       convention ||= @instance.class.respond_to?(:roxml_naming_convention) && @instance.class.roxml_naming_convention
       if !what.blank? && convention.respond_to?(:call)
@@ -84,8 +83,12 @@ module ROXML
       opts.wrapper ? "#{namespacify(opts.wrapper)}/#{xpath_name}" : xpath_name.to_s
     end
 
+    def auto_wrapper
+      namespacify(conventionize(opts.name.pluralize))
+    end
+
     def auto_xpath
-      "#{namespacify(conventionize(opts.name.pluralize))}/#{xpath_name}" if array?
+      "#{auto_wrapper}/#{xpath_name}" if array?
     end
 
     def several?
@@ -93,11 +96,13 @@ module ROXML
     end
 
     def wrap(xml)
-      return xml if !wrapper || xml.name == wrapper
-      if child = xml.children.find {|c| c.name == wrapper }
+      wrap_with = @auto_vals ? auto_wrapper : wrapper
+
+      return xml if !wrap_with || xml.name == wrap_with
+      if child = xml.children.find {|c| c.name == wrap_with }
        return child
       end
-      xml.add_child(XML::Node.create(wrapper.to_s))
+      xml.add_child(XML::Node.create(wrap_with.to_s))
     end
 
     def nodes_in(xml)
@@ -166,10 +171,10 @@ module ROXML
         xml.name = value
       elsif array?
         value.each do |v|
-          add(xml.add_child(XML::Node.create(name)), v)
+          add(xml.add_child(XML::Node.create(xpath_name)), v)
         end
       else
-        add(xml.add_child(XML::Node.create(name)), value)
+        add(xml.add_child(XML::Node.create(xpath_name)), value)
       end
     end
 
@@ -177,12 +182,12 @@ module ROXML
       if content? || name?
         value =
           if content?
-            xml.content.to_s.strip
+            xml.content.to_s
           elsif name?
             xml.name
           end
 
-        if value.empty?
+        if value.blank?
           raise RequiredElementMissing, "#{name} from #{xml} for #{accessor}" if required?
           default
         else
@@ -190,7 +195,7 @@ module ROXML
         end
       else
         nodes_in(xml) do |node|
-          node.content.strip
+          node.content
         end
       end
     end
@@ -271,14 +276,15 @@ module ROXML
     # Updates the composed XML object in the given XML block to
     # the value provided.
     def write_xml(xml, value)
+      params = {:name => name, :namespace => opts.namespace}
       if array?
         value.each do |v|
-          xml.add_child(v.to_xml(name))
+          xml.add_child(v.to_xml(params))
         end
       elsif value.is_a?(ROXML)
-        xml.add_child(value.to_xml(name))
+        xml.add_child(value.to_xml(params))
       else
-        node = XML::Node.create(name)
+        node = XML::Node.create(xpath_name)
         node.content = value.to_xml
         xml.add_child(node)
       end

data/roxml.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roxml}
-  s.version = "3.1.1"
+  s.version = "3.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Woosley", "Zak Mandhro", "Anders Engstrom", "Russ Olsen"]
-  s.date = %q{2009-10-17}
+  s.date = %q{2009-10-18}
   s.description = %q{ROXML is a Ruby library designed to make it easier for Ruby developers to work with XML.
 Using simple annotations, it enables Ruby classes to be mapped to XML. ROXML takes care
 of the marshalling and unmarshalling of mapped attributes so that developers can focus on
@@ -25,7 +25,7 @@ RESTful applications, Web Services, and XML-RPC.
     ".gitignore",
      ".gitmodules",
      "History.txt",
-     "MIT-LICENSE",
+     "LICENSE",
      "README.rdoc",
      "Rakefile",
      "TODO",

data/spec/definition_spec.rb

@@ -51,7 +51,15 @@ describe ROXML::Definition do
         <question>&quot;Wickard &amp; Filburn&quot; &gt;</question>
         <question> &lt; McCulloch &amp; Maryland?</question>
       </xml>
-    }).should == ["\"Wickard & Filburn\" >", "< McCulloch & Maryland?"]
+    }).should == ["\"Wickard & Filburn\" >", " < McCulloch & Maryland?"]
+  end
+
+  it "should unescape utf characters in xml" do
+    ROXML::Definition.new(:questions, :as => []).to_ref(RoxmlObject.new).value_in(%{
+      <xml>
+        <question>ROXML\342\204\242</question>
+      </xml>
+    }).should == ["ROXML™"]
   end
 
   describe "attr name" do

data/spec/xml/namespace_spec.rb

@@ -1,32 +1,61 @@
 require 'spec/spec_helper.rb'
 
 describe ROXML, "with namespaces" do
-  context "when an included namespace is not defined in the xml" do
-    context "where the missing namespace is the default" do
-      it "should raise"
+  describe "for writing" do
+    before do
+      @xml = <<EOS
+<?xml version="1.0" encoding="UTF-8"?>
+<gronk:VApp name="My new vApp" status="1" href="https://vcloud.example.com/vapp/833" type="application/vnd.vmware.vcloud.vapp+xml" xmlns:vmw="http://foo.example.com" xmlns:gronk="http://gronk.example.com">
+  <gronk:NetworkConfig name="Network 1">
+    <vmw:FenceMode>allowInOut</vmw:FenceMode>
+    <vmw:Dhcp>true</vmw:Dhcp>
+    <gronk:errors>
+      <gronk:error>OhNo!</gronk:error>
+      <gronk:error>Another!</gronk:error>
+    </gronk:errors>
+  </gronk:NetworkConfig>
+  <foo />
+  <bar>
+    gronk
+  </bar>
+</gronk:VApp>
+EOS
+    end
 
-      context "but the namespace is declared in the body" do
-        it "should succeed"
-      end
+    class NetworkConfig
+      include ROXML
+      xml_namespace :gronk
+
+      xml_name 'NetworkConfig'
+      xml_reader    :name, :from => '@name'
+      xml_reader    :errors, :as => []
+      xml_accessor  :fence_mode, :from => 'vmw:FenceMode'
+      xml_accessor  :dhcp?, :from => 'vmw:Dhcp'
     end
-    
-    context "where the missing namespace is included in a namespacey from" do
-      it "should raise"
 
-      context "but the namespace is declared in the body" do
-        it "should succeed"
-      end
+    class VApp
+      include ROXML
+      xml_namespace :gronk
+
+      xml_name "VApp"
+      xml_reader    :name,    :from => '@name'
+      xml_reader    :status,  :from => '@status'
+      xml_reader    :href,    :from => '@href'
+      xml_reader    :type,    :from => '@type'
+      xml_accessor  :foo,     :from => 'foo', :namespace => false
+      xml_accessor  :bar,     :from => 'bar', :namespace => false
+      xml_accessor  :network_configs, :as => [NetworkConfig], :namespace => :gronk
     end
-    
-    context "where the missing namespace is included in an explicit :namespace" do
-      it "should raise"
 
-      context "but the namespace is declared in the body" do
-        it "should succeed"
+    describe "#to_xml" do
+      it "should reproduce the input xml" do
+        output = ROXML::XML::Document.new
+        output.root = VApp.from_xml(@xml).to_xml
+        output.should == ROXML::XML::Parser.parse(@xml)
       end
     end
   end
-  
+
   describe "roxml namespacey declaration", :shared => true do
     context "with a namespacey :from" do
       context "and an explicit :namespace" do

data/spec/xml/namespaces_spec.rb

@@ -1,32 +1,60 @@
 require 'spec/spec_helper.rb'
 
 describe ROXML, "#xml_namespaces" do
-  class Tires
-     include ROXML
-
-     xml_namespaces \
-       :bobsbike => 'http://bobsbikes.example.com',
-       :alicesauto => 'http://alicesautosupply.example.com/'
-
-     xml_reader :bike_tires, :as => [], :from => '@name', :in => 'bobsbike:tire'
-     xml_reader :car_tires, :as => [], :from => '@name', :in => 'alicesauto:tire'
-   end
-
-  before do
-     @xml = %{<?xml version="1.0"?>
-       <inventory xmlns="http://alicesautosupply.example.com/" xmlns:bike="http://bobsbikes.example.com">
-        <tire name="super slick racing tire" />
-        <tire name="all weather tire" />
-        <bike:tire name="skinny street" />
-       </inventory>
-     }
-  end
+  describe "for reading" do
+    class Tires
+       include ROXML
+
+       xml_namespaces \
+         :bobsbike => 'http://bobsbikes.example.com',
+         :alicesauto => 'http://alicesautosupply.example.com/'
+
+       xml_reader :bike_tires, :as => [], :from => '@name', :in => 'bobsbike:tire'
+       xml_reader :car_tires, :as => [], :from => '@name', :in => 'alicesauto:tire'
+     end
+
+    before do
+       @xml = %{<?xml version="1.0"?>
+         <inventory xmlns="http://alicesautosupply.example.com/" xmlns:bike="http://bobsbikes.example.com">
+          <tire name="super slick racing tire" />
+          <tire name="all weather tire" />
+          <bike:tire name="skinny street" />
+         </inventory>
+       }
+    end
   
-  it "should remap default namespaces" do
-    Tires.from_xml(@xml).car_tires.should =~ ['super slick racing tire', 'all weather tire']
+    it "should remap default namespaces" do
+      Tires.from_xml(@xml).car_tires.should =~ ['super slick racing tire', 'all weather tire']
+    end
+
+    it "should remap prefix namespaces" do
+      Tires.from_xml(@xml).bike_tires.should == ['skinny street']
+    end
   end
 
-  it "should remap prefix namespaces" do
-    Tires.from_xml(@xml).bike_tires.should == ['skinny street']
+  context "when an included namespace is not defined in the xml" do
+    context "where the missing namespace is the default" do
+      it "should raise"
+
+      context "but the namespace is declared in the body" do
+        it "should succeed"
+      end
+    end
+    
+    context "where the missing namespace is included in a namespacey from" do
+      it "should raise"
+
+      context "but the namespace is declared in the body" do
+        it "should succeed"
+      end
+    end
+    
+    context "where the missing namespace is included in an explicit :namespace" do
+      it "should raise"
+
+      context "but the namespace is declared in the body" do
+        it "should succeed"
+      end
+    end
   end
 end

data/tasks/rdoc.rake

@@ -7,7 +7,7 @@ Rake::RDocTask.new do |rdoc|
   end
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "roxml-new #{version}"
+  rdoc.title = "roxml #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/tasks/test.rake

@@ -1,30 +1,23 @@
 require 'rake/testtask'
-Rake::TestTask.new(:bugs) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/bugs/*_bugs.rb'
-  test.verbose = true
-end
-
 desc "Test ROXML using the default parser selection behavior"
 task :test do
   require 'rake/runtest'
+  $LOAD_PATH << 'lib'
   Rake.run_tests 'test/unit/*_test.rb'
 end
 
 namespace :test do
   desc "Test ROXML under the Nokogiri parser"
   task :nokogiri do
-    module ROXML
-      XML_PARSER = 'nokogiri'
-    end
+    $LOAD_PATH << 'spec'
+    require 'spec/support/nokogiri'
     Rake::Task["test"].invoke
   end
 
    desc "Test ROXML under the LibXML parser"
   task :libxml do
-    module ROXML
-      XML_PARSER = 'libxml'
-    end
+    $LOAD_PATH << 'spec'
+    require 'spec/support/libxml'
     Rake::Task["test"].invoke
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: roxml
 version: !ruby/object:Gem::Version 
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors: 
 - Ben Woosley
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-17 00:00:00 -04:00
+date: 2009-10-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,7 +84,7 @@ files:
 - .gitignore
 - .gitmodules
 - History.txt
-- MIT-LICENSE
+- LICENSE
 - README.rdoc
 - Rakefile
 - TODO

data/MIT-LICENSE

@@ -1,18 +0,0 @@
-The MIT License
-
-Copyright (c) 2004-2009 by Ben Woosley, Zak Mandhro and Anders Engstrom
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software
-and associated documentation files (the "Software"), to deal in the Software without restriction,
-including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
-and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial
-portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
-LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
-EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
-USE OR OTHER DEALINGS IN THE SOFTWARE.