javaclass 0.0.3 → 0.0.4

data/lib/javaclass/dsl/classpath_analysers.rb

@@ -0,0 +1,27 @@
+require 'javaclass/dsl/loading_classpath'
+require 'javaclass/dsl/caching_classpath'
+require 'javaclass/analyse/dependencies'
+require 'javaclass/analyse/transitive_dependencies'
+
+module JavaClass
+  module Dsl
+
+    # A mixin for all class path analyser functions that need to be mixed into LoadingClasspath.
+    # Author::          Peter Kofler
+    module ClasspathAnalysers
+      # add dependency analysis to LoadingClasspath
+      include Analyse::Dependencies
+      # add transitive dependency analysis to LoadingClasspath
+      include Analyse::TransitiveDependencies
+    end
+
+    class LoadingClasspath
+      include ClasspathAnalysers
+    end
+
+    class CachingClasspath
+      include ClasspathAnalysers
+    end
+
+  end
+end

data/lib/javaclass/dsl/java_name_factory.rb

@@ -0,0 +1,79 @@
+require 'javaclass/java_language'
+require 'javaclass/java_name'
+
+module JavaClass
+  module Dsl 
+
+    # Module to mixin to recognize full qualified Java classnames in Ruby code.
+    # Packages have to be suffixed with ".*" to be recognized.
+    # This is a bit dangerous, as wrong method or variable names with are a valid 
+    # country code are not recognized as invalid.
+    # Author::          Peter Kofler
+    #
+    # === Usage
+    #
+    #  require 'javaclass/dsl/java_name_factory'
+    #  include JavaNameFactory
+    #  
+    #  java.lang.String      # => "java.lang.String" 
+    #  java.lang.*           # => "java.lang"
+    # 
+    module JavaNameFactory
+
+      alias :__top_level_method_missing__ :method_missing # :nodoc:
+      
+      # Convert the beginning of a full qualified Java classname starting with 'java' to a JavaQualifiedName instance.
+      def java
+        TemporaryJavaNamePart.new('java') { __top_level_method_missing__(:java) }
+      end
+
+      # Convert the beginning of a full qualified Java classname to a JavaQualifiedName instance.
+      def method_missing(method_id, *args)
+        str = method_id.id2name
+        if JavaLanguage::ALLOWED_PACKAGE_PREFIX.include?(str)
+          TemporaryJavaNamePart.new(str) { __top_level_method_missing__(method_id, args) }
+        else
+          __top_level_method_missing__(method_id, args)
+        end
+      end
+
+      # # Overwrite the _id_ method. It's deprecated anyway.
+      # def id
+      #   TemporaryJavaNamePart.new('id')
+      # end
+
+      # Private temporary result to continue collecting qualified name parts.
+      # Author::          Peter Kofler
+      class TemporaryJavaNamePart # :nodoc:
+
+        # Create a part with _history_ package name so far that started in _context_ instance.
+        def initialize(history, &fail)
+          @history = history
+          @context = fail
+        end
+
+        alias :__unused_method_missing__ :method_missing
+
+        def method_missing(method_id, *args)
+          str = method_id.id2name
+          if JavaLanguage::RESERVED_WORDS.include?(str)
+            @context.call
+          elsif str =~ /^#{JavaLanguage::TYPE_REGEX}$/
+            # starts with an uppercase letter, this is a class
+            JavaQualifiedName.new("#{@history}#{JavaLanguage::SEPARATOR}#{str}", &@context) 
+          elsif str == '*'
+            # special syntax, ending with *, this is a package
+            JavaPackageName.new("#{@history}") 
+          elsif str =~ JavaLanguage::PACKAGE_REGEX
+            # starts with a lowercase letter, this is a package
+            TemporaryJavaNamePart.new("#{@history}#{JavaLanguage::SEPARATOR}#{str}", &@context)
+          else
+            @context.call
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/javaclass/dsl/loader.rb

