rxsd 0.2 → 0.3

data/lib/rxsd/loader.rb

@@ -1,6 +1,6 @@
 # RXSD resource loader 
 #
-# 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/parser.rb

@@ -1,11 +1,11 @@
 # xml / xsd parsers
 #
-# 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
 
-# provides class methods to parse xsd and xml data
+# Provides class methods to parse xsd and xml data
 class Parser
  private
   def initialize
@@ -13,10 +13,10 @@ class Parser
 
  public
 
-  # parse xsd specified by uri or in raw data form into RXSD::XSD::Schema instance
+  # Parse xsd specified by uri or in raw data form into RXSD::XSD::Schema instance
   # args should be a hash w/ optional keys:
-  #   * :uri location which to load resource from
-  #   * :raw raw data which to parse
+  # * :uri location which to load resource from
+  # * :raw raw data which to parse
   def self.parse_xsd(args)
      data = Loader.load(args[:uri]) unless args[:uri].nil?
      data = args[:raw]              unless args[:raw].nil?
@@ -33,7 +33,7 @@ class Parser
      return schema
   end
 
-  # parse xml specified by uri or in raw data form into RXSD::XSD::SchemaInstance instance
+  # Parse xml specified by uri or in raw data form into RXSD::XSD::SchemaInstance instance
   def self.parse_xml(args)
      data = Loader.load(args[:uri]) unless args[:uri].nil?
      data = args[:raw]              unless args[:raw].nil?
@@ -46,12 +46,12 @@ class Parser
      return schema_instance
   end
 
-  # return true is specified class is builtin, else false
+  # Return true is specified class is builtin, else false
   def self.is_builtin?(builtin_class)
     [Array, String, Boolean, Char, Time, XSDFloat, XSDInteger].include? builtin_class
   end
 
-  # return ruby class corresponding to builting type
+  # Return ruby class corresponding to builtin type
   def self.parse_builtin_type(builtin_type_name)
     res = nil
 

data/lib/rxsd/resolver.rb

@@ -2,12 +2,12 @@
 #
 # resolves hanging node relationships and provides overall node access
 #
-# 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
 
-# resolves 
+# Resolves xsd relationships, used internally
 class Resolver
 
    # return hash of xsd types -> array of type instances for all nodes

data/lib/rxsd/translator.rb

@@ -2,7 +2,7 @@
 #
 # transaltes xsd <-> ruby classes & xml <-> instances
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
 # See COPYING for the License of this software
 
 # include whatever output builders you want here,
