xmlstruct 1.0.0

data/GPL2

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/README

@@ -0,0 +1,21 @@
+# XmlStruct is a specialised version of OpenStruct that allows you to create 
+# XML layout automagically using Ruby assignment. 
+#
+# ----
+# Copyright (c) 2006 Neil Wilson, Aldur Systems Ltd
+#
+# Part of the 3accounts system
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

data/lib/xml_char.rb

@@ -0,0 +1,110 @@
+# =xml_char.rb: XmlChar implementation
+#
+# XmlChar provides mechanisms to escape special characters in a string so
+# that they can be placed in an XML stream without causing havoc.
+#
+# XmlChar is based on Sam Ruby's XChar module 
+# 
+# ----
+# Copyright (c) 2006 Neil Wilson, Aldur Systems Ltd
+#
+# Part of the 3accounts system
+#
+# Licensed under the GNU Public License v2. No warranty is provided.
+
+
+# = Purpose
+# This module provides Module procedures to escape special characters in
+# a string so that it can be placed in an XML stream without causing havoc.
+#
+# A true object-oriented version would reopen +String+ and +Fixnum+ and stick
+# the methods in there. Personally I prefer to keep these special
+# functions on standard objects in their own namespace where they can't
+# cause any nasty name clashes.
+#
+# = Usage
+#
+#    unclean_string="<ShowMe>this < that && that > this</ShowMe>"
+#    XmlChar::xml_string(unclean_string)
+#    => "&lt;ShowMe&gt;this &lt; that &amp;&amp; that &gt; this&lt;/ShowMe&gt;"
+#
+module XmlChar
+  
+  # :stopdoc:
+  #
+  # http://intertwingly.net/stories/2004/04/14/i18n.html#CleaningWindows
+  #
+  CP1252 =  	 { # :nodoc:
+    128 => 8364, # euro sign
+    130 => 8218, # single low-9 quotation mark
+    131 =>  402, # latin small letter f with hook
+    132 => 8222, # double low-9 quotation mark
+    133 => 8230, # horizontal ellipsis
+    134 => 8224, # dagger
+    135 => 8225, # double dagger
+    136 =>  710, # modifier letter circumflex accent
+    137 => 8240, # per mille sign
+    138 =>  352, # latin capital letter s with caron
+    139 => 8249, # single left-pointing angle quotation mark
+    140 =>  338, # latin capital ligature oe
+    142 =>  381, # latin capital letter z with caron
+    145 => 8216, # left single quotation mark
+    146 => 8217, # right single quotation mark
+    147 => 8220, # left double quotation mark
+    148 => 8221, # right double quotation mark
+    149 => 8226, # bullet
+    150 => 8211, # en dash
+    151 => 8212, # em dash
+    152 =>  732, # small tilde
+    153 => 8482, # trade mark sign
+    154 =>  353, # latin small letter s with caron
+    155 => 8250, # single right-pointing angle quotation mark
+    156 =>  339, # latin small ligature oe
+    158 =>  382, # latin small letter z with caron
+    159 =>  376 # latin capital letter y with diaeresis
+    } 
+
+  # http://www.w3.org/TR/REC-xml/#dt-chardata
+  PREDEFINED = {    # :nodoc:
+    ?' => '&apos;', # single quote
+    ?" => '&quot;', # double quote
+    ?& => '&amp;',  # ampersand
+    ?< => '&lt;',   # left angle bracket
+    ?> => '&gt;'}   # right angle bracket
+
+  # http://www.w3.org/TR/REC-xml/#charsets
+  VALID = [[0x9, 0xA, 0xD], (0x20..0xD7FF),   # :nodoc:
+    (0xE000..0xFFFD), (0x10000..0x10FFFF)]
+  #
+  # :startdoc:
+  #
+  # Create an XML escaped version of +normal_string+ 
+  #
+  # === Contract
+  #
+  #    require:: !normal_string.nil?
+  #
+  def self.xml_string(normal_string)
+    normal_string.unpack('U*').map {|n| XmlChar::xml_char(n)}.join # ASCII, UTF-8
+  rescue
+    normal_string.unpack('C*').map {|n| XmlChar::xml_char(n)}.join # ISO-8859-1, WIN-1252
+  end
+
+  #
+  # Create an XML escaped version of +normal_char+
+  #
+  # === Contract
+  # 
+  #    require: normal_char && normal_char.integer?
+  #
+  def self.xml_char(normal_char)
+    char_value = XmlChar::CP1252[normal_char] || normal_char
+    if XmlChar::VALID.find { |range| range.include? char_value }
+      XmlChar::PREDEFINED[char_value] ||
+       	(char_value<0x80 ? char_value.chr : "&##{char_value};")
+    else
+      "*"
+    end
+  end
+    
+end

