rgen 0.8.2 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb797f971990b12a38d234053b5edd0be3bd3cab
-  data.tar.gz: 27b2698616fa3536d71800db0784485b3903d019
+  metadata.gz: e58b57346e1f7e95fcaa15f29112706c911d20ed
+  data.tar.gz: 6551cb4e9579f7e76582018876973edd9a58d0e6
 SHA512:
-  metadata.gz: 79f31649d8f3a8da15723545841ba91b0b6294478000508b8f5abbd35b84d8c3d52d0b0100b35dd6803621a7e11d450ce4f06253e81be60a8c19ec06b45f4ff7
-  data.tar.gz: 267ee0574d6ce33e41c19825b86e8fff027c061dde40497124968c654e43cb7822f085c6614ce97cd372e58e2ce4643d8efbc10eebe310da137d5cc8afeaa543
+  metadata.gz: 1e82e58dd4eaf95de47ef1714a778558a6bd3cb76f8229fb43e029a98f9e03c6234ee2fab831adde1d7de1b953665afab031f27f39b0ad7a060a91c4ed7c7328
+  data.tar.gz: 47b73a00783a82d630b0771fb55b01c4da6adffe73a459cd35828dd5040644b8b0f6cd00a565a4abf257d8c4d2e97ca17db2c072cbe05e8ae44fe9b2b3a2637e

data/CHANGELOG

@@ -212,4 +212,13 @@
 
 =0.8.2
 
-* Added helper methods
+* Added helper methods
+
+=0.8.3
+
+* Performance improvement: getGeneric made a lot faster
+
+=0.8.4
+
+* Add early loading for types which have attributes conflicting with Ruby reserved words.
+* Change type checking code to use ObjectSpace to find class objects. This is to find classes with an unbound name.

data/Project.yaml

@@ -0,0 +1,21 @@
+name: rgen
+gemspec: rgen.gemspec
+git: https://github.com/mthiede/rgen.git
+version: 0.8.4
+summary: Ruby Modelling and Generator Framework
+email: martin dot thiede at gmx de
+homepage: http://ruby-gen.org
+rubyforge_project: rgen
+description: RGen is a framework for Model Driven Software Development (MDSD) in Ruby. This means that it helps you build Metamodels, instantiate Models, modify and transform Models and finally generate arbitrary textual content from it.
+authors: [Martin Thiede]
+rdoc_options: [--main, README.rdoc, -x, test, -x, metamodels, -x, ea_support/uml13*]
+extra_rdoc_files: [README.rdoc, CHANGELOG, MIT-LICENSE]
+include_files: ['lib/**/*', 'test/**/*', README.rdoc, CHANGELOG, MIT-LICENSE, Rakefile]
+exclude_files: ['**/*.bak']
+encrypt_sources: false
+dependencies:
+  https://rubygems.org:
+    - {name: nokogiri,           version: ['~> 1.6.0', '>= 1.6.8.1'], development: true}
+    - {name: rake,               version: '~> 12.0',                development: true}
+    - {name: minitest,           version: ['~> 5.0', '>= 5.10.1'], development: true}
+    - {name: minitest-fail-fast, version: '~> 0.1.0',               development: true}

data/Rakefile

@@ -1,41 +1,38 @@
 require 'rubygems/package_task'
 require 'rdoc/task'
+require 'bundler/setup'
+require 'rake/testtask'
 
