javaclass 0.0.4 → 0.4.1

data/examples/test_corpus.rb

@@ -0,0 +1,32 @@
+# :nodoc:
+
+require 'test/unit'
+require 'test/unit/testcase'
+require File.join(File.dirname(__FILE__), '..', 'examples', 'corpus')
+
+class TestCorpus < Test::Unit::TestCase
+
+  def test_regular_corpus
+    c = Corpus[:HBD]
+    assert_equal('E:\OfficeDateien\Corpus/Java6_Web(HBD_Online)', c.location)
+    assert_equal('E:\OfficeDateien\Corpus/Java6_Web(HBD_Online)/classes.zip', c.classes)
+    assert_equal('E:\OfficeDateien\Corpus/Java6_Web(HBD_Online)/test-classes.zip', c.testClasses)
+    assert_equal(['at.herold'], c.packages)
+    assert_equal('at.herold', c.package)
+  end
+
+  def test_regular_corpus_without_tests
+    c = Corpus[:WF]
+    assert_equal('E:\OfficeDateien\Corpus/Java2_Swing(WF_iMagine)', c.location)
+    assert_equal('E:\OfficeDateien\Corpus/Java2_Swing(WF_iMagine)/classes.zip', c.classes)
+    assert_nil(c.testClasses)
+    assert_equal(['at.workforce'], c.packages)
+  end
+
+  def test_regular_corpus_without_packages
+    c = Corpus[:Harmony15]
+    assert_equal([], c.packages)
+  end
+
+end
+

data/history.txt

@@ -1,4 +1,16 @@
-=== 0.0.4 19/12/2011
+=== 0.4.1 30/05/2015
+
+* make compatible with Ruby 2.0
+* upgrade rubyzip to 1.x (still supports 0.x as well)
+* moved code to Bitbucket, moved API doc to code-cop.org
+* Cloudbees dropped support for Ruby 1.8.6 and 1.8.7 - not testet there anymore
+* add plain class Node for dependency graph
+* add dependency graph and classpath (module/component/plugin) implementation
+* add Maven artefact to generate classpath from group/name/version
+* change version number from micro to minor which more proper reflects code
+* fix some warnings shown by Ruby 1.9.1
+
+=== 0.4 named "0.0.4" 19/12/2011
 
 * convert examples to RDOC using example_task
 * added transitive dependency trees from references
@@ -14,13 +26,13 @@
 * added usage of system 7za/unzip (if available) which unpack much faster
 * added option to unpack JARs for faster access later
 * added support for Java Enum and Annotations
-* added DSL like shortcuts for java.* and javax.* package and class names.
+* added DSL like shortcuts for java.* and javax.* package and class names
 * added interfaces implemented by the class
 * fixed string ux problem in Ruby 1.9
 * replaced leading 0 in exponent of float/double because of Linux printf
 * split Gemspec from Rakefile as proposed by Yeguda Katz
 
-=== 0.0.3 02/10/2010
+=== 0.3 named "0.0.3" 02/10/2010
 
 * integrated ClassList from another project as first analyser
 * added abstraction of Java names to all class names that are returned
@@ -31,14 +43,14 @@
 * added references to used classes
 * added classpath abstraction
 
-=== 0.0.2 08/04/2009
+=== 0.2 named "0.0.2" 08/04/2009
 
 * refactored code to smaller objects for version and constant pool
 * fixed float and double constant pool items
 * added tests
 * added implementation with class name and references of a class file
 
-=== 0.0.1 01/03/2009
+=== 0.1 named "0.0.1" 01/03/2009
 
 * extracted initial version of javaclass-rb from ClassList project
 * reads the class version and package/public flag of a class

data/javaclass.gemspec

@@ -1,27 +1,28 @@
 GEM_NAME = 'javaclass'
-GOOGLE_PROJECT = "#{GEM_NAME}-rb"
+HG_PROJECT = "#{GEM_NAME}-rb"
 
 Gem::Specification.new do |s|
-  s.version = '0.0.4'
+  s.version = '0.4.1'
   s.name = GEM_NAME
   s.rubyforge_project = 'javaclass' # old, just redirects
-  s.summary = 'A parser and disassembler for Java class files'
+  s.summary = 'Java class files parser and disassembler for Ruby'
   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.license = 'BSD'
-  s.homepage = "http://code.google.com/p/#{GOOGLE_PROJECT}/"
+  s.homepage = "https://bitbucket.org/pkofler/#{HG_PROJECT}"
   s.author = 'Peter Kofler'
   s.email = 'peter dot kofler at code minus cop dot org'
-  s.date = Time::gm(2011, 12, 19)
+  s.date = Time::gm(2015, 5, 30) # set current date for release
 
