rxsd 0.2 → 0.3

data/README.rdoc

@@ -0,0 +1,56 @@
+== RXSD - XSD / Ruby Translator
+
+Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+
+RXSD is made available under the GNU LESSER GENERAL PUBLIC LICENSE
+as published by the Free Software Foundation, either version 3
+of the License, or (at your option) any later version.
+
+== Info
+RXSD is a library that translates XSD XML Schema Definitions into Ruby Classes 
+on the fly. It is able to read XSD resources and use them to define Ruby 
+classes in memory or string class definitions to be written to the filesystem
+
+RXSD implements a full XSD parser that not only defines the various xsd schema
+classes, parsing them out of a XSD file, but translates them into a 
+meta-class heirarchy, for use in subsequent transformations. The builder interface
+can easily be extended to output any format one could want including classes
+in other languages (Python, C++, Java, etc), other XML formats, etc.
+
+RXSD also parses XML conforming to a XSD schema, and instantiates objects 
+corresponding to the XSD classes created. Furthermore, RXSD will work with
+existing class definitions resulting in a quick way to map XSD to Ruby constructs,
+letting you define the schema features that you need, and autogenerting handlers
+to the others.
+
+== Installation
+
+To install rxsd simply run:
+   gem install rxsd
+
+Source code is available via:
+   git clone http://github.com/movitto/rxsd
+
+== Usage
+
+  require 'lib/rxsd'
+  
+  xsd_uri = "file:///home/user/schema.xsd"
+  xml_uri = "file:///home/user/data.xml"
+  
+  schema = RXSD::Parser.parse_xsd :uri => xsd_uri
+  
+  puts "=======Classes======="
+  classes = schema.to :ruby_classes
+  puts classes.collect{ |cl| !cl.nil? ? (cl.to_s + " < " + cl.superclass.to_s) : ""}.sort.join("\n")
+  
+  puts "=======Tags======="
+  puts schema.tags.collect { |n,cb| n + ": " + cb.to_s + ": " + (cb.nil? ? "ncb" : cb.klass_name.to_s + "-" + cb.klass.to_s) }.sort.join("\n")
+  
+  puts "=======Objects======="
+  data = RXSD::Parser.parse_xml :uri => xml_uri
+  objs = data.to :ruby_objects, :schema => schema
+  objs.each {  |obj|
+    puts "#{obj}"
+  }
+  

data/Rakefile