data/lib/xml_struct.rb

@@ -0,0 +1,387 @@
+# =xml_struct.rb: XmlStruct implementation
+#
+# XmlStruct is a specialised version of OpenStruct that allows you to create 
+# XML layout automagically using Ruby assignment. 
+#
+# ----
+# Copyright (c) 2006 Neil Wilson, Aldur Systems Ltd
+#
+# Part of the 3accounts system
+#
+# Licensed under the GNU Public License v2. No warranty is provided.
+
+# = Purpose
+# XMLStruct is a specialised version of OpenStruct that allows you to create 
+# XML layout automagically using Ruby assignment. The class supports XML tag
+# attributes and element content.
+#
+# The class has been designed so that you can rapidly change a flat dataset 
+# into an XML layout without all that tedious messing about with Xpaths,
+# tree traversal, nested blocks and the like. 
+#
+# = Usage
+#
+# Create a blank document using the usual #new method.
+# 
+#    xml = XmlStruct.new
+#
+# Add items as required and output using the #to_s command
+#
+#    xml.GovTalkMessage = {:xmlns => "http://www.govtalk.gov.uk/CM/envelope"}
+#    md = xml.GovTalkMessage.Header.MessageDetails
+#    md.Class="IR-PAYE-EOY"
+#    md.Transformation="XML"
+#    xml.GovTalkMessage.GovTalkDetails
+#    xml.GovTalkMessage.Body
+#    xml.to_s
+#
+# gives
+#
+#    <GovTalkMessage xmlns="http://www.govtalk.gov.uk/CM/envelope">
+#    <Header>
+#    <MessageDetails>
+#    <Class>IR-PAYE-EOY</Class>
+#    <Transformation>XML</Transformation>
+#    </MessageDetails>
+#    </Header>
+#    <GovTalkDetails>
+#    </GovTalkDetails>
+#    <Body>
+#    </Body>
+#    </GovTalkMessage>
+#
+# == Content
+#
+# Xml content is added using standard Ruby assign. Any wrapper tags are
+# created automatically.
+#
+#    xml.GovTalkMessage.Header.MessageDetails.Class="IR-PAYE-EOY"
+#
+# XML is output using the #to_s method. The above would output as:
+#
+#    <GovTalkMessage>
+#    <Header>
+#    <MessageDetails>
+#    <Class>IR-PAYE-EOY</Class>
+#    </MessageDetails>
+#    </Header>
+#    </GovTalkMessage>
+#
+# Blank elements with no content are created by simply referencing the element.
+#
+#    xml.GovTalkMessage.Body
+#
+# Content is stored in an array like manner within the structure so that
+# you can have multiple elements with the same tag, e.g.
+#
+#    xml.Address.Line[0] = "1 Some Street"
+#    xml.Address.Line[1] = "Somewhere"
+#    xml.Address.Line[2] = "Sometown"
+#    xml.to_s
+#
+# gives
+#
+#    <Address>
+#    <Line>1 Some Street</Line>
+#    <Line>Somewhere</Line>
+#    <Line>Sometown</Line>
+#    </Address>
+#
+# Any element can be referenced to a variable as a shortcut.
+# That address example again.
+#
+#    ln = xml.Address.Line
+#    ln[0] = "1 Some Street"
+#    ln[1] = "Somewhere"
+#    ln[2] = "Sometown"
+#
+# To make things really simple assigning an array of values to an element
+# creates multiple elements with the same tag.
+#
+#    xml.Address.Line = ["1 Some Street", "Somewhere", "Sometown"]
+#
+# ==Attributes
+#
+# You set attributes for elements by assigning a hash of attributes
+# to the element, e.g 
+#
+#    xml.GovTalkMessage = {:xmlns => "http://www.govtalk.gov.uk/CM/envelope"}
+#    xml.to_s
+# 
+# gives
+#
+#    <GovTalkMessage xmlns="http://www.govtalk.gov.uk/CM/envelope">
+#    </GovTalkMessage>
+#
+# Each element can have its own set of attributes - even those with the same
+# element name, eg.
+#
+#    xml.Keys.Key[0]={:Type => "VendorNumber"}
+#    xml.Keys.Key[0]=275687
+#    xml.Keys.Key[1]={:Type => "MainCPH"}
+#    xml.Keys.Key[1]="14/02/0327"
+#    xml.to_s
+#
+# gives
+#
+#    <Keys>
+#    <Key Type="VendorNumber">275687</Key>
+#    <Key Type="MainCPH">14/02/0327</Key>
+#    </Keys>
+#    
+# Multiple attributes are simply a matter of enumerating all the attributes in
+# the hash, eg.
+#
+#     xml.Keys.Key = {:Type => "Unique Tax Reference", :Length => "10"}
+#
+# gives
+#
+#     <Keys>
+#     <Key Type="Unique Tax Reference" Length="10">
+#     </Key>
+#     </Keys
+#
+# ==Caveats
+#
+# XMLStruct undefines all the instance methods that may clash with XML tags
+# except for <tt>inspect</tt>. So if you have a file with an <tt><inspect></tt> XML tag then
+# the class won't work without modification.
+#
+# If you need to add methods to this class or any subclass, then use the !
+# and ? suffixes. Otherwise the method will clash with the XML tag of the
+# same name. (Fortunately ! and ? are not valid XML tag characters).
+#
+# There is no 'delete' or 'reorder' methods within this class. The
+# class is designed to take flat data and impose an XML structure on
+# it statically. So the original purpose doesn't require anything other
+# than assign and output facilities. Still I hope you find it useful.
+#
+class XmlStruct
+
+  require 'xml_char'
+  # Undefine any instance method that may clash with an XML tag - all except
+  # the vital +__id__+ and +__send__+ methods.
+  instance_methods.each do |m|
+    unless m =~ /^__|inspect/ then
+      undef_method m if m =~ /^[a-z:_][\w:\.-]*$/i
+    end
+  end
+  
+  #
+  # Creates a new XmlStruct document. The optional +tag+ can be used to set
+  # the initial tag for the document. However normally it is omitted.
+  #
+  #    xml = XmlStruct.new
+  #    xml.FirstTag
+  #    xml.to_s
+  #
+  # and
+  #
+  #    xml = XmlStruct.new("FirstTag")
+  #    xml.to_s
+  #
+  # both give the same output, viz:
+  #
+  #    <FirstTag>
+  #    </FirstTag>
+  #
+  def initialize (tag = "")
+    @my_tag = tag
+    @content = []
+    @attributes = []
+    @children = {}
+    @create_order = []
+  end
+
+  #
+  # Allows you to access the content values for a particular element.
+  # The default assign places content in [0], and you use that index to read
+  # the content back, e.g.
+  #
+  #    xml.Address.PostCode = "EC1A 5SW"
+  #    xml.Address.PostCode[0]
+  #    => "EC1A 5SW" 
+  #
+  #
+  def [](index)
+    @content[index]
+  end
+
+  # Assigning to [0] is the same as the default assign.
+  # The following are equivalent
+  #
+  #    xml.Address.PostCode = "EC1A 5SW"
+  #    xml.Address.PostCode[0] = "EC1A 5SW"
+  #
+  # Assigning to indexes greater than zero creates an additional element with
+  # the same tag but different content
+  #
+  #    xml.Address.Line[0] = "1 Some Street"
+  #    xml.Address.Line[1] = "Somewhere"
+  #
+  # However the default assign with an array is easier to use.
+  #
+  #    xml.Address.Line = [ "1 Some Street", "Somewhere" ]
+  #
+  def []=(index, rval)
+    case
+      when rval.kind_of?(Hash)
+	@attributes[index] = rval
+      when rval.kind_of?(Array)
+	rval.each_index { |i| @content[i] = rval[i] }
+      else
+	@content[index] = rval
+    end
+  end
+
+  # 
+  # The +method_missing+ method implements the Proxy pattern for this class. 
+  # It automatically creates any attribute if it is missing and handles
+  # the default assignment by passing the assignment onto the [0] element.
+  #
+  # Methods that cannot be XML tags (essentially those ending in ? and !) are
+  # raised as errors. 
+  def method_missing(method_id, *args) # :nodoc:
+    method_name = method_id.id2name
+    len = args.length
+    if method_name[-1] == ?=
+      unless len == 1
+	raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1)
+      end
+      if frozen?
+	raise TypeError, "can't modify frozen object", caller(1)
+      end
+      method_name.chop!
+      unless method_name =~ /^[a-z:_][\w:\.-]*$/i
+	raise NoMethodError, "undefined method '#{method_name}'", caller(1)
+      end
+      child = obtain_accessor!(method_name)
+      child[0] = args[0]
+    elsif method_name =~ /^[a-z:_][\w:\.-]*$/i
+      if len == 0
+	obtain_accessor!(method_name)
+      else
+	raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1)
+      end
+    else
+      raise NoMethodError, "undefined method '#{method_name}'", caller(1)
+    end
+  end
+
+  # 
+  # Converts the XMLStruct into XML format. Returns an empty string if
+  # the XMLStruct is empty.
+  # 
+  def to_s
+    %{#{open_my_tags!}#{
+      @create_order.collect do |tag_id|
+      @children[tag_id].to_s
+      end.join}#{end_my_tags!}}
+  end
+
+private
+
+  #
+  # Recover the child XMLStruct from the +@children+ hash if it exists, 
+  # otherwise create one.
+  # 
+  def obtain_accessor!(name)
+    access_method = name.intern
+    if ptr = @children[access_method]
+      ptr
+    else
+      @create_order.push(access_method)
+      @children[access_method] = XmlStruct.new(name)
+    end
+  end
+
+  #
+  # If we're in an XMLStruct with a name, then layout the attributes and
+  # contents in XML format and always leave at least one tag open. 
+  # 
+  def open_my_tags!
+    if @my_tag.empty?
+      ""
+    else
+      (0...max_xsval_length?).collect do |x|
+	%{<#{@my_tag}#{
+	    format_attributes!(@attributes[x])
+	}>#{
+	    format_content!(@content[x])
+	}}
+      end.join(end_my_tags!)
+    end
+  end
+
+  #
+  # If we're in an XMLStruct with a name, then close our XML tag
+  #
+  # ==Contract
+  #
+  # require: !@my_tag.nil?
+  #
+  def end_my_tags!
+    if @my_tag.empty? 
+      ""
+    else
+      "</#{@my_tag}>\n" 
+    end
+  end
+
+  #
+  # Layout the XML attributes from the supplied attributes collection
+  # in XML format, in the order supplied by the collection.
+  #
+  # ==Contract
+  # 
+  # require: attributes.nil? || attributes.respond_to?("collect")
+  # 
+  def format_attributes!(attributes)
+    if attributes
+      attributes.collect do |attrib, value|
+	" #{attrib}=\"#{XmlChar::xml_string(value)}\""
+      end.join
+    end
+  end
+
+  # 
+  # Layout the content in string format from the supplied content object
+  #
+  # ==Contract
+  #
+  # require: content.respond_to?("to_s")
+  # 
+  def format_content!(content)
+    if content.to_s.empty?
+      "\n"
+    else
+      XmlChar::xml_string(content.to_s)
+    end
+  end
+
+  # Returns the maxium value in the range 1 to the maximum length of
+  # either the +@attributes+ collection or the +@content+ collection
+  #
+  # ==Contract
+  #
+  # require: @content && @content.respond_to?("length")
+  # require: @attributes && @attributes.respond_to?("length")
+  #
+  # ensure: Result == 1 && @attributes.length <= 1 && @content.length <= 1
+  # ensure: Result == @attributes.length && @attributes.length >= @content.length
+  # ensure: Result == @content.length && @content.length >= @attributes.length
+  # 
+  def max_xsval_length?
+    x= @content.length
+    y= @attributes.length
+    if x<=1 && y<=1
+      1
+    elsif x>=y
+      x
+    else
+      y
+    end
+  end
+
+end
+

