rgen 0.4.3 → 0.4.4

data/CHANGELOG

@@ -64,3 +64,9 @@
 * Bugfix: Use object identity for metamodel to-many add/remove methods
 * Bugfix: If expand's :for expression evaluates to nil an error is generated (silently used current context before)
 * Template language indentation string can be set on DirectoryTemplateContainer and with the "file" command
+
+=0.4.4 (Sep 10th, 2008)
+
+* Added "abstract" metamodel DSL command
+* Added ecore_ext.rb with convenience methods
+* Added XMI1.1 serializer, revised XMLSerializer super class

data/lib/mmgen/metamodel_generator.rb

@@ -1,7 +1,8 @@
 require 'rgen/environment'
 require 'rgen/template_language'
 require 'rgen/ecore/ecore'
-require 'mmgen/mm_ext/ecore_ext'
+require 'rgen/ecore/ecore_ext'
+require 'mmgen/mm_ext/ecore_mmgen_ext'
 
 module MMGen
 

data/lib/mmgen/mm_ext/{ecore_ext.rb → ecore_mmgen_ext.rb}

@@ -16,10 +16,6 @@ module RGen
         eSuperPackage.qualifiedModuleName(rootPackage) + "::" + moduleName
       end
       
-      def allClassifiers
-        eSubpackages.inject(eClassifiers) {|r,p| r.concat(p.allClassifiers) }	 
-      end
-      
       def ancestorPackages
         return [] unless eSuperPackage
         [eSuperPackage] + eSuperPackage.ancestorPackages
@@ -66,17 +62,17 @@ module RGen
       def classifierName
         firstToUpper(name)			
       end
-      def qualifiedName(rootPackage)
+      def qualifiedClassifierName(rootPackage)
        (ePackage ? ePackage.qualifiedModuleName(rootPackage) + "::" : "") + classifierName
       end
       def ancestorPackages
         return [] unless ePackage
         [ePackage] + ePackage.ancestorPackages
       end
-      def qualifiedNameIfRequired(package)
+      def qualifiedClassifierNameIfRequired(package)
         if ePackage != package
           commonSuper = (package.ancestorPackages & ancestorPackages).first
-          qualifiedName(commonSuper)
+          qualifiedClassifierName(commonSuper)
         else
           classifierName
         end

data/lib/mmgen/templates/metamodel_generator.tpl

@@ -23,6 +23,7 @@
 		<% expand 'EnumTypes' %>
 		<% for c in ownClasses %><%nl%>
 			<% expand 'ClassHeader', this, :for => c %><%iinc%>
+				<% if c.abstract %>abstract<% end %>
 				<% expand 'annotations::Annotations', :for => c %>
 				<% expand 'Attribute', this, :foreach => c.eAttributes %>
 				<%idec%>
@@ -37,6 +38,7 @@
 <% define 'GenerateClassesReordered', :for => EPackage do %>
 	<% for c in allClassesSorted %><%nl%>
 		<% expand 'ClassHeaderFullyQualified', this, :for => c %><%iinc%>
+			<% if c.abstract %>abstract<% end %>
 			<% expand 'annotations::Annotations', :for => c %>
 			<% expand 'Attribute', this, :foreach => c.eAttributes %>
 			<%idec%>
@@ -61,7 +63,7 @@
 	<% if upperBound == 1%>
 	has_attr '<%= name %>', <%nows%>
 	<% if eType.is_a?(EEnum) %><%nows%>
-		<%= eType.qualifiedName(rootp) %><%nows%>
+		<%= eType.qualifiedClassifierName(rootp) %><%nows%>
 	<% else %><%nows%>
 		<%= eType && eType.instanceClass.to_s %><%nows%>
 	<% end %><%nows%>
@@ -90,7 +92,7 @@
 
 <% define 'GenerateAssocs', :for => EPackage do %>
 	<% refDone = {} %>
-	<% for ref in allClassifiers.select{|c| c.is_a?(EClass)}.eReferences %>
+	<% for ref in eAllClassifiers.select{|c| c.is_a?(EClass)}.eReferences %>
 		<% if !refDone[ref] && ref.eOpposite %>
 			<% ref = ref.eOpposite if ref.eOpposite.containment %>
 			<% refDone[ref] = refDone[ref.eOpposite] = true %>
@@ -133,7 +135,7 @@
 <% end %>
 
 <% define 'Reference', :for => EReference do |cmd, rootpackage| %>
