javaclass 0.0.4 → 0.4.1

data/lib/javaclass/dsl/java_name_factory.rb

@@ -20,7 +20,7 @@ module JavaClass
     # 
     module JavaNameFactory
 
-      alias :__top_level_method_missing__ :method_missing # :nodoc:
+      alias :__top_level_method_missing__ :method_missing unless method_defined?('__top_level_method_missing__') # :nodoc:
       
       # Convert the beginning of a full qualified Java classname starting with 'java' to a JavaQualifiedName instance.
       def java
@@ -52,7 +52,7 @@ module JavaClass
           @context = fail
         end
 
-        alias :__unused_method_missing__ :method_missing
+        alias :__unused_method_missing__ :method_missing unless method_defined?('__unused_method_missing__')
 
         def method_missing(method_id, *args)
           str = method_id.id2name

data/lib/javaclass/gems/zip_file.rb

@@ -1,4 +1,7 @@
-require 'zip/zipfilesystem'
+begin
+  # 0.x name
+  require 'zip/zipfilesystem'
+  FILESYSTEM = Zip::ZipFile
 
 # Patch the zip for invalid Linux file system flags found in some JARs.
 module Zip # :nodoc:all
@@ -58,47 +61,53 @@ module Zip # :nodoc:all
       end
 
       case @fstype
-        when FSTYPE_UNIX
-          @unix_perms = (@externalFileAttributes >> 16) & 07777
-  
-          case (@externalFileAttributes >> 28)
-          when 04
-            @ftype = :directory
-          when 010
-            @ftype = :file
-          when 012
-            @ftype = :link
-          else
-            # raise ZipInternalError, "unknown file type #{'0%o' % (@externalFileAttributes >> 28)}"
-            
-            # PKZIP format see http://www.pkware.com/documents/APPNOTE/APPNOTE-6.3.0.TXT
-            # external file attributes: (4 bytes)
-            # The mapping of the external attributes is host-system dependent (see 'version made by').
-            # For MS-DOS, the low order byte is the MS-DOS directory attribute byte. If input came 
-            # from standard input, this field is set to zero.
-            # for the meaning of these flags see http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute
-
-            # unknown flag, fall back to name detection
-            if name_is_directory?
-              @ftype = :directory
-            else
-              @ftype = :file
-            end
-            
-          end
-          
+      when FSTYPE_UNIX
+        @unix_perms = (@externalFileAttributes >> 16) & 07777
+
+        case (@externalFileAttributes >> 28)
+        when 04
+          @ftype = :directory
+        when 010
+          @ftype = :file
+        when 012
+          @ftype = :link
         else
+          # raise ZipInternalError, "unknown file type #{'0%o' % (@externalFileAttributes >> 28)}"
+          
+          # PKZIP format see http://www.pkware.com/documents/APPNOTE/APPNOTE-6.3.0.TXT
+          # external file attributes: (4 bytes)
+          # The mapping of the external attributes is host-system dependent (see 'version made by').
+          # For MS-DOS, the low order byte is the MS-DOS directory attribute byte. If input came 
+          # from standard input, this field is set to zero.
+          # for the meaning of these flags see http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute
+
+          # unknown flag, fall back to name detection
           if name_is_directory?
             @ftype = :directory
           else
             @ftype = :file
           end
+          
         end
+        
+      else
+        if name_is_directory?
+          @ftype = :directory
+        else
+          @ftype = :file
+        end
+      end
     end
 
   end
 end
 
+rescue LoadError
+  # 1.x name
+  require 'zip/filesystem'
+  FILESYSTEM = Zip::File
+end
+
 module JavaClass
 
   # Module for wrappers around used gems to avoid direct dependencies to gems.
@@ -116,7 +125,7 @@ module JavaClass
       # Read the _file_ from archive.
       def read(file)
         begin
-          Zip::ZipFile.open(@archive) { |zipfile| zipfile.file.read(file) }
+          FILESYSTEM.open(@archive) { |zipfile| zipfile.file.read(file) }
         rescue
           nil
         end
@@ -124,7 +133,7 @@ module JavaClass
 
       # List the entries of this zip for the block given.
       def entries(&block)
-        Zip::ZipFile.foreach(@archive) do |entry|
+        FILESYSTEM.foreach(@archive) do |entry|
           block.call(ZipEntry.new(entry))
         end
       end
@@ -151,4 +160,3 @@ module JavaClass
 
   end
 end
-

data/lib/javaclass/java_name.rb

@@ -56,7 +56,7 @@ module JavaClass
     # Split the simple name at the camel case boundary _pos_ and return two parts. _pos_ may be < 0 for counting backwards.
     def split_simple_name(pos)
       parts = @simple_name.scan(/([A-Z][^A-Z]+)/).flatten
-      pos = parts.size + pos +1 if pos < 0
+      pos = parts.size + pos + 1 if pos < 0
       return ['', @simple_name] if pos <= 0
       return [@simple_name, ''] if pos >= parts.size
       [parts[0...pos].join, parts[pos..-1].join]

