javaclass 0.0.3 → 0.0.4

data/Rakefile

@@ -1,63 +1,56 @@
-#require 'FileUtils' # already required
 require 'net/http'
 require 'rubygems'
 require 'rubygems/gem_runner' # install and uninstall
+require 'rubygems/package_task'
 require 'rake'
 require 'rake/clean' # for clean/clobber
 require 'rake/testtask'
-require 'rake/gempackagetask'
 require 'rake/packagetask'
 require 'rake/rdoctask'
+require 'example_task'
 
 # Test, package and publish functions.
-# Author::          Peter Kofler
-# See: http://rake.rubyforge.org/files/doc/rakefile_rdoc.html
-GEM_NAME = 'javaclass'
-GOOGLE_PROJECT = "#{GEM_NAME}-rb"
+# Author::           Peter Kofler
+# See::              http://rake.rubyforge.org/files/doc/rakefile_rdoc.html
+# Acknowledgement::  Building this Rake file was supported as System One Research Day. Thank you System One for funding Open Source :-)
+
 RDOC_DIR = 'html'
 RDOC_REPO = 'api'
 
-gemspec = Gem::Specification.new do |s|
-  s.version = '0.0.3'
-  s.name = GEM_NAME
-  s.rubyforge_project = 'javaclass' # old, just redirects
-  s.summary = 'A parser and disassembler for Java class files'
-  s.description = 'Provides access to the package, protected, and public fields and methods of the classes passed to it together with a list of all outgoing references.'
-  s.homepage = "http://code.google.com/p/#{GOOGLE_PROJECT}/"
-  s.author = 'Peter Kofler'
-  s.email = 'peter dot kofler at code minus cop dot org'
-  
-  s.files = FileList['Readme.txt', '{lib,test,examples}/**/*.*', 'history.txt', 'Rakefile']
-  s.test_files = FileList['test/**/test_*.rb']
-  s.require_path = 'lib'
-  s.add_dependency('rubyzip', '>= 0.9.1')
-  s.required_ruby_version = '>= 1.8.6' 
-  s.platform = Gem::Platform::RUBY
-  s.add_development_dependency('rake', '>= 0.8.4')
-  s.add_development_dependency('ZenTest', '>= 4.4.0')
-  
-  s.has_rdoc = true
-  s.extra_rdoc_files = ['Readme.txt', 'history.txt']
-  s.rdoc_options << '--title' << "#{s.name}-#{s.version} Documentation" <<
-                    '--main' << 'Readme.txt' 
-end
+gemspec = eval(IO.readlines('javaclass.gemspec').join)
 full_gem_name = "#{gemspec.name}-#{gemspec.version}"
 
 desc 'Validates the gemspec'
-task :validate_gem do 
+task :validate_gem do
   gemspec.validate
 end
 
 desc 'Displays the current version'
-task :version do 
+task :version do
   puts gemspec.version
 end
 
 # :test
-Rake::TestTask.new do |t| 
+Rake::TestTask.new do |t|
+  t.test_files = gemspec.test_files
+  t.warning = true
+  # t.verbose = false is default
+end
+
+begin
+  require 'rcov/rcovtask'
+
+# :rcov
+Rcov::RcovTask.new do |t|
   t.test_files = gemspec.test_files
   t.warning = true
-  #t.verbose = false is default
+  t.rcov_opts << "--sort=coverage"
+  t.rcov_opts << "--only-uncovered"
+end
+
+rescue LoadError
+  # skip if not installed
+  warn("rcov not installed. coverage not available. #{$!}")
 end
 
 desc 'Find missing test methods with ZenTest'
@@ -68,12 +61,12 @@ task :zentest do
 end
 
 # :gem
-Rake::GemPackageTask.new(gemspec) do |pkg| 
+Gem::PackageTask.new(gemspec) do |pkg|
   pkg.need_zip = true
 end
 
 # :package, :clobber_package, :repackage
-Rake::PackageTask.new(gemspec.name, gemspec.version) do |pkg| 
+Rake::PackageTask.new(gemspec.name, gemspec.version) do |pkg|
   #pkg.need_tar = true - no compress in tar on unxutils in Windows
   #pkg.need_tar_gz = true - no compress in tar on unxutils in Windows
   pkg.need_zip = true
@@ -99,7 +92,9 @@ end
 desc 'Tag current version in Hg'
 task :tag do
   hg ['tag', '-f', "-m \"Released gem version #{gemspec.version}\"", "#{full_gem_name}"]