-  s.files = Dir.glob('*.txt') + Dir.glob('{lib,test,examples}/**/*') + ['javaclass.gemspec', 'Rakefile', 'example_task.rb']
+  s.files = Dir.glob('*.txt') + Dir.glob('{lib,test,examples}/**/*') + ['javaclass.gemspec', 'Rakefile'] + Dir.glob('rake_*.rb') + Dir.glob('dev/*_task.rb')
   s.test_files = Dir.glob('test/**/test_*.rb')
   s.require_path = 'lib'
   s.add_dependency('rubyzip', '>= 0.9.1')
   s.required_ruby_version = '>= 1.8.6'
   s.required_rubygems_version = nil if s.respond_to? :required_rubygems_version=
   s.platform = Gem::Platform::RUBY
-  s.add_development_dependency('rake', '>= 0.8.4')
-  s.add_development_dependency('rcov', '>= 0.8.1.2')
+  s.add_development_dependency('rake', '>= 0.8.3')
+  # s.add_development_dependency('rcov', '>= 0.8.1.2')
+  # s.add_development_dependency('saikuro', '>= 1.2.1')
   # s.add_development_dependency('ZenTest', '>= 4.4.0')
 
   s.has_rdoc = true

data/lib/javaclass/analyse/dependencies.rb

@@ -1,7 +1,7 @@
 module JavaClass
 
   # The module Analyse is for separating namespaces. It contains various methods
-  # to analyse classes accross a whole whole code bases (Classpath). The functionality
+  # to analyse classes accross a whole code bases (Classpath). The functionality
   # of all analysers is collected in Dsl::ClasspathAnalysers.
   # Author::          Peter Kofler
   module Analyse

data/lib/javaclass/analyse/transitive_dependencies.rb

@@ -24,8 +24,8 @@ module JavaClass
         end
 
         if includes?(classname)
-          load(classname).imported_3rd_party_types.each do |classname|
-            transitive_dependency_tree(classname, tree, &filter)
+          load(classname).imported_3rd_party_types.each do |type|
+            transitive_dependency_tree(type, tree, &filter)
           end
         end
         

data/lib/javaclass/classfile/class_magic.rb

@@ -16,7 +16,7 @@ module JavaClass
 
       # Return +true+ if the data was valid, i.e. if the class started with +CAFEBABE+.
       def valid?
-        @bytes == CAFE_BABE
+        @bytes.same_bytes_as?(CAFE_BABE)
       end
 
       # Return the value of the magic in this class.

data/lib/javaclass/classfile/constant_pool.rb

@@ -25,6 +25,7 @@ module JavaClass
         NAME_AND_TYPE_TAG = 12 => Constants::ConstantNameAndType,
         ASCIZ_TAG     = 1 => Constants::ConstantAsciz,
       }
+      # TODO Java7/Java8 JDK, implement 3 new tags, see https://docs.oracle.com/javase/specs/jvms/se7/html/jvms-4.html#jvms-4.4
 
       # Size of the whole constant pool in bytes.
       attr_reader :size

data/lib/javaclass/classfile/java_class_header_as_java_name.rb

@@ -27,6 +27,10 @@ module JavaClass
       delegate :split_simple_name, :this_class
       delegate :in_jdk?, :this_class
 
+      def to_s
+        to_classname
+      end
+      
     end
 
   end

data/lib/javaclass/classfile/java_class_header_shortcuts.rb

@@ -15,5 +15,7 @@ module JavaClass
 
     end
 
+    # TODO add tests for this
+    
   end
 end

data/lib/javaclass/classlist/jar_searcher.rb

@@ -62,16 +62,22 @@ module JavaClass
       # _list_ must provide a <code>add_class(entry, is_public, version)</code> method.
       def compile_list(version, path, list)
         cpe = Classpath::AnyClasspath.new(path)
-        filter_classes(cpe.names).each do |entry|
-          is_public = public?(cpe, entry)
+        add_list_from_classpath(version, cpe, list)
+        list
+      end
+
+      # Compile the class list for the given _classpath_ . This searches the _path_ for zips and JARs
+      # and adds them to the given _list_ of found classes. _version_ is a number >= 0, e.g. 2 for JDK 1.2.
+      # _list_ must provide a <code>add_class(entry, is_public, version)</code> method.
+      def add_list_from_classpath(version, classpath, list)
+        filter_classes(classpath.names).each do |entry|
+          is_public = public?(classpath, entry)
           next if @skip_package_classes && !is_public
           list.add_class(entry, is_public, version) if list
           yield(entry, is_public, version) if block_given?
         end
-
-        list
       end
-
+      
     end
 
   end

data/lib/javaclass/classlist/list.rb

