Empact-roxml 2.0

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+The MIT License
+
+Copyright (c) 2004-2008 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.

data/README.rdoc

@@ -0,0 +1,122 @@
+ROXML Ruby Object to XML mapping library. For more information
+visit http://roxml.rubyforge.org
+
+=Quick Start Guide
+
+This is a short usage example. See ROXML::ROXML_Class and packaged test cases for more information.
+
+==Basic Mapping
+
+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
+ROXML, you can annotate the Ruby classes as follows:
+
+  class Book
+    include ROXML
+
+    xml_reader :isbn, :attr => "ISBN" # attribute with name 'ISBN'
+    xml_reader :title
+    xml_reader :description, :as => :cdata  # text node with cdata protection
+    xml_reader :author
+  end
+
+  class Library
+    include ROXML
+
+    xml_accessor :name, :from => "NAME", :as => :cdata
+    xml_accessor :books, [Book], :in => "books"
+  end
+
+To create a library and put a number of books in it we could run the following code:
+
+  book = Book.new()
+  book.isbn = "0201710897"
+  book.title = "The PickAxe"
+  book.description = "Best Ruby book out there!"
+  book.author = "David Thomas, Andrew Hunt, Dave Thomas"
+
+  lib = Library.new()
+  lib.name = "Favorite Books"
+  lib << book
+
+To save this information to an XML file:
+
+  File.open("library.xml", "w") do |f|
+    lib.to_xml.write(f, 0)
+  end
+
+To later populate the library object from the XML file:
+
+  lib = Library.parse(File.read("library.xml"))
+
+Similarly, to do a one-to-one mapping between XML objects, such as book and publisher,
+you would add a reference to another ROXML class. For example:
+
+  <book isbn="0974514055">
+    <title>Programming Ruby - 2nd Edition</title>
+    <description>Second edition of the great book.</description>
+    <publisher>
+      <name>Pragmatic Bookshelf</name>
+    </publisher>
+  </book>
+
+can be mapped using the following code:
+
+  class BookWithPublisher
+    include ROXML
+
+    xml_name :book
+    xml_reader :publisher, Publisher
+  end
+
+Note: In the above example, _xml_name_ annotation tells ROXML to set the element
+name to "book" for mapping to XML. The default is XML element name is the class name in lowercase; "bookwithpublisher"
+in this case.
+
+== Manipulation
+
+Extending the above examples, say you want to parse a book's page count and have it available as an Integer.
+In such a case, you can extend any object with a block to manipulate it's value at parse time.  For example:
+
+  class Child
+    include ROXML
+
+    xml_reader :age, :attr do |val|
+      Integer(val)
+    end
+  end
+
+The result of the block above is stored, rather than the actual value parsed from the document.
+
+== Construction
+
+Complicated initialization may require action on multiple attributes of an object.  As such, you can
+use xml_construct to cause your ROXML object to call its own constructor.  For example:
+
+  class Measurement
+    include ROXML
+
+    xml_reader :units, :attr
+    xml_reader :value, :content
+
+    xml_construct :value, :units
+
+    def initialize(value, units)
+      # translate units & value into metric, for example
+    end
+  end
+
+Will, on parse, read all listed xml attributes (units and value, in this case), then call initialize
+with the arguments listed after the xml_construct call.
+
+== Selecting a parser ==
+
+By default, ROXML will use LibXML if it is available, or otherwise REXML.  If you'd like to
+explicitly require one or the other, you may do the following:
+
+  module ROXML
+    XML_PARSER = 'libxml' # or 'rexml'
+  end
+  require 'roxml'
+
+For more information on available annotations, see ROXML::ROXML_Class

data/Rakefile