@@ -55,7 +55,7 @@ class Schema
       results = []
       cbs.each { |cb|
         # probably a better way to do this at some point than invoking the copy constructors
-        #
+
         # FIXME we create class builders in the translator on the fly, this may cause
         # problems for later operations that need to access class builder attributes which
         # have been created
@@ -83,29 +83,29 @@ class SchemaInstance
   # array of object builders represented by current instance
   attr_accessor :object_builders
 
-  # return array of ObjectBuilders parsed out of a RXSD::XML::Node.
+  # Return array of ObjectBuilders parsed out of a RXSD::XML::Node.
   # Optionally specify parent ObjectBuilder to use
   def self.builders_from_xml(node, parent = nil)
      node_builder = ObjectBuilder.new(:tag_name => node.name, :attributes => node.attrs, :parent => parent)
      parent.children.push node_builder unless parent.nil? || parent.children.include?(node_builder)
      builders = [ node_builder ]
-     node.children.each { |c|
-        if c.text?
-          node_builder.content = c.content  if node.children.size == 1 # FIXME if text/children-elements be mixed under a node this wont work
-        else
-          builders += SchemaInstance.builders_from_xml(c, node_builder )
-        end
-     }
+     if node.text?
+        node_builder.content = node.content
+     else
+        node.children.each { |c|
+           builders += SchemaInstance.builders_from_xml(c, node_builder )
+        }
+     end
      return builders
   end
 
-  # create new schema instance w/ specified args
+  # Create new schema instance w/ specified args
   def initialize(args = {})
     @object_builders = args[:builders] if args.has_key? :builders
   end
 
   # translates SchemaInstance's objects into instances of the specified output type.
-  # :output_type may be one of
+  # * :output_type may be one of
   #   * :ruby_objects
   # Must specify :schema argument containing RXSD::XSD::Schema to use in object creation
   def to(output_type, args = {})

data/lib/rxsd/xml.rb

@@ -1,6 +1,6 @@
 # xml parsing subsystem
 #
-# 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'
@@ -11,31 +11,31 @@ require 'libxml_adapter'
 module RXSD
 module XML
 
-# RXSD XML node interface subclasses must conform to and helper methods
+# RXSD XML node interface that subclasses must conform to and implement methods
 class Node
  
-  # should return name of node, eg <foo> => "foo"
+  # Should return name of node, eg <foo> => "foo"
   virtual :name
 
-  # return hash of attribute name / values
+  # Return hash of attribute name / values
   virtual :attrs
   
-  # should return bool if node has a parent
+  # Should return bool if node has a parent
   virtual :parent?
 
-  # should return this nodes's parent, if any
+  # Should return this nodes's parent, if any
   virtual :parent
   
-  # should return children nodes
+  # Should return children nodes
   virtual :children
 
-  # should return bool if node only contains text
+  # Should return bool if node only contains text
   virtual :text?
 
-  # should return string contents of text node
+  # Should return string contents of text node
   virtual :content
 
-  # should return list of namespaces corresponding to node
+  # Should return list of namespaces corresponding to node
   virtual :namespaces
 
   # should also define class method 'xml_root' that returns a node instance corresponding
@@ -43,7 +43,7 @@ class Node
 
   ############################################################################
 
-  # node factory, returns root node corresponding to specified backend and xml data
+  # Node factory, returns root node corresponding to specified backend and xml data
   def self.factory(args = {})
     backend = args[:backend]
     xml     = args[:xml]
@@ -53,40 +53,53 @@ class Node
     return nil
   end
 
-  # returns root node
+  # Returns root node
   def root
      parent? ? parent.root : self
   end
 
-  # provides accessor interface to related obj, in our case related xsd obj
+  # Provides accessor interface to related obj, in our case related xsd obj
   attr_accessor :related
 
-  # instantiate all children of provided class type
+  # Instantiate all children of provided class type
   def children_objs(klass)
      elements = []
      children.find_all { |c| c.name == klass.tag_name }.each { |c| 
-        elements.push(klass.from_xml(c)) }
+        elements << klass.from_xml(c)
+     }
      return elements
   end
 
-  # instantiate first child of provided class type
+  # Instantiate first child of provided class type
   def child_obj(klass)
       return children_objs(klass)[0]
   end
 
-  # return 'value' attribute of all children w/ specified tag
+  # Return 'value' attribute of all children w/ specified tag
   def child_values(tag_name)
      values = []
      children.find_all { |c| c.name == tag_name }.each { |c| values.push(c.attrs['value']) }
      return values
   end
 
-  # return 'value' attribute of first childw/ specified tag
+  # Return 'value' attribute of first childw/ specified tag
   def child_value(tag_name)
      return child_values(tag_name)[0]
   end
 
 end
 
+# RXSD XML namespace interface that subclasses must conform to and implement methods
+class Namespace
+  # Should return prefix of namespace
+  virtual :prefix
+
+  # Should return href of namespace
+  virtual :href
+
+  # Should return namespace in string format
+  virtual :to_s
+end
+
 end # module XML
 end # module RXSD

data/lib/rxsd/xsd/attribute.rb

@@ -1,6 +1,6 @@
 # The XSD Attribute definition
 #
-# 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/xsd/attribute_group.rb

@@ -1,6 +1,6 @@
 # The XSD AttributeGroup definition
 #
-# 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/xsd/choice.rb

@@ -1,6 +1,6 @@
 # The XSD Choice definition
 #
-# 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/xsd/complex_content.rb

@@ -1,6 +1,6 @@
 # The XSD ComplexContent definition
 #
-# 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/xsd/complex_type.rb

@@ -1,6 +1,6 @@
 # The XSD ComplexType definition
 #