-	<%= eContainingClass.qualifiedName(rootpackage) %>.<%= cmd %> '<%= name %>', <%= eType && eType.qualifiedName(rootpackage) %><%nows%>
+	<%= eContainingClass.qualifiedClassifierName(rootpackage) %>.<%= cmd %> '<%= name %>', <%= eType && eType.qualifiedClassifierName(rootpackage) %><%nows%>
 	<% if eOpposite %><%nows%>
 		, '<%= eOpposite.name%>'<%nows%>
 	<% end %><%nows%>
@@ -151,20 +153,20 @@
 <% define 'ClassHeader', :for => EClass do |rootp| %>
 	class <%= classifierName %> < <% nows %>
 	<% if eSuperTypes.size > 1 %><% nows %>
-		RGen::MetamodelBuilder::MMMultiple(<%= eSuperTypes.collect{|t| t.qualifiedNameIfRequired(rootp)}.join(', ') %>)
+		RGen::MetamodelBuilder::MMMultiple(<%= eSuperTypes.collect{|t| t.qualifiedClassifierNameIfRequired(rootp)}.join(', ') %>)
 	<% elsif eSuperTypes.size > 0 %><% nows %>
-		<%= eSuperTypes.first.qualifiedNameIfRequired(rootp) %>
+		<%= eSuperTypes.first.qualifiedClassifierNameIfRequired(rootp) %>
 	<% else %><% nows %>
 		RGen::MetamodelBuilder::MMBase
 	<% end %>
 <% end %>
 
 <% define 'ClassHeaderFullyQualified', :for => EClass do |rootp| %>
-	class <%= qualifiedName(rootp) %> < <% nows %>
+	class <%= qualifiedClassifierName(rootp) %> < <% nows %>
 	<% if eSuperTypes.size > 1 %><% nows %>
-		RGen::MetamodelBuilder::MMMultiple(<%= eSuperTypes.collect{|t| t.qualifiedName(rootp)}.join(', ') %>)
+		RGen::MetamodelBuilder::MMMultiple(<%= eSuperTypes.collect{|t| t.qualifiedClassifierName(rootp)}.join(', ') %>)
 	<% elsif eSuperTypes.size > 0 %><% nows %>
-		<%= eSuperTypes.first.qualifiedName(rootp) %>
+		<%= eSuperTypes.first.qualifiedClassifierName(rootp) %>
 	<% else %><% nows %>
 		RGen::MetamodelBuilder::MMBase
 	<% end %>

data/lib/rgen/ecore/ecore_ext.rb

@@ -0,0 +1,69 @@
+require 'rgen/array_extensions'
+require 'rgen/ecore/ecore'
+
+module RGen
+  module ECore
+  	
+    # make super type reference bidirectional
+    EClass.many_to_many 'eSuperTypes', ECore::EClass, 'eSubTypes'
+    
+	  module EModelElement::ClassModule
+	    
+	    def annotationValue(source, tag)
+  			detail = eAnnotations.select{ |a| a.source == source }.details.find{ |d| d.key == tag }
+			  detail && detail.value
+  		end
+      
+  	end
+		
+  	module EPackage::ClassModule
+  	  
+			def qualifiedName
+				if eSuperPackage
+					eSuperPackage.qualifiedName+"::"+name
+				else
+					name
+				end
+			end
+      
+  		def eAllClassifiers
+  			eClassifiers + eSubpackages.eAllClassifiers
+  		end
+      def eAllSubpackages
+        eSubpackages + eSubpackages.eAllSubpackages
+      end
+      
+      def eClasses
+        eClassifiers.select{|c| c.is_a?(ECore::EClass)}
+      end
+      
+      def eAllClasses
+        eClasses + eSubpackages.eAllClasses
+      end
+      
+      def eDataTypes
+        eClassifiers.select{|c| c.is_a?(ECore::EDataType)}
+      end
+      
+      def eAllDataTypes
+        eDataTypes + eSubpackages.eAllDataTypes
+      end      
+  	end
+		
+		module EClass::ClassModule
+		  
+			def qualifiedName
+				if ePackage
+					ePackage.qualifiedName+"::"+name
+				else
+					name
+				end
+			end
+      
+      def eAllSubTypes
+        eSubTypes + eSubTypes.eAllSubTypes
+      end
+      
+		end
+  end
+end

data/lib/rgen/ecore/ecore_transformer.rb