@@ -36,20 +36,7 @@ module JavaClass
           is_public = (versions !~ /p/)
           versions = versions.gsub(/p/, '')
 
-          # \d, \d-\d, only \d, -\d, oder leer
-          if versions =~ /^(\d)$/
-            first_vers = $1.to_i
-          elsif versions =~ /^(\d)-(\d)$/
-            first_vers = $1.to_i
-            last_vers = $2.to_i
-          elsif versions =~ /^(?:bis\s|-)(\d)$/
-            last_vers = $1.to_i
-          elsif versions =~ /^only (\d)$/
-            first_vers = $1.to_i
-            last_vers = $1.to_i
-          else
-            raise "can't match version number #{versions} in line #{line.chomp}" unless versions == ''
-          end
+          first_vers, last_vers = *split_version(versions, first_vers, last_vers)
         end
 
         first_vers.upto(last_vers) do |v|
@@ -59,6 +46,32 @@ module JavaClass
         raise "#{$!} in line #{line.chomp}: class_name=#{class_name}, versions=#{versions}, first_vers=#{first_vers}, last_vers=#{last_vers}, is_public=#{is_public}"
       end
 
+      private
+
+      # Split _versions_ String which is \d, \d-\d, only \d, -\d, or empty.
+      def split_version(versions, prior_first_vers, prior_last_vers)
+        if versions =~ /^(\d)$/
+          first_vers = $1.to_i
+          [first_vers, prior_last_vers]
+        elsif versions =~ /^(\d)-(\d)$/
+          first_vers = $1.to_i
+          last_vers = $2.to_i
+          [first_vers, last_vers]
+        elsif versions =~ /^(?:bis\s|-)(\d)$/
+          last_vers = $1.to_i
+          [prior_first_vers, last_vers]
+        elsif versions =~ /^only (\d)$/
+          first_vers = $1.to_i
+          last_vers = $1.to_i
+          [first_vers, last_vers]
+        else
+          raise "can't match version number #{versions}" unless versions == ''
+          [prior_first_vers, prior_last_vers]
+        end
+      end
+      
+      public
+      
       def packages
         @packages.values.sort
       end

data/lib/javaclass/classpath/any_classpath.rb

@@ -29,7 +29,7 @@ module JavaClass
         begin
           Dir.chdir File.expand_path(path)
 
-          Dir['*'].collect do |name|
+          Dir['*'].sort.collect do |name|
             if FileTest.directory?(name)
               find_jars(name)
             elsif name =~ /\.jar$|\.zip$/

data/lib/javaclass/classpath/eclipse_classpath.rb

@@ -31,41 +31,61 @@ module JavaClass
         unless EclipseClasspath::valid_location?(folder)
           raise IOError, "folder #{folder} not an Eclipse project"
         end
-        dot_classpath = File.join(folder, DOT_CLASSPATH)
+        @folder = folder
+        dot_classpath = File.join(@folder, DOT_CLASSPATH)
         super(dot_classpath)
-        classpath = IO.readlines(dot_classpath)
         
-        classpath.find_all { |line| line =~ /kind\s*=\s*"output"/ }.each do |line|
+        add_entries_from(dot_classpath)
+      end
+      
+      private
+      
+      def add_entries_from(dot_classpath)
+        dot_classpath_lines = IO.readlines(dot_classpath)
+        
+        add_output_folder(dot_classpath_lines)
+        add_source_output_folder(dot_classpath_lines)
+        
+        @@skip_lib ||= false
+        unless @@skip_lib
+          add_local_libraries(dot_classpath_lines)
+
+          @@variables ||= Hash.new
+          add_variables(dot_classpath_lines)
+        end
+      end
+      
+      def add_output_folder(dot_classpath_lines)
+        dot_classpath_lines.find_all { |line| line =~ /kind\s*=\s*"output"/ }.each do |line|
           if line =~ /path\s*=\s*"([^"]+)"/
-            add_file_name(File.join(folder, $1))
+            add_file_name(File.join(@folder, $1))
           end
         end
-
-        classpath.find_all { |line| line =~ /output\s*=\s*"/ }.each do |line|
+      end
+      
+      def add_source_output_folder(dot_classpath_lines)
+        dot_classpath_lines.find_all { |line| line =~ /output\s*=\s*"/ }.each do |line|
           if line =~ /output\s*=\s*"([^"]+)"/
-            add_file_name(File.join(folder, $1))
+            add_file_name(File.join(@folder, $1))
           end
         end