data/test/perf_test_xml_struct.rb

@@ -0,0 +1,27 @@
+require 'profile'
+require 'lib/xml_struct'
+
+LOOP_COUNT=1000
+
+LOOP_COUNT.times do
+  xml=XmlStruct.new
+  xml.GovTalkMessage={:xmlns => "http://www.govtalk.gov.uk/CM/envelope"}
+  xml.GovTalkMessage.EnvelopeVersion="2.0"
+  md=xml.GovTalkMessage.Header.MessageDetails
+  md.Class="MAFF-IACS-AAPS2001"
+  md.Qualifier='request'
+  md.Function='list'
+  md.CorrelationID
+  md.Transformation='XML'
+  ia=xml.GovTalkMessage.Header.SenderDetails.IDAuthentication
+  ia.SenderID="VendorID"
+  ia.Authentication.Method="clear"
+  ia.Authentication.Role
+  ia.Authentication.Value="password"
+  xml.GovTalkMessage.GovTalkDetails.Keys
+  xml.GovTalkMessage.Body.StartDate="01/02/1999"
+  xml.GovTalkMessage.Body.EndDate="01/0r32/1999"
+  xml.GovTalkMessage.Body.StartTime="01:02:44"
+  xml.GovTalkMessage.Body.EndTime="01:02:44"
+  xml.to_s
+end

