roxml 1.0 → 1.1

data/MIT-LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2006 Zak Mandhro and Anders Engstrom
+Copyright (c) 2006 by 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:
 

data/README

@@ -0,0 +1,2 @@
+ROXML Ruby Object to XML mapping library. For more information
+visit http://roxml.rubyforge.org

data/lib/roxml.rb

@@ -81,20 +81,27 @@
 # 
 # For more information on available annotations, see ROXML::ROXML_Class
 module ROXML
-
     require 'rexml/document'
 
+    # Default tag behavior declaration with single
+    # read and write.
+    TAG_DEFAULT = 0
+
     # Option that may be used to declare that 
     # a variable accessor should be read-only (no "accessor=(val)" is generated).
     TAG_READONLY = 1
 
-    # Option that declares that an XML text element should be
+    # Option that declares that an XML text element's value should be
     # wrapped in a CDATA section.
     TAG_CDATA = 2
 
     # Option that declares an accessor as an array (referencing "many"
     # items).
     TAG_ARRAY = 4
+    
+    # Option that declares an xml_text annotation to define the text
+    # content of the container tag
+    TEXT_CONTENT = 5
 
     #
     # Internal base class that represents an XML - Class binding.
@@ -108,22 +115,6 @@ module ROXML
             yield self if block_given?
             @array = false unless @array
         end
-        
-        # Converts this XML reference to XML and updates the
-        # passed in element (XML) with data.
-        #
-        # <b>Returns</b>: The updated XML node.
-        def update_xml(xml, value)
-            xml
-        end
-
-        # Reads data from the XML element and populates the object
-        # instance accordingly.
-        #
-        # <b>Returns</b>: The updated instance.
-        def populate(xml, instance)
-            instance
-        end
     end
 
     # Interal class representing an XML attribute binding
@@ -154,14 +145,16 @@ module ROXML
     #   <element attribute="XMLAttributeRef">
     #     XMLTextRef
     #   </element>
-    class XMLTextRef < XMLAttributeRef
-        attr_accessor :cdata, :wrapper
+    class XMLTextRef < XMLRef
+        attr_accessor :cdata, :wrapper, :text_content
 
         # Updates the text in the given _xml_ block to
         # the _value_ provided.
         def update_xml(xml, value)
             parent = (wrapper ? xml.add_element(wrapper) : xml)
-            if array
+            if text_content
+              parent.text = (cdata ? REXML::CData.new(value.to_s.to_utf) : value.to_s.to_utf)              
+            elsif array
                 value.each do |v|
                     parent.add_element(name).text = (cdata ? REXML::CData.new(v.to_s.to_utf) : v.to_s.to_utf)   
                 end
@@ -175,10 +168,9 @@ module ROXML
         # accordingly.
         def populate(xml, instance)
             data = nil
-            unless array
-                child = xml.elements[1, name]
-                data = child.text if child && child.text
-            else
+            if text_content
+              data = xml.text
+            elsif array
                 xpath = (wrapper ? "#{wrapper}/#{name}" : "#{name}")
                 data = []
                 xml.each_element(xpath) do |e|
@@ -186,7 +178,9 @@ module ROXML
                         data << e.text.strip.to_latin                        
                     end
                 end
-
+            else
+                child = xml.elements[1, name]
+                data = child.text if child && child.text
             end
             instance.instance_variable_set("@#{accessor}", data) if data
             instance
@@ -306,11 +300,17 @@ module ROXML
         # [sym]     Symbol representing the name of the accessor.
         # [name]    An optional name that should be used for the attribute in XML.
         #           Default is sym.id2name.
-        # [options] TAG_CDATA for character data, TAG_ARRAY for one-to-many, and
-        #           TAG_READONLY for read-only access.
+        # [options] TAG_CDATA for character data, TAG_ARRAY for one-to-many, 
+        #           TEXT_CONTENT to declare main text content for containing tag,
+        #           and TAG_READONLY for read-only access.
         # [wrapper] An optional name of a wrapping tag for this XML accessor.
         #
         # Example:
+        #   class Author
+        #     xml_attribute :role
+        #     xml_text :text, nil, ROXML::TEXT_CONTENT
+        #   end
+        #   
         #   class Book
         #     xml_text :description, nil, ROXML::TAG_CDATA
         #   end
@@ -318,12 +318,14 @@ module ROXML
         # To map:
         #   <book>
         #     <description><![CDATA[Probably the best Ruby book out there]]></description>