@@ -0,0 +1,42 @@
+require 'javaclass/classfile/java_class_header'
+require 'javaclass/classfile/java_class_header_as_java_name'
+require 'javaclass/classfile/java_class_header_shortcuts'
+
+module JavaClass
+  module Dsl
+
+    # Load the classfiles and create the JavaClassHeader. This module ties together all ClassFile and Classpath modules.
+    # Author::          Peter Kofler
+    module Loader
+
+      # Read and disassemble the given class from _filename_ (full file name).
+      def load_fs(filename)
+        begin
+          disassemble(File.open(filename, 'rb') { |io| io.read.freeze } )
+        rescue ClassFile::ClassFormatError => ex
+          ex.add_classname(filename)
+          raise ex
+        end
+      end
+
+      # Read and disassemble the given class _classname_ from _classpath_ .
+      def load_cp(classname, classpath)
+        begin
+          disassemble(classpath.load_binary(classname))
+        rescue ClassFile::ClassFormatError => ex
+          ex.add_classname(classname, classpath.to_s)
+          raise ex
+        end
+      end
+
+      # Read and disassemble the given class inside _data_ (byte data). Might throw a 
+      # ClassFile::ClassFormatError if the classfile is not valid.
+      # This creates a +ClassFile::JavaClassHeader+ .
+      def disassemble(data)
+        ClassFile::JavaClassHeader.new(data)
+      end
+
+    end
+
+  end
+end

data/lib/javaclass/dsl/loading_classpath.rb

@@ -0,0 +1,53 @@
+require 'delegate'
+require 'javaclass/classscanner/scanners'
+require 'javaclass/dsl/loader'
+
+module JavaClass
+  module Dsl
+
+    # A delegator Classpath that loads and parses classes.
+    # Author::          Peter Kofler
+    class LoadingClasspath < SimpleDelegator
+      
+      # Create a lading instance of the _classpath_ .
+      def initialize(classpath)
+        unless classpath.respond_to? :load_binary 
+          raise ArgumentError, "wrong type of delegatee #{classpath.class}"
+        end
+        super(classpath)
+      end
+
+      # Read and disassemble the given class _classname_ .
+      def load(classname)
+        analyse(load_cp(classname, self))
+      end
+
+      # Load _listed_ or all classes and return the list of them. An additional block is used as _filter_ on class names.
+      def values(listed=nil, &filter)
+        listed ||= names(&filter)
+        listed.collect { |name| load(name) }
+      end
+      
+      private
+
+      # add loader so binary data from classpath can be parsed
+      include Loader
+      # add scanners so loaded class headers can be scanned
+      include ClassScanner::Scanners
+      
+    end
+
+    # A special directive which wraps a method with a LoadingClasspath.
+    # Author::          Peter Kofler
+    module LoadDirective # :nodoc:
+      
+      # Wrap the method with _method_name_ in a LoadingClasspath.
+      def wrap_classpath(method_name)
+        self.module_eval("alias :__pure_#{method_name}__ #{method_name.to_s}")
+        self.module_eval("def #{method_name}(*obj) LoadingClasspath.new(__pure_#{method_name}__(*obj)) end")
+      end
+      
+    end      
+    
+  end
+end

data/lib/javaclass/dsl/mixin.rb