data/test/test_xml_char.rb

@@ -0,0 +1,42 @@
+require 'lib/xml_char'
+require 'test/unit'
+
+class TestXmlEscaping < Test::Unit::TestCase
+  def test_ascii
+    assert_equal 'abc', XmlChar::xml_string('abc')
+  end
+
+  def test_predefined
+    assert_equal '&amp;', XmlChar::xml_string('&')              # ampersand
+    assert_equal '&lt;',  XmlChar::xml_string('<')              # left angle bracket
+    assert_equal '&gt;',  XmlChar::xml_string('>')              # right angle bracket
+    assert_equal '&quot;',  XmlChar::xml_string('"')            # Double Quote
+    assert_equal '&apos;',  XmlChar::xml_string("'")            # Single Quote
+  end
+
+  def test_invalid
+    assert_equal '*', XmlChar::xml_string("\x00")               # null
+    assert_equal '*', XmlChar::xml_string("\x0C")               # form feed
+    assert_equal '*', XmlChar::xml_string("\xEF\xBF\xBF")       # U+FFFF
+  end
+
+  def test_iso_8859_1
+    assert_equal '&#231;', XmlChar::xml_string("\xE7")          # small c cedilla
+    assert_equal '&#169;', XmlChar::xml_string("\xA9")          # copyright symbol
+  end
+
+  def test_win_1252
+    assert_equal '&#8217;', XmlChar::xml_string("\x92")         # smart quote
+    assert_equal '&#8364;', XmlChar::xml_string("\x80")         # euro
+  end
+
+  def test_utf8
+    assert_equal '&#8217;', XmlChar::xml_string("\xE2\x80\x99") # right single quote
+    assert_equal '&#169;',  XmlChar::xml_string("\xC2\xA9")     # copy
+  end
+
+  def test_the_lot
+    assert_equal("I&#241;t&#235;rn&#226;ti&#244;n&#224;liz&#230;ti&#248;n", 
+		 XmlChar::xml_string("Iñtërnâtiônàlizætiøn"))
+  end
+end