data/lib/javaclass/java_name_scanner.rb

@@ -17,17 +17,17 @@ module JavaClass
   # Author::          Peter Kofler
   module JavaNameScanner
 
-    def scan_config_for_3rd_party_class_names(path)
-      scan_config_for_class_names(path).reject { |name| name.in_jdk? }
+    def scan_config_for_3rd_party_class_names(path, ignorepattern=/^\./)
+      scan_config_for_class_names(path, ignorepattern).reject { |name| name.in_jdk? }
       # need abstraction for - .reject { |name| name.in_jdk? } - have it three times
       # maybe a mixin for enumerables containing JavaTypes
       #JavaNameEnumerable with - .reject { |name| name.in_jdk? } - und anderen? reject_in_jdk = 3rd Party
       # and find_all { |n| n.same_or_subpackage_of?(x) } -- also very often  = in_package()
     end
 
-    # Find all possible class names in all XML and property files under _path_
-    def scan_config_for_class_names(path)
-      return unless File.exist? path
+    # Find all possible class names in all XML and property files under _path_ and optionally ignore _ignorepattern_
+    def scan_config_for_class_names(path, ignorepattern=/^\./)
+      return [] unless File.exist? path
       if File.file?(path) 
         if path =~ /\.xml$|\.properties$|MANIFEST.MF$/
           scan_text_for_class_names(IO.readlines(path).join)
@@ -35,12 +35,14 @@ module JavaClass
           []
         end
       else
-        Dir.entries(path).reject { |n| n=~/^\./ }.map { |n| scan_config_for_class_names(File.join(path, n)) }.flatten.sort
+        Dir.entries(path).reject { |n| n =~ /^\./ or n=~ ignorepattern }.
+                          map { |n| scan_config_for_class_names(File.join(path, n), ignorepattern) }.
+                          flatten.sort
       end
     end
 
     TEXT_REGEX = /