+  # hg ['push']
   puts 'Tag created. Don\'t forget to push'
+  puts 'hg push'
 end
 
 # internal - desc 'Release the gem to Rubygems'
@@ -112,11 +107,11 @@ end
 # <code>HOME</code> environment must be set.
 def user_pass_from_hgrc(authname)
   lines = IO.readlines(File.expand_path('~/.hgrc'))
-  user = lines.find{ |l| l =~ /#{authname}.username/ }[/[^\s=]+$/] 
+  user = lines.find{ |l| l =~ /#{authname}.username/ }[/[^\s=]+$/]
   raise "could not find key #{authname}.username in ~/.hgrc" unless user
   pass = lines.find{ |l| l =~ /#{authname}.password/ }[/[^\s=]+$/]
   raise "could not find key #{authname}.password in ~/.hgrc" unless pass
-  [user, pass] 
+  [user, pass]
 end
 
 # Download the <code>googlecode_upload.py</code> from Google Code repository and save it as _name_ .
@@ -142,19 +137,34 @@ task :release_googlecode => :package do
   download_googlecode_upload_py 'googlecode_upload.py'
   ['gem', 'zip'].each do |extension|
     puts "uploading \"pkg/#{full_gem_name}.#{extension}\"..."
-    python ['googlecode_upload.py', "-s \"JavaClass #{gemspec.version} #{extension.capitalize}\"", "-p #{GOOGLE_PROJECT}", "-u #{user}", "-w #{pass}", "pkg/#{full_gem_name}.#{extension}"]
+    python ['googlecode_upload.py', "-s \"JavaClass #{gemspec.version} #{extension.capitalize}\"", 
+                                    "-p #{GOOGLE_PROJECT}", "-u #{user}", "-w #{pass}", 
+                                    "pkg/#{full_gem_name}.#{extension}"]
   end
 end
 
 desc 'Package and upload gem to Rubygems and Google Code'
-task :publish_gem => [:clobber_package, :package, :release_rubygems, :release_googlecode] 
+task :publish_gem => [:clobber_package, :example, :package, :release_rubygems, :release_googlecode]
+
+# :example, :clobber_example, :reexample
+example_task_lib = Rake::ExampleTask.new do |example|
+  example.example_files.include 'examples/**/*.rb'
+end
+task :clobber_rdoc => [:clobber_example]
+task :rdoc => [:example]
+task :package => [:example]
 
 # :rdoc, :clobber_rdoc, :rerdoc
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = RDOC_DIR # 'html' is default anyway
   rdoc.title = "#{full_gem_name} Documentation"
   rdoc.main = 'Readme.txt'
-  rdoc.rdoc_files.include 'Readme.txt', 'lib/**/*.rb', 'history.txt'
+
+  # examples are generated later and not necessarily available at definition time
+  examples = example_task_lib.conversion_pairs.map { |a| a[1] }
+  
+  rdoc.rdoc_files.include *examples
+  rdoc.rdoc_files.include 'lib/**/*.rb', *gemspec.extra_rdoc_files
 end
 
 # Helper method to add target="_parent" to all external links in _file_ html.
@@ -162,7 +172,7 @@ def add_href_parent(file)
   lines = IO.readlines(file).collect do |line|
     if line =~ /(href=(?:'|")https?:\/\/)/
       "#{$`}target=\"_parent\" #{$1}#{$'}"
-    else 
+    else
       line
     end
   end
@@ -170,8 +180,8 @@ def add_href_parent(file)
 end
 
 desc 'Fix the RDoc hrefs in framesets'
-task :fix_rdoc => [:rdoc] do 
-  Dir["#{RDOC_DIR}/**/*.html"].each { |file| add_href_parent(file) } 
+task :fix_rdoc => [:rdoc] do
+  Dir["#{RDOC_DIR}/**/*.html"].each { |file| add_href_parent(file) }
 end
 
 # Helper method to add the gem version _dir_ into index _file_ to frameset links.
@@ -179,7 +189,7 @@ def add_frameset_version(file, dir)
   lines = IO.readlines(file).collect do |line|
     if line =~ /(frame src=")/
       "#{$`}#{$1}#{dir}/#{$'}"
-    else 
+    else
       line
     end
   end
@@ -187,35 +197,36 @@ def add_frameset_version(file, dir)
 end
 
 desc 'Publish the RDoc files to Google Code'
-task :publish_rdoc => [:clobber_rdoc, :rdoc, :fix_rdoc] do 
+task :publish_rdoc => [:clobber_rdoc, :fix_rdoc] do
   puts "Releasing #{full_gem_name} to API"
-
-  remote_repo = "https://#{RDOC_REPO}.#{GOOGLE_PROJECT}.googlecode.com/hg/"
+  remote_repo = "https://code.google.com/p/#{GOOGLE_PROJECT}.#{RDOC_REPO}"
   remote_dir = "#{gemspec.version}"
-  
+
   FileUtils.rm_r RDOC_REPO rescue nil
   hg ['clone', remote_repo, RDOC_REPO]
-  
+
   FileUtils.rm_r "#{RDOC_REPO}/#{remote_dir}" rescue nil
   FileUtils.cp_r RDOC_DIR, "#{RDOC_REPO}/#{remote_dir}"
-  
+
   # modify index, update redirect in frameset
   file = "#{RDOC_REPO}/index.html"
   FileUtils.cp "#{RDOC_REPO}/#{remote_dir}/index.html", file
   add_frameset_version(file, remote_dir)
-  
+
   hg ['addremove', '-q', "-R #{RDOC_REPO}"]
   hg ['ci', "-m \"Update Rdoc for version #{gemspec.version}\"", "-R #{RDOC_REPO}"]
   hg ['tag', '-f', "-m \"Released gem version #{gemspec.version}\"", "-R #{RDOC_REPO}", "#{full_gem_name}"]
-  hg ['push', "-R #{RDOC_REPO}"]
+  # hg ['push', "-R #{RDOC_REPO}"]
+  puts 'API site created. Don\'t forget to push'
+  puts "hg push -R #{RDOC_REPO}"
 end
 
-# :clean :clobber 
-CLOBBER.include(RDOC_REPO, 'googlecode_upload.py')
+# :clean :clobber
+CLOBBER.include(RDOC_REPO, 'googlecode_upload.py', 'ClassLists', 'fullClassList*.txt')
 
 # Helper method to grep all the sources for some _pattern_ words.
 def egrep(pattern)
-  Dir['**/*'].find_all { |fn| FileTest.file? fn }.each do |fn|
+  Dir['**/*'].find_all { |fn| FileTest.file?(fn) && File.basename(fn) != /^\./ }.each do |fn|
     line_count = 0
     open(fn) do |f|
       while line = f.gets

data/Readme.txt

@@ -17,10 +17,10 @@ of the classes passed to it together with a list of all outgoing references.
 I am still doing Java most of the time. I used to be quite enthusiastic about
 it, but after 11 years I can see the advantages of being a polyglot. So I use
 Ruby for all kind of stuff, just for fun. When I needed some Java class
-analysis I wrote it with Ruby. As I am a puritan, I did not
+analysis I wrote it in Ruby. As I am a puritan, I did not
 want to call javap from my script, so I started disassembling the class files,
 which might be the base for some serious static code analysis tools. (I
-started adding methods to that end...)
+{started adding methods}[link:/files/history_txt.html] to that end.)
 
 == Install
 
@@ -29,56 +29,59 @@ started adding methods to that end...)
 * {Gem Hosting}[http://rubygems.org/gems/javaclass]
 * {Download of tarballs and gems}[http://code.google.com/p/javaclass-rb/downloads/list]
 
-== Usage
-
-  require 'javaclass'
-
-  # load the class directly from the file system
-  clazz = JavaClass.load_fs('packagename/Public.class')
-  
-  # better lookup the class from some classpath
-  classpath = JavaClass.classpath('some/path')
-  clazz = JavaClass.load_cp('packagename.Public', classpath)
-  
-  clazz.version                          # => 50.0
-  clazz.constant_pool.items[1]           # => packagename/Public
-  clazz.access_flags.public?             # => true
-  clazz.this_class                       # => packagename/Public
-  clazz.this_class.to_java_file          # => packagename/Public.java
-  clazz.super_class                      # => java/lang/Object
-  clazz.super_class.to_classname         # => java.lang.Object
-  clazz.references.referenced_methods[0] # => java/lang/Object.<init>:()V
-
 == Documentation
 
-Module +JavaClass+ is the entry point for most functions in the gem.
-The main class is JavaClass::ClassFile::JavaClassHeader which provides access to
-all information of a Java class file. There are also some examples in the examples
-folder of the gem.
+Module JavaClass is the entry point for basic functions. All advanced functions are
+available in Object through the JavaClass::Dsl::Mixin. The main class or the parser 
+is JavaClass::ClassFile::JavaClassHeader which provides access to all information 
+of a Java class file. 
 
 * {API RDoc}[http://api.javaclass-rb.googlecode.com/hg/index.html]
 
+I tried hard to rdoc all classes and public methods, so just {read it}[http://api.javaclass-rb.googlecode.com/hg/index.html].
+
+== Usage
+
+See the various examples in the examples folder of the gem. 
+
+* {Basic Usage}[link:/files/lib/generated/examples/simple_usage_txt.html]
+* {Number of classes in modules/JARs}[link:/files/lib/generated/examples/count_classes_in_modules_txt.html]
+* {Check names of all interfaces}[link:/files/lib/generated/examples/check_interface_names_txt.html]
+* {All imported types}[link:/files/lib/generated/examples/find_all_imported_types_txt.html]
+* {Cumulative dependencies of a class}[link:/files/lib/generated/examples/cumulative_dependencies_txt.html]
+* {Find (un)referenced JARs}[link:/files/lib/generated/examples/find_referenced_modules_txt.html] 
+* {Find unused classes}[link:/files/lib/generated/examples/find_unreferenced_classes_txt.html]
+* {Generate lists of JDK classes}[link:/files/lib/generated/examples/generate_class_lists_txt.html]
+
+There is some experimental logic to recognize Java class name literals in Ruby 
+which are mapped to JavaClass::JavaQualifiedName. Packages have to be suffixed 
+with ".*" to be recognized. See JavaClass::Dsl::JavaNameFactory for its usage. 
+
 == Support
 
-The bug tracker is available at http://code.google.com/p/javaclass-rb/issues/list or just drop me an email.
+The bug tracker is available at {Google Code}[http://code.google.com/p/javaclass-rb/issues/list]
+or just drop me an email.
+
+== How to submit patches
+
+Read the {8 steps for fixing other people's code}[http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/]
+and for section 8, use the {Issue Tracker}[http://code.google.com/p/javaclass-rb/issues/list].
+
+The trunk repository is available with
+
+  hg clone https://javaclass-rb.googlecode.com/hg/ javaclass-rb
 
 == Dependencies
 
-* Ruby 1.8.6
-* {rubyzip}[http://rubyzip.sourceforge.net/]
+* Ruby 1.8.6 (runs with 1.8.7 and 1.9.1, too)
+* {rubyzip}[http://rubyzip.sourceforge.net/] 0.9.1
 
 == References
 
-* {JavaWorld: The Java class file lifestyle}[http://www.javaworld.com/javaworld/jw-07-1996/jw-07-classfile.html]
-* {VM Spec: The class File Format}[http://java.sun.com/docs/books/jvms/second_edition/html/ClassFile.doc.html]
-* {Similar Project by unageanu}[http://github.com/unageanu/javaclass]
+* {The Java class file lifestyle}[http://www.javaworld.com/javaworld/jw-07-1996/jw-07-classfile.html], JavaWorld 1996.
+* {The class File Format}[http://java.sun.com/docs/books/jvms/second_edition/html/ClassFile.doc.html], The Java Virtual Machine Specification, Second Edition.
+* {Similar Project by unageanu}[http://github.com/unageanu/javaclass], GitHub 2010. 
 
 == License
 
-* {New BSD License}[http://www.opensource.org/licenses/bsd-license.php]
-
-== Disclaimer Note
-
-This software is provided "as is" and without any express or implied warranties,
-including, without limitation, the implied warranties of merchantability and
-fitness for a particular purpose.
+* {BSD License}[http://www.opensource.org/licenses/bsd-license.php], it's enclosed in {license.txt}[link:/files/license_txt.html].

data/example_task.rb

@@ -0,0 +1,172 @@
+require 'rake'
+require 'rake/tasklib'
+
+module Rake
+
+  # Create a documentation task that will generate the example files for a project.
+  #
+  # The ExampleTask will create the following targets:
+  #
+  # [<b>:<em>example</em></b>]
+  #   Main task for this example task.
+  #
+  # [<b>:clobber_<em>example</em></b>]
+  #   Delete all the example files.  This target is automatically added to the main clobber target.
+  #
+  # [<b>:re<em>example</em></b>]
+  #   Rebuild the example files from scratch, even if they are not out of date.
+  #
+  # Simple example:
+  #
+  #   Rake::ExampleTask.new do |rd|
+  #     rd.target_dir = 'generated/examples'
+  #     rd.example_files.include('examples/**/*.rb')
+  #   end
+  #
+  # The +rd+ object passed to the block is an ExampleTask object. See the
+  # attributes list for the ExampleTask class for available customization options.
+  #
+  # == Specifying different task names
+  #
+  # You may wish to give the task a different name, such as if you are generating two
+  # sets of examples.  For instance, if you want to have a development set of examples:
+  #
+  #   Rake::ExampleTask.new(:example_dev) do |rd|
+  #     rd.example_files.include('dev_examples/**/*.rb')
+  #   end
+  #
+  # The tasks would then be named :<em>example_dev</em>, :clobber_<em>example_dev</em>, and :re<em>example_dev</em>.
+  #
+  class ExampleTask < TaskLib
+
+    # Name of the main, top level task. (default is :example)
+    attr_accessor :name
+
+    # Name of directory to receive the example output files. (default is 'lib/generated/examples')
+    attr_accessor :target_dir
+
+    # List of files to be included in the example generation. (default is [])
+    attr_accessor :example_files
+
+    # Create the Example tasks with the given base _name_ .
+    def initialize(name = :example)  # :yield: self
+      @name = name
+      @example_files = Rake::FileList.new
+      @target_dir = 'lib/generated/examples'
+      
+      yield self if block_given?
+      
+      define_tasks
+    end
+
+    private
+
+    # Create the tasks defined by this task lib.
+    def define_tasks
+      define_repeat_task
+      define_clobber_task
+      define_build_task
+    end
+    
+    def define_repeat_task
+      desc 'Force a rebuild of the example files'
+      task repeat_task_name => [clobber_task_name, build_task_name]
+    end
+
+    def define_clobber_task
+      desc 'Remove example products'
+      task clobber_task_name do
+        rm_r @target_dir rescue nil
+      end
+
+      task :clobber => [clobber_task_name]
+    end
+
+    def define_build_task
+      desc "Build the #{build_task_name} files"
+      task build_task_name
+
+      directory @target_dir
+      conversion_pairs.each { | a | define_transform(*a) }
+    end
+
+    def conversion_pairs
+      files_to_convert.map do |example_path|
+        [example_path, to_target_file(example_path)]
+      end
+    end
+    public :conversion_pairs
+    
+    def files_to_convert
+      @example_files.find_all { |example_path| convert?(example_path) }
+    end
+
+    def define_transform(example_path, example_target)
+      task build_task_name => [example_target]
+      file example_target => [example_path, Rake.application.rakefile] do
+        print '.'
+        transform(example_path, example_target)
+      end
+    end
+        
+    def build_task_name
+      name.to_s
+    end
+
+    def clobber_task_name
+      "clobber_#{name}"
+    end
+
+    def repeat_task_name
+      "re#{name}"
+    end
+
+    def convert?(text_file)
+      IO.readlines(text_file).find { |line| line =~ /# *:nodoc:/ } == nil
+    end
+
+    def to_target_file(file)
+      target_file = File.basename(file)
+      target_file[/\.rb$/] = '.txt'
+      File.join(@target_dir, target_file)
+    end
+
+    def transform(source, dest)
+      input = IO.readlines(source)
+      if source =~ /\.rb$/
+        lines = commentify(input)
+      else
+        lines = source
+      end
+      save(dest, lines)
+    end
+
+    def commentify(input)
+      lines = []
+      input.inject(true) do |add, line|
+        if line =~ /^#--/
+          false
+        elsif line =~ /^#\+\+/
+          true
+        elsif !add
+          false
+        elsif line =~ /^#/
+          lines << line
+          true
+        else
+          lines << "#  #{line}"
+          true
+        end
+      end
+      lines
+    end
+
+    def save(name, lines)
+      folder = File.dirname(name)
+      mkdir_p folder unless File.exist?(folder)
+      File.delete name rescue nil
+      File.open(name, 'w') { |f| f.print lines.join }
+    end
+
+  end
+end

data/examples/check_interface_names.rb

@@ -0,0 +1,44 @@
+# Example usage of classpath and class files: Scan all classes of an workspace.
+# Find all interfaces, print their names and find all which are prefixed with 'I'.
+# Author::          Peter Kofler
+# Copyright::       Copyright (c) 2009, 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')
+
+location = Corpus[:Base]
+package = 'at.kugel'
+#++
+require 'javaclass/dsl/mixin'
+
+# 1) define the location of the project and a package you are interrested
+#  location = 'C:\Eclipse\workspace'
+#  package = 'com.biz.app'
+
+# e.g. add an Eclipse classpath variable to find external dependencies.
+Eclipse.add_variable('KOR_HOME', location)
+
+# 2) create the classpath of the given workspace
+cp = workspace(location)
+puts "#{cp.elements.size} classpaths found under the workspace #{location}:"
+puts "  #{cp.elements.join("\n  ")}"
+puts "#{cp.count} classes found on classpath"
+
+# 3) filter the classes to analyse, using JavaClass::JavaQualifiedName methods
+to_analyse = cp.names { |classname| classname.same_or_subpackage_of?(package) }
+puts "#{to_analyse.size} classes matched #{package}"
+
+# 4) load all selected classes, parse into JavaClass::ClassFile, find all interfaces and collect their qualified names
+names = cp.values(to_analyse).
+           find_all { |clazz| clazz.interface? }.
+           collect { |clazz| clazz.to_classname }
+puts "#{names.size} interfaces found:\n  #{names.sort.join("\n  ")}"
+
+# 5) print all qualified names have a simple namee staring with an I
+inames = names.find_all { |classname| classname.simple_name =~ /^I[A-Z][a-z]/ }
+puts "#{inames.size} interfaces start with I:\n  #{inames.join("\n  ")}"

data/examples/corpus.rb

@@ -0,0 +1,19 @@
+# :nodoc:
+# 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])] 
+  }.flatten
+]
+Corpus[:Base] = 'E:\Develop\Java'
+Corpus[:Lib] = 'E:\Develop\Java\CodeLib'

data/examples/count_classes_in_modules.rb

@@ -0,0 +1,38 @@
+# Example usage of classpath (JavaClass::Classpath): Scan all classpaths (e.g. modules)
+# of an an Eclipse "workspace". A workspace is a folder containing several Eclipse
+# projects, e.g. JavaClass::Classpath::EclipseClasspath. Report the number of found
+# classes per module.
+# Author::          Peter Kofler
+# Copyright::       Copyright (c) 2009, 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')
+
+location = Corpus[:HBD]
+#++
+require 'javaclass/classpath/factory'
+include JavaClass::Classpath::Factory
+# The require/include above just imports what is needed, but usually one would require the whole 
+# JavaClass::Dsl::Mixin for conveniance, e.g. require 'javaclass/dsl/mixin'. 
+
+# 1) define the location of the project
+#  location = 'C:\Eclipse\workspace'
+
+# 2) create a JavaClass::Classpath::CompositeClasspath of the complete workspace, which will contain many classpath elements.
+cp = workspace(location)
+puts "#{cp.elements.size} classpaths found under the workspace #{location}"
+
+# 3a) find all empty elements by querying the classpath elements
+empty = cp.elements.find_all { |clp| clp.count == 0 }
+puts "\n#{empty.size} empty modules found:\n  #{empty.join("\n  ")}"
+
+# 3b) or print the list of each element with its class count
+puts "library (module path): number of contained classes"
+puts cp.elements.map { |clp| [clp.to_s, clp.count] }.
+                 sort { |a,b| a[1] <=> b[1] }.
+                 map { |e| "  #{e[0]}: #{e[1]}" }

data/examples/cumulative_dependencies.rb

@@ -0,0 +1,39 @@
+# Example usage of the featuress of JavaClass::Analyse::TransitiveDependencies
+# to collect all transitive dependencies of a certain class or a whole package
+# (Cumulative Component Dependencies).
+# Author::          Peter Kofler
+# Copyright::       Copyright (c) 2009, Peter Kofler.       
+# License::         {BSD License}[link:/files/license_txt.html]
+# See::             Another example how to {list all imported types}[link:/files/lib/generated/examples/find_all_imported_types_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')
+
+location = Corpus[:HBD]
+package = 'at.herold'
+start_class = 'at.herold.waf.hbd.servlet.HBDServlet'
+# 'at/spardat/krimiaps/service/client/service/impl/ClientSmeSearchServiceImpl'
+# 'at/spardat/krimiaps/service/client/service/impl/ClientPrivateSearchServiceImpl'
+#++
+require 'javaclass/dsl/mixin'
+
+# 1) create the classpath of the given workspace
+cp = workspace(location)
+puts "#{cp.count} classes found on classpath"
+
+# define a filter to limit all operations to the classes we are interested in
+filter = Proc.new { |classname| classname.same_or_subpackage_of?(package) }
+
+# 2a) collect all transitive dependencies of a single class into an AdderTree 
+dependencies = cp.transitive_dependency_tree(start_class.to_javaname, &filter)
+puts "#{dependencies.size} classes in transitive dependency graph of class #{start_class}"
+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"
+#  dependencies.debug_print