data/test/test_xml_struct.rb

@@ -0,0 +1,58 @@
+require 'test/unit'
+require 'lib/xml_struct'
+
+class TestXmlStruct < Test::Unit::TestCase
+
+  def setup
+    @xmldoc = XmlStruct.new
+  end
+
+  def test_empty
+    #Empty root node
+    #assert_equal("",xmldoc.to_s)
+    assert_not_nil(@xmldoc)
+    assert_nil(@xmldoc[0])
+  end
+
+  def test_autocreate_read
+    #Autocreate nodes by reading them
+    @xmldoc.Header
+    @xmldoc.Header.MessageDetails.Class
+    #Assign to already created node
+    assert_equal("IR-PAYE-EOY",@xmldoc.Header.MessageDetails.Class="IR-PAYE-EOY")
+    #element[0] reads the value.
+    assert_equal("IR-PAYE-EOY",@xmldoc.Header.MessageDetails.Class[0])
+  end
+
+  def test_autocreate_assign
+    #Autocreate nodes by assigning to them.
+    assert_equal("IR-PAYE-EOY",@xmldoc.Header.MessageDetails.Class="IR-PAYE-EOY")
+    assert_equal("IR-PAYE-EOY",@xmldoc.Header.MessageDetails.Class[0])
+  end
+
+  def test_failures
+    assert_raise(NoMethodError){ @xmldoc.fred? }
+    assert_raise(NoMethodError){ @xmldoc.hello! }
+    assert_raise(ArgumentError){ @xmldoc.Header(45) }
+    @xmldoc.Header
+    assert_raise(ArgumentError){ @xmldoc.Header(45) }
+  end
+
+  def test_key_creation
+    @xmldoc.GovTalkDetails.Keys.Key[0]={:Type => "VendorNumber"}
+    @xmldoc.GovTalkDetails.Keys.Key[0]=275687
+    @xmldoc.GovTalkDetails.Keys.Key[1]={:Type => "MainCPH"}
+    @xmldoc.GovTalkDetails.Keys.Key[1]="14/02/0327"
+    @xmldoc.GovTalkDetails.Address.Line=["1 Some Street", "Somewhere", "SomeTown"]
+    @xmldoc.Body
+    print @xmldoc.to_s
+  end
+
+  def test_escapes
+    @xmldoc.TestEntity={:Test1 => "\"", :Test2 => "'", :Test3 => "Iñtërnâtiônàlizætiøn" }
+    @xmldoc.TestEntity="Iñtërnâtiônàlizætiøn"
+    print @xmldoc.to_s
+  end
+
+end
+

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: xmlstruct
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-03-22 00:00:00 +00:00
+summary: A Struct that allows you to create an XML layout quickly and easily
+require_paths: 
+- lib
+email: aldursys@gmail.com
+homepage: 
+rubyforge_project: 
+description: 
+autorequire: xml_struct
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Neil Wilson
+files: 
+- test/test_xml_char.rb
+- test/test_xml_struct.rb
+- test/perf_test_xml_struct.rb
+- lib/xml_struct.rb
+- lib/xml_char.rb
+- README
+- GPL2
+test_files: 
+- test/test_xml_struct.rb
+- test/test_xml_char.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+- GPL2
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+