-# 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
@@ -33,7 +33,8 @@ class ComplexType
 
   # returns array of all children
   def children
-    (@attributes + @attribute_groups).push(@simple_content).push(@complex_content).push(@choice).push(@group).push(@sequence)
+    (@attributes + @attribute_groups).push(@simple_content).
+    push(@complex_content).push(@choice).push(@group).push(@sequence)
   end
 
   # node passed in should be a xml node representing the complex type

data/lib/rxsd/xsd/element.rb

@@ -1,6 +1,6 @@
 # The XSD Element definition
 #
-# 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
@@ -13,7 +13,7 @@ class Element
   # element attribute values
   attr_accessor :id, :name, :type, 
                 :nillable, :abstract, :ref, 
-                :substitionGroup, :form, :maxOccurs,
+                :substitutionGroup, :form, :maxOccurs,
                  :minOccurs, :default, :fixed
 
   # simple type in element
@@ -64,7 +64,7 @@ class Element
        ref = ref.split(':')[1] if !(ref.nil? || ref.index(":").nil?)
        element.ref              = ref
 
-       element.substitionGroup  = node.attrs["substitionGroup"]
+       element.substitutionGroup  = node.attrs["substitutionGroup"]
        element.form             = node.attrs.has_key?("form") ? 
                                      node.attrs["form"] :
                                       node.root.attrs["elementFormDefault"]
@@ -108,8 +108,8 @@ class Element
       @ref = node_objs[Element].find { |no| no.name == @ref }
     end
     
-    unless @substitionGroup.nil?
-      @substitutionGroup = node_objs[Element].find { |no| no.name == @substitionGroup }
+    unless @substitutionGroup.nil?
+      @substitutionGroup = node_objs[Element].find { |no| no.name == @substitutionGroup }
     end
   end
 

data/lib/rxsd/xsd/extension.rb

@@ -1,6 +1,6 @@
 # The XSD Extension definition
 #
-# 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/xsd/group.rb

@@ -1,6 +1,6 @@
 # The XSD Group definition
 #
-# 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/xsd/list.rb

@@ -1,6 +1,6 @@
 # The XSD List definition
 #
-# 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/xsd/restriction.rb

@@ -1,6 +1,6 @@
 # The XSD Restriction definition
 #
-# 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/xsd/schema.rb

@@ -1,6 +1,6 @@
 # The XSD Schema definition
 #
-# 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
@@ -40,7 +40,8 @@ class Schema
 
   # returns array of all schema children
   def children
-    ([@elements] + [@simple_types] + [@complex_types] + [@attributes] + [@attribute] + [@attribute_groups] + [@groups]).flatten
+    ([@elements] + [@simple_types] + [@complex_types] + [@attributes] + 
+     [@attribute_groups] + [@groups]).flatten
   end
 
   # node passed in should be a xml root node representing the schema

data/lib/rxsd/xsd/sequence.rb

@@ -1,6 +1,6 @@
 # The XSD Sequence definition
 #
-# 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/xsd/simple_content.rb

@@ -1,6 +1,6 @@
 # The XSD SimpleContent definition
 #
-# 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/xsd/simple_type.rb

@@ -1,6 +1,6 @@
 # The XSD SimpleType definition
 #
-# 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/spec/builder_spec.rb