@@ -0,0 +1,46 @@
+# rxsd project Rakefile
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the LGPLv3+ http://www.gnu.org/licenses/lgpl.txt
+
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require 'rake/gempackagetask'
+
+
+GEM_NAME="rxsd"
+PKG_VERSION='0.3'
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Rake::RDocTask.new do |rd|
+    rd.main = "README.rdoc"
+    rd.rdoc_dir = "doc/site/api"
+    rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+end
+
+PKG_FILES = FileList['bin/**/*', 'lib/**/*.rb', 'COPYING', 'LICENSE', 'Rakefile', 'README.rdoc', 'spec/**/*.rb' ]
+
+SPEC = Gem::Specification.new do |s|
+    s.name = GEM_NAME
+    s.version = PKG_VERSION
+    s.files = PKG_FILES
+
+    s.required_ruby_version = '>= 1.8.1'
+    s.required_rubygems_version = Gem::Requirement.new(">= 1.3.3")
+
+    s.author = "Mohammed Morsi"
+    s.email = "movitto@yahoo.com"
+    s.date = %q{2010-03-18}
+    s.description = %q{A library to translate xsd schemas and xml implementations into ruby classes/objects}
+    s.summary = %q{A library to translate xsd schemas and xml implementations into ruby classes/objects}
+    s.homepage = %q{http://morsi.org/projects/RXSD}
+end
+
+Rake::GemPackageTask.new(SPEC) do |pkg|
+    pkg.need_tar = true
+    pkg.need_zip = true
+end

data/bin/gen_ruby_definitions.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby
+# Simple rxsd test utility
+#
+# Usage rxsd-test.rb uri-to-schema uri-to-xml-instance
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# See COPYING for the License of this software
+
+require 'fileutils'
+require 'lib/rxsd'
+
+if ARGV.size < 2
+  puts "missing required arguments"
+  puts "usage: gen_ruby_definitions xsd_uri output_dir"
+  exit
+end
+
+xsd_uri    = ARGV[0]
+output_dir = ARGV[1]
+
+if File.exists?(output_dir) && ! File.directory?(output_dir)
+  puts "#{output_dir} is not a dir, exiting"
+  exit
+end
+
+if !File.exists?(output_dir)
+  FileUtils.mkdir(output_dir)
+end
+
+schema = RXSD::Parser.parse_xsd :uri => xsd_uri
+definitions = schema.to :ruby_definitions
+
+definitions.each { |d|
+   d =~ /^.*class\s*([A-Za-z]*).*$/ # XXX Hacky way to get class name
+   cl = $1
+   File.write(output_dir + "/" + $1 + ".rb", d)
+}

data/bin/rxsd-test.rb

@@ -1,14 +1,16 @@
+#!/usr/bin/ruby
 # Simple rxsd test utility
 #
 # Usage rxsd-test.rb uri-to-schema uri-to-xml-instance
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 require 'lib/rxsd'
 
 if ARGV.size < 2
   puts "missing required arguments"
+  puts "usage: rxsd-test xsd_uri xml_uri"
   exit
 end
 
@@ -16,15 +18,6 @@ xsd_uri = ARGV[0]
 xml_uri = ARGV[1]
 
 schema = RXSD::Parser.parse_xsd :uri => xsd_uri
-#def disp_child(obj)
-#  if obj.respond_to? 'children'
-#  puts "#{obj}"
-#    obj.children.each { |c|
-#      disp_child c
-#    }
-#  end
-#end
-#disp_child(schema)
 
 puts "=======Classes======="
 classes = schema.to :ruby_classes

data/lib/rxsd.rb

@@ -1,6 +1,6 @@
 # include all rxsd modules
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 lib = File.dirname(__FILE__)

data/lib/rxsd/builder.rb

@@ -2,12 +2,12 @@
 #
 # responsible for providing  interface to build any output format from XSD metadata
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 module RXSD
 
-# base interface and helper methods to build classes in various formats from specified parameters
+# Base interface and helper methods to build classes in various formats from xsd schemas
 class ClassBuilder
    # actual class built
    attr_accessor :klass
@@ -27,8 +27,10 @@ class ClassBuilder
    # name of the attribute which this class represents, for use in accessor construction
    attr_accessor :attribute_name
 
-   # create a new class builder w/ specified args
+   # Create a new class builder w/ specified args. 
    def initialize(args = {})
+      @klass = @klass_name = @attribute_name = @associated_builder = @base_builder = nil
+
       if args.has_key? :builder
         @klass              = args[:builder].klass
         @klass_name         = args[:builder].klass_name
@@ -52,12 +54,13 @@ class ClassBuilder
       end
    end
 
-   # helper method
+   # Set base builder
    def base=(base)
      @base_builder = ClassBuilder.new :klass => base
    end
 
-   # perform a deep copy of builder, takes optional recursive guard
+   # Perform a deep copy of builder. 
+   # cloned param is used internally and should not be set by invoker.
    def clone(cloned = {})
       return cloned[self] if cloned.has_key? self
 
@@ -74,7 +77,7 @@ class ClassBuilder
       return cb
    end
 
-   # helper method to get all associated class builders
+   # Helper method to get all associated class builders
    def associated(builders = [])
        unless @base_builder.nil? || builders.include?(@base_builder)
          builders.push @base_builder
@@ -102,7 +105,7 @@ class ClassBuilder
 
 end # class ClassBuilder
 
-# base interface and helper methods to build objects in various formats from specified parameters
+# Base interface and helper methods to build objects in various formats from specified parameters
 class ObjectBuilder
    # name of class instance to build
    attr_accessor :tag_name
@@ -124,7 +127,7 @@ class ObjectBuilder
    # parent object builder, optionally set
    attr_accessor :parent
 
-   # create a new class builder w/ specified args
+   # Create a new class builder w/ specified args
    def initialize(args = {})
       if args.has_key? :builder
         @tag_name           = args[:builder].tag_name

data/lib/rxsd/builders/ruby_class.rb

@@ -1,11 +1,11 @@
 # RXSD Ruby Class builder
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 module RXSD
 
-# Implements the RXSD::ClassBuilder interface to build Ruby Classes from xsd
+# Implements the RXSD::ClassBuilder interface to build Ruby Classes from a xsd schema
 class RubyClassBuilder < ClassBuilder
 
 

data/lib/rxsd/builders/ruby_definition.rb

@@ -1,6 +1,6 @@
 # RXSD Ruby Definition builder
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 module RXSD

data/lib/rxsd/builders/ruby_object.rb

@@ -1,6 +1,6 @@
 # RXSD Ruby Object builder
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 module RXSD

data/lib/rxsd/builtin_types.rb

@@ -7,7 +7,7 @@
 # no arguments as well as from a string string parameter
 # (exception is made in the case of Array)
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 require 'date'
@@ -15,8 +15,9 @@ require 'date'
 # Array, String, Time can be instantiated as is
 
 class Array
-  # arrays take addition parameter when instantiating from
-  # string, the item type which to instantiate array elements w/
+  # Convert string to array and return.
+  # * str should be the string encoded array
+  # * item_type should be the class on which to invoke from_s on each array item
   def self.from_s(str, item_type)
      arr = []
      str.split.each { |i|
@@ -27,47 +28,69 @@ class Array
 end
 
 class String
-  # convert string to boolean
+  # Convert string to boolean
   def to_b
     return true if self == true || self =~ /^true$/i
     return false if self == false || self.nil? || self =~ /^false$/i
     raise ArgumentError, "invalid value for Boolean: \"#{self}\""
   end
 
+  # Convert string to string (just return str)
   def self.from_s(str)
      str
   end
+
+  # Helper to convert string to array of specified type.
+  def to_a(args = {})
+     arr = []
+     item_type = args[:type]
+     delim     = args.has_key?(:delim) ? args[:delim] : ' '
+     split(delim).collect { |item| arr.push(item_type.from_s(item)) }
+     return arr
+  end
 end
 
 class Time
+  # Convert string to Time and return 
   def self.from_s(str)
      return Time.parse(str)
   end
 end
 
-# ruby doesn't define Char class, so we dispatch to string
+# Ruby doesn't define a Char class, so we define one here and dispatch to string
 class Char < String
 end
 
-# Since we can't create new instances of Integer, Float,
-# etc subclasses, we use the delegate module
-# http://codeidol.com/other/rubyckbk/Numbers/Simulating-a-Subclass-of-Fixnum/
 require 'delegate'
 
+# Since we can't create new instances of Integer subclasses,
+# we use the delegate module.
+# http://codeidol.com/other/rubyckbk/Numbers/Simulating-a-Subclass-of-Fixnum/
 class XSDInteger < DelegateClass(::Integer)
+
+  # Convert string to integer and return
   def self.from_s(str)
      str.to_i
   end
+
 end
 
+# Since we can't create new instances of Float subclasses,
+# we use the delegate module.
+# http://codeidol.com/other/rubyckbk/Numbers/Simulating-a-Subclass-of-Fixnum/
 class XSDFloat < DelegateClass(::Float)
+
+  # Convert string to float and return
   def self.from_s(str)
      str.to_f
   end
+
 end
 
-# ruby doesn't define Boolean class, so we define one ourselves
+# Ruby doesn't define a Boolean class, so we define one ourselves
 class Boolean
+
+  # Convert string to boolean and return
   def self.from_s(str)
      str.to_b
   end

data/lib/rxsd/common.rb

@@ -1,6 +1,6 @@
 # Things that don't fit elsewhere
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 # we make use of the activesupport inflector
@@ -10,6 +10,7 @@ require 'active_support'
 require 'logger'
 
 class Logger
+  # Override default logger format
   def format_message(severity, timestamp, progname, msg)
     "#{severity} #{timestamp} (#{$$}) #{msg}\n"
   end

data/lib/rxsd/exceptions.rb

@@ -1,6 +1,6 @@
 # RXSD exceptions
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 require 'uri' # use uri to parse sources

data/lib/rxsd/libxml_adapter.rb

@@ -1,7 +1,6 @@
-
 # libxml adapter
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 require 'rubygems'
@@ -10,65 +9,103 @@ require 'libxml' # based on libxml
 module RXSD
 module XML
 
-# class prototype needed :-(
-class Node
+class Node ; end
+class Namespace ; end
+
+# Some additions to the libxml namespace interface
+class LibXMLNamespace < Namespace
+   def initialize(args = {})
+      @ns = args[:ns]
+   end
+
+   # Implementation of RXSD::XML::Namespace.prefix
+   def prefix
+      @ns.prefix
+   end
+
+   # Implementation of RXSD::XML::Namespace.href
+   def href
+      @ns.href
+   end
+
+   # Implementation of RXSD::XML::Namespace.to_s
+   def to_s
+      @ns.to_s
+   end
 end
 
-# some additions to libxml xml node interface 
+# Some additions to libxml xml node interface 
 class LibXMLNode < Node
 
-  # implementation of RXSD::XML::Node::xml_root(xml)
+  # Implementation of RXSD::XML::Node::xml_root(xml)
   def self.xml_root(xml)
       LibXMLNode.new :node => LibXML::XML::Document.string(xml).root
   end
 
-  # create libxml node adapter w/ specified args, which may include
-  #   * :node LibXML::Node to use to satify requests
+  # Create libxml node adapter w/ specified args, which may include
+  # * :node LibXML::Node to use to satify requests
   def initialize(args = {})
      @node = args[:node]
+     @parent = args[:parent] if args.has_key? :parent
+
+     @attributes = @node.attributes.to_h
+
+     @children = []
+     @node.children.find_all { |n| !n.text? }.each { |n|
+       @children << LibXMLNode.new(:node => n, :parent => self)
+     }
+     
+     @namespaces = []
+     @node.namespaces.each { |ns| 
+        @namespaces << LibXMLNamespace.new(:ns => ns)
+     }
   end
 
 
-  # implementation of RXSD::XML::Node.name
+  # Implementation of RXSD::XML::Node.name
   def name 
      @node.name
   end
 
-  # implementation of RXSD::XML::Node.attrs
+  # Implementation of RXSD::XML::Node.attrs
   def attrs
-     @node.attributes.to_h
+     @attributes
   end
   
-  # implementation of RXSD::XML::Node.parent?
+  # Implementation of RXSD::XML::Node.parent?
   def parent?
      @node.parent? && @node.parent.class != LibXML::XML::Document
   end
 
-  # implementation of RXSD::XML::Node.parent
+  # FIXME in parent and children don't instantiate new objects, instead use some shared registry
+
+  # Implementation of RXSD::XML::Node.parent
   def parent
-     parent? ? LibXMLNode.new(:node => @node.parent) : nil
+     parent? ? @parent : nil
   end
 
-  # implementation of RXSD::XML::Node.children
+  # Implementation of RXSD::XML::Node.children
   def children
-     @node.children.collect { |n|
-       LibXMLNode.new :node => n
-     }
+     @children
   end
 
-  # implementation of RXSD::XML::Node.text?
+  # Implementation of RXSD::XML::Node.text?. 
+  # See #content method as well
   def text?
-     @node.text?
+     @node.text? || (@node.children.size == 1 && @node.children[0].text?)
   end
 
-  # implementation of RXSD::XML::Node.content
+  # Implementation of RXSD::XML::Node.content
+  # See text? method as well
   def content
-     @node.content
+     return nil unless text?
+     @node.content if @node.text?
+     @node.children[0].content
   end
 
-  # implementation of RXSD::XML::Node.namespaces
+  # Implementation of RXSD::XML::Node.namespaces
   def namespaces
-     @node.namespaces
+     @namespaces
   end
 
 end