+        #     <author role="primary">David Thomas</author>
         #   </book>
-        def xml_text(sym, name = nil, options = 0, wrapper = nil)
+        def xml_text(sym, name = nil, options = TAG_DEFAULT, wrapper = nil)
             ref = XMLTextRef.new(sym, name) do |r|
-                r.cdata = (TAG_CDATA & options == TAG_CDATA)
-                r.array = (TAG_ARRAY & options == TAG_ARRAY)
-                r.wrapper = wrapper if wrapper
+              r.text_content = (TEXT_CONTENT & options==TEXT_CONTENT)
+              r.cdata = (TAG_CDATA & options==TAG_CDATA)
+              r.array = (TAG_ARRAY & options==TAG_ARRAY)
+              r.wrapper = wrapper if wrapper
             end
             add_ref(ref)
             add_accessor(sym, (TAG_READONLY & options != TAG_READONLY), ref.array)
@@ -391,7 +393,7 @@ module ROXML
         # If no tag name is set with xml_name method, returns default class name
         # in lowercase.
         def tag_name
-            @tag_name || self.name.downcase
+            @tag_name ||= self.name.split('::').last.downcase
         end
 
         # Returns array of internal reference objects, such as attributes

data/test/fixtures/book_text_with_attribute.xml

@@ -0,0 +1,5 @@
+<book ISDN="0201710897">
+  <title>The PickAxe</title>
+  <description><![CDATA[Probably the best Ruby book out there]]></description>
+  <author role="primary">David Thomas</author>
+</book>

data/test/mocks/mocks.rb

@@ -11,6 +11,18 @@ class Book < RoxmlMockObject
     xml_text :author
 end
 
+class Author < RoxmlMockObject
+  xml_attribute :role
+  xml_text :text, nil, ROXML::TEXT_CONTENT
+end
+
+class BookWithAuthorTextAttribute < RoxmlMockObject
+    xml_attribute :isbn
+    xml_text :title
+    xml_text :description, nil, ROXML::TAG_CDATA
+    xml_object :author, Author
+end
+
 class Contributor < RoxmlMockObject
   xml_attribute :role
   xml_text :name

data/test/test_roxml.rb

@@ -12,6 +12,13 @@ class TestROXML < Test::Unit::TestCase
     assert_equal("The PickAxe", book.title)
   end
 
+  # Test book with text and attribute
+  def test_book_author_text_attribute
+    book = BookWithAuthorTextAttribute.parse(fixture(:book_text_with_attribute))
+    assert_equal("primary",book.author.role)
+    assert_equal("David Thomas",book.author.text)
+  end
+
   # Malformed XML parsing should throw REXML::ParseException
   def test_malformed
     begin

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: roxml
 version: !ruby/object:Gem::Version 
-  version: "1.0"
-date: 2006-07-01 00:00:00 -04:00
+  version: "1.1"
+date: 2006-09-24 00:00:00 -04:00
 summary: Ruby Object to XML mapping library
 require_paths: 
 - lib
@@ -25,11 +25,13 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Zak Mandhro
 files: 
 - lib/roxml.rb
 - MIT-LICENSE.txt
+- README
 - test/test_roxml.rb
 - test/mocks
 - test/fixtures
@@ -42,52 +44,7 @@ files:
 - test/fixtures/book_with_contributions.xml
 - test/fixtures/book_with_contributors.xml
 - test/fixtures/library.xml
