ontomde-uml2-kbjava 1.0.4

data/History.txt

@@ -0,0 +1,5 @@
+== 1.0.0 / 2007-10-28
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ontomde-uml2-kbjava.rb
+lib/ontomde-uml2-kbjava/version.rb
+lib/ontomde-uml2-kbjava/rdfToJava.rb
+test/test_ontomde-uml2-kbjava.rb

data/README.txt

@@ -0,0 +1,43 @@
+ontomde-uml2-kbjava
+    by Stephane (Pierre) Carrie
+    http://ontomde.rubyforge.org 
+
+== DESCRIPTION:
+
+ontomde-uml2-kbjava is a library to generate tests data as java code and java junit from Prot�g� 2000 data project generated with ontomde-uml2-kb.  
+
+ontomde-uml2-kbjava should be used through ontomde-java-frontend command line utility.
+
+== FEATURES/PROBLEMS:
+  
+* generator assumes JPA persistence is used.
+
+== SYNOPSIS:
+
+== REQUIREMENTS:
+
+== INSTALL:
+
+* (windows) gem install ontomode-uml2-kbjava
+* (unix) sudo gem install ontomode-uml2-kbjava
+
+Additional information is available on ontoMDE web site :
+http://ontomde.rubyforge.org/website/download.html
+== LICENSE:
+
+Copyright (C) 2008 Orange-labs 
+38 rue General Leclerc
+92130 ISSY LES MOULINEAUX, France
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see http://www.gnu.org/licenses/.

data/Rakefile

@@ -0,0 +1,22 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/ontomde-uml2-kbjava/version.rb'
+
+Hoe.new('ontomde-uml2-kbjava', Ontomde::Uml2::Kbjava::VERSION) do |p|
+  p.rubyforge_name = 'ontomde'
+  p.author = 'Stephane (Pierre) Carrie'
+  p.email = 'stephanepierre.carrie@orange-ftgroup.com'
+  p.summary = 'OntoMDE Protege 2000 java data-test cartridge'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url="http://ontomde.rubyforge.org"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps=[ 
+	  ['ontomde-uml2-kb',"= #{Ontomde::Uml2::Kbjava::VERSION}"],
+	  ['ontomde-uml2-java',"= #{Ontomde::Uml2::Kbjava::VERSION}"]
+  	]
+  p.spec_extras={ :required_ruby_version => '>=1.8.6' ,:required_rubygems_version => '>=1.0.0'}
+end
+
+# vim: syntax=Ruby

data/lib/ontomde-uml2-kbjava.rb

@@ -0,0 +1,7 @@
+h=File.dirname(__FILE__)
+
+require "ontomde-uml2-kb"
+require "ontomde-uml2-java"
+
+require "#{h}/ontomde-uml2-kbjava/version.rb"
+require "#{h}/ontomde-uml2-kbjava/rdfToJava.rb"

data/lib/ontomde-uml2-kbjava/rdfToJava.rb