@@ -0,0 +1,104 @@
+# Rake libraries used
+require "rubygems"
+require "rails_plugin_package_task"
+require "rake/rdoctask"
+require "rake/contrib/rubyforgepublisher"
+require "rake/contrib/publisher"
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+# load settings
+spec = eval(IO.read("roxml.gemspec"))
+
+# Provide the username used to upload website etc.
+RubyForgeConfig = {
+  :unix_name=>"roxml",
+  :user_name=>"zakmandhro"
+}
+
+task :default => :test
+
+Rake::RDocTask.new do |rd|
+  rd.rdoc_dir = "doc"
+  rd.rdoc_files.include('MIT-LICENSE', 'README.rdoc', "lib/**/*.rb")
+  rd.options << '--main' << 'README.rdoc' << '--title' << 'ROXML Documentation'
+end
+
+Rake::RailsPluginPackageTask.new(spec.name, spec.version) do |p|
+  p.package_files = FileList[
+    "lib/**/*.rb", "*.txt", "README.rdoc", "Rakefile",
+    "rake/**/*", "test/**/*.rb", "test/**/*.xml"]
+  p.plugin_files = FileList["rails_plugin/**/*"]
+  p.extra_links = {"Project page" => spec.homepage,
+                   "Author: Zak Mandhro" => 'http://rubyforge.org/users/zakmandhro/'}
+  p.verbose = true
+end
+task :rails_plugin=>:clobber
+
+desc "Publish Ruby on Rails plug-in on RubyForge"
+task :release_plugin=>:rails_plugin do |task|
+  pub = Rake::SshDirPublisher.new("#{RubyForgeConfig[:user_name]}@rubyforge.org",
+	"/var/www/gforge-projects/#{RubyForgeConfig[:unix_name]}",
+	"pkg/rails_plugin")
+  pub.upload()
+end
+
+desc "Publish and plugin site on RubyForge"
+task :publish do |task|
+  pub = Rake::RubyForgePublisher.new(RubyForgeConfig[:unix_name], RubyForgeConfig[:user_name])
+  pub.upload()
+end
+
+desc "Install the gem"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{spec.name}-#{spec.version}}
+end
+
+Rake::TestTask.new(:bugs) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/bugs/*_bugs.rb']
+  t.verbose = true
+end
+
+task :test => :'test:rexml'
+
+namespace :test do
+  desc "Test ROXML under the LibXML parser"
+  task :libxml do
+    module ROXML
+      XML_PARSER = 'libxml'
+    end
+    require 'lib/roxml'
+    require 'rake/runtest'
+    Rake.run_tests 'test/unit/*_test.rb'
+  end
+
+  desc "Test ROXML under the REXML parser"
+  task :rexml do
+    module ROXML
+      XML_PARSER = 'rexml'
+    end
+    require 'lib/roxml'
+    require 'rake/runtest'
+    Rake.run_tests 'test/unit/*_test.rb'
+  end
+end
+
+desc "Create the ZIP package"
+Rake::PackageTask.new(spec.name, spec.version) do |p|
+  p.need_zip = true
+  p.package_files = FileList[
+    "lib/**/*.rb", "*.txt", "README.rdoc", "Rakefile",
+    "rake/**/*","test/**/*.rb", "test/**/*.xml", "html/**/*"]
+end
+
+desc "Create the plugin package"
+
+task :package=>:rdoc
+task :rdoc=>:test
+
+desc "Create a RubyGem project"
+Rake::GemPackageTask.new(spec).define
+
+desc "Clobber generated files"
+task :clobber=>[:clobber_package, :clobber_rdoc]

data/lib/roxml.rb

