javaclass 0.0.4 → 0.4.1

data/Rakefile

@@ -6,8 +6,7 @@ require 'rake'
 require 'rake/clean' # for clean/clobber
 require 'rake/testtask'
 require 'rake/packagetask'
-require 'rake/rdoctask'
-require 'example_task'
+require File.dirname(__FILE__) + '/dev/example_task'
 
 # Test, package and publish functions.
 # Author::           Peter Kofler
@@ -103,48 +102,8 @@ task :release_rubygems => :package do
   Gem::GemRunner.new.run ['push', "pkg/#{full_gem_name}.gem"]
 end
 
-# Read username and password from the <code>~/.hgrc</code> for _authname_ prefix.
-# <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=]+$/]
-  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]
-end
-
-# Download the <code>googlecode_upload.py</code> from Google Code repository and save it as _name_ .
-# See:: http://support.googlecode.com/svn/trunk/scripts/googlecode_upload.py
-def download_googlecode_upload_py(name)
-  Net::HTTP.start('support.googlecode.com', 80) do |http|
-    body = http.get("/svn/trunk/scripts/#{name}").body
-    File.open(name, 'w') { |f| f.print body }
-  end
-end
-
-# Helper method to execute Python with the _params_ array.
-# The +python+ executable must be in the path.
-def python(params)
-  puts `python #{params.join(' ')}`
-end
-
-# internal - desc 'Release the gem to Google Code'
-task :release_googlecode => :package do
-  puts "Releasing #{full_gem_name} to GoogleCode"
-  user, pass = user_pass_from_hgrc(gemspec.name)
-  # See:: http://code.google.com/p/support/wiki/ScriptedUploads
-  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}"]
-  end
-end
-
-desc 'Package and upload gem to Rubygems and Google Code'
-task :publish_gem => [:clobber_package, :example, :package, :release_rubygems, :release_googlecode]
+desc 'Package and upload gem to Rubygems'
+task :publish_gem => [:clobber_package, :example, :package, :release_rubygems]
 
 # :example, :clobber_example, :reexample
 example_task_lib = Rake::ExampleTask.new do |example|
@@ -154,17 +113,25 @@ task :clobber_rdoc => [:clobber_example]
 task :rdoc => [:example]
 task :package => [:example]
 
+begin
+  require 'rdoc/task'
+  SomeRDocTask = RDoc::Task
+rescue LoadError
+  require 'rake/rdoctask'
+  SomeRDocTask = Rake::RDocTask
+end
+
 # :rdoc, :clobber_rdoc, :rerdoc
-Rake::RDocTask.new do |rdoc|
+SomeRDocTask.new do |rdoc|
   rdoc.rdoc_dir = RDOC_DIR # 'html' is default anyway
   rdoc.title = "#{full_gem_name} Documentation"
   rdoc.main = 'Readme.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
+
+  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.
@@ -196,10 +163,10 @@ def add_frameset_version(file, dir)
   File.open(file, 'w') { |f| f.print lines.join }
 end
 
-desc 'Publish the RDoc files to Google Code'
+desc 'Publish the RDoc files to repository'
 task :publish_rdoc => [:clobber_rdoc, :fix_rdoc] do
   puts "Releasing #{full_gem_name} to API"
-  remote_repo = "https://code.google.com/p/#{GOOGLE_PROJECT}.#{RDOC_REPO}"
+  remote_repo = "https://bitbucket.org/pkofler/#{HG_PROJECT}.#{RDOC_REPO}/"
   remote_dir = "#{gemspec.version}"
 
   FileUtils.rm_r RDOC_REPO rescue nil
@@ -222,26 +189,6 @@ task :publish_rdoc => [:clobber_rdoc, :fix_rdoc] do
 end
 
 # :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) && File.basename(fn) != /^\./ }.each do |fn|