@@ -12,7 +12,7 @@ class ECoreTransformer < Transformer
   
   transform Class, :to => EClass, :if => :convert? do
     { :name => name.gsub(/.*::(\w+)$/,'\1'),
-      :abstract => false,
+      :abstract => _abstract_class,
       :interface => false,
       :eStructuralFeatures => trans(_metamodel_description),
       :ePackage =>  trans(name =~ /(.*)::\w+$/ ? eval($1) : nil),

data/lib/rgen/metamodel_builder/builder_extensions.rb

@@ -218,9 +218,17 @@ module BuilderExtensions
 	def _metamodel_description # :nodoc:
 		@metamodel_description ||= []
 	end
+  
+  def abstract
+    @abstract = true
+  end
+  
+  def _abstract_class
+    @abstract || false
+  end
 	
-  	def inherited(c)
-    	c.send(:include, c.const_set(:ClassModule, Module.new))
+	def inherited(c)
+	  c.send(:include, c.const_set(:ClassModule, Module.new))
 	end
 		
 	protected

data/lib/rgen/serializer/xmi11_serializer.rb

@@ -0,0 +1,101 @@
+require 'rgen/serializer/xml_serializer'
+
+module RGen
+
+module Serializer
+
+class XMI11Serializer < XMLSerializer
+
+  def initialize(file)
+    super
+    @namespacePrefix = ""
+  end
+  
+  def setNamespace(shortcut, url)
+    @namespaceShortcut = shortcut
+    @namespaceUrl = url
+    @namespacePrefix = shortcut+":"
+  end
+  
+  def serialize(rootElement, headerInfo=nil)
+	  attrs = {}
+		attrs['xmi.version'] = "1.1"
+		attrs['xmlns:'+@namespaceShortcut] = @namespaceUrl if @namespaceUrl
+		attrs['timestamp'] = Time.now.to_s
+    startTag("XMI", attrs)
+    if headerInfo
+      startTag("XMI.header")
+      writeHeaderInfo(headerInfo)
+      endTag("XMI.header")
+    end
+    startTag("XMI.content")
+    writeElement(rootElement)
+    endTag("XMI.content") 
+    endTag("XMI") 
+	end
+  
+  def writeHeaderInfo(hash)
+    hash.each_pair do |k,v|
+      tag = "XMI." + k.to_s
+      startTag(tag)
+      if v.is_a?(Hash)
+        writeHeaderInfo(v)
+      else
+        writeText(v.to_s)
+      end
+	    endTag(tag)
+    end
+  end
+  
+	def writeElement(element)
+	  tag = @namespacePrefix + element.class.ecore.name
+		attrs = attributeHash(element)
+		startTag(tag, attrs)
+    containmentReferences(element).each do |r|
+		  roletag = @namespacePrefix + r.eContainingClass.name + "." + r.name
+      targets = element.getGeneric(r.name)
+      targets = [ targets ] unless targets.is_a?(Array)
+      targets.compact!
+      next if targets.empty?
+		  startTag(roletag)
+      targets.each do |t|
+        writeElement(t)
+      end
+			endTag(roletag)
+		end
+		endTag(tag)
+	end
+
+	def attributeHash(element)
+	  result = {"xmi.id" => xmiId(element)}
+		eAllAttributes(element).select{|a| !a.derived}.each do |a|
+			val = element.getGeneric(a.name)
+			result[a.name] = val unless val.nil? || val == ""
+		end
+		eAllReferences(element).each do |r|
+		  next if r.derived
+		  next if r.containment
+		  next if r.eOpposite && r.eOpposite.containment
+		  next if r.eOpposite && r.many && !r.eOpposite.many
+			targetElements = element.getGeneric(r.name)
+			targetElements = [targetElements] unless targetElements.is_a?(Array)
+      targetElements.compact!
+			val = targetElements.collect{|te| xmiId(te)}.compact.join(' ')
+			result[r.name] = val unless val == ""
+		end
+		result	
+	end
+  
+  def xmiId(element)
+    if element.respond_to?(:_xmi_id) && element._xmi_id
+      element._xmi_id.to_s
+    else
+      element.object_id.to_s
+    end
+  end
+  
+end
+
+end
+
+end

data/lib/rgen/serializer/xmi20_serializer.rb

@@ -14,19 +14,19 @@ class XMI20Serializer < XMLSerializer
 		attrs['xmlns:xsi'] = "http://www.w3.org/2001/XMLSchema-instance"
 		attrs['xmlns:ecore'] = "http://www.eclipse.org/emf/2002/Ecore" 
 		tag = "ecore:"+rootElement.class.ecore.name
-		startTag(tag, attrs, 0)
-		writeComposites(rootElement, 1)
-		endTag(tag, 0)
+		startTag(tag, attrs)
+		writeComposites(rootElement)
+		endTag(tag)
 	end
 	
-	def writeComposites(element, indent)
+	def writeComposites(element)
 		eachReferencedElement(element, containmentReferences(element)) do |r,te|
 			attrs = attributeHash(te)
 			attrs['xsi:type'] = "ecore:"+te.class.ecore.name
 			tag = r.name
-			startTag(tag, attrs, indent)
-			writeComposites(te, indent+1)
-			endTag(tag, indent)
+			startTag(tag, attrs)
+			writeComposites(te)
+			endTag(tag)
 		end
 	end
 

data/lib/rgen/serializer/xml_serializer.rb

@@ -4,25 +4,41 @@ module Serializer
 
 class XMLSerializer
 
-	def initialize
-		@output = ""
-	end
-	
-	def result
-		@output
+  INDENT_SPACE = 2
+  
+	def initialize(file)
+    @indent = 0
+    @lastStartTag = nil
+    @textContent = false
+    @file = file
 	end
 	
 	def serialize(rootElement)
 		raise "Abstract class, overwrite method in subclass!"
 	end
-	
-	def startTag(tag, attributes, indent)
-		@output += "  "*indent + "<#{tag} " + attributes.keys.collect{|k| "#{k}=\"#{attributes[k]}\""}.join(" ") + ">\n"
-	end
+  
+  def startTag(tag, attributes={})
+    @textContent = false
+    handleLastStartTag(false, true)
+    @lastStartTag = " "*@indent*INDENT_SPACE +
+    	"<#{tag} "+attributes.keys.collect{|k| "#{k}=\"#{attributes[k]}\""}.join(" ")
+    @indent += 1
+  end
+  
+  def endTag(tag)
+    @indent -= 1
+    unless handleLastStartTag(true, true)
+      output " "*@indent*INDENT_SPACE unless @textContent
+      output "</#{tag}>\n"
+    end
+    @textContent = false
+  end
 
-	def endTag(tag, indent)
-		@output += "  "*indent + "</#{tag}>\n"
-	end
+  def writeText(text)
+    handleLastStartTag(false, false)
+    output "#{text}"
+    @textContent = true
+  end  
 	
 	protected
 
@@ -52,8 +68,25 @@ class XMLSerializer
 	end  
 
   def containmentReferences(element)
-  	eAllReferences(element).select{|r| r.containment}
+    @containmentReferences ||= {}
+    @containmentReferences[element.class] ||= eAllReferences(element).select{|r| r.containment}
+  end
+  
+  private
+  
+  def handleLastStartTag(close, newline)
+    return false unless @lastStartTag
+    output @lastStartTag
+    output close ? "/>" : ">"
+    output "\n" if newline
+    @lastStartTag = nil
+    true
+  end
+  
+  def output(text)
+    @file.write(text)
   end
+  
 end
 
 end

data/test/ea_serializer_test.rb

@@ -0,0 +1,29 @@
+$:.unshift File.join(File.dirname(__FILE__),"..","lib")
+
+require 'test/unit'
+require 'rgen/environment'
+require 'metamodels/uml13_metamodel'
+require 'instantiators/ea_instantiator'
+require 'rgen/serializer/xmi11_serializer'
+
+class EASerializerTest < Test::Unit::TestCase
+
+	MODEL_DIR = File.join(File.dirname(__FILE__),"testmodel")
+	TEST_DIR = File.join(File.dirname(__FILE__),"ea_serializer_test")
+  
+	def test_serializer
+		envUML = RGen::Environment.new
+		File.open(MODEL_DIR+"/ea_testmodel.xml") { |f|
+			inst = EAInstantiator.new(envUML, EAInstantiator::ERROR)
+			inst.instantiate(f.read)
+		}
+    models = envUML.find(:class => UML13::Model)
+    assert_equal 1, models.size
+    
+    File.open(TEST_DIR+"/ea_testmodel_regenerated.xml", "w") do |f|
+      ser = RGen::Serializer::XMI11Serializer.new(f)
+      ser.serialize(models.first, {:documentation => {:exporter => "Enterprise Architect", :exporterVersion => "2.5"}})
+    end
+	end
+	
+end