rgen 0.4.0 → 0.4.1

data/CHANGELOG

@@ -35,3 +35,18 @@
 * Added UML1.3 Metamodel
 * Added tranformation from UML1.3 to ECore
 
+=0.4.1 (Nov 25th, 2007)
+
+* Template language performance improvement
+* Bugfix: use true/false instead of symbols for boolean attribute default values in metamodel classes
+* Minor fixes on metamodel generator and ecore primitive type handling
+* Made transformer implementation non-recursive to prevent "stack level too deep" exception for large models
+* Minor fixes on EAInstantiator
+* Made transformer search for matching rules for superclasses 
+* Bugfix: Enums are now added to EPackages created using the "ecore" method on a module
+* Bugfix: Metamodel generator now writes enum names
+* Performance improvement: don't require ecore transformer every time someone calls "ecore"
+* Major performance improvement of template engine (no Regexps to check \n at end of line)
+* Major performance improvement: AbstractXMLInstantiator optionally controls the garbage collector
+* Major performance improvement: ERB templates are reused in metamodel_builder
+* Added delete method to Environment

data/lib/instantiators/ea_instantiator.rb

@@ -8,13 +8,16 @@ class EAInstantiator < XMI11Instantiator
     :tags => {
       "EAStub" => proc { |tag, attr| UML13::Class.new(
         :name => attr["name"]
-      )}
+      )},
+      "ActivityModel" => "ActivityGraph",
+      "PseudoState" => "Pseudostate"
     },
     :feature_names => {
       "isOrdered" => "ordering",
       "subtype" => "child",
       "supertype" => "parent",
-      "changeable" => "changeability"
+      "changeable" => "changeability",
+      "substate" => "subvertex"
     },
     :feature_values => {
       "ordering" => {"true" => "ordered", "false" => "unordered"},

data/lib/metamodels/uml13_metamodel.rb

@@ -4,16 +4,16 @@ module UML13
    extend RGen::MetamodelBuilder::ModuleExtension
    include RGen::MetamodelBuilder::DataTypes
 
-   AggregationKind = Enum.new([ :none, :aggregate, :composite ])
-   ChangeableKind = Enum.new([ :changeable, :frozen, :addOnly ])
-   OperationDirectionKind = Enum.new([ ])
-   ParameterDirectionKind = Enum.new([ :in, :inout, :out, :return ])
-   MessageDirectionKind = Enum.new([ ])
-   ScopeKind = Enum.new([ :instance, :classifier ])
-   VisibilityKind = Enum.new([ :public, :protected, :private ])
-   PseudostateKind = Enum.new([ :initial, :deepHistory, :shallowHistory, :join, :fork, :branch, :junction, :final ])
-   CallConcurrencyKind = Enum.new([ :sequential, :guarded, :concurrent ])
-   OrderingKind = Enum.new([ :unordered, :ordered, :sorted ])
+   AggregationKind = Enum.new(:name => "AggregationKind", :literals =>[ :none, :aggregate, :composite ])
+   ChangeableKind = Enum.new(:name => "ChangeableKind", :literals =>[ :changeable, :frozen, :addOnly ])
+   OperationDirectionKind = Enum.new(:name => "OperationDirectionKind", :literals =>[ ])
+   ParameterDirectionKind = Enum.new(:name => "ParameterDirectionKind", :literals =>[ :in, :inout, :out, :return ])
+   MessageDirectionKind = Enum.new(:name => "MessageDirectionKind", :literals =>[ ])
+   ScopeKind = Enum.new(:name => "ScopeKind", :literals =>[ :instance, :classifier ])
+   VisibilityKind = Enum.new(:name => "VisibilityKind", :literals =>[ :public, :protected, :private ])
+   PseudostateKind = Enum.new(:name => "PseudostateKind", :literals =>[ :initial, :deepHistory, :shallowHistory, :join, :fork, :branch, :junction, :final ])
+   CallConcurrencyKind = Enum.new(:name => "CallConcurrencyKind", :literals =>[ :sequential, :guarded, :concurrent ])
+   OrderingKind = Enum.new(:name => "OrderingKind", :literals =>[ :unordered, :ordered, :sorted ])
 
    class Element < RGen::MetamodelBuilder::MMBase
    end

data/lib/mmgen/templates/annotations.tpl

@@ -33,5 +33,5 @@
 <% end %>
 
 <% define 'Details', :for => EAnnotation do %>
-	<%= details.sort{|a,b| a.key<=>b.key}.collect{ |d| "\'" + d.key + "\' => \'"+ d.value.gsub('\'','\\\'').to_s + "\'"}.join(', ') %><%nows%>
+	<%= details.sort{|a,b| a.key<=>b.key}.collect{ |d| "\'" + d.key + "\' => \'"+ (d.value || "").gsub('\'','\\\'').to_s + "\'"}.join(', ') %><%nows%>
 <% end %>

data/lib/mmgen/templates/metamodel_generator.tpl

@@ -83,7 +83,7 @@
 
 <% define 'EnumTypes', :for => EPackage do %>
 	<% for enum in eClassifiers.select{|c| c.is_a?(EEnum)} %>
-		<%= enum.name %> = Enum.new([ <%nows%>
+		<%= enum.name %> = Enum.new(:name => '<%= enum.name %>', :literals =>[ <%nows%>
 		<%= enum.eLiterals.collect { |lit| ":"+lit.name }.join(', ') %> ])
 	<% end %>
 <% end %>

data/lib/rgen/ecore/ecore.rb

@@ -67,10 +67,10 @@ module RGen
       has_attr 'instanceClassName', String
       module ClassModule
         def instanceClass_derived
-          map = {"java.lang.String" => "String", "boolean" => "RGen::MetamodelBuilder::DataTypes::Boolean", "int" => "Integer"}
+          map = {"java.lang.string" => "String", "boolean" => "RGen::MetamodelBuilder::DataTypes::Boolean", "int" => "Integer"}
           icn = instanceClassName
           icn = "NilClass" if icn.nil?
-          icn = map[icn] if map[icn]
+          icn = map[icn.downcase] if map[icn.downcase]
           eval(icn)
         end
       end

data/lib/rgen/ecore/ecore_instantiator.rb

@@ -13,8 +13,10 @@ module ECoreInstantiator
 	# class or module using ECoreTransformer.
 	# 
 	def ecore
-		require 'rgen/ecore/ecore_transformer'
-		@@transformer ||= ECoreTransformer.new
+		unless defined?(@@transformer)
+			require 'rgen/ecore/ecore_transformer'
+			@@transformer = ECoreTransformer.new
+		end
 		@@transformer.trans(self)
 	end	
 	

data/lib/rgen/ecore/ecore_transformer.rb

@@ -31,8 +31,12 @@ class ECoreTransformer < Transformer
   end
   
   transform Module, :to => EPackage, :if => :convert?  do
+  	@enumParentModule ||= {}
+  	constants.select {|c| const_get(c).is_a?(MetamodelBuilder::DataTypes::Enum)}.
+  		each {|c| @enumParentModule[const_get(c)] = @current_object}
     { :name => name.gsub(/.*::(\w+)$/,'\1'),
-      :eClassifiers => trans(constants.collect{|c| const_get(c)}.select{|c| c.is_a?(Class)}),
+      :eClassifiers => trans(constants.collect{|c| const_get(c)}.select{|c| c.is_a?(Class) || 
+	      (c.is_a?(MetamodelBuilder::DataTypes::Enum) && c != MetamodelBuilder::DataTypes::Boolean) }),
       :eSuperPackage => trans(name =~ /(.*)::\w+$/ ? eval($1) : nil),
       :eSubpackages => trans(constants.collect{|c| const_get(c)}.select{|c| c.is_a?(Module) && !c.is_a?(Class)}),
       :eAnnotations => trans(_annotations)
@@ -71,6 +75,7 @@ class ECoreTransformer < Transformer
   
   transform MetamodelBuilder::DataTypes::Enum, :to => EEnum do
     { :name => name, 
+      :instanceClassName => @enumParentModule && @enumParentModule[@current_object] && @enumParentModule[@current_object].name+"::"+name,
       :eLiterals => literals.collect do |l|
         lit = EEnumLiteral.new
         lit.name = l.to_s

data/lib/rgen/environment.rb

@@ -18,6 +18,11 @@ class Environment
 		self
 	end
 	
+	# Removes model element from environment.
+	def delete(el)
+		@elements.delete(el)
+	end
+		
 	# Iterates each element
 	#
 	def each(&b)

data/lib/rgen/environment.rb.bak

@@ -0,0 +1,42 @@
+require 'rgen/find_helper'
+
+module RGen
+
+# An Environment is used to hold model elements.
+#
+class Environment
+	include RGen::FindHelper
+
+	def initialize
+		@elements = []
+	end
+	
+	# Add a model element. Returns the environment so <code><<</code> can be chained.
+	# 
+	def <<(el)
+		@elements << el
+		self
+	end
+	
+	# Iterates each element
+	#
+	def each(&b)
+		@elements.each(&b)
+	end
+	
+	# Return the elements of the environment as an array
+	#
+	def elements
+		@elements.dup
+	end
+	
+	# This method can be used to instantiate a class and automatically put it into
+	# the environment. The new instance is returned.
+	#
+	def new(clazz, *args)
+		@elements << clazz.new(*args)
+		@elements[-1]
+	end
+end
+	
+end

data/lib/rgen/instantiator/abstract_xml_instantiator.rb

@@ -7,9 +7,10 @@ class AbstractXMLInstantiator
   class XMLScanVisitor
     include XMLScan::NSVisitor
     
-    def initialize(inst)
+    def initialize(inst, gcSuspendCount)
       @current_attributes = {}
       @instantiator = inst
+      @gcSuspendCount = gcSuspendCount
     end
     
     def on_attribute_ns(qname, prefix, localpart)
@@ -30,6 +31,7 @@ class AbstractXMLInstantiator
     end
     
     def on_stag_end_ns(qname, namespaces)
+			controlGC
       prefix, tag = split_qname(qname)
       @instantiator.start_tag(prefix, tag, namespaces, @current_attributes)
       @current_attributes.each_pair { |k,v| @instantiator.set_attribute(k, v) }
@@ -37,6 +39,7 @@ class AbstractXMLInstantiator
     end
     
     def on_stag_end_empty_ns(qname, namespaces)
+			controlGC
       prefix, tag = split_qname(qname)
       @instantiator.start_tag(prefix, tag, namespaces, @current_attributes)
       @current_attributes.each_pair { |k,v| @instantiator.set_attribute(k, v) }
@@ -48,12 +51,44 @@ class AbstractXMLInstantiator
       prefix, tag = split_qname(qname)
       @instantiator.end_tag(prefix, tag)
     end
+		
+		def on_chardata(str)
+			@instantiator.text(str)
+		end
+		
+		def controlGC
+			return unless @gcSuspendCount > 0
+			@gcCounter ||= 0
+			@gcCounter += 1
+			if @gcCounter == @gcSuspendCount
+				@gcCounter = 0
+				GC.enable
+				ObjectSpace.garbage_collect
+				GC.disable 
+			end    	
+		end
   end
 
-  def instantiate(str)
-    visitor = XMLScanVisitor.new(self)
-	parser = XMLScan::XMLParserNS.new(visitor)
-    parser.parse(str)
+	# Parses str and calls start_tag, end_tag, set_attribute and text methods of a subclass.
+	# 
+	# If gcSuspendCount is specified, the garbage collector will be disabled for that
+	# number of start or end tags. After that period it will clean up and then be disabled again.
+	# A value of about 1000 can significantly improve overall performance.
+	# The memory usage normally does not increase.
+	# Depending on the work done for every xml tag the value might have to be adjusted.
+	# 
+  def instantiate(str, gcSuspendCount=0)
+  	gcDisabledBefore = GC.disable
+  	gcSuspendCount = 0 if gcDisabledBefore
+  	begin
+	    visitor = XMLScanVisitor.new(self, gcSuspendCount)
+			parser = XMLScan::XMLParserNS.new(visitor)
+			parser.parse(str)
+   	ensure 	
+    	GC.enable unless gcDisabledBefore
+    end
   end
   
+	def text(str)
+	end
 end

data/lib/rgen/instantiator/ecore_xml_instantiator.rb

@@ -81,7 +81,7 @@ class ECoreXMLInstantiator < AbstractXMLInstantiator
   def instantiate(str)
     @resolver_descs = []
 #    puts "Instantiating ..."
-    super
+    super(str, 1000)
     rootpackage = @env.find(:class => EPackage).first
 #    puts "Resolving ..."
     @resolver_descs.each do |rd|

data/lib/rgen/instantiator/xmi11_instantiator.rb

@@ -28,7 +28,7 @@ class XMI11Instantiator < AbstractXMLInstantiator
   def instantiate(str)
     @resolver_descs = []
     @element_by_id = {}
-    super(str)
+    super(str, 1000)
     @resolver_descs.each do |rd|
       if rd.many
         newval = rd.value.split(" ").collect{|v| @element_by_id[v]}

data/lib/rgen/metamodel_builder/builder_extensions.rb

@@ -2,7 +2,6 @@
 # (c) Martin Thiede, 2006
 
 require 'erb'
-require 'rgen/metamodel_builder/build_helper'
 require 'rgen/metamodel_builder/metamodel_description.rb'
 
 module RGen
@@ -268,39 +267,41 @@ module BuilderExtensions
 		if props.value(:derived)
 			build_derived_method(name, props, :one)
 		else
-			BuildHelper.build _class_module, binding, <<-CODE
+			@@one_read_builder ||= ERB.new <<-CODE
 			
-				def #{name}
+				def <%= name %>
 				  <% if props.is_a?(AttributeDescription) && props.value(:defaultValueLiteral) %>
 					<% defVal = props.value(:defaultValueLiteral) %>
                     <% defVal = '"'+defVal+'"' if props.impl_type == String %>
-                    <% defVal = ':'+defVal if props.impl_type.is_a?(DataTypes::Enum) %>
-					@#{name}.nil? ? <%= defVal %> : @#{name}
+                    <% defVal = ':'+defVal if props.impl_type.is_a?(DataTypes::Enum) && props.impl_type != DataTypes::Boolean %>
+					@<%= name %>.nil? ? <%= defVal %> : @<%= name %>
 				  <% else %>
-				    @#{name}
+				    @<%= name %>
 				  <% end %>
 				end
-				alias get<%= firstToUpper(name) %> #{name}
+				alias get<%= firstToUpper(name) %> <%= name %>
 
 			CODE
+			_class_module.module_eval(@@one_read_builder.result(binding))
 		end
 		
 		if props.value(:changeable)
-			BuildHelper.build _class_module, binding, <<-CODE
+			@@one_write_builder ||= ERB.new <<-CODE
 				
-				def #{name}=(val)
-					return if val == @#{name}
+				def <%= name %>=(val)
+					return if val == @<%= name %>
 					<%= type_check_code("val", props) %>
-					oldval = @#{name}
-					@#{name} = val
+					oldval = @<%= name %>
+					@<%= name %> = val
 					<% if other_role && other_kind %>
-						_unregister(self,oldval,"#{other_role}","#{other_kind}")
-						_register(self,val,"#{other_role}","#{other_kind}")
+						_unregister(self,oldval,"<%= other_role %>","<%= other_kind %>")
+						_register(self,val,"<%= other_role %>","<%= other_kind %>")
 					<% end %>
 				end 
-				alias set<%= firstToUpper(name) %> #{name}=
+				alias set<%= firstToUpper(name) %> <%= name %>=
 				
 			CODE
+			_class_module.module_eval(@@one_write_builder.result(binding))
 
 		end
 	end
@@ -315,51 +316,53 @@ module BuilderExtensions
 		if props.value(:derived)
 			build_derived_method(name, props, :many)
 		else
-			BuildHelper.build _class_module, binding, <<-CODE
+			@@many_read_builder ||= ERB.new <<-CODE
 			
-				def #{name}
-					( @#{name} ? @#{name}.dup : [] )
+				def <%= name %>
+					( @<%= name %> ? @<%= name %>.dup : [] )
 				end
-				alias get<%= firstToUpper(name) %> #{name}
+				alias get<%= firstToUpper(name) %> <%= name %>
 							
 			CODE
+			_class_module.module_eval(@@many_read_builder.result(binding))
 		end
 		
 		if props.value(:changeable)
-			BuildHelper.build _class_module, binding, <<-CODE
+			@@many_write_builder ||= ERB.new <<-CODE
 		
 				def add<%= firstToUpper(name) %>(val)
-					@#{name} = [] unless @#{name}
-					return if val.nil? or @#{name}.include?(val) 
+					@<%= name %> = [] unless @<%= name %>
+					return if val.nil? or @<%= name %>.include?(val) 
 					<%= type_check_code("val", props) %>
-					@#{name}.push val
+					@<%= name %>.push val
 					<% if other_role && other_kind %>
-						_register(self, val, "#{other_role}", "#{other_kind}")
+						_register(self, val, "<%= other_role %>", "<%= other_kind %>")
 					<% end %>
 				end
 				
 				def remove<%= firstToUpper(name) %>(val)
-					@#{name} = [] unless @#{name}
-					return unless @#{name}.include?(val)
-					@#{name}.delete val
+					@<%= name %> = [] unless @<%= name %>
+					return unless @<%= name %>.include?(val)
+					@<%= name %>.delete val
 					<% if other_role && other_kind %>
-						_unregister(self, val, "#{other_role}", "#{other_kind}")
+						_unregister(self, val, "<%= other_role %>", "<%= other_kind %>")
 					<% end %>
 				end
 				
-				def #{name}=(val)
+				def <%= name %>=(val)
 					return if val.nil?
 					raise _assignmentTypeError(self, val, Array) unless val.is_a? Array
-					getGeneric(:#{name}).each {|e|
+					getGeneric(:<%= name %>).each {|e|
 						remove<%= firstToUpper(name) %>(e)
 					}
 					val.each {|v|
 						add<%= firstToUpper(name) %>(v)
 					}
 				end
-				alias set<%= firstToUpper(name) %> #{name}=
+				alias set<%= firstToUpper(name) %> <%= name %>=
 				
 			CODE
+			_class_module.module_eval(@@many_write_builder.result(binding))
 		end		
 				
 	end	
@@ -369,12 +372,12 @@ module BuilderExtensions
 	def build_derived_method(name, props, kind)
 		raise "Implement method #{name}_derived instead of method #{name}" \
 			if (public_instance_methods+protected_instance_methods+private_instance_methods).include?(name)
-		BuildHelper.build _class_module, binding, <<-CODE
+		@@derived_builder ||= ERB.new <<-CODE
 		
-			def #{name}
-				raise "Derived feature requires public implementation of method #{name}_derived" \
-					unless respond_to?(:#{name+"_derived"})
-				val = #{name}_derived
+			def <%= name %>
+				raise "Derived feature requires public implementation of method <%= name %>_derived" \
+					unless respond_to?(:<%= name+"_derived" %>)
+				val = <%= name %>_derived
 				<% if kind == :many %>
 					raise _assignmentTypeError(self,val,Array) unless val && val.is_a?(Array)
 					val.each do |v|
@@ -385,13 +388,28 @@ module BuilderExtensions
 				<% end %>	
 				val
 			end
-			alias get#{firstToUpper(name)} #{name}
-			#TODO final_method :#{name}
+			alias get<%= firstToUpper(name) %> <%= name %>
+			#TODO final_method :<%= name %>
 			
 		CODE
+		_class_module.module_eval(@@derived_builder.result(binding))
 	end
 	
-	private
+	def type_check_code(varname, props)
+		code = ""
+		if props.impl_type.is_a?(Class)
+			code << "unless #{varname}.nil? or #{varname}.is_a? #{props.impl_type}\n"
+			expected = props.impl_type.to_s
+		elsif props.impl_type.is_a?(RGen::MetamodelBuilder::DataTypes::Enum)
+			code << "unless #{varname}.nil? or [#{props.impl_type.literals_as_strings.join(',')}].include?(#{varname})\n"
+		    expected = "["+props.impl_type.literals_as_strings.join(',')+"]"
+		else
+			raise StandardError.new("Unkown type "+props.impl_type.to_s)
+		end
+		code << "raise _assignmentTypeError(self,#{varname},\"#{expected}\")\n"
+		code << "end"
+		code		
+	end	
 	
 	def _ownProps(props)
 	  Hash[*(props.select{|k,v| !(k.to_s =~ /^opposite_/)}.flatten)]