-        
-        @@skip_lib ||= false
-        unless @@skip_lib
-        
-          classpath.find_all { |line| line =~ /kind\s*=\s*"lib"/ }.each do |line|
-            if line =~ /path\s*=\s*"([^"]+)"/
-              add_file_name(File.join(folder, $1))
-            end
-          end 
-          
-          @@variables ||= Hash.new
-          classpath.find_all { |line| line =~ /kind\s*=\s*"var"/ }.each do |line|
-            if line =~ /path\s*=\s*"([^\/]+)\/([^"]+)"/
-              path = @@variables[$1]
-              add_file_name(File.join(path, $2)) if path
-            end
+      end
+
+      def add_local_libraries(dot_classpath_lines)
+        dot_classpath_lines.find_all { |line| line =~ /kind\s*=\s*"lib"/ }.each do |line|
+          if line =~ /path\s*=\s*"([^"]+)"/
+            add_file_name(File.join(@folder, $1))
+          end
+        end 
+      end
+            
+      def add_variables(dot_classpath_lines)
+        dot_classpath_lines.find_all { |line| line =~ /kind\s*=\s*"var"/ }.each do |line|
+          if line =~ /path\s*=\s*"([^\/]+)\/([^"]+)"/
+            path = @@variables[$1]
+            add_file_name(File.join(path, $2)) if path
           end
-          
         end
-      
       end
 
     end

data/lib/javaclass/classpath/factory.rb

@@ -36,7 +36,8 @@ module JavaClass
       
       # Create a classpath from a workspace _basepath_ which contains Eclipse or Maven projects.
       def workspace(basepath, cp=CompositeClasspath.new)
-        # check for a valid project in this folder
+
+        # check for a valid project in this basepath
         Classpath_types.each do |classpath_type|
           if classpath_type.valid_location?(basepath)
             cp.add_element(classpath_type.new(basepath))
@@ -44,21 +45,30 @@ module JavaClass
           end
         end
 
-        # check the children as regular workspace
-        Dir.entries(basepath).each do |entry|
-          next if entry == '.' || entry == '..'
-          file = File.join(basepath, entry)
-
-          Classpath_types.each do |classpath_type|
-            if classpath_type.valid_location?(file)
-              cp.add_element(classpath_type.new(file))
-              break
+        root_folder(basepath, cp)
+      end
+      
+      # Create a classpath from a project root directory _basepath_ by looking in the children folder for regular workspaces.
+      def root_folder(basepath, cp=CompositeClasspath.new)
+        if FileTest.directory? basepath
+        
+          Dir.entries(basepath).each do |entry|
+            next if entry == '.' || entry == '..'
+            file = File.join(basepath, entry)
+  
+            Classpath_types.each do |classpath_type|
+              if classpath_type.valid_location?(file)
+                cp.add_element(classpath_type.new(file))
+                break
+              end
             end
           end
-        end if FileTest.directory? basepath
-        cp
+        
+        end
+        
+        cp 
       end
-      
+
     end
     
   end

data/lib/javaclass/classpath/maven_artefact.rb

@@ -0,0 +1,62 @@
+require 'javaclass/classpath/composite_classpath'
+
+module JavaClass
+  module Classpath
+
+    # A reference to a Maven artefact. This is a group/artefact/version tuple that points to a single Jar in the Maven repository.
+    # Author::   Peter Kofler
+    class MavenArtefact
+
+      attr_reader :group, :name, :version, :title
+
+      # Create a Maven artefact with given _group_ , _name_ and _version_ .
+      def initialize(group, name, version, title=nil)
+        @group = group
+        @name = name
+        @version = version
+        @title = title || make_title
+      end
+
+      # Kind of hack function to call Maven to download the current artefact if it does not exist.      
+      def download_if_needed
+        unless File.exist? repository_path
+          puts `#{download_command}`
+        end
+      end
+
+      # Return this Maven artefact's JavaClass::Classpath. This is a single Jar in the Maven repository.
+      def classpath
+        cp = CompositeClasspath.new(basename)
+        cp.add_file_name(repository_path)
+        cp
+      end
+
+      # Return the Jar's file path of this artefact inside ~/.m2/repository
+      def repository_path
+        File.join(ENV['HOME'], '.m2', 'repository', @group.gsub(/\./, '/'),  @name, @version, "#{basename}.jar" )
+      end
+
+      private
+      
+      def make_title
+        @name.sub(/\d$/, '').split(/[\s-]/).map { |p|
+          if p.size < 4
+            p.upcase
+          else
+            p.capitalize
+          end 
+        }.join(' ')
+      end
+
+      def basename
+        "#{@name}-#{@version}"
+      end
+
+      def download_command
+        "mvn org.apache.maven.plugins:maven-dependency-plugin:2.5:get -Dartifact=#{@group}:#{@name}:#{@version}"
+      end
+
+    end
+
+  end
+end