@@ -0,0 +1,54 @@
+require 'javaclass/classpath/factory'
+require 'javaclass/classscanner/scanners'
+require 'javaclass/dsl/loader'
+require 'javaclass/dsl/loading_classpath'
+require 'javaclass/dsl/classpath_analysers'
+require 'javaclass/java_name_scanner'
+
+module JavaClass
+
+  # The module DSL contains shortcuts to make loading and analysing classes
+  # easier. This is the high-level API with usage/DSL features.
+  # Author::          Peter Kofler
+  module Dsl
+
+    class EclipseClasspathDelegator # :nodoc:
+      def add_variable(name, value)
+        Classpath::EclipseClasspath::add_variable(name, value)
+      end
+      def skip_lib
+        Classpath::EclipseClasspath::skip_lib
+      end
+    end
+
+    # Methods to be mixed into Object.
+    # Author::          Peter Kofler
+    module Mixin
+      # add the Java language constants
+      include JavaLanguage
+      # add classpath factory methods
+      include Classpath::Factory
+      # add class header loading
+      include Loader
+      # decorate classpath with loading
+      extend LoadDirective
+      wrap_classpath :classpath
+      wrap_classpath :environment_classpath
+      wrap_classpath :full_classpath
+      wrap_classpath :workspace
+      # add scanner factory methods for direct use by user
+      include ClassScanner::Scanners
+      # add hard coded class name finder
+      include JavaNameScanner      
+
+      # Delegate shortcut to Classpath::EclipseClasspath
+      Eclipse = EclipseClasspathDelegator.new
+      
+    end
+
+  end
+end
+
+class Object # :nodoc:
+  include JavaClass::Dsl::Mixin
+end

data/lib/javaclass/gems/zip_file.rb

@@ -0,0 +1,154 @@
+require 'zip/zipfilesystem'
+
+# Patch the zip for invalid Linux file system flags found in some JARs.
+module Zip # :nodoc:all
+  class ZipEntry
+
+    # uncomment next method to avoid swallowing errors, else we get +nil+ entries later.
+    # def ZipEntry.read_c_dir_entry(io)
+    #   entry = new(io.path)
+    #   entry.read_c_dir_entry(io)
+    #   return entry
+    # end
+    
+    alias :strict_read_c_dir_entry read_c_dir_entry
+    
+    def read_c_dir_entry(io)  
+      staticSizedFieldsBuf = io.read(CDIR_ENTRY_STATIC_HEADER_LENGTH)
+      unless (staticSizedFieldsBuf.size == CDIR_ENTRY_STATIC_HEADER_LENGTH)
+        raise ZipError, "Premature end of file. Not enough data for zip cdir entry header"
+      end
+
+      @header_signature      ,
+      @version               , # version of encoding software
+      @fstype                , # filesystem type
+      @versionNeededToExtract,
+      @gp_flags              ,
+      @compression_method    ,
+      lastModTime            ,
+      lastModDate            ,
+      @crc                   ,
+      @compressed_size       ,
+      @size                  ,
+      nameLength             ,
+      extraLength            ,
+      commentLength          ,
+      diskNumberStart        ,
+      @internalFileAttributes,
+      @externalFileAttributes,
+      @localHeaderOffset     ,
+      @name                  ,
+      @extra                 ,
+      @comment               = staticSizedFieldsBuf.unpack('VCCvvvvvVVVvvvvvVV')
+
+      unless @header_signature == CENTRAL_DIRECTORY_ENTRY_SIGNATURE
+        raise ZipError, "Zip local header magic not found at location '#{localHeaderOffset}'"
+      end
+      set_time(lastModDate, lastModTime)
+
+      @name = io.read(nameLength)
+      if ZipExtraField === @extra
+        @extra.merge(io.read(extraLength))
+      else
+        @extra = ZipExtraField.new(io.read(extraLength))
+      end
+      @comment = io.read(commentLength)
+      unless (@comment && @comment.length == commentLength)
+        raise ZipError, "Truncated cdir zip entry header"
+      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
+          
+        else
+          if name_is_directory?
+            @ftype = :directory
+          else
+            @ftype = :file
+          end
+        end
+    end
+
+  end
+end
+
+module JavaClass
+
+  # Module for wrappers around used gems to avoid direct dependencies to gems.
+  # Author::   Peter Kofler
+  module Gems 
+
+    # Abstraction of a Zip archive. Wraps around
+    # Zip::ZipFile of {rubyzip}[http://rubyzip.sourceforge.net/]
+    # Author::   Peter Kofler
+    class ZipFile
+      def initialize(file)
+        @archive = file
+      end
+
+      # Read the _file_ from archive.
+      def read(file)
+        begin
+          Zip::ZipFile.open(@archive) { |zipfile| zipfile.file.read(file) }
+        rescue
+          nil
+        end
+      end
+
+      # List the entries of this zip for the block given.
+      def entries(&block)
+        Zip::ZipFile.foreach(@archive) do |entry|
+          block.call(ZipEntry.new(entry))
+        end
+      end
+
+    end
+    
+    # Abstraction of an entry in a Zip archive. Wraps around 
+    # Zip::ZipEntry of {rubyzip}[http://rubyzip.sourceforge.net/]
+    # Author::   Peter Kofler
+    class ZipEntry
+
+      def initialize(entry)
+        @entry = entry
+      end
+      
+      def name
+        @entry.name
+      end
+
+      def file?
+        @entry.file?
+      end
+    end
+
+  end
+end
+