-RGenGemSpec = Gem::Specification.new do |s|
-  s.name = %q{rgen}
-  s.version = "0.8.2"
-  s.date = Time.now.strftime("%Y-%m-%d")
-  s.summary = %q{Ruby Modelling and Generator Framework}
-  s.email = %q{martin dot thiede at gmx de}
-  s.homepage = %q{http://ruby-gen.org}
-  s.rubyforge_project = %q{rgen}
-  s.description = %q{RGen is a framework for Model Driven Software Development (MDSD) in Ruby. This means that it helps you build Metamodels, instantiate Models, modify and transform Models and finally generate arbitrary textual content from it.}
-  s.authors = ["Martin Thiede"]
-  gemfiles = Rake::FileList.new
-  gemfiles.include("{lib,test}/**/*")
-  gemfiles.include("README.rdoc", "CHANGELOG", "MIT-LICENSE", "Rakefile") 
-  gemfiles.exclude(/\b\.bak\b/)
-  s.files = gemfiles
-  s.rdoc_options = ["--main", "README.rdoc", "-x", "test", "-x", "metamodels", "-x", "ea_support/uml13*"]
-  s.extra_rdoc_files = ["README.rdoc", "CHANGELOG", "MIT-LICENSE"]
-end
+RGenGemSpec = eval(File.read('rgen.gemspec'))
 
 RDoc::Task.new do |rd|
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include("README.rdoc", "CHANGELOG", "MIT-LICENSE", "lib/**/*.rb")
-  rd.rdoc_files.exclude("lib/metamodels/*")
-  rd.rdoc_files.exclude("lib/ea_support/uml13*")
-  rd.rdoc_dir = "doc"
+  rd.main = 'README.rdoc'
+  rd.rdoc_files.include('README.rdoc', 'CHANGELOG', 'MIT-LICENSE', 'lib/**/*.rb')
+  rd.rdoc_files.exclude('lib/metamodels/*')
+  rd.rdoc_files.exclude('lib/ea_support/uml13*')
+  rd.rdoc_dir = 'doc'
 end
 
 RGenPackageTask = Gem::PackageTask.new(RGenGemSpec) do |p|
   p.need_zip = false
-end	
+end
+
+::Rake::TestTask.new(:test) do |t|
+  t.test_files = ['test/rgen_test.rb']
+  t.warning = false
+end
 
 task :prepare_package_rdoc => :rdoc do
-  RGenPackageTask.package_files.include("doc/**/*")
+  RGenPackageTask.package_files.include('doc/**/*')
 end
 
 task :release => [:prepare_package_rdoc, :package]
 
 task :clobber => [:clobber_rdoc, :clobber_package]
+
+task :ecore_to_json do
+  require 'rgen/ecore/ecore_to_json'
+
+  exporter = RGen::ECore::ECoreToJson.new
+  File.write('ecore.json', exporter.epackage_to_json_string(RGen.ecore, exporter.ecore_datatypes))
+end

data/lib/rgen/ecore/ecore_to_json.rb

@@ -0,0 +1,188 @@
+require 'rgen/ecore/ecore'
+require 'json'
+
+module RGen
+
+module ECore
+
+# ECoreToJson can turn ECore models into their JSON metamodel representations
+class ECoreToJson
+
+def initialize
+
+end
+  
+def root_elements_to_json_string(root_elements)
+  JSON.pretty_generate(root_elements.map do |el|
+    if el.is_a?(RGen::ECore::EPackage)
+      epackage(el)
+    elsif el.is_a?(RGen::ECore::EClass)
+      eclass(el)
+    else
+      raise "Not implemented for #{el}"
+    end
+  end)
+end
+
+def epackage_to_json(package)
+  epackage(package)
+end
+
+def ecore_datatypes
+  [RGen::ECore::EString, RGen::ECore::EInt, RGen::ECore::ELong, RGen::ECore::EBoolean, RGen::ECore::EFloat,
+   RGen::ECore::ERubyObject, RGen::ECore::EJavaObject, RGen::ECore::ERubyClass, RGen::ECore::EJavaClass]
+      .map {|dt| edatatype(dt)}
+end
+
+def epackage_to_json_pretty_string(package, append = [])
+  JSON.pretty_generate([epackage_to_json(package)] + append)
+end
+
+def epackage_to_json_string(package, append = [])
+  JSON.generate([epackage_to_json(package)] + append)
+end
+  
+def emodelelement(me)
+  {
+    :eAnnotations => me.eAnnotations.map { |e| eannotation(e) }
+  }
+end
+
+
+def enamedelement(ne)
+  merge(emodelelement(ne), {:name => ne.name})
+end
+
+def epackage(package)
+  merge(enamedelement(package), {
+    :_class_ref => 'RGen.ECore.EPackage',
+    :eClassifiers => package.eClassifiers.map do |classifier|
+      if classifier.is_a?(RGen::ECore::EClass)
+        eclass(classifier)
+      elsif classifier.is_a?(RGen::ECore::EEnum)
+        eenum(classifier)
+      else
+        edatatype(classifier)
+      end
+    end,
+    :eSubpackages => package.eSubpackages.map { |sp| epackage(sp) },
+    :nsURI => package.nsURI,
+    :nsPrefix => package.nsPrefix
+  })
+end
+  
+def eclassifier(classifier)
+  enamedelement(classifier).merge({
+    # omit :instanceClassName => classifier.instanceClassName
+  })
+end
+  
+def eclass(_class)
+  merge(eclassifier(_class), {
+    :_class_ref => 'RGen.ECore.EClass',
+    :abstract => _class.abstract,
+    :interface => _class.interface,
+    :eStructuralFeatures => _class.eStructuralFeatures.map do |sf|
+      if sf.is_a?(RGen::ECore::EReference)
+        ereference(sf)
+      else
+        eattribute(sf)
+      end
+    end,
+    :eSuperTypes => _class.eSuperTypes.map { |st| {:_ref => ref_id(st)} }
+  })
+end
+  
+def edatatype(_datatype)
+  merge(eclassifier(_datatype), {
+    :_class_ref => 'RGen.ECore.EDataType',
+    :serializable => _datatype.serializable,
+    :instanceClassName => _datatype.instanceClassName
+  })
+end
+
+def eenum(enum)
+  merge(edatatype(enum), {
+    :_class_ref => 'RGen.ECore.EEnum',
+    :eLiterals => enum.eLiterals.map do |l|
+      merge({}, {
+        :_class_ref => 'RGen.ECore.EEnumLiteral',
+        :value => l.value,
+        :literal => l.literal
+      })
+    end      
+  })
+end
+
+def eannotation(e)
+  merge(emodelelement(e), {
+    :source => e.source,
+    :details => e.details.map do |d|
+      merge({}, {
+          :_class_ref => 'RGen.ECore.EStringToStringMapEntry',
+          :key => d.key,
+          :value => d.value
+      })
+    end
+  })
+end
+
+def etypedelement(te)
+  merge(enamedelement(te), {
+    :ordered => te.ordered,
+    :unique => te.unique,
+    :lowerBound => te.lowerBound,
+    :upperBound => te.upperBound,
+    :many => te.many,
+    :required => te.required,
+    :eType => {:_ref => te.eType ? ref_id(te.eType) : nil}
+  })
+end
+
+def estructuralfeature(sf)
+  merge(etypedelement(sf), {
+    :changeable => sf.changeable,
+    :volatile => sf.volatile,
+    :transient => sf.transient,
+    :defaultValueLiteral => sf.defaultValueLiteral,
+    :unsettable => sf.unsettable,
+    :derived => sf.derived,
+  })
+end
+  
+def eattribute(attr)
+  merge(estructuralfeature(attr), {
+    :_class_ref => 'RGen.ECore.EAttribute',
+    :iD => attr.iD
+  })
+end
+  
+def ereference(ref)
+  merge(estructuralfeature(ref), {
+    :_class_ref => 'RGen.ECore.EReference',
+    :containment => ref.containment,
+    :resolveProxies => ref.resolveProxies,
+    :eOpposite => ref.eOpposite ? {:_ref => "#{ref_id(ref.eOpposite.eContainer)}.#{ref.eOpposite.name}"} : nil
+  })
+end
+  
+def ref_id(obj)
+  res = ref_parts(obj)
+  res.join('.')
+end
+  
+def ref_parts(obj)
+  return [obj.name] unless obj&.eContainer
+  ref_parts(obj.eContainer) << obj.name 
+end
+  
+def merge(hash, values)
+  values.each { |k, v| hash[k] = v unless v.nil? }
+  hash
+end
+  
+end
+  
+end
+  
+end

data/lib/rgen/ecore/ecore_to_ruby.rb

@@ -1,3 +1,4 @@
+require 'set'
 require 'rgen/ecore/ecore'
 
 module RGen
@@ -11,6 +12,7 @@ class ECoreToRuby
     @modules = {}
     @classifiers = {}
     @features_added = {}
+    @reserved = Set.new(Object.methods)
   end
 
   # Create a Ruby module representing +epackage+.
@@ -50,12 +52,23 @@ class ECoreToRuby
         end
       end
 
+      load_classes_with_reserved_keywords(epackage)
       mod
     end
   end
 
   private
 
+  def load_classes_with_reserved_keywords(epackage)
+    epackage.eAllClassifiers.each do |eclass|
+      # we early load classes which have ruby reserved keywords
+      if eclass.is_a?(RGen::ECore::EClass)
+        reserved_used = eclass.eStructuralFeatures.any? { |f| @reserved.include?(f.name.to_sym) }
+        add_features(eclass) if reserved_used
+      end
+    end
+  end
+
   def create_module_internal(epackage, under, temp)
     return @modules[epackage] if @modules[epackage]
     

data/lib/rgen/fragment/fragmented_model.rb

@@ -111,6 +111,8 @@ class FragmentedModel
   # This is a Hash mapping identifiers to model elements accessible via the identifier. 
   #
   def index
+    # Invalidate the cache when any fragment's local index changes.
+    # Assumption: If the local index content changes, there is a new index object.
     fragments.each do |f|
       if !@fragment_index[f] || (@fragment_index[f].object_id != f.index.object_id)
         @fragment_index[f] = f.index

data/lib/rgen/fragment/model_fragment.rb

@@ -117,6 +117,9 @@ class ModelFragment
   end
   
   # Returns the index of the element contained in this fragment.
+  # 
+  # FragmentedModel's index caching depends on the fact that any change 
+  # of a fragment's index contents implies a new index object.
   #
   def index
     build_index unless @index

data/lib/rgen/metamodel_builder/builder_extensions.rb

@@ -319,6 +319,10 @@ module BuilderExtensions
         end
         <% if name != "class" %>
           alias <%= name %> get<%= firstToUpper(name) %>
+        <% else %>
+          def getGeneric(role)
+            send("get\#{firstToUpper(role.to_s)}")
+          end
         <% end %>
 
       CODE
@@ -380,10 +384,14 @@ module BuilderExtensions
       @@many_read_builder ||= ERB.new <<-CODE
       
         def get<%= firstToUpper(name) %>
-          ( @<%= name %> ? @<%= name %>.dup : [] )
+          ( defined?(@<%= name %>) ? @<%= name %>.dup : [] )
         end
         <% if name != "class" %>
           alias <%= name %> get<%= firstToUpper(name) %>
+        <% else %>
+          def getGeneric(role)
+            send("get\#{firstToUpper(role.to_s)}")
+          end
         <% end %>
               
       CODE
@@ -394,7 +402,7 @@ module BuilderExtensions
       @@many_write_builder ||= ERB.new <<-CODE
     
         def add<%= firstToUpper(name) %>(val, index=-1)
-          @<%= name %> = [] unless @<%= name %>
+          @<%= name %> = [] unless defined?(@<%= name %>)
           return if val.nil? || (val.is_a?(MMBase) || val.is_a?(MMGeneric)) && @<%= name %>.any? {|e| e.equal?(val)}
           <%= type_check_code("val", props) %>
           @<%= name %>.insert(index, val)
@@ -407,7 +415,7 @@ module BuilderExtensions
         end
         
         def remove<%= firstToUpper(name) %>(val)
-          @<%= name %> = [] unless @<%= name %>
+          @<%= name %> = [] unless defined?(@<%= name %>)
           @<%= name %>.each_with_index do |e,i|
             if e.equal?(val)
               @<%= name %>.delete_at(i)
@@ -428,7 +436,7 @@ module BuilderExtensions
           get<%= firstToUpper(name) %>.each {|e|
             remove<%= firstToUpper(name) %>(e)
           }
-          @<%= name %> = [] unless @<%= name %>
+          @<%= name %> = [] unless defined?(@<%= name %>)
           <% if props.reference? %>
           val.uniq {|elem| elem.object_id }.each {|elem|
             next if elem.nil?
@@ -451,7 +459,7 @@ module BuilderExtensions
         alias <%= name %>= set<%= firstToUpper(name) %>
         
         def _register<%= firstToUpper(name) %>(val)
-          @<%= name %> = [] unless @<%= name %>
+          @<%= name %> = [] unless defined?(@<%= name %>)
           @<%= name %>.push val
           <% if props.reference? && props.value(:containment) %>
             val._set_container(self, :<%= name %>)
@@ -531,7 +539,7 @@ module BuilderExtensions
       code << "\n"
       expected = "Integer"
     elsif props.impl_type.is_a?(Class)
-      code << "unless #{varname}.nil? || #{varname}.is_a?(#{props.impl_type}) || #{varname}.is_a?(MMGeneric)"
+      code << "unless #{varname}.nil? || #{varname}.is_a?(ObjectSpace._id2ref(#{props.impl_type.object_id})) || #{varname}.is_a?(MMGeneric)"
       code << " || #{varname}.is_a?(BigDecimal)" if props.impl_type == Float && defined?(BigDecimal)
       code << "\n"
       expected = props.impl_type.to_s

data/lib/rgen/metamodel_builder/builder_runtime.rb

@@ -58,14 +58,17 @@ module BuilderRuntime
     end
   end
 
-	def getGeneric(role)
-		send("get#{firstToUpper(role.to_s)}")
-	end
+  alias getGeneric send
 
   def getGenericAsArray(role)
     result = getGeneric(role)
-    result = [result].compact unless result.is_a?(Array)
-    result
+    if result.nil?
+      []
+    elsif result.is_a?(Array)
+      result
+    else
+      [result]
+    end
   end
 
   def eIsSet(role)
@@ -100,6 +103,10 @@ module BuilderRuntime
 
   # if a block is given, calls the block on every contained element in depth first order. 
   # if the block returns :prune, recursion will stop at this point.
+  # 
+  # BEWARE of concurrent modification of contained elements while iterating!
+  # (adding/removing containers or contained elements)
+  # if you need to do such modifications, use the variant without a block instead.
   #
   # if no block is given builds and returns a list of all contained elements.
   #

data/test/array_extensions_test.rb

@@ -1,9 +1,9 @@
 $:.unshift File.join(File.dirname(__FILE__),"..","lib")
 
-require 'test/unit'
+require 'minitest/autorun'
 require 'rgen/array_extensions'
 
-class ArrayExtensionsTest < Test::Unit::TestCase
+class ArrayExtensionsTest < MiniTest::Test
 
   def test_element_methods
     c = Struct.new("SomeClass",:name,:age)
@@ -11,11 +11,11 @@ class ArrayExtensionsTest < Test::Unit::TestCase
     a << c.new('MyName',33)
     a << c.new('YourName',22)
     assert_equal ["MyName", "YourName"], a >> :name
-    assert_raise NoMethodError do
+    assert_raises NoMethodError do
       a.name
     end
     assert_equal [33, 22], a>>:age
-    assert_raise NoMethodError do
+    assert_raises NoMethodError do
       a.age
     end
     # unfortunately, any method can be called on an empty array
@@ -42,11 +42,11 @@ class ArrayExtensionsTest < Test::Unit::TestCase
     # put something into the array that is not an MMBase
     a << "not a MMBase"
     # the dot operator will tell that there is something not a MMBase
-    assert_raise StandardError do
+    assert_raises StandardError do
       a.age
     end
     # the >> operator will try to call the method anyway
-    assert_raise NoMethodError do
+    assert_raises NoMethodError do
       a >> :age
     end
   end
@@ -56,7 +56,7 @@ class ArrayExtensionsTest < Test::Unit::TestCase
   end
 
   def test_to_str_on_empty_array
-    assert_raise NoMethodError do
+    assert_raises NoMethodError do
       [].to_str
     end
   end

data/test/ea_instantiator_test.rb

@@ -1,6 +1,6 @@
 $:.unshift File.join(File.dirname(__FILE__),"..","lib")
 
-require 'test/unit'
+require 'minitest/autorun'
 require 'rgen/environment'
 require 'metamodels/uml13_metamodel'
 require 'ea_support/ea_support'
@@ -9,7 +9,7 @@ require 'testmodel/class_model_checker'
 require 'testmodel/object_model_checker'
 require 'testmodel/ecore_model_checker'
 
-class EAInstantiatorTest < Test::Unit::TestCase
+class EAInstantiatorTest < MiniTest::Test
 
     include Testmodel::ClassModelChecker
     include Testmodel::ObjectModelChecker

data/test/ea_serializer_test.rb

@@ -1,12 +1,12 @@
 $:.unshift File.join(File.dirname(__FILE__),"..","lib")
 
-require 'test/unit'
+require 'minitest/autorun'
 require 'rgen/environment'
 require 'metamodels/uml13_metamodel'
 require 'ea_support/ea_support'
 require 'rgen/serializer/xmi11_serializer'
 
-class EASerializerTest < Test::Unit::TestCase
+class EASerializerTest < MiniTest::Test
 
 	MODEL_DIR = File.join(File.dirname(__FILE__),"testmodel")
 	TEST_DIR = File.join(File.dirname(__FILE__),"ea_serializer_test")

data/test/ecore_self_test.rb

@@ -1,10 +1,10 @@
 $:.unshift File.join(File.dirname(__FILE__),"..","lib")
 
-require 'test/unit'
+require 'minitest/autorun'
 require 'rgen/ecore/ecore'
 require 'rgen/array_extensions'
 
-class ECoreSelfTest < Test::Unit::TestCase
+class ECoreSelfTest < MiniTest::Test
   include RGen::ECore
   
   def test_simple

data/test/ecore_to_ruby_test.rb

@@ -1,12 +1,12 @@
 $:.unshift File.join(File.dirname(__FILE__),"..","lib")
 
-require 'test/unit'
+require 'minitest/autorun'
 require 'rgen/environment'
 require 'rgen/ecore/ecore'
 require 'rgen/ecore/ecore_ext'
 require 'rgen/ecore/ecore_to_ruby'
 
-class ECoreToRubyTest < Test::Unit::TestCase
+class ECoreToRubyTest < MiniTest::Test
 
 module ContainerSimple
 end

data/test/environment_test.rb

@@ -1,10 +1,10 @@
 $:.unshift File.join(File.dirname(__FILE__),"..","lib")
 
-require 'test/unit'
+require 'minitest/autorun'
 require 'rgen/environment'
 require 'rgen/metamodel_builder'
 
-class EnvironmentTest < Test::Unit::TestCase
+class EnvironmentTest < MiniTest::Test
 
 	class Model
 		attr_accessor :name

data/test/json_test.rb

@@ -1,12 +1,12 @@
 $:.unshift File.join(File.dirname(__FILE__),"..","lib")
 
-require 'test/unit'
+require 'minitest/autorun'
 require 'rgen/environment'
 require 'rgen/metamodel_builder'
 require 'rgen/serializer/json_serializer'
 require 'rgen/instantiator/json_instantiator'
 
-class JsonTest < Test::Unit::TestCase
+class JsonTest < MiniTest::Test
 
   module TestMM
     extend RGen::MetamodelBuilder::ModuleExtension
@@ -61,7 +61,7 @@ class JsonTest < Test::Unit::TestCase
     inst.instantiate(%q({ "_class": "TestNode", "text": "some text", "childs": [ 
   { "_class": "TestNode", "text": "child" }] }))
     root = env.find(:class => TestMM::TestNode, :text => "some text").first
-    assert_not_nil root
+    assert root != nil
     assert_equal 1, root.childs.size
     assert_equal TestMM::TestNode, root.childs.first.class
     assert_equal "child", root.childs.first.text
@@ -149,7 +149,7 @@ class JsonTest < Test::Unit::TestCase
   def test_json_instantiator_subpackage_no_shortname_opt
     env = RGen::Environment.new
     inst = RGen::Instantiator::JsonInstantiator.new(env, TestMMSubpackage, :short_class_names => false)
-    assert_raise RuntimeError do
+    assert_raises RuntimeError do
       inst.instantiate(%q({ "_class": "Data2", "data2": "something" }))
     end
   end