-      (?:^|>|"|'|=|:)
+      (?:^|>|"|'|=|:|!)
       \s*
       (   (?:#{JavaLanguage::IDENTIFIER_REGEX}#{JavaLanguage::SEPARATOR_REGEX})+#{JavaLanguage::TYPE_REGEX}   )
       \s*

data/lib/javaclass/string_20.rb

@@ -0,0 +1,40 @@
+# Compatibility methods to work with Ruby 1.8, 1.9 and 2.0 Strings.
+# Author::          Peter Kofler
+class String
+
+  RUBY19 = ''.respond_to? :codepoints
+
+  # Return the _index_'th element as byte.
+  def byte_at(index=0)
+    if RUBY19
+      self[index..index].unpack('C')[0]
+    else
+      self[index]
+    end
+  end
+
+  def same_bytes_as?(other)
+    if RUBY19
+      self.unpack('C*') == other.unpack('C*')
+    else
+      self == other
+    end
+  end
+
+  def number_bytes
+    if RUBY19
+      self.bytesize
+    else
+      self.length
+    end
+  end
+
+  def strip_non_printable
+    if RUBY19
+      self.unpack('C*').map { |c| if c < 32 or c > 127 then 46 else c end }.pack('C*')
+    else
+      self.gsub(Regexp.new("[^ -\x7f]", nil, 'n'), '.')
+    end
+  end
+  
+end

data/lib/javaclass/string_hexdump.rb

@@ -1,3 +1,5 @@
+require 'javaclass/string_20'
+
 # Add some +hexdump+ helper method to dump the data contained in this String.
 # Author::          Peter Kofler
 class String
@@ -7,9 +9,11 @@ class String
     return StringLineHexdumper.empty(columns).format if size == 0
 
     input = [0, []]
-    output = scan(/[\x00-\xff]{1,#{columns}}/).inject(input) { |result, part|
+    lines = 1..number_hexdump_lines(columns)
+    output = lines.inject(input) { |result, line_index|
       offset, previous_lines = *result
 
+      part = hexdump_line(line_index, columns)
       line = StringLineHexdumper.new(offset, columns, part).format
       
       [ offset + columns, previous_lines + [line] ]
@@ -17,6 +21,18 @@ class String
     offset, lines = *output
     lines.join
   end
+  
+  private
+  
+  def number_hexdump_lines(columns=16)
+    (self.number_bytes + columns - 1) / columns
+  end
+  
+  def hexdump_line(index, columns=16)
+    from = (index-1) * columns
+    to = index * columns - 1
+    self[from..to]
+  end
 
 end
 
@@ -70,7 +86,7 @@ class StringLineHexdumper
   end
 
   def strip_non_printable
-    @data.gsub(/[^ -\x7f]/, '.')
+    @data.strip_non_printable
   end
   
 end

data/lib/javaclass/string_ux.rb

@@ -1,16 +1,12 @@
+require 'javaclass/string_20'
+
 # Add some +unpack+ helper methods for HI-LO byte order (network byte order) contained in this String.
 # Author::          Peter Kofler
 class String
 
-  RUBY19 = ''.respond_to? :codepoints 
-  
   # Return the _index_'th element as byte.
   def u1(index=0)
-    if RUBY19
-      self[index..index].unpack('C')[0]
-    else
-      self[index]
-    end
+    self.byte_at(index)
   end
 
   # Return the _index_'th and the next element as unsigned word.

data/planned.txt

@@ -1,13 +1,59 @@
-=== Planned
+=== Defect
 
-* add collecting of incoming references (mark my interfaces, mark my referenced classes)
-  * can calculate stability
-  * find interfaces with only 1 implementation (smell?)
+* also find as dependency a class inside an annotation. This is likely a String, still could find it
+  @IdClass(ChangeHistoryDetailPK.class)
+  class ...
+
+=== Tools
+
+* find boundaries of my own code, i.e. find leafs of my dependency hull
+  * find all without dependency on my code
+  * find all with one dependency to these
+  * etc.
+
+
+=== Classpath (JavaClass::Classpath)
+
+* WARs and EARs contain JARs and a folder
+
+
+=== Class File Format (JavaClass::ClassFile)
+
+* {understand synthetic class}[http://stackoverflow.com/questions/8540768/when-is-the-jvm-bytecode-access-modifier-flag-0x1000-hex-synthetic-set]
 
 * implement byte code awareness
   * add the byte code sequences to the methods so it can be analysed later (see JVM spec) 
   * scanning of byte code for numbers, which methods loaded, which fields loaded
 
+* see what {similar project by unageanu}[http://github.com/unageanu/javaclass] has to offer ;-)
+
+
+=== Class Analysis, on a single class (JavaClass::ClassScanner)
+
+* count outgoing references (usage) per method, similar to general imported types
+* display graph of fields and methods per class and which methods use/call which (as seen in "Code Blindness")
+
+
+=== Metrics/Analysis across a whole classpath (JavaClass::Analyse)
+
+* add collecting of incoming references (mark my interfaces, mark my referenced classes)
+  * can calculate stability
+  * find interfaces with only 1 implementation (smell?)
+
+* "Greed Detector" = "metric" if all referencing classes of a class is another package, propose moving it there.
+  * count outgoing references (usage) per method 
+  * which signatures are called how often
+  * maybe move current method there?
+
+* {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/]
+
+
+=== Test
+
 * test with a large set of classes
   * use all classes of all JDKs against javap (compileTheWorld)
   * use the Quality Corpus
+  
+* improve test coverage

data/rake_analysis.rb

@@ -0,0 +1,46 @@
+require 'rake'
+require 'rake/clean' # for clean/clobber
+
+# Static analysis functions.
+# Author::           Peter Kofler
+
+gemspec = eval(IO.readlines('javaclass.gemspec').join)
+
+begin
+  require File.dirname(__FILE__) + '/dev/saikuro_task'
+
+# :complexity, :clobber_complexity, :recomplexity
+Rake::SaikuroTask.new do |saikuro|
+  saikuro.files.include "#{gemspec.require_path}/**/*.rb"
+end
+
+rescue LoadError
+  # skip if not installed
+  warn("saikuro not installed. complexity not available. #{$!}")
+end
+
+# Helper method to grep all the sources for some _pattern_ words.
+def egrep(pattern)
+  Dir['**/*'].
+    find_all { |fn| FileTest.file?(fn) }.
+    reject { |fn| File.basename(fn) =~ /^\./ }.
+    reject { |fn| fn =~ /^hosting\// }.
+    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
+
+task :default => :complexity

data/test/logging_folder_classpath.rb

@@ -6,8 +6,8 @@ module JavaClass
 
     # Add a field +was_called+ to see if the load_binary was called.
     class FolderClasspath
-      alias :__old_load_binary :load_binary
-
+      alias :__old_load_binary :load_binary unless method_defined?('__old_load_binary')  
+      
       def load_binary(classname)
         @was_called = true
         __old_load_binary(classname)

data/test/{test_adder_tree.rb → test_adder_tree_node.rb}

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/setup'
 require 'javaclass/adder_tree'
 
-class TestAdderTree < Test::Unit::TestCase
+class TestAdderTreeNode < Test::Unit::TestCase
 
   def setup
     @tree = AdderTree.new(0)

data/test/test_class_magic.rb

@@ -17,7 +17,7 @@ module TestJavaClass
       end
 
       def test_bytes
-        assert_equal("\xCA\xFE\xBA\xBE", @magic.bytes)
+        assert("\xCA\xFE\xBA\xBE".same_bytes_as?(@magic.bytes))
       end
 
       def test_check

data/test/test_eclipse_classpath.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/setup'
 require 'javaclass/classpath/eclipse_classpath'
-require 'test/dot_classpath'
+require File.dirname(__FILE__) + '/dot_classpath'
 
 module TestJavaClass
   module TestClasspath