@@ -0,0 +1,224 @@
+# tests the builder module
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# See COPYING for the License of this software
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Builder" do
+
+  # test to_class_builder method on all XSD classes
+
+  it "should return schema class builders" do
+    schema = Schema.new
+    elem1  = MockXSDEntity.new
+    elem2  = MockXSDEntity.new
+
+    schema.elements = [elem1, elem2]
+    class_builders = schema.to_class_builders
+
+    class_builders.size.should == 2
+    class_builders[0].class.should == ClassBuilder
+    class_builders[0].instance_variable_get("@xsd_obj").should == elem1
+    class_builders[1].class.should == ClassBuilder
+    class_builders[1].instance_variable_get("@xsd_obj").should == elem2
+  end
+
+  it "should return element class builders" do
+    elem1 = MockXSDEntity.new
+    st1   = MockXSDEntity.new
+    ct1   = MockXSDEntity.new
+
+    element = Element.new
+    element.name = "foo_element"
+    element.ref = elem1
+    cb = element.to_class_builder
+    cb.class.should == ClassBuilder
+    cb.instance_variable_get("@xsd_obj").should == elem1
+    cb.klass_name.should == "FooElement"
+
+    # FIXME the next two 'type' test cases need to be fixed / expanded
+    element = Element.new
+    element.name = "bar_element"
+    element.type = st1
+    cb = element.to_class_builder
+    cb.class.should == ClassBuilder
+    #cb.instance_variable_get("@xsd_obj").should == st1     TODO since clone is invoked, @xsd_obj test field never gets copied, fix this
+    cb.klass_name.should == "BarElement"
+
+    element = Element.new
+    element.type = ct1
+    cb = element.to_class_builder
+    cb.class.should == ClassBuilder
+    #cb.instance_variable_get("@xsd_obj").should == ct1
+
+    element = Element.new
+    element.simple_type = st1
+    cb = element.to_class_builder
+    cb.class.should == ClassBuilder
+    cb.instance_variable_get("@xsd_obj").should == st1
+
+    element = Element.new
+    element.complex_type = ct1
+    cb = element.to_class_builder
+    cb.class.should == ClassBuilder
+    cb.instance_variable_get("@xsd_obj").should == ct1
+  end
+
+  # FIXME test other XSD classes' to_class_builder methods
+
+  ##########
+
+  it "should correctly return associated builders" do
+     gp = ClassBuilder.new
+     p  = ClassBuilder.new :base_builder => gp
+     c  = ClassBuilder.new :base_builder => p
+     as = ClassBuilder.new 
+     c.associated_builder = as
+     at1 = ClassBuilder.new
+     at2 = ClassBuilder.new
+     c.attribute_builders.push at1
+     c.attribute_builders.push at2
+
+     ab = c.associated
+     ab.size.should == 5
+  end
+
+  it "should build class" do
+     cb1 = RubyClassBuilder.new :klass => String, :klass_name => "Widget"
+     cb1.build.should == String
+
+     cb2 = RubyClassBuilder.new :klass_name => "Foobar"
+     c2 = cb2.build
+     c2.should == Foobar
+     c2.superclass.should == Object
+
+     acb = RubyClassBuilder.new :klass => Array, :klass_name => "ArrSocket", :associated_builder => cb1
+     ac = acb.build
+     ac.should == Array
+
+     tcb = RubyClassBuilder.new :klass_name => "CamelCased"
+
+     cb3 = RubyClassBuilder.new :klass_name => "Foomoney", :base_builder => cb2
+     cb3.attribute_builders.push cb1
+     cb3.attribute_builders.push tcb
+     cb3.attribute_builders.push acb
+     c3 = cb3.build
+     c3.should == Foomoney
+     c3.superclass.should == Foobar
+     c3i = c3.new
+     c3i.method(:widget).should_not be_nil
+     c3i.method(:widget).arity.should == 0
+     c3i.method(:widget=).should_not be_nil
+     c3i.method(:widget=).arity.should == 1
+     c3i.method(:camel_cased).should_not be_nil
+     c3i.method(:camel_cased).arity.should == 0
+     c3i.method(:camel_cased=).should_not be_nil
+     c3i.method(:camel_cased=).arity.should == 1
+     c3i.method(:arr_socket).should_not be_nil
+     c3i.method(:arr_socket).arity.should == 0
+     c3i.method(:arr_socket=).should_not be_nil
+     c3i.method(:arr_socket=).arity.should == 1
+  end
+
+  it "should build definition" do
+     cb1 = RubyDefinitionBuilder.new :klass => String, :klass_name => "Widget"
+     cb1.build.should == "class String\nend"
+
+     cb2 = RubyDefinitionBuilder.new :klass_name => "Foobar"
+     d2 = cb2.build
+     d2.should == "class Foobar < Object\nend"
+
+     acb = RubyDefinitionBuilder.new :klass => Array, :klass_name => "ArrSocket", :associated_builder => cb1
+     ad = acb.build
+     ad.should == "class Array\nend"
+
+     tcb = RubyDefinitionBuilder.new :klass_name => "CamelCased"
+
+     cb3 = RubyDefinitionBuilder.new :klass_name => "Foomoney", :base_builder => cb2
+     cb3.attribute_builders.push cb1
+     cb3.attribute_builders.push tcb
+     cb3.attribute_builders.push acb
+     d3 = cb3.build
+     d3.should == "class Foomoney < Foobar\n" +
+                  "attr_accessor :widget\n" +
+                  "attr_accessor :camel_cased\n" +
+                  "attr_accessor :arr_socket\n" +
+                  "end"
+  end
+
+  it "should build object" do
+     schema_data = "<schema xmlns:xs='http://www.w3.org/2001/XMLSchema'>" +
+                   "<xs:element name='Godzilla'>" +
+                     "<xs:complexType>" +
+                       "<xs:simpleContent>" +
+                         "<xs:extension base='xs:string'>" +
+                           "<xs:attribute name='first_attr' type='xs:string' />" +
+                           "<xs:attribute name='SecondAttr' type='xs:integer' />" +
+                         "</xs:extension>" +
+                       "</xs:simpleContent>"+
+                     "</xs:complexType>"+
+                   "</xs:element>" +
+                   "</schema>"
+
+     schema = Parser.parse_xsd :raw => schema_data
+     rbclasses = schema.to :ruby_classes
+
+     rob = RubyObjectBuilder.new :tag_name => "Godzilla", :content => "some stuff", :attributes => { "first_attr" => "first_val", "SecondAttr" => "420" }
+     obj = rob.build schema
+
+     obj.class.should == Godzilla
+     obj.should == "some stuff"  # since obj derives from string
+     obj.first_attr.should == "first_val"
+     obj.second_attr.should == 420
+
+
+     schema_data = "<schema xmlns:xs='http://www.w3.org/2001/XMLSchema'>" +
+                      '<xs:element name="employee" type="fullpersoninfo"/>' +
+                         '<xs:complexType name="personinfo">'+
+                            '<xs:attribute name="ssn" type="xs:string" />' +
+                            '<xs:sequence>'+
+                               '<xs:element name="firstname" type="xs:string"/>'+
+                               '<xs:element name="lastname" type="xs:string"/>'+
+                            '</xs:sequence>'+
+                         '</xs:complexType>'+
+                         '<xs:complexType name="fullpersoninfo">'+
+                           '<xs:complexContent>'+
+                             '<xs:extension base="personinfo">'+
+                               '<xs:attribute name="residency" type="xs:string" />' +
+                               '<xs:sequence>'+
+                                 '<xs:element name="address" type="xs:string"/>'+
+                                 '<xs:element name="country" type="xs:string"/>'+
+                               '</xs:sequence>'+
+                             '</xs:extension>'+
+                           '</xs:complexContent>'+
+                         '</xs:complexType> '+
+                   "</schema>"
+
+     schema = Parser.parse_xsd :raw => schema_data
+     rbclasses = schema.to :ruby_classes
+
+     rob = RubyObjectBuilder.new :tag_name => "employee", :attributes => { "ssn" => "111-22-3333", "residency" => "citizen" },
+                             :children => [ ObjectBuilder.new(:tag_name => "firstname", :content => "mo" ),
+                                            ObjectBuilder.new(:tag_name => "lastname",  :content => "morsi"),
+                                            ObjectBuilder.new(:tag_name => "address",   :content => "wouldn't you like to know :-p"),
+                                            ObjectBuilder.new(:tag_name => "country",   :content => "USA") ]
+
+     obj = rob.build schema
+
+     obj.class.should == Employee
+     obj.ssn.should == "111-22-3333"
+     obj.residency.should == "citizen"
+     obj.firstname.should == "mo"
+     obj.lastname.should == "morsi"
+     obj.country.should == "USA"
+  end
+end
+
+class MockXSDEntity
+  def to_class_builder
+     cb = ClassBuilder.new
+     cb.instance_variable_set("@xsd_obj", self)
+     return cb
+  end
+end