data/lib/javaclass/java_language.rb

@@ -0,0 +1,50 @@
+module JavaClass
+
+  # All kind of constant information related to Java and the Java language.
+  # Author::   Peter Kofler
+  module JavaLanguage
+
+    SOURCE = '.java'
+    SOURCE_REGEX = /#{Regexp.escape(SOURCE)}$/
+    CLASS = '.class'
+    CLASS_REGEX = /#{Regexp.escape(CLASS)}$/
+
+    # A general Java identifier from Java spec.
+    IDENTIFIER_REGEX = /[a-zA-Z_$][a-zA-Z_$0-9]*/
+    LOWER_IDENTIFIER_REGEX = /[a-z_$][a-z_$0-9]*/
+
+    # A proper package name part. This is more strict than IDENTIFIER_REGEX because it's all lowercase letters.
+    PACKAGE_REGEX = /^#{LOWER_IDENTIFIER_REGEX}$/
+        
+    # A proper type (class) name. This is more strict than IDENTIFIER_REGEX because it starts with uppercase letters.
+    TYPE_REGEX = /[A-Z][a-zA-Z_$0-9]*/
+
+    # A proper member (field or method) name. This is more strict than IDENTIFIER_REGEX because it starts with lowercase letters.
+    MEMBER_REGEX = /^[a-z][a-zA-Z_$0-9]*$/
+
+    # Separator between qualified name parts.
+    SEPARATOR = '.'
+    SEPARATOR_REGEX = Regexp::escape(SEPARATOR)
+    
+    RESOURCE_FOLDER = File.join(File.dirname(__FILE__), 'resources')
+
+    # Reserved words of the Java language.
+    RESERVED_WORDS = IO.readlines(File.join(RESOURCE_FOLDER, 'reserved_words.txt')).map { |l| l.chomp }
+
+    # List of ISO 3166 two letter country names. Used to recognize valid domain suffix/Java package names.
+    # See::            http://www.iso.org/iso/list-en1-semic-3.txt
+    ISO_COUNTRIES = IO.readlines(File.join(RESOURCE_FOLDER, 'iso_3166_countries.txt')).map { |l| l.chomp }
+
+    # List of non  ISO 3166 U.S. domain suffix.
+    US_DOMAINS = %w| com net biz org |
+
+    # List of all (usual) allowed Java package prefixes.
+    ALLOWED_PACKAGE_PREFIX = %w| java javax | + US_DOMAINS + ISO_COUNTRIES
+
+    # List of all package prefixes found in the JDK (up to 1.6).
+    JDK_PACKAGES = IO.readlines(File.join(RESOURCE_FOLDER, 'jdk_packages.txt')).map { |l| l.chomp }
+    JDK_PACKAGES_REGEX = JDK_PACKAGES.collect { |pkg| /^#{pkg}\./ }
+
+  end
+
+end