@@ -0,0 +1,398 @@
+#This module is meant to be applied
+#to a protege 2000 knowledge model
+class Crdf_ProtegeDataModel < Crdf_Model
+
+  #uml model used to generate this protege data model
+  #attr :umlSourceModel
+  attr_accessor :kbjava_umlSourceModel
+
+  #Generates a DataSet
+  #default generation path may be overriden by providing appropriate context.
+  def kbjava_generate
+    mtk_default_context(:dataTestClassName=>'UserData',:dataTestPackageName => 'xmda.test') {
+
+      dc=@kbjava_umlSourceModel.umlx_reserved_model.umlx_getOrCreateClass("#{context[:dataTestPackageName]}.#{context[:dataTestClassName]}")
+      dc.umlx_external=RDF_FALSE
+
+      #No Gui is provided for TestData (class is too big)
+      dc.umlx_businessMethod=RDF_FALSE
+
+      #UserData must be transient because UserData links
+      #eventually to many many many objects and this
+      #would generate has many columns in database
+      #and as many joins.
+      dc.db_isTransient=RDF_TRUE
+
+      kbjava_addData!(dc)
+    }
+  end
+
+
+
+  #writes all in one java class which will contain all of
+  #our test instances loaded from source protege data model.
+  def kbjava_addData!(umlDataClass)
+    #write "package #{context[:dataTestPackageName]};\n"
+    #write("public class #{context[:dataTestClassName]} {\n")
+
+    #mtk_protected("converter") {
+    umlDataClass.java_customCode= <<END
+ private static java.text.SimpleDateFormat dfCalendar= new java.text.SimpleDateFormat("yyyy/MM/dd",java.util.Locale.ENGLISH);
+ private static java.text.SimpleDateFormat dfTimestamp= new java.text.SimpleDateFormat("yyyy/MM/dd",java.util.Locale.ENGLISH);
+  public java.util.Date convertCalendar(final String s) {
+	try  {
+	return dfCalendar.parse(s) ;
+	} catch (java.text.ParseException e) {
+		throw new java.lang.RuntimeException(e);
+	}
+  }
+  public java.util.Date convertTimestamp(final String s) {
+	try  {
+	return dfTimestamp.parse(s) ;
+	} catch (java.text.ParseException e) {
+		throw new java.lang.RuntimeException(e);
+	}
+  }
+
+END
+
+    #}
+    [true,false].each {|stepOne|
+      self.each { |k,c|
+        next unless c.kbjava_isUmlObject?
+        c.kbjava_writeJavaObject(@kbjava_umlSourceModel, self,umlDataClass,stepOne)
+      }}
+    #write "}"
+    #@kbjava_umlSourceModel.kbjava_computeCoverage
+  end
+
+  def kbjava_generateJavaJunit!
+    self.each { |k,c|
+      next unless c.kind_of?(Mkb_UML_TEST_DATA_SET)
+      uml_type=c.rdf_type.kbjava_uml_model_element(@kbjava_umlSourceModel)
+      p=uml_type.umlx_owner_one
+      p=p.umlx_getOrCreatePackage(context[:kbjava_junitSubPackage,"junitUseCase"],p)
+      p=p.umlx_getOrCreatePackage(uml_type.java_Name.to_s,p)
+
+      n=p.umlx_createAndAddClass("#{c.rdf_uri}_junit","junit#{c.kb_UML_DATA_SET_NAME}")
+
+      #Provide a Gui
+      n.umlx_businessMethod=RDF_TRUE
+      puts "n=#{n.uml_name} busniess=#{n.umlx_businessMethod?}"
+      #n.apaCom_addLogger!
+      n.db_isTransient=RDF_TRUE
+      #n.struts_isForm=RDF_FALSE
+      n.umlx_external=RDF_FALSE
+      n.java_import='org.junit.Test'
+      #n.java_import_add('java.io.PrintWriter');
+      #n.java_import_add('java.io.StringWriter');
+      n.java_isATestFile=RDF_TRUE
+
+      #also avoid org.junit.* import notused warning in Eclipse
+      n.java_customCode="@Test\npublic void replaceWithMeaningfulTest(){}\n"
+
+      m=n.umlx_createAndAddOperation(n.rdf_uri+"merge","merge");
+      #TODO merge referenced items
+      m.java_code="return this;"
+      p=m.umlx_createAndAddReturnParameter(m.rdf_uri+'_ret',"return")
+      p.uml_type=n
+      m.umlx_businessMethod=RDF_FALSE
+
+
+      persist=n.umlx_createAndAddOperation(n.rdf_uri+"persist","persist");
+      persist.java_code="" # #{java_debug(%{log.debug("persisting referenced persistent elements");}\n}"
+      p=persist.umlx_createAndAddReturnParameter(persist.rdf_uri+'_ret',"return")
+      p.uml_type=n
+      persist.umlx_businessMethod=RDF_FALSE
+
+
+      #v=n.umlx_createAndAddProperty(n.rdf_uri+"__source","source");
+
+      #ds="#{context[:dataTestPackageName]}.#{context[:dataTestClassName]}"
+      #TODO: remove hard coded
+      ds="xmda.test.UserData"
+      #v.uml_type=n.umlx_getOrCreateClass(ds)
+      #v.java_code="null"
+
+      j=<<END
+	// using one single source object
+	// enables objects retrieved to be linked together.
+	// Objects retrieved with a new source will *not* be linked together.
+	#{ds} source=new #{ds}();
+END
+      c.kb_UML_DATA.each { |d|
+        if  d.kb_UML_INSTANCE_ALIAS.empty?
+          log.warn("data ignored in junit #{c} because of missing UML_INSTANCE_ALIAS")
+          next
+        end
+        u=d.rdf_type.kbjava_uml_model_element(@kbjava_umlSourceModel)
+        p=n.umlx_createAndAddProperty(n.rdf_uri+d.rdf_uri,"#{d.kb_UML_INSTANCE_ALIAS}");
+        p.uml_type=u
+        p.uml_isReadOnly=RDF_TRUE
+        p.java_code="null"
+
+        j="#{j}\n	set#{p.java_NameBean}(source.get#{p.java_NameBean}());"
+        persist.java_code="#{persist.java_code.to_s} get#{p.java_NameBean}().persist();\n"
+      }
+
+      m=n.umlx_createAndAddOperation(n.rdf_uri+"initData","initData")
+      m.umlx_businessMethod=RDF_FALSE
+      m.java_code="#{j} return this;"
+      m.java_annotation_add(%{@SuppressWarnings("unused")})
+      p=m.umlx_createAndAddReturnParameter(m.rdf_uri+'_ret',"return")
+      p.uml_type=n
+
+      persist.java_code="#{persist.java_code.to_s} return this;\n"
+    }
+  end
+
+end
+
+class Ckb_UML_SLOT < ::Crdf_Property
+end
+
+#
+class Ckb_UML_METACLASS < Crdfs_Class
+  def kbjava_uml_model_element(umlSourceModelParam)
+    r=umlSourceModelParam[::UriNamespace.instance.urialias(@kb_UML_URI.to_s)]
+    return r unless r.nil?
+    puts("WARNING: uml item not found for uri=--#{@kb_UML_URI}--")
+    return nil
+  end
+end
+
+class ::Crdfs_Class
+
+  def kbjava_umlSourceModel
+    return rdf_model.kbjava_umlSourceModel
+  end
+
+  #uml model used to generate this protege data model
+  rdf_safe_attr_reader_many :kbjava_property
+  #rdf_safe_attr_reader_many :kbjava_initMethod
+  def kbjava_writeJavaObject(umlSourceModelParam, dataSource,umlDataClass,stepOne)
+    uml_type=rdf_type.kbjava_uml_model_element(umlSourceModelParam)
+
+    return if uml_type.kind_of?(Muml_UseCase)
+
+    if stepOne
+      # Create attributes and every init methods (body expected)
+      uml_type.kb_coverage_add(self)
+      p=umlDataClass.umlx_createAndAddProperty(umlDataClass.rdf_uri+kbjava_varName,kbjava_varName.to_s)
+      p.uml_type=uml_type
+      p.uml_visibility=  Cuml_VisibilityKind::Private
+      #p.java_noAccessors=RDF_TRUE
+      self.kbjava_property=p
+
+      #init method
+      #p=self.kbjava_property_one
+      #i=umlDataClass.umlx_createAndAddOperation(umlDataClass.rdf_uri+"init"+kbjava_varName,"init#{kbjava_varName}")
+      #i.uml_visibility=  kbjava_isPublic? ? Cuml_VisibilityKind::Public : Cuml_VisibilityKind::Private
+      #r=i.umlx_createAndAddReturnParameter(i.rdf_uri+"ret","_return")
+      #r.uml_type=p.uml_type_one
+      #self.kbjava_initMethod=i
+
+      umlDataClass.java_addGlobalGetter!(p)
+    else
+      # Create init methods body
+      p=self.kbjava_property_one
+      #i=self.kbjava_initMethod_one
+      i=p.java_AttributeGlobalGetter_one
+      #write "private #{uml_type.java_qualifiedName} #{kbjava_varName}=null;\n"
+      #write "#{kbjava_public ? "public" : "private"} #{uml_type.java_qualifiedName} get#{kbjava_varName}() {"
+      #p=self.kbjava_property_one
+      i.java_code= <<ENDinit
+	if(#{p.java_Name}==null){
+		#{p.java_Name}= new #{uml_type.java_qualifiedName}();
+		#{p.uml_type_one.java_qualifiedName} elt= #{p.java_Name};
+		#{mtk_stss{kbjava_writeJavaObjectSetters(dataSource)}}
+	}
+	return #{p.java_Name};
+ENDinit
+
+      # overide getter with init
+    end
+  end
+
+  # Returns test object variable name which will be used to store this test object.
+  # Return uri if test object has no name.
+  def kbjava_varName
+    return kbjava_aliasName.nil? ? uri : kbjava_aliasName
+  end
+
+  #
+  def kbjava_aliasName
+    s=@kb_UML_INSTANCE_ALIAS
+    return nil if s.nil?  || s.empty?
+    return s.to_s
+  end
+
+  def kbjava_isPublic?
+    return !kbjava_aliasName.nil?
+  end
+
+  def kbjava_uml_property_values(dataSource)
+    ret=Hash.new
+    instance_variables.each {
+      |m|
+      next if ["@kbjava_property","@kb_UML_URI","@kb_UML_LABEL","@rdfs_label","@ext_isReferencedBy","@rdfs_subClassOf", "@kb_UML_INSTANCE_ALIAS","@kb_UML_REFERENCED_USE_CASE","@kb_inv_UML_REFERENCED_USE_CASE","@kb_UML_USE_CASE_ENV"].include?(m)
+
+      var = instance_variable_get(m)
+      rawval = self.instance_variable_get(m)
+
+      next unless rawval.kind_of?(ArrayOrSingleElement)
+
+      protprop_ident=m[1,m.length] #remove leading @
+      protprop_uri=getRubyNameInverse(protprop_ident)
+      protprop=dataSource[protprop_uri]
+
+      umluri=protprop.instance_variable_get("@kb_UML_URI").to_s
+      umlurialiased=::UriNamespace.instance.urialias(umluri)
+      umlprop=kbjava_umlSourceModel[umlurialiased]
+
+      if umlprop.nil?
+        log.warn { "uml prop not found for slot '#{m}' umluri='#{umluri}' umluriprop='#{umlurialiased}'" }
+        next
+      end
+      ret[umlprop]=rawval
+    }
+    return ret
+  end
+
+  def kbjava_writeJavaObjectSetters(dataSource)
+    kbjava_uml_property_values(dataSource).each {
+      |umlprop,rawval|
+      umlprop.kb_coverage_add(rawval)
+      rawval.each {|v|
+        kbjava_writeJavaObjectSetter(umlprop,v)
+      }
+    }
+  end
+
+  def kbjava_writeJavaObjectSetter(umlprop,valitem)
+    return if umlprop.uml_name.empty?
+    return unless umlprop.umlx_isNavigable?
+
+    #t=umlprop.uml_type_one.java_qualifiedName
+
+    m=JavaMapping.instance.getTemplate(umlprop.uml_type_one)
+    v=m.prot_convertToJava(umlprop,valitem)
+    #i=m.prot_init(umlprop,valitem)
+
+    #puts "i='#{i}'"
+    meth=umlprop.umlx_upperValueIsOne? ? "set" : "add"
+    #write "    #{i}/* tpl-kbjava01 */\n"
+    write "// read only " if umlprop.uml_isReadOnly?
+    write "    elt.#{meth}#{umlprop.java_NameBean}(#{v});\n"
+  end
+end
+
+module Muml_Element
+  rdf_safe_attr_reader_many :kb_coverage
+end
+module Mrdf_Model
+  def kbjava_computeCoverage
+    puts "COVERAGE REPORT"
+    puts %{class|property|hit|min hit\n}
+    ret=Array.new
+    uml_Class_all.each { |c|
+
+      next if c.uml_isAbstract?
+      next if c.kind_of?(Cuml_Enumeration)
+      next if c.uml_ownedAttribute.empty?
+      puts %{#{c.uml_name}|id|#{c.kb_coverage.size}|1\n}
+      c.uml_ownedAttribute.each {|a|
+        max=a.uml_type_one.kind_of?(Muml_Enumeration) ? a.uml_type_one.uml_ownedLiteral.size : "1"
+        puts %{#{c.uml_name}|#{a.uml_name}|#{a.kb_coverage.size}|#{max}\n}
+        ret<< { "class" => c.uml_name,"property"=> a.uml_name, "hit" =>a.kb_coverage.size, "minhit" => max}
+      }
+
+    }
+    puts "COVERAGE REPORT END"
+    return ret
+  end
+end
+
+module Mrdf_Resource
+  def kbjava_isUmlObject?
+    c=self
+    # filters out Protege meta-model element
+    return false if (c.kind_of?(Ckb_UML_METACLASS))||(c.kind_of?(Ckb_UML_SLOT))
+    # filters out rdf root elements
+    return false if (c.class==Crdf_Resource) || (c.class==Crdf_Property)
+    return true
+  end
+end
+
+class JavaMapping
+  def prot_init(umlprop,valitem)
+    return ""
+  end
+end
+
+class JavaMappingText < JavaMapping
+  # Protege string to Java code conversions
+  def prot_convertToJava(umlprop,valitem)
+    return %{"#{valitem}"}
+  end
+end
+class JavaMappingInteger < JavaMappingOrdinal
+  # Protege string to Java code conversions
+  def prot_convertToJava(umlprop,valitem)
+    #Remove leading 0 (octal)
+    return valitem.gsub(/^0*([0-9])/,'\1')
+  end
+end
+class JavaMappingLong < JavaMappingOrdinal
+  # Protege string to Java code conversions
+  def prot_convertToJava(umlprop,valitem)
+    #Remove leading 0 (octal)
+    return valitem.gsub(/^0*([0-9])/,'\1')
+  end
+end
+class JavaMappingFile < JavaMapping
+  # Protege string to Java code conversions
+  def prot_convertToJava(umlprop,valitem)
+    # ??
+    return valitem
+  end
+end
+class JavaMappingBoolean < JavaMapping
+  # Protege string to Java code conversions
+  def prot_convertToJava(umlprop,valitem)
+    return valitem
+  end
+end
+class JavaMappingTimeStamp < JavaMapping
+  # Protege string to Java code conversions
+  def prot_convertToJava(umlprop,valitem)
+    return %{convertTimestamp("#{valitem}")}
+  end
+end
+class JavaMappingCalendar < JavaMapping
+  # Protege string to Java code conversions
+  def prot_convertToJava(umlprop,valitem)
+    return %{convertCalendar("#{valitem}")}
+  end
+end
+class JavaMappingGenericClass < JavaMapping
+  # Protege string to Java code conversions
+  def prot_convertToJava(umlprop,valitem)
+    return "#{valitem.kbjava_property_one.java_AttributeGlobalGetter_one.java_Name}()"
+  end
+  def prot_init(umlprop,valitem)
+    return ""
+    #return "init#{umlprop.java_NameBean}();/* #{umlprop.class} */"
+  end
+end
+class JavaMappingGenericEnum < JavaMapping
+  # Protege string to Java code conversions
+  def prot_convertToJava(umlprop,valitem)
+    lit=nil
+    umlprop.uml_type_one.uml_ownedLiteral.each { |i|
+      next if i.to_s!=valitem.to_s
+      lit=i
+    }
+    return "#{umlprop.uml_type_one.java_qualifiedName}.#{lit.java_Name}"
+  end
+end

data/lib/ontomde-uml2-kbjava/version.rb

@@ -0,0 +1,7 @@
+module Ontomde
+  module Uml2
+    module Kbjava
+      VERSION = '1.0.4'
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: ontomde-uml2-kbjava
+version: !ruby/object:Gem::Version 
+  version: 1.0.4
+platform: ruby
+authors: 
+- Stephane (Pierre) Carrie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-kb
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ontomde-uml2-java
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+description: "ontomde-uml2-kbjava is a library to generate tests data as java code and java junit from Prot\xE9g\xE9 2000 data project generated with ontomde-uml2-kb.    ontomde-uml2-kbjava should be used through ontomde-java-frontend command line utility.  == FEATURES/PROBLEMS:  * generator assumes JPA persistence is used.  == SYNOPSIS:"
+email: stephanepierre.carrie@orange-ftgroup.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/ontomde-uml2-kbjava.rb
+- lib/ontomde-uml2-kbjava/version.rb
+- lib/ontomde-uml2-kbjava/rdfToJava.rb
+- test/test_ontomde-uml2-kbjava.rb
+has_rdoc: true
+homepage: http://ontomde.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.0.0
+  version: 
+requirements: []
+
+rubyforge_project: ontomde
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: OntoMDE Protege 2000 java data-test cartridge
+test_files: 
+- test/test_ontomde-uml2-kbjava.rb