-    line_count = 0
-    open(fn) do |f|
-      while line = f.gets
-        line_count += 1
-        if line =~ pattern
-          puts "#{fn}:#{line_count}:#{line.strip}"
-        end
-      end
-    end
-  end
-end
-
-desc 'Look for TODO and FIXME tags'
-task :todo do
-  egrep(/#.*(FI[X]ME|TO[D]O|T[B]D|H[A]CK)/i) # use 'odd' brackets to not find myself (and not have Eclipse markers)
-end
+CLOBBER.include(RDOC_REPO, 'ClassLists', 'fullClassList*.txt')
 
 task :default => :test

data/Readme.txt

@@ -1,8 +1,7 @@
 javaclass-rb
 by {Peter 'Code Cop' Kofler}[http://www.code-cop.org/]
 
-* {Homepage (Google Code)}[http://code.google.com/p/javaclass-rb/]
-* {Rubyforge Project (old)}[http://rubyforge.org/projects/javaclass]
+* {Homepage (Bitbucket)}[https://bitbucket.org/pkofler/javaclass-rb]
 * email peter dot kofler at code minus cop dot org
 
 == Description
@@ -20,14 +19,15 @@ Ruby for all kind of stuff, just for fun. When I needed some Java class
 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}[link:/files/history_txt.html] to that end.)
+{started adding methods}[link:/files/history_txt.html] to that end and
+{planned}[link:/files/planned_txt.html] for some common metrics as well.)
 
 == Install
 
   sudo gem install javaclass
 
 * {Gem Hosting}[http://rubygems.org/gems/javaclass]
-* {Download of tarballs and gems}[http://code.google.com/p/javaclass-rb/downloads/list]
+* {Download of tarballs and gems}[https://bitbucket.org/pkofler/javaclass-rb/downloads]
 
 == Documentation
 
@@ -36,9 +36,9 @@ available in Object through the JavaClass::Dsl::Mixin. The main class or the par
 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]
+* {API RDoc}[http://www.code-cop.org/api/javaclass-rb/]
 
-I tried hard to rdoc all classes and public methods, so just {read it}[http://api.javaclass-rb.googlecode.com/hg/index.html].
+I tried hard to rdoc all classes and public methods, so just {read it}[http://www.code-cop.org/api/javaclass-rb/].
 
 == Usage
 
@@ -51,30 +51,20 @@ See the various examples in the examples folder of the gem.
 * {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]
+* {Extract and chart dependencies between classes}[link:/files/lib/generated/examples/chart_class_dependencies_txt.html]
+* {Extract and chart dependency info between modules}[link:/files/lib/generated/examples/chart_module_dependencies_txt.html]
 * {Generate lists of JDK classes}[link:/files/lib/generated/examples/generate_class_lists_txt.html]
+* {List content of a (Maven) JAR}[link:/files/lib/generated/examples/show_jar_api_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 {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 (runs with 1.8.7 and 1.9.1, too)
-* {rubyzip}[http://rubyzip.sourceforge.net/] 0.9.1
+* Ruby 1.8.7 (also tested under 1.9.3, 2.0.0 and 2.1.6)
+* {rubyzip}[https://github.com/rubyzip/rubyzip] 0.9.1 (also tested with 0.9.6.1, 0.9.9, 1.0.0 and 1.1.7)
+* Originally Ruby 1.8.6 with rubyzip 0.9.1
 
 == References
 
@@ -84,4 +74,5 @@ The trunk repository is available with
 
 == License
 
+Typically the licenses listed for the project are that of the project itself, and not of dependencies.
 * {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 → dev/example_task.rb}

@@ -104,8 +104,8 @@ module Rake
     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)
+        puts "generated #{example_target}"
       end
     end
         

data/dev/saikuro_task.rb

@@ -0,0 +1,120 @@
+require 'rake'
+require 'rake/tasklib'
+require 'saikuro'
+
+module Rake
+
+  # Create a task that will generate the Saikuro complexity report for a project.
+  # See http://saikuro.rubyforge.org/
+  #
+  # The SaikuroTask will create the following targets:
+  #
+  # [<b>:<em>complexity</em></b>]
+  #   Main task for this Saikuro task.
+  #
+  # [<b>:clobber_<em>complexity</em></b>]
+  #   Delete all the Saikuro report files.  This target is automatically added to the main clobber target.
+  #
+  # Simple Saikuro:
+  #
+  #   Rake::SaikuroTask.new do |rd|
+  #     rd.output_dir = 'html'
+  #     rd.files.include('lib/**/*.rb')
+  #   end
+  #
+  # The +rd+ object passed to the block is an SaikuroTask object. See the
+  # attributes list for the SaikuroTask class for available customization options.
+  #
+  # Author::          Peter Kofler
+  # Copyright::       Copyright (c) 2009, Peter Kofler.
+  # License::         {BSD License}[link:/files/license_txt.html]
+  #
+  class SaikuroTask < TaskLib
+    include Saikuro::ResultIndexGenerator
+
+    # Name of the main, top level task. (default is :complexity)
+    attr_accessor :name
+
+    # Name of directory to receive the Saikuro output files. (default is 'complexity')
+    attr_accessor :output_dir
+
+    # List of files to be included in the saikuro report. (default is [])
+    attr_accessor :files
+
+    # Create the Saikuro tasks with the given base _name_ .
+    def initialize(name = :complexity)  # :yield: self
+      @name = name
+      @files = Rake::FileList.new
+      @output_dir = 'complexity'
+      @cyclo = true
+      @token = false
+
+      yield self if block_given?
+
+      define_tasks
+    end
+
+    private
+
+    # Create the tasks defined by this task lib.
+    def define_tasks
+      define_clobber_task
+      define_build_task
+    end
+
+    def define_clobber_task
+      desc 'Remove Saikuro products'
+      task clobber_task_name do
+        rm_r @output_dir rescue nil
+      end
+
+      task :clobber => [clobber_task_name]
+    end
+
+    def define_build_task
+      desc "Generate #{build_task_name} report with Saikuro"
+      task build_task_name => [clobber_task_name] do
+        directory @output_dir
+        create_report
+      end
+    end
+
+    def build_task_name
+      name.to_s
+    end
+
+    def clobber_task_name
+      "clobber_#{name}"
+    end
+
+    def create_report
+      if @cyclo
+        # state_filter = Filter.new(0) use threshold 0 for reporting Measure compatible counts
+        state_filter = Filter.new(5)
+        state_formater = Saikuro::StateHTMLComplexityFormater.new(STDOUT, state_filter)
+      else
+        state_formater = nil
+      end
+
+      if @token
+        token_filter = Filter.new(10, 25, 50)
+        token_count_formater = Saikuro::HTMLTokenCounterFormater.new(STDOUT, token_filter)
+      else
+        token_count_formater = nil
+      end
+
+      # ignore DEBUG log in Saikuro
+      verbosity = $VERBOSE
+      $VERBOSE = nil
+      begin
+        idx_states, idx_tokens = Saikuro.analyze(@files, state_formater, token_count_formater, @output_dir)
+      ensure
+        $VERBOSE = verbosity
+      end
+
+      write_cyclo_index(idx_states, @output_dir)
+      write_token_index(idx_tokens, @output_dir)
+    end
+
+  end
+end

data/examples/chart_class_dependencies.rb

@@ -0,0 +1,43 @@
+# Example usage of JavaClass::Dependencies::Graph: Iterate all classes of a 
+# classpath and construct the Java dependency graph.
+# 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')
+
+corpus = Corpus[:WF]
+location = corpus.classes
+#++
+require 'javaclass/dsl/mixin'
+require 'javaclass/dependencies/graph'
+require 'javaclass/dependencies/class_node'
+require 'javaclass/dependencies/yaml_serializer'
+require 'javaclass/dependencies/graphml_serializer'
+
+# 1) create the classpath of a given location
+cp = classpath(location)
+
+dependencies = JavaClass::Dependencies::Graph.new
+
+# 2) iterate all classes of the classpath
+cp.values.each do |clazz|
+  next unless clazz.access_flags.public?
+
+# 3) add a JavaClass::Dependencies::ClassNode for each class to the graph 
+  dependencies.add(JavaClass::Dependencies::ClassNode.new(clazz))
+end
+
+# 4) resolve all dependencies of all nodes in the graph. Now each class (Node) has a dependency to
+# all imported classes (Nodes).
+dependencies.resolve_dependencies
+puts "#{dependencies.to_a.size} classes loaded" 
+
+# 5) save the result in various formats, e.g. GraphML or YAML, skipping outgoing edges information
+JavaClass::Dependencies::GraphmlSerializer.new(:edges => :no_text).save('class_dependencies', dependencies)
+JavaClass::Dependencies::YamlSerializer.new(:outgoing => :none).save('class_dependencies', dependencies)

data/examples/chart_module_dependencies.rb

@@ -0,0 +1,64 @@
+# Example usage of JavaClass::Dependencies::Graph: Iterate all folders of a root folder.
+# Load each component separately and construct the dependency graph.
+# 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[:RCP].location
+
+def relatedPlugin?(name)
+  name == 'com.some.pricing' ||
+  name == 'org.eclipse.update.scheduler' || # all other org.eclipse, nebula and zentest are in 1st level
+  name =~ /^com\.some\./ && !(
+    name =~ /gpe\.persistence$/ || # looks like duplicate of rocketdb
+    name =~ /\.test$|\.testing$|\.mock$|\.test\.perfmon$/ || # test
+    name =~ /\.build/ || # build
+    name =~ /rocketDBtools$/ # tools
+  )
+end
+#++
+require 'javaclass/dsl/mixin'
+require 'javaclass/dependencies/graph'
+require 'javaclass/dependencies/classpath_node'
+require 'javaclass/dependencies/yaml_serializer'
+require 'javaclass/dependencies/graphml_serializer'
+
+# 1) define the location of the plugins
+#  location = 'C:\Eclipse\workspace'
+
+plugins = JavaClass::Dependencies::Graph.new
+
+# 2) iterate all plugins of a workspace location
+Dir.new(location).each do |folder|
+#--
+  next unless relatedPlugin?(folder)
+#++
+  path = File.join(location, folder)
+  next unless FileTest.directory? path
+
+  classes = File.join(path, 'bin')
+  next unless FileTest.exist?(classes)
+
+# 3) create a classpath for each plugin
+  cp = classpath(classes)
+  next if cp.count == 0
+
+# 4) add a JavaClass::Dependencies::Node for that plugin to the graph 
+  plugins.add(JavaClass::Dependencies::ClasspathNode.new(folder, cp))
+end
+
+# 5) resolve all dependencies of all nodes in the graph
+plugins.resolve_dependencies
+puts "#{plugins.to_a.size} plugins loaded" 
+
+# 6) save the result in various formats, e.g. GraphML or YAML
+JavaClass::Dependencies::GraphmlSerializer.new.save('plugin_dependencies', plugins)
+JavaClass::Dependencies::YamlSerializer.new.save('plugin_dependencies', plugins)
+JavaClass::Dependencies::YamlSerializer.new(:outgoing => :summary).save('plugin_dependencies_summary', plugins)