@@ -0,0 +1,362 @@
+require 'rubygems'
+require 'extensions/enumerable'
+require 'extensions/array'
+require 'activesupport'
+
+%w(array string options xml).each do |file|
+  require File.join(File.dirname(__FILE__), 'roxml', file)
+end
+
+module ROXML
+  # This class defines the annotation methods that are mixed into your
+  # Ruby classes for XML mapping information and behavior.
+  #
+  # See xml_name, xml_construct, xml, xml_reader and xml_accessor for
+  # available annotations.
+  #
+  module ROXML_Class
+    #
+    # Creates a new Ruby object from XML using mapping information
+    # annotated in the class.
+    #
+    # The input data is either an XML::Node or a String representing
+    # the XML document.
+    #
+    # Example
+    #  book = Book.parse(File.read("book.xml"))
+    # or
+    #  book = Book.parse("<book><name>Beyond Java</name></book>")
+    #
+    # See also: xml_construct
+    #
+    def parse(data)
+      xml = (data.kind_of?(XML::Node) ? data : XML::Parser.parse(data).root)
+
+      unless xml_construction_args.empty?
+        args = xml_construction_args.map do |arg|
+           tag_refs.find {|ref| ref.name == arg.to_s }
+        end.map {|ref| ref.value(xml) }
+        new(*args)
+      else
+        returning allocate do |inst|
+          tag_refs.each do |ref|
+            ref.populate(xml, inst)
+          end
+        end
+      end
+    end
+
+    # Sets the name of the XML element that represents this class. Use this
+    # to override the default lowercase class name.
+    #
+    # Example:
+    #  class BookWithPublisher
+    #   xml_name :book
+    #  end
+    #
+    # Without the xml_name annotation, the XML mapped tag would have been "bookwithpublisher".
+    #
+    def xml_name(name)
+      @tag_name = name
+    end
+
+    # Declares an accesser to a certain xml element, whether an attribute, a node,
+    # or a typed collection of nodes
+    #
+    # [sym]   Symbol representing the name of the accessor
+    #
+    # == Type options
+    # All type arguments may be used as the type argument to indicate just type,
+    # or used as :from, pointing to a xml name to indicate both type and attribute name.
+    # Also, any type may be passed via an array to indicate that multiple instances
+    # of the object should be returned as an array.
+    #
+    # === :attr
+    # Declare an accessor that represents an XML attribute.
+    #
+    # Example:
+    #  class Book
+    #   xml_reader :isbn, :attr => "ISBN" # 'ISBN' is used to specify :from
+    #   xml_accessor :title, :attr        # :from defaults to :title
+    #  end
+    #
+    # To map:
+    #  <book ISBN="0974514055" title="Programming Ruby: the pragmatic programmers' guide" />
+    #
+    # === :text
+    # The default type, if none is specified. Declares an accessor that
+    # represents a text node from XML.
+    #
+    # Example:
+    #  class Book
+    #    xml :author, false, :text => 'Author'
+    #    xml_accessor :description, :text, :as => :cdata
+    #    xml_reader :title
+    #  end
+    #
+    # To map:
+    #  <book>
+    #   <title>Programming Ruby: the pragmatic programmers' guide</title>
+    #   <description><![CDATA[Probably the best Ruby book out there]]></description>
+    #   <Author>David Thomas</author>
+    #  </book>
+    #
+    # Likewise, a number of :text node values can be collected in an array like so:
+    #
+    # Example:
+    #  class Library
+    #    xml_reader :books, [:text], :in => 'books'
+    #  end
+    #
+    # To map:
+    #  <library>
+    #    <books>
+    #      <book>To kill a mockingbird</book>
+    #      <book>House of Leaves</book>
+    #      <book>Gödel, Escher, Bach</book>
+    #    </books>
+    #  </library>
+    #
+    # === :content
+    # A special case of :text, this refers to the content of the current node,
+    # rather than a sub-node
+    #
+    # Example:
+    #  class Contributor
+    #    xml_reader :name, :content
+    #    xml_reader :role, :attr
+    #  end
+    #
+    # To map:
+    #  <contributor role="editor">James Wick</contributor>
+    #
+    # === Hash
+    # Somewhere between the simplicity of a :text/:attr mapping, and the complexity of
+    # a full Object/Type mapping, lies the Hash mapping.  It serves in the case where you have
+    # a collection of key-value pairs represented in your xml.  You create a hash declaration by
+    # passing a hash mapping as the type argument.  A few examples:
+    #
+    # ==== Hash of :attrs
+    # For xml such as this:
+    #
+    #    <dictionary>
+    #      <definitions>
+    #        <definition dt="quaquaversally"
+    #                    dd="adjective: (of a geological formation) sloping downward from the center in all directions." />
+    #        <definition dt="tergiversate"
+    #                    dd="To use evasions or ambiguities; equivocate." />
+    #      </definitions>
+    #    </dictionary>
+    #
+    # You can use the :attrs key in you has with a [:key, :value] name array:
+    #
+    #    xml_reader :definitions, {:attrs => ['dt', 'dd']}, :in => :definitions
+    #
+    # ==== Hash of :texts
+    # For xml such as this:
+    #
+    #    <dictionary>
+    #      <definition>
+    #        <word/>
+    #        <meaning/>
+    #      </definition>
+    #      <definition>
+    #        <word/>
+    #        <meaning/>
+    #      </definition>
+    #    </dictionary>
+    #
+    # You can individually declare your key and value names:
+    #    xml_reader :definitions, {:key => 'word',
+    #                              :value => 'meaning'}
+    #
+    # ==== Hash of :content &c.
+    # For xml such as this:
+    #
+    #    <dictionary>
+    #      <definition word="quaquaversally">adjective: (of a geological formation) sloping downward from the center in all directions.</definition>
+    #      <definition word="tergiversate">To use evasions or ambiguities; equivocate.</definition>
+    #    </dictionary>
+    #
+    # You can individually declare the key and value, but with the attr, you need to provide both the type
+    # and name of that type (i.e. {:attr => :word}), because omitting the type will result in ROXML
+    # defaulting to :text
+    #    xml_reader :definitions, {:key => {:attr => 'word'},
+    #                              :value => :content}
+    #
+    # ==== Hash of :name &c.
+    # For xml such as this:
+    #
+    #    <dictionary>
+    #      <quaquaversally>adjective: (of a geological formation) sloping downward from the center in all directions.</quaquaversally>
+    #      <tergiversate>To use evasions or ambiguities; equivocate.</tergiversate>
+    #    </dictionary>
+    #
+    # You can pick up the node names (e.g. quaquaversally) using the :name keyword:
+    #    xml_reader :definitions, {:key => :name,
+    #                              :value => :content}
+    #
+    # === Other ROXML Class
+    # Declares an accessor that represents another ROXML class as child XML element
+    # (one-to-one or composition) or array of child elements (one-to-many or
+    # aggregation) of this type. Default is one-to-one. Use :array option for one-to-many, or
+    # simply pass the class in an array.
+    #
+    # Composition example:
+    #  <book>
+    #   <publisher>
+    #     <name>Pragmatic Bookshelf</name>
+    #   </publisher>
+    #  </book>
+    #
+    # Can be mapped using the following code:
+    #   class Book
+    #     xml_reader :publisher, Publisher
+    #   end
+    #
+    # Aggregation example:
+    #  <library>
+    #   <books>
+    #    <book/>
+    #    <book/>
+    #   </books>
+    #  </library>
+    #
+    # Can be mapped using the following code:
+    #  class Library
+    #    xml_reader :books, [Book], :in => "books"
+    #  end
+    #
+    # If you don't have the <books> tag to wrap around the list of <book> tags:
+    #  <library>
+    #   <name>Ruby books</name>
+    #   <book/>
+    #   <book/>
+    #  </library>
+    #
+    # You can skip the wrapper argument:
+    #    xml_reader :books, [Book]
+    #
+    # == Blocks
+    # For readonly attributes, you may pass a block which manipulates the associated parsed value.
+    #
+    #  class Muffins
+    #    include ROXML
+    #
+    #    xml_reader :count, :from => 'bakers_dozens' {|val| val.to_i * 13 }
+    #  end
+    #
+    # For hash types, the block recieves the key and value as arguments, and they should
+    # be returned as an array of [key, value]
+    #
+    # == Other options
+    # [:from] The name by which the xml value will be found, either an attribute or tag name in XML.  Default is sym, or the singular form of sym, in the case of arrays and hashes.
+    # [:as] :cdata for character data
+    # [:in] An optional name of a wrapping tag for this XML accessor
+    # [:else] Default value for attribute, if missing
+    #
+    def xml(sym, writable = false, type_and_or_opts = :text, opts = nil, &block)
+      opts = Opts.new(sym, *[type_and_or_opts, opts].compact)
+
+      tag_refs << case opts.type
+      when :attr    then XMLAttributeRef
+      when :content then XMLTextRef
+      when :text    then XMLTextRef
+      when :hash    then XMLHashRef
+      when Symbol   then raise ArgumentError, "Invalid type argument #{opts.type}"
+      else               XMLObjectRef
+      end.new(sym, opts, &block)
+
+      add_accessor(sym, writable, opts.array?, opts.default)
+    end
+
+    # Declares a read-only xml reference. See xml for details.
+    def xml_reader(sym, type_and_or_opts = :text, opts = nil, &block)
+      xml sym, false, type_and_or_opts, opts, &block
+    end
+
+    # Declares a writable xml reference. See xml for details.
+    def xml_accessor(sym, type_and_or_opts = :text, opts = nil, &block)
+      xml sym, true, type_and_or_opts, opts, &block
+    end
+
+    def xml_construction_args # ::nodoc::
+      @xml_construction_args ||= []
+    end
+
+    # On parse, call the target object's initialize function with the listed arguments
+    def xml_construct(*args)
+      if missing_tag = args.detect {|arg| !tag_refs.map(&:name).include?(arg.to_s) }
+        raise ArgumentError, "All construction tags must be declared first using xml, " +
+                             "xml_reader, or xml_accessor. #{missing_tag} is missing. " +
+                             tag_refs.map(&:name).join(', ') + ' are declared.'
+      end
+      @xml_construction_args = args
+    end
+
+    # Returns the tag name (also known as xml_name) of the class.
+    # If no tag name is set with xml_name method, returns default class name
+    # in lowercase.
+    def tag_name
+      @tag_name ||= name.split('::').last.downcase
+    end
+
+    # Returns array of internal reference objects, such as attributes
+    # and composed XML objects
+    def tag_refs
+      @xml_refs ||= []
+    end
+
+  private
+    def assert_accessor(name)
+      @tag_accessors ||= []
+      raise "Accessor #{name} is already defined as XML accessor in class #{self}" if @tag_accessors.include?(name)
+      @tag_accessors << name
+    end
+
+    def add_accessor(name, writable, as_array, default = nil)
+      assert_accessor(name)
+      unless instance_methods.include?(name)
+        default ||= Array.new if as_array
+
+        define_method(name) do
+          val = instance_variable_get("@#{name}")
+          if val.nil?
+            val = default
+            instance_variable_set("@#{name}", val)
+          end
+          val
+        end
+      end
+      if writable && !instance_methods.include?("#{name}=")
+        define_method("#{name}=") do |v|
+          instance_variable_set("@#{name}", v)
+        end
+      end
+    end
+  end
+
+  class << self
+    #
+    # Extends the klass with the ROXML_Class module methods.
+    #
+    def included(klass) # ::nodoc::
+      super
+      klass.__send__(:extend, ROXML_Class)
+    end
+  end
+
+  #
+  # To make it easier to reference the class's
+  # attributes all method calls to the instance that
+  # doesn't match an instance method are forwarded to the
+  # class's singleton instance. Only methods 'tag_name' and 'tag_refs' are delegated.
+  def method_missing(name, *args)
+    if [:tag_name, :tag_refs].include? name
+      self.class.__send__(name, *args)
+    else
+      super
+    end
+  end
+end
+