-- doc/created.rid
-- doc/rdoc-style.css
-- doc/files
-- doc/classes
-- doc/fr_file_index.html
-- doc/fr_class_index.html
-- doc/fr_method_index.html
-- doc/index.html
-- doc/files/lib
-- doc/files/lib/roxml_rb.html
-- doc/classes/String.src
-- doc/classes/ROXML.src
-- doc/classes/ROXML
-- doc/classes/String.html
-- doc/classes/ROXML.html
-- doc/classes/String.src/M000001.html
-- doc/classes/String.src/M000002.html
-- doc/classes/ROXML.src/M000003.html
-- doc/classes/ROXML.src/M000004.html
-- doc/classes/ROXML.src/M000005.html
-- doc/classes/ROXML/ROXML_Class.src
-- doc/classes/ROXML/XMLObjectRef.src
-- doc/classes/ROXML/XMLAttributeRef.src
-- doc/classes/ROXML/XMLRef.src
-- doc/classes/ROXML/XMLTextRef.src
-- doc/classes/ROXML/ROXML_Class.html
-- doc/classes/ROXML/XMLObjectRef.html
-- doc/classes/ROXML/XMLAttributeRef.html
-- doc/classes/ROXML/XMLRef.html
-- doc/classes/ROXML/XMLTextRef.html
-- doc/classes/ROXML/ROXML_Class.src/M000006.html
-- doc/classes/ROXML/ROXML_Class.src/M000007.html
-- doc/classes/ROXML/ROXML_Class.src/M000008.html
-- doc/classes/ROXML/ROXML_Class.src/M000009.html
-- doc/classes/ROXML/ROXML_Class.src/M000010.html
-- doc/classes/ROXML/ROXML_Class.src/M000011.html
-- doc/classes/ROXML/ROXML_Class.src/M000012.html
-- doc/classes/ROXML/XMLObjectRef.src/M000013.html
-- doc/classes/ROXML/XMLObjectRef.src/M000014.html
-- doc/classes/ROXML/XMLAttributeRef.src/M000015.html
-- doc/classes/ROXML/XMLAttributeRef.src/M000016.html
-- doc/classes/ROXML/XMLRef.src/M000017.html
-- doc/classes/ROXML/XMLRef.src/M000018.html
-- doc/classes/ROXML/XMLRef.src/M000019.html
-- doc/classes/ROXML/XMLTextRef.src/M000020.html
-- doc/classes/ROXML/XMLTextRef.src/M000021.html
+- test/fixtures/book_text_with_attribute.xml
 test_files: 
 - test/test_roxml.rb
 rdoc_options: []

data/doc/classes/ROXML.html

