javaclass 0.0.4 → 0.4.1

data/examples/check_interface_names.rb

@@ -11,8 +11,9 @@
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require File.join(File.dirname(__FILE__), 'corpus')
 
-location = Corpus[:Base]
-package = 'at.kugel'
+corpus = Corpus[:Base]
+location = corpus.location
+package = corpus.package
 #++
 require 'javaclass/dsl/mixin'
 

data/examples/corpus.rb

@@ -1,19 +1,59 @@
 # :nodoc:
+
+# Attributes of a project in the test corpus of Java projects.
+# Test corpus has classes in classes/ or classes.zip. Same for test-classes.
+# Author::          Peter Kofler
+# Copyright::       Copyright (c) 2009, Peter Kofler.       
+# License::         {BSD License}[link:/files/license_txt.html]
+#
+class CorpusInfo < Struct.new(:location, :classes, :testClasses, :packages)
+   
+  def self.with_default_folders(location, packages)
+    classes = pure_zip_or_nil(location, 'classes')
+    testClasses = pure_zip_or_nil(location, 'test-classes')
+    CorpusInfo.new(location, classes, testClasses, packages )
+  end
+  
+  def self.pure_zip_or_nil(location, name)
+    classes = File.join(location, name)
+    classes = File.join(location, name + '.zip') unless File.exist?(classes) 
+    classes = nil unless File.exist?(classes)
+    classes
+  end
+  
+  def package
+    if packages.size > 0
+      packages[0]
+    else
+      nil
+    end
+  end
+  
+end
+
 # Set location of the test data corpus.
 corpus_root = 'E:\OfficeDateien\Corpus'
 Corpus = Hash[
   *[
-    %w[Sun10      Java1_JDK-1.0.2(Sun_official) ],
-    %w[WF         Java2_Swing(WF_iMagine) ],
-    %w[S1         Java5_Batch(S1_Fabric)  ],
-    %w[Harmony15  Java5_JDK-1.5M15-r991518(Apache_Harmony)  ],
-    %w[Harmony16  Java5_JDK-1.6M3-r991881(Apache_Harmony)   ],
-    %w[RCP        Java5_RCP_2011(IBM_Costing)   ],
-    %w[BIA        Java6_Swing(BIA_Monarch)  ],
-    %w[HBD        Java6_Web(HBD_Online)  ],
-  ].map { |pair| 
-    [pair[0].to_sym, File.join(corpus_root, pair[1])] 
+    %w[Sun10      Java1_JDK-1.0.2(Sun_official)            java],
+    %w[WF         Java2_Swing(WF_iMagine)                  at.workforce], 
+    %w[S1         Java5_Batch(S1_Fabric)                   ],
+    %w[Harmony15  Java5_JDK-1.5M15-r991518(Apache_Harmony) ],
+    %w[Harmony16  Java5_JDK-1.6M3-r991881(Apache_Harmony)  ],
+    %w[RCP        Java5_RCP_2011(IBM_Costing)              ],
+    %w[BIA        Java6_Swing(BIA_Monarch)                 com.bia],
+    %w[HBD        Java6_Web(HBD_Online)                    at.herold],
+  ].map { |pair|
+    if pair[2] then package = [pair[2]] else package = [] end
+    c =  CorpusInfo.with_default_folders(File.join(corpus_root, pair[1]), package)
+    [pair[0].to_sym, c]
   }.flatten
 ]
-Corpus[:Base] = 'E:\Develop\Java'
-Corpus[:Lib] = 'E:\Develop\Java\CodeLib'
+
+# my own projects 
+Corpus[:Base] = CorpusInfo.with_default_folders('E:\Develop\Java', ['at.kugel'])
+Corpus[:Lib] = CorpusInfo.with_default_folders('E:\Develop\Java\CodeLib', ['at.kugel'])
+
+# temporary corpus for static analysis
+Corpus[:Uep2] = CorpusInfo.new('D:\Internet\uep2', 'D:\Internet\cummulated.clz', 'D:\Internet\cummulated_test.clz', ['uep'])
+Corpus[:Nuss] = CorpusInfo.new('D:\Backend\NUSS',  'D:\Backend\cummulated.clz',  'D:\Backend\cummulated_test.clz',  ['at.lotterien'])

data/examples/count_classes_in_modules.rb

