javaclass 0.0.2 → 0.0.3

data/lib/javaclass/metric/class_usage.rb

@@ -0,0 +1,41 @@
+# add the lib to the load path
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+# TODO cleanup this code fragment and make a proper class 
+
+require 'javaclass'
+include JavaClass
+
+JDK_PACKAGES = %w| java javax.accessibility javax.activity javax.crypto javax.imageio javax.jnlp javax.management 
+                   javax.naming javax.net javax.print javax.rmi javax.script javax.security.auth javax.security.cert
+                   javax.security.sasl javax.sound.midi javax.sound.sampled javax.sql javax.swing javax.transaction
+                   javax.xml org.ietf.jgss org.w3c.dom org.xml.sax|.collect { |pkg| /^#{pkg}\./ }
+                     
+def in_jdk?(name)
+  JDK_PACKAGES.find { |regex| name =~ regex } != nil
+end                     
+
+def imported_types(classes)
+  own_classes = classes.names.collect { |name| name.gsub('/', '.').sub(/\.class$/, '')}.sort 
+  
+  imported = classes.names.collect do |name|
+    clazz = JavaClassHeader.new(classes.load_binary(name))
+    clazz.references.used_classes.collect { |c| c.to_s.gsub('/', '.') }  
+  end.flatten.uniq.sort
+  
+  imported.reject { |name| in_jdk?(name) } - own_classes
+end
+
+# TODO detect and read spring XML configs?
+
+classes = JavaClass::Classpath::FolderClasspath.new("./target/classes")
+own = classes.names.collect { |name| name.gsub('/', '.').sub(/\.class$/, '')}.sort
+used = imported_types(classes)
+puts "---------- used types" 
+puts used
+
+test_classes = JavaClass::Classpath::FolderClasspath.new("./target/test-classes")
+test = imported_types(test_classes) - own - used 
+puts "---------- for tests" 
+puts test
+

data/lib/javaclass/metric/metrics.txt

@@ -0,0 +1,15 @@
+=== Metrics
+ 
+ * "metric" if all referencing classes of a class is another package, propose moving it there.
+ * "Greed Detector"
+  * count outgoing references (usage) per method 
+  * which signatures are called how often
+  * maybe move current method there?
+  * CRSS Metric
+  * CCD
+
+ * {Chidamber and Kemerer Java Metrics (ckjm)}[http://www.spinellis.gr/sw/ckjm/]
+ * {The CRSS Metric for Package Design Quality}[http://crpit.com/confpapers/CRPITV62Melton2.pdf]
+
+ * {Evolutionary architecture and emergent design: Emergent design through metrics}[http://www.ibm.com/developerworks/java/library/j-eaed6/]
+

data/lib/javaclass.rb

@@ -1,14 +1,47 @@
-require 'javaclass/java_class_header'
+require 'javaclass/classfile/java_class_header'
+require 'javaclass/classpath/java_home_classpath'
+require 'javaclass/classpath/composite_classpath'
 
-# Parse and disassemble Java class files, similar to the +javap+ command.
+# Main entry point for class file parsing.
 # Author::          Peter Kofler
-# See::             http://java.sun.com/docs/books/jvms/second_edition/html/ClassFile.doc.html
-# See::             http://en.wikipedia.org/wiki/Class_(file_format)
-module JavaClass 
-  
-  # Read and disassemble the given class called _name_ (full file name).
-  def self.parse(name)
-    JavaClassHeader.new(File.open(name, 'rb') {|io| io.read } )
-  end
-  
+module JavaClass
+
+    # Read and disassemble the given class from _filename_ (full file name).
+    def self.load_fs(filename)
+      disassemble(File.open(filename, 'rb') { |io| io.read } )
+    end
+    
+    def self.parse(filename)
+      warn 'Deprecated method JavaClass::parse will be removed in next release. Use method load_fs instead.'
+      load_fs(filename)
+    end
+
+    # Read and disassemble the given class _classname_ from _classpath_ .
+    def self.load_cp(classname, classpath)
+      disassemble(classpath.load_binary(classname))
+    end
+
+    # Read and disassemble the given class inside _data_ (byte data).
+    def self.disassemble(data)
+      ClassFile::JavaClassHeader.new(data)
+    end
+
+    # Parse the given path variable _path_ and return a chain of class path elements.
+    def self.classpath(path)
+      full_classpath(nil, path)
+    end
+    
+    # Parse and scan the system classpath. Needs +JAVA_HOME+ set. Uses environment +CLASSPATH+ if set.
+    def self.environment_classpath
+      full_classpath(ENV['JAVA_HOME'], ENV['CLASSPATH'])
+    end
+
+    # Parse the given path variable _path_ and return a chain of class path elements together with _javahome_ if any.
+    def self.full_classpath(javahome, path='')
+      cp = Classpath::CompositeClasspath.new
+      cp.add_element(Classpath::JavaHomeClasspath.new(javahome)) if javahome
+      path.split(File::PATH_SEPARATOR).each { |cpe| cp.add_file_name(cpe) } if path
+      cp
+    end
+
 end

data/test/data/access_flags/AccessFlagsTestPublic.java

@@ -0,0 +1,11 @@
+package packagename;
+
+public class AccessFlagsTestPublic {
+
+   private class Inner { }
+
+   static class StaticInner { }
+
+   interface InnerInterface { }
+
+}

data/test/data/access_flags/AccessFlagsTestPublic_javap.txt

@@ -0,0 +1,29 @@
+public class packagename.AccessFlagsTestPublic extends java.lang.Object
+  minor version: 0
+  major version: 50
+  Constant pool:
+const #1 = Method       #3.#17; //  java/lang/Object."<init>":()V
+const #2 = class        #18;    //  packagename/AccessFlagsTestPublic
+const #3 = class        #19;    //  java/lang/Object
+const #4 = class        #20;    //  packagename/AccessFlagsTestPublic$InnerInterface
+const #5 = Asciz        InnerInterface;
+const #6 = Asciz        InnerClasses;
+const #7 = class        #21;    //  packagename/AccessFlagsTestPublic$StaticInner
+const #8 = Asciz        StaticInner;
+const #9 = class        #22;    //  packagename/AccessFlagsTestPublic$Inner
+const #10 = Asciz       Inner;
+const #11 = Asciz       <init>;
+const #12 = Asciz       ()V;
+const #13 = Asciz       Code;
+const #14 = Asciz       LineNumberTable;
+const #15 = Asciz       SourceFile;
+const #16 = Asciz       AccessFlagsTestPublic.java;
+const #17 = NameAndType #11:#12;//  "<init>":()V
+const #18 = Asciz       packagename/AccessFlagsTestPublic;
+const #19 = Asciz       java/lang/Object;
+const #20 = Asciz       packagename/AccessFlagsTestPublic$InnerInterface;
+const #21 = Asciz       packagename/AccessFlagsTestPublic$StaticInner;
+const #22 = Asciz       packagename/AccessFlagsTestPublic$Inner;
+
+{
+}

data/test/data/jar_classpath/make.bat

@@ -0,0 +1,24 @@
+if exist JarClasspathTest*.* del JarClasspathTest*.*
+
+md JarClasspathTestFolder\package
+copy ..\class_version\ClassVersionTest10.class JarClasspathTestFolder
+copy ..\class_version\ClassVersionTest11.class JarClasspathTestFolder\package
+
+cd JarClasspathTestFolder
+jar -cf ..\JarClasspathTest.jar .
+cd ..
+
+call winzip -a JarClasspathTest.zip ClassVersionTest10.class
+
+echo Class-Path: JarClasspathTest.jar > manifest.txt
+jar -cfm JarClasspathTestManifest.jar manifest.txt ClassVersionTest11.class
+del manifest.txt
+
+echo Version: 1.0.0> manifest.txt
+echo Main-Class: at.kugel.tool.disconnect.Main>> manifest.txt
+echo Class-Path: lib/httpunit-1.6.2.jar lib/nekohtml-0.9.1.jar             >> manifest.txt
+echo    lib/xercesImpl-2.5.jar lib/js-1.5R4.1.jar>> manifest.txt
+jar -cfm JarClasspathTestMultiManifest.jar manifest.txt ClassVersionTest11.class
+del manifest.txt
+
+pause

data/test/data/jar_searcher/PublicClass.java

@@ -0,0 +1,12 @@
+package packagename;
+
+public class PublicClass {
+
+   class InnerClass {
+   }
+
+}
+
+class PackageClass {
+
+}

data/test/data/jar_searcher/PublicInterface.java

@@ -0,0 +1,5 @@
+package packagename;
+
+public interface PublicInterface {
+
+}

data/test/data/jar_searcher/make.bat

@@ -0,0 +1,13 @@
+del *.class
+del *.jar
+
+md classes
+javac -d classes *.java
+cd classes
+jar -cf ..\JarClassListTest.jar *
+cd ..
+
+copy classes\packagename\*.class .
+
+rmdir /S /Q classes
+pause

data/test/data/java_home_classpath/make.bat

@@ -0,0 +1,13 @@
+if exist JavaHomeClasspathTest\nul rmdir /S /Q JavaHomeClasspathTest
+
+md JavaHomeClasspathTest\jdk\jre\lib
+jar -cf JavaHomeClasspathTest\jdk\jre\lib\rt.jar ..\class_version\ClassVersionTest10.class
+
+md JavaHomeClasspathTest\jre\lib
+jar -cf JavaHomeClasspathTest\jre\lib\rt.jar ..\class_version\ClassVersionTest10.class
+
+md JavaHomeClasspathTest\jre-ext\lib\ext
+jar -cf JavaHomeClasspathTest\jre-ext\lib\rt.jar ..\class_version\ClassVersionTest10.class
+jar -cf JavaHomeClasspathTest\jre-ext\lib\ext\ext.jar ..\class_version\ClassVersionTest11.class
+
+pause

data/test/data/references/ReferencesTest.java

@@ -0,0 +1,12 @@
+public class ReferencesTest {
+
+   private ReferencesTest field; // self reference
+
+   public ReferencesTest() {
+      super(); // Object is super class, also has ctor
+      field.x();
+   }
+
+  public void x() { }
+
+}

data/test/data/references/make.bat

@@ -0,0 +1,5 @@
+if exist ReferencesTest.class del ReferencesTest.class
+
+javac -g:none ReferencesTest.java
+
+pause

data/test/setup.rb

@@ -1,4 +1,8 @@
-require 'test/unit'
+require 'test/unit' 
+require 'test/unit/testcase'
+
+# Base require of tests.
+# Author::   Peter Kofler
 
 # add the lib to the load path
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
@@ -7,8 +11,5 @@ TEST_DATA_PATH = File.join(File.dirname(__FILE__), 'data')
 
 # Load the binary class data of given _name_ from the test path.
 def load_class(name)
-  File.open("#{TEST_DATA_PATH}/#{name}.class", 'rb') {|io| io.read } 
+  File.open("#{TEST_DATA_PATH}/#{name}.class", 'rb') {|io| io.read }
 end
-
-# require 'javaclass'
-# require File.join(File.dirname(__FILE__), %w[.. lib javaclass])

data/test/test_access_flags.rb

@@ -1,53 +1,68 @@
 require File.dirname(__FILE__) + '/setup'
-require 'javaclass/java_class_header'
+require 'javaclass/classfile/java_class_header'
 
 module TestJavaClass
-  
-  class TestAccessFlags < Test::Unit::TestCase
+  module TestClassFile
     
-    def setup
-      @cls = {}
-      %w[Public Package Abstract Interface Final].each do |t| 
-        eval("@#{t.downcase} = JavaClass::JavaClassHeader.new(load_class('AccessFlagsTest#{t}')).access_flags") 
+    class TestAccessFlags < Test::Unit::TestCase
+      
+      def setup
+        @cls = {}
+        %w[Public Package Abstract Interface Final Public$Inner Public$StaticInner Public$InnerInterface].each do |t| 
+          eval("@#{t.sub(/Public\$/, '').downcase} = JavaClass::ClassFile::JavaClassHeader.new(load_class('access_flags/AccessFlagsTest#{t}')).access_flags") 
+        end
       end
-    end
-    
-    def test_accessible_eh
-      assert(@public.accessible?)
-      assert(!@package.accessible?)
-      assert(@abstract.accessible?)
-      assert(@interface.accessible?)
-      assert(@final.accessible?)
-    end
-    
-    def test_public_eh
-      assert(@public.public?)
-    end    
-    
-    def test_interface_eh
-      assert(!@public.interface?)
-      assert(!@package.interface?)
-      assert(!@abstract.interface?)
-      assert(@interface.interface?)
-      assert(!@final.interface?)
-    end
-    
-    def test_abstract_eh
-      assert(!@public.abstract?)
-      assert(!@package.abstract?)
-      assert(@abstract.abstract?)
-      assert(@interface.abstract?)
-      assert(!@final.abstract?)
-    end
-    
-    def test_final_eh
-      assert(!@public.final?)
-      assert(!@package.final?)
-      assert(!@abstract.final?)
-      assert(!@interface.final?)
-      assert(@final.final?)
+      
+      def test_accessible_eh
+        assert(@public.accessible?)
+        assert(!@package.accessible?)
+        assert(@abstract.accessible?)
+        assert(@interface.accessible?)
+        assert(@final.accessible?)
+      end
+      
+      def test_public_eh
+        assert(@public.public?)
+      end    
+      
+      def test_interface_eh
+        assert(!@public.interface?)
+        assert(!@package.interface?)
+        assert(!@abstract.interface?)
+        assert(@interface.interface?)
+        assert(!@final.interface?)
+        assert(@innerinterface.interface?)
+      end
+      
+      def test_abstract_eh
+        assert(!@public.abstract?)
+        assert(!@package.abstract?)
+        assert(@abstract.abstract?)
+        assert(@interface.abstract?)
+        assert(!@final.abstract?)
+        assert(@innerinterface.abstract?)
+      end
+      
+      def test_final_eh
+        assert(!@public.final?)
+        assert(!@package.final?)
+        assert(!@abstract.final?)
+        assert(!@interface.final?)
+        assert(@final.final?)
+      end
+      
+      #    def test_inner_eh
+      #      assert(!@public.inner?)
+      #      assert(!@package.inner?)
+      #      assert(!@abstract.inner?)
+      #      assert(!@interface.inner?)
+      #      assert(!@final.inner?)
+      #      assert(@inner.inner?)
+      #      assert(@staticinner.inner?)
+      #      assert(@innerinterface.inner?)
+      #    end
+      
     end
     
   end
-  
 end

data/test/test_base.rb

@@ -1,22 +1,27 @@
 require File.dirname(__FILE__) + '/setup'
-require 'javaclass/constants/base'
+require 'javaclass/classfile/constants/base'
 
 module TestJavaClass
-  
-  class TestConstantBase < Test::Unit::TestCase
-    
-    class ConstantClass < JavaClass::Constants::Base;
-      def initialize(name=nil); super(name); end
-    end
-    
-    def test_name
-      v = ConstantClass.new
-      assert_equal("Class", v.name)
+  module TestClassFile
+    module TestConstants
+      
+      class TestBase < Test::Unit::TestCase
+        
+        class ConstantClass < JavaClass::ClassFile::Constants::Base; # ZenTest SKIP mock class
+          def initialize(name=nil); super(name); end
+        end
+        
+        def test_name
+          v = ConstantClass.new
+          assert_equal('Class', v.name)
+          
+          v = ConstantClass.new('Bubu')
+          assert_equal('Bubu', v.name)
+        end
+        
+      end
       
-      v = ConstantClass.new("Bubu")
-      assert_equal("Bubu", v.name)
     end
-    
   end
-  
 end
+