@@ -1,352 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Module: ROXML</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">ROXML</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/lib/roxml_rb.html">
-                lib/roxml.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-<a href="ROXML.html">ROXML</a> Ruby Object to XML mapping library. For more
-information visit <a
-href="http://roxml.rubyforge.org">roxml.rubyforge.org</a>
-</p>
-<p>
-Copyright &#169; 2004-2006 Zak Mandhro and Anders Engstrom
-</p>
-<p>
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the
-&quot;Software&quot;), 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:
-</p>
-<p>
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-</p>
-<p>
-THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, 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.
-</p>
-<h1>Quick Start Guide</h1>
-<p>
-This is a short usage example. See <a
-href="ROXML/ROXML_Class.html">ROXML::ROXML_Class</a> and packaged test
-cases for more information.
-</p>
-<p>
-Consider an XML document representing a Library containing a number of
-Books. You can map this structure to Ruby classes that provide addition
-useful behavior. With <a href="ROXML.html">ROXML</a>, you can annotate the
-Ruby classes as follows:
-</p>
-<pre>
-  class Book
-      include ROXML
-
-      xml_attribute :isbn, &quot;ISBN&quot;
-      xml_text :title
-      xml_text :description, nil, ROXML::TAG_CDATA
-      xml_text :author
-  end
-
-  class Library
-      include ROXML
-
-      xml_text :name, &quot;NAME&quot;, ROXML::TAG_CDATA
-      xml_object :books, Book, ROXML::TAG_ARRAY, &quot;books&quot;
-  end
-</pre>
-<p>
-To create a library and put a number of books in it we could run the
-following code:
-</p>
-<pre>
-  book = Book.new()
-  book.isbn = &quot;0201710897&quot;
-  book.title = &quot;The PickAxe&quot;
-  book.description = &quot;Best Ruby book out there!&quot;
-  book.author = &quot;David Thomas, Andrew Hunt, Dave Thomas&quot;
-
-  lib = Library.new()
-  lib.name = &quot;Favorite Books&quot;
-  lib &lt;&lt; book
-</pre>
-<p>
-To save this information to an XML file:
-</p>
-<pre>
-  File.open(&quot;library.xml&quot;, &quot;w&quot;) do |f|
-      lib.to_xml.write(f, 0)
-  end
-</pre>
-<p>
-To later populate the library object from the XML file:
-</p>
-<pre>
-  lib = Library.parse(File.read(&quot;library.xml&quot;))
-</pre>
-<p>
-Similarly, to do a one-to-one mapping between XML objects, such as book and
-publisher, you would use the <b>xml_object</b> annotation. For example:
-</p>
-<pre>
-      &lt;book isbn=&quot;0974514055&quot;&gt;
-        &lt;title&gt;Programming Ruby - 2nd Edition&lt;/title&gt;
-        &lt;description&gt;Second edition of the great book.&lt;/description&gt;
-        &lt;publisher&gt;
-           &lt;name&gt;Pragmatic Bookshelf&lt;/name&gt;
-        &lt;/publisher&gt;
-      &lt;/book&gt;
-</pre>
-<p>
-can be mapped using the following code:
-</p>
-<pre>
-      class BookWithPublisher
-      include ROXML
-
-          xml_name :book
-          xml_object :publisher, Publisher
-      end
-</pre>
-<p>
-Note: In the above example, <em>xml_name</em> annotation tells <a
-href="ROXML.html">ROXML</a> to set the element name to &quot;book&quot; for
-mapping to XML. The default is XML element name is the class name in
-lowercase; &quot;bookwithpublisher&quot; in this case.
-</p>
-<p>
-For more information on available annotations, see <a
-href="ROXML/ROXML_Class.html">ROXML::ROXML_Class</a>
-</p>
-
-    </div>
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000003">included</a>&nbsp;&nbsp;
-      <a href="#M000005">method_missing</a>&nbsp;&nbsp;
-      <a href="#M000004">to_xml</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-    <div id="class-list">
-      <h3 class="section-bar">Classes and Modules</h3>
-
-      Module <a href="ROXML/ROXML_Class.html" class="link">ROXML::ROXML_Class</a><br />
-Class <a href="ROXML/XMLAttributeRef.html" class="link">ROXML::XMLAttributeRef</a><br />
-Class <a href="ROXML/XMLObjectRef.html" class="link">ROXML::XMLObjectRef</a><br />
-Class <a href="ROXML/XMLRef.html" class="link">ROXML::XMLRef</a><br />
-Class <a href="ROXML/XMLTextRef.html" class="link">ROXML::XMLTextRef</a><br />
-
-    </div>
-
-    <div id="constants-list">
-      <h3 class="section-bar">Constants</h3>
-
-      <div class="name-list">
-        <table summary="Constants">
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">TAG_READONLY</td>
-          <td>=</td>
-          <td class="context-item-value">1</td>
-          <td width="3em">&nbsp;</td>
-          <td class="context-item-desc">
-Option that may be used to declare that a variable accessor should be
-read-only (no &quot;accessor=(val)&quot; is generated).
-
-</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">TAG_CDATA</td>
-          <td>=</td>
-          <td class="context-item-value">2</td>
-          <td width="3em">&nbsp;</td>
-          <td class="context-item-desc">
-Option that declares that an XML text element should be wrapped in a CDATA
-section.
-
-</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">TAG_ARRAY</td>
-          <td>=</td>
-          <td class="context-item-value">4</td>
-          <td width="3em">&nbsp;</td>
-          <td class="context-item-desc">
-Option that declares an accessor as an array (referencing &quot;many&quot;
-items).
-
-</td>
-        </tr>
-        </table>
-      </div>
-    </div>
-
-
-
-      
-
-
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Class methods</h3>
-
-      <div id="method-M000003" class="method-detail">
-        <a name="M000003"></a>
-
-        <div class="method-heading">
-          <a href="ROXML.src/M000003.html" target="Code" class="method-signature"
-            onclick="popupCode('ROXML.src/M000003.html');return false;">
-          <span class="method-name">included</span><span class="method-args">(klass)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Extends the klass with the <a href="ROXML/ROXML_Class.html">ROXML_Class</a>
-module methods.
-</p>
-        </div>
-      </div>
-
-      <h3 class="section-bar">Public Instance methods</h3>
-
-      <div id="method-M000005" class="method-detail">
-        <a name="M000005"></a>
-
-        <div class="method-heading">
-          <a href="ROXML.src/M000005.html" target="Code" class="method-signature"
-            onclick="popupCode('ROXML.src/M000005.html');return false;">
-          <span class="method-name">method_missing</span><span class="method-args">(name, *args)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-To make it easier to reference the class&#8217;s attributes all method
-calls to the instance that doesn&#8217;t match an instance method are
-forwarded to the class&#8217;s singleton instance. Only methods starting
-with &#8216;tag_&#8217; are delegated.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
-
-        <div class="method-heading">
-          <a href="ROXML.src/M000004.html" target="Code" class="method-signature"
-            onclick="popupCode('ROXML.src/M000004.html');return false;">
-          <span class="method-name">to_xml</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Returns an REXML::Element representing this object.
-</p>
-        </div>
-      </div>
-
-
-    </div>
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>