@@ -13,7 +13,8 @@
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require File.join(File.dirname(__FILE__), 'corpus')
 
-location = Corpus[:HBD]
+corpus = Corpus[:HBD]
+location = corpus.location
 #++
 require 'javaclass/classpath/factory'
 include JavaClass::Classpath::Factory

data/examples/cumulative_dependencies.rb

@@ -13,8 +13,9 @@
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require File.join(File.dirname(__FILE__), 'corpus')
 
-location = Corpus[:HBD]
-package = 'at.herold'
+corpus = Corpus[:HBD]
+location = corpus.location
+package = corpus.package
 start_class = 'at.herold.waf.hbd.servlet.HBDServlet'
 # 'at/spardat/krimiaps/service/client/service/impl/ClientSmeSearchServiceImpl'
 # 'at/spardat/krimiaps/service/client/service/impl/ClientPrivateSearchServiceImpl'
@@ -35,5 +36,5 @@ dependencies.debug_print
 
 # 2b) or collect all transitive dependencies of a whole package
 dependencies = cp.transitive_dependencies_package(start_class.to_javaname.package, &filter)
-puts "#{dependencies.size} classes in transitive dependency graph of package"
+puts "#{dependencies.size} classes in transitive dependency graph of package #{start_class.to_javaname.package}"
 #  dependencies.debug_print

data/examples/find_all_imported_types.rb

@@ -13,10 +13,10 @@
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require File.join(File.dirname(__FILE__), 'corpus')
 
-location = Corpus[:Lib]
-prod_location = File.join(location, '..', 'classes')
-test_location = File.join(location, 'classes')
-conf_location = location
+corpus = Corpus[:Lib]
+prod_location = corpus.classes
+test_location = corpus.testClasses
+conf_location = corpus.location
 #++
 require 'javaclass/dsl/mixin'
 
@@ -27,15 +27,19 @@ cp = classpath(prod_location)
 prod_classnames = cp.types
 
 # 3) collect all dependencies of all classes defined there
-imported_classnames = cp.used_types
+imported_types_with_numbers = cp.used_types_map
+imported_classnames = imported_types_with_numbers.keys
 
 # 4) also collect all classes referenced from config files, defined in JavaClass::JavaNameScanner
 hardcoded_classnames = scan_config_for_3rd_party_class_names(conf_location)
 
 # 5) now we know all classes imported/used by production classes
-puts '---------- used 3rd party types in production'
+puts '---------- used 3rd party types in production ; 0 = hardcoded'
 used_classnames = (imported_classnames + hardcoded_classnames).uniq.sort  - prod_classnames
-puts used_classnames
+# puts used_classnames
+used_classnames.each do |name|
+  puts "#{name} ; #{imported_types_with_numbers[name]}"
+end
 
 # 6) do the same for test classes, at least org.junit.* should show up here
 test_cp = classpath(test_location)

data/examples/find_incoming_dependency_graph.rb

@@ -0,0 +1,81 @@
+# Example usage of dependency graph: Invert the graph and see incoming dependencies of a module.
+# After getting all classes of a module, use previously generated dependency graph to iterate 
+# all incoming edges. Then either report all incoming edges as CSV or find all private/inner
+# classes of the module. Works with an existing dependency graph, 
+# e.g. created by {chart module dependencies example}[link:/files/lib/generated/examples/chart_module_dependencies_txt.html].
+# Author::          Peter Kofler
+# Copyright::       Copyright (c) 2012, Peter Kofler.
+# License::         {BSD License}[link:/files/license_txt.html]
+#
+# === Steps
+
+#--
+# add the lib of this gem to the load path
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require File.join(File.dirname(__FILE__), 'corpus')
+
+corpus = Corpus[:RCP]
+location = corpus.location
+#++
+require 'javaclass/dsl/mixin'
+require 'javaclass/classpath/tracking_classpath'
+require 'javaclass/dependencies/edge'
+require 'javaclass/dependencies/yaml_serializer'
+
+# 1) create a classpath of the main model  plugin
+Plugin_name = 'org.codecop.model'
+cp = classpath(File.join(location, Plugin_name, 'bin'))
+classes = cp.names
+puts "#{classes.count} classes found in main plugin"
+cp.reset_access
+
+# 2) load a dependency Graph containing the model
+plugins = JavaClass::Dependencies::YamlSerializer.new.load('plugin_dependencies')
+
+# used to strip beginning of full qualified names
+def strip(name)
+  name.sub(/^org\.codecop\./, '*.')
+end
+
+# 3) mark all accessed classes in model plugin using the dependency graph
+plugins.each_node do |plugin|
+  next if plugin.name == Plugin_name
+  plugin.each_edge do |dep, edge|
+    next unless dep.name == Plugin_name
+    cp.mark_accessed(edge.target)
+  end
+end
+
+plugins.each_node do |plugin|
+  plugin.each_dependency_provider do |dep, dependencies|
+    plugin.dependencies[dep] = dependencies.map { |edge| 
+      # replace class edges by package edges
+      # JavaClass::Dependencies::Edge.new(edge.source.to_javaname.package, edge.target.to_javaname.package)
+
+      # replace class edges with source plugin, target package
+      # JavaClass::Dependencies::Edge.new(plugin.name, edge.target.to_javaname.package)
+
+      # replace source edges with source plugin
+      JavaClass::Dependencies::Edge.new(plugin.name, edge.target)
+    }.uniq.sort
+  end
+end
+
+# 4) report all incoming dependencies (edges) for further Excel analysis 
+plugins.each_node do |plugin|
+  next if plugin.name == Plugin_name
+  plugin.each_edge do |dep, edge|
+    next unless dep.name == Plugin_name
+    puts "#{strip(edge.target)};#{strip(plugin.name)};#{strip(edge.source)}"
+  end
+end
+
+# 5) report unused classes in model from outside
+unused_classes = classes.
+    find_all { |clazz| cp.accessed(clazz) == 0 }.
+    reject { |clazz| clazz =~ /\$.*$/ }
+report = unused_classes.map { |clazz| "#{clazz.to_classname}" }.uniq
+puts "#{report.size} private classes found:"
+report.each do |clazz|
+  puts "#{strip(clazz)};(internal);NA"
+end  

data/examples/find_layers_of_modules.rb

@@ -0,0 +1,79 @@
+# Example usage of dependency graph: Organize the nodes into layers 
+# depending on their dependencies. Works with an existing dependency graph, 
+# e.g. created by {chart module dependencies example}[link:/files/lib/generated/examples/chart_module_dependencies_txt.html].
+# Author::          Peter Kofler
+# Copyright::       Copyright (c) 2012, Peter Kofler.
+# License::         {BSD License}[link:/files/license_txt.html]
+#
+# === Steps
+
+#--
+# add the lib of this gem to the load path
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+#++
+require 'javaclass/dependencies/yaml_serializer'
+
+# 1) load dependency graph 
+plugins = JavaClass::Dependencies::YamlSerializer.new.load('plugin_dependencies')
+components = plugins.to_a
+
+@layerOfComponents = []
+
+# 2) find modules without any dependencies, these are the first/bottom 
+first_elements = components.find_all { |c| c.dependencies.size == 0 }.sort
+@layerOfComponents << first_elements
+components = components - first_elements
+
+def has_all_deps_satisfied?(component)
+  already_sorted_dependencies = @layerOfComponents.flatten
+  component.dependencies.keys.find { |dependency|
+    !already_sorted_dependencies.include?(dependency)
+  } == nil
+end
+
+while components.size > 0
+  cycle = true
+
+  # 3) for each component, check if all dependencies are satisfied combined layers below
+  components.each do |component|
+
+    if has_all_deps_satisfied?(component)
+      components -= [component]
+
+      # 4) if yes, walk up the dependencies until highest/lowest possible
+      index = @layerOfComponents.size - 1
+      while (component.dependencies.keys.find { |dependency| @layerOfComponents[index].include?(dependency) } == nil)
+        index = index -1
+      end
+      index = index + 1 # take next
+
+      # and add to the layers
+      if index == @layerOfComponents.size
+        @layerOfComponents[index] = []
+      end
+      @layerOfComponents[index] << component
+
+      puts "added #{component}"
+      cycle = false
+      break
+    end
+
+  end
+  
+  if cycle
+    warn "cycle in #{components.join(', ')}, can't continue with layering"
+    break
+  end
+end
+
+# 5) output the found layering
+(1..@layerOfComponents.size).each do |i|
+  layer = @layerOfComponents[i-1].sort
+  puts "#{i} " + layer.join(', ')
+end
+
+#--
+# TODO separate components not only by layer, but also be "stream/slice" in layer
+# If it depends only on a single parent and not on others in the same layer - but a chart would be better for that.
+#++

data/examples/find_referenced_modules.rb

@@ -13,12 +13,10 @@
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require File.join(File.dirname(__FILE__), 'corpus')
 
-location = Corpus[:HBD]
-location = Corpus[:RCP]
-location = Corpus[:BIA]
-
-main_location = File.join(location, 'classes')
-test_location = File.join(location, 'test-classes')
+corpus = Corpus[:BIA]
+location = corpus.location
+main_location = corpus.classes
+test_location = corpus.testClasses
 #++
 require 'javaclass/dsl/mixin'
 

data/examples/find_unreferenced_classes.rb

@@ -1,7 +1,8 @@
 # Advanced example usage of JavaClass::Classpath::TrackingClasspath. Load all 
 # classes of an Eclipse workspace. Then mark all referenced classes. In the end 
 # report remaining classes as unreferenced. This lists *potential* unused classes. 
-# Note that the classes may still be used by reflection.
+# Note that the classes may still be used by reflection. Also this can be used to
+# find classes that have a certain number of references to them, e.g. only used once.
 # Author::          Peter Kofler
 # Copyright::       Copyright (c) 2009, Peter Kofler.
 # License::         {BSD License}[link:/files/license_txt.html]
@@ -13,9 +14,9 @@
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require File.join(File.dirname(__FILE__), 'corpus')
 
-location = Corpus[:RCP]
-package1 = 'com.ibm.arc.sdm'
-package2 = 'pricingTool'
+location = Corpus[:Lib].location
+package1 = 'at.kugel'
+package2 = 'org.codecop'
 #++
 require 'javaclass/dsl/mixin'
 require 'javaclass/classpath/tracking_classpath'
@@ -63,3 +64,12 @@ puts 'test classes mapped'
 unused_classes = classes.find_all { |clazz| cp.accessed(clazz) == 0 }
 report = unused_classes.map { |clazz| "#{clazz.to_classname}" }
 puts "#{report.size} unused classes found:\n  #{report.join("\n  ")}"
+
+# 7) find only once accessed classes and report them
+once_used_classes = classes.find_all { |clazz| cp.accessed(clazz) == 1 }
+report = once_used_classes.map { |clazz| "#{clazz.to_classname}" }
+puts "#{report.size} once used classes found:\n  #{report.join("\n  ")}"
+
+twice_used_classes = classes.find_all { |clazz| cp.accessed(clazz) == 2 }
+report = twice_used_classes.map { |clazz| "#{clazz.to_classname}" }
+puts "#{report.size} twice used classes found:\n  #{report.join("\n  ")}"

data/examples/generate_class_lists.rb

@@ -30,6 +30,7 @@ JDKS = [
   JDK_CONFIG.new(5, '1.5.0-07', [PROGRAMS + '\jdk1.5.0_07\jre\lib', PROGRAMS + '\jdk1.5.0_07\lib\dt.jar']),
   JDK_CONFIG.new(6, '1.6.0-26', [PROGRAMS + '\jdk1.6.0_26\jre\lib', PROGRAMS + '\jdk1.6.0_26\lib\dt.jar']),
   JDK_CONFIG.new(7, '1.7.0',    [PROGRAMS + '\jdk1.7.0\jre\lib',    PROGRAMS + '\jdk1.7.0\lib\dt.jar']),
+  JDK_CONFIG.new(8, '1.8.0',    [PROGRAMS + '\jdk1.8.0_25\jre\lib', PROGRAMS + '\jdk1.8.0_25\lib\dt.jar']),
 ]
 #++
 # configuration for some JDKs

data/examples/show_jar_api.rb

@@ -0,0 +1,93 @@
+# Generate a JavaClass::ClassList, which contains all class of a given
+# JAR in the local Maven repository. Use JavaClass::Classpath::MavenArtefact
+# to identify and (possibly download) the JAR under question.
+# Author::          Peter Kofler
+# Copyright::       Copyright (c) 2009, Peter Kofler.
+# License::         {BSD License}[link:/files/license_txt.html]
+#
+# === Usage
+
+#--
+# add the lib of this gem to the load path
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+#++
+require 'javaclass/classlist/jar_searcher'
+require 'javaclass/classpath/maven_artefact'
+require 'javaclass/classlist/list'
+
+#--
+JARS = [
+  # some Apache Commons
+#  JavaClass::Classpath::MavenArtefact.new('commons-beanutils',     'commons-beanutils', '1.8.3', 'Commons BeanUtils'),
+#  JavaClass::Classpath::MavenArtefact.new('commons-cli',           'commons-cli', '1.2'),
+#  JavaClass::Classpath::MavenArtefact.new('commons-codec',         'commons-codec', '1.6'),
+#  JavaClass::Classpath::MavenArtefact.new('commons-collections',   'commons-collections', '3.2.1'),
+#  JavaClass::Classpath::MavenArtefact.new('commons-configuration', 'commons-configuration', '1.8'),
+#  JavaClass::Classpath::MavenArtefact.new('commons-digester',      'commons-digester', '2.1'),
+#  JavaClass::Classpath::MavenArtefact.new('org.apache.commons',    'commons-digester3', '3.2'),
+#  JavaClass::Classpath::MavenArtefact.new('org.apache.commons',    'commons-email', '1.2'),
+#  JavaClass::Classpath::MavenArtefact.new('org.apache.commons',    'commons-exec', '1.1'),
+#  JavaClass::Classpath::MavenArtefact.new('commons-httpclient',    'commons-httpclient', '3.0', 'Jakarta Httpclient'),
+#  JavaClass::Classpath::MavenArtefact.new('org.apache.commons',    'commons-id', '1.0-SNAPSHOT'),
+#  JavaClass::Classpath::MavenArtefact.new('commons-io',            'commons-io', '2.4'),
+#  JavaClass::Classpath::MavenArtefact.new('org.apache.commons',    'commons-jexl', '2.1.1', 'Commons JEXL'),
+#  JavaClass::Classpath::MavenArtefact.new('commons-jxpath',        'commons-jxpath', '1.3', 'Commons JXPath'),
+   JavaClass::Classpath::MavenArtefact.new('commons-lang',          'commons-lang', '2.6'),
+#  JavaClass::Classpath::MavenArtefact.new('org.apache.commons',    'commons-lang3', '3.1'),
+#  JavaClass::Classpath::MavenArtefact.new('org.apache.commons',    'commons-math', '2.2'),
+#  JavaClass::Classpath::MavenArtefact.new('org.apache.commons',    'commons-math3', '3.0'),
+#  JavaClass::Classpath::MavenArtefact.new('commons-net',           'commons-net', '3.1'),
+#  JavaClass::Classpath::MavenArtefact.new('oro',                           'oro', '2.0.8', 'Jakarta ORO'),
+]
+#++
+# Define configuration for some Maven artefacts
+#  JARS = [ JavaClass::Classpath::MavenArtefact.new('commons-lang', 'commons-lang', '2.6'),, ... ]
+
+# For all artefacts listed in +JARS+, load classes and write list files.
+JARS.each do |artefact|
+
+# 1) create a new JavaClass::ClassList::List to contain the classes of this JAR
+  list = JavaClass::ClassList::List.new
+
+# 2) create a JavaClass::ClassList::JarSearcher
+  searcher = JavaClass::ClassList::JarSearcher.new
+  searcher.skip_package_classes = true
+
+# 3) create the classpath of the artefact's JAR
+  artefact.download_if_needed
+  classpath = artefact.classpath
+
+# 4) scan the JAR and add classes to the list
+  searcher.add_list_from_classpath(artefact.version, classpath, list)
+
+# 5) save the list to a file named "Commons Lang 2.6.txt" (after the artefact)
+  File.open("#{artefact.title} #{artefact.version}.txt", "w") do |f|
+    # print title
+    f.print "*** #{artefact.title}\n"
+
+    list.packages.each { |pkg|
+      f.print "\n"
+      # print package name
+      f.print "* #{pkg.name}\n"
+    
+      # print class names
+      pkg.classes.each { |c| f.print "   #{c.name}\n" }
+    }
+  end
+
+  puts "processed #{artefact.name}"
+end
+
+# 6) the generated file looks like
+#  *** Commons Lang
+#
+#  * org.apache.commons.lang
+#     ArrayUtils
+#     BitField
+#     ...
+#
+#  * org.apache.commons.lang.builder
+#     CompareToBuilder
+#     EqualsBuilder
+#     HashCodeBuilder
+#     ...