gjp 0.8.0 → 0.9.0

data/lib/gjp.rb

@@ -9,3 +9,4 @@ require "gjp/get_pom"
 require "gjp/get_parent_pom"
 require "gjp/get_source_address"
 require "gjp/get_source"
+require "gjp/jar_table"

data/lib/gjp/cli.rb

@@ -74,5 +74,13 @@ module Gjp
         puts Gjp::SourceGetter.get_source(address, pom, directory)
       end    
     end
+
+    subcommand "scaffold-jar-table", "Creates a heuristic version of a project's jar table" do
+      parameter "[DIRECTORY]", "project directory", :default => "."
+
+      def execute
+        puts Gjp::JarTable.new(directory).to_s
+      end    
+    end
   end
 end

data/lib/gjp/jar_table.rb

@@ -0,0 +1,119 @@
+# encoding: UTF-8
+
+require "text"
+
+module Gjp
+  # encapsulates information of a project's jar files
+  # assumes the project is in a directory with jar files
+  # in its (possibly nested) subdirectories
+  class JarTable
+    def self.log
+      Gjp.logger
+    end
+
+    attr_reader :dir, :rows
+
+    # builds a JarTable from a directory (paths relative to the current directory)
+    def initialize(dir)
+      @dir = dir
+
+      @rows = Hash[
+        jars.map do |jar|
+          [jar, get_type(jar)]
+        end
+      ]
+    end
+
+    def to_s
+      "# Legend: "
+      "#b - jar is required for building the project"
+      "#r - jar is required runtime by the project"
+      "#p - jar is produced by the project"
+      @rows.map do |key, value|
+        "#{value.to_s[0]} #{key}"
+      end.sort
+    end
+
+    # jar files in the project's directory
+    def jars
+      Dir["#{@dir}/**/*.jar"]
+    end
+
+    # returns packages defined in a jar file
+    def jar_defined_packages(jar)
+      result = []
+      begin
+        Zip::ZipFile.foreach(jar) do |entry|
+          if entry.name =~ /^(.+)\/.+?\.class$/
+            result << $1.gsub("/", ".")
+          end
+        end
+      rescue Zip::ZipError
+        log.info "#{file} does not seem to be a valid jar archive, skipping"
+      rescue TypeError
+        log.info "#{file} seems to be a valid jar archive but is corrupt, skipping"
+      end
+
+      return result.sort.uniq
+    end
+
+    # returns :produced if the jar was produced from the project's sources, and
+    # :required or :build_required if it is needed at runtime or build time
+    # (heuristically)
+    def get_type(jar)
+      if source_defined?(jar)
+        :produced
+      elsif runtime_required?(jar)
+        :required
+      else
+        :build_required        
+      end
+    end
+
+    # returns true if a jar is produced from source code in the project's directory
+    def source_defined?(jar)
+      jar_defined_packages(jar).all? { |package| source_defined_packages.include?(package)  }
+    end
+
+    # returns true if a jar is required runtime, false if it is only needed
+    # at compile time. Current implementation is heuristic (looks for "import" statements
+    # in java code)
+    def runtime_required?(jar)
+      jar_defined_packages(jar).any? { |package| source_required_packages.include?(package)  }
+    end
+
+    # java source files in the project's directory
+    def sources
+      Dir["#{@dir}/**/*.java"]
+    end
+
+    # java statements in java source files
+    def statements
+      sources.map do |source|
+        File.readlines(source)
+          .map { |line| line.split(";")  }
+          .flatten
+          .map { |statement| statement.strip }
+      end.flatten
+    end
+
+    # heuristically determined package names that the sources require
+    def source_required_packages
+      statement_fragments_from(/^import[ \t]+(?:static[ \t]+)?(.+)\..+?$/)
+    end
+
+    # heuristically determined package names that the sources define
+    def source_defined_packages
+      statement_fragments_from(/^package[ \t]+(.+)$/)
+    end
+
+    # matches a regex against all source statements
+    def statement_fragments_from(regex)
+      statements.map do |statement|
+        if statement =~ regex
+          $1
+        end
+      end.select {|package| package != nil}.flatten.sort.uniq
+    end
+  end
+end

data/lib/gjp/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Gjp
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/spec/data/ant-super-simple-code/build.xml

@@ -0,0 +1,133 @@
+<!-- 
+Ant simple sample project.
+ Kick start your java builds.
+ Find out more at http://www.bodkinconsulting.com
+ or http://java.net/projects/ant-simple-sample 
+ 
+Instructions:
+Put this file in an empty directory and run the 'ant' command in that directory. The build file will create directories and make a very empty jar file in the same directory as the build.xml.
+
+Create src/HW.java and put this code in it.
+
+public class HW
+{
+    public static void main(String [] args)
+    {
+        System.out.println("Hello World");
+    }
+
+}
+
+in the build file below change  
+<property name="main_class_name" value="changeme"/> 
+to 
+<property name="main_class_name" value="HW"/>
+ 
+Run the ant command again, and now you can run your main class with the command
+java -jar antsimple.jar
+
+It should print:
+Hellow World
+and exit.
+
+Add a junit.jar (from junit.org) into your ANT_HOME/lib directory and run 'ant test'
+ 
+Create the file test/HWTest.java and add this code.
+import junit.framework.*;
+public class HWTest extends TestCase {
+    public void testTrue()
+    {
+        assertTrue(true);
+    }
+}
+
+ -->
+
+<project name="antsimple" default="dist" basedir=".">
+    <description>
+        Ant Simple Sample File
+    </description>
+  <!-- set global properties for this build -->
+  <property name="ant.project.name" value="antsimple"/>
+  <property name="main_class_name" value="HW"/>
+  <property name="jarname"  value="${ant.project.name}"/> 
+  <!-- set directories -->
+  <property name="src" location="src"/>
+  <property name="test" location="test"/>
+  <property name="build" location="build"/>
+  <property name="dist"  location="dist"/>
+  <property name="lib"  location="lib"/>
+
+  <path id="project.classpath">
+    <pathelement location="${build}" />
+    <pathelement location="${lib}/log4j-1.2.13.jar" />
+  </path>
+
+
+  <target name="init">
+    <!-- Create the time stamp -->
+    <tstamp/>
+    <!-- Create directories if needed -->
+    <mkdir dir="${src}"/>
+    <mkdir dir="${test}"/>
+    <mkdir dir="${build}"/>
+    <mkdir dir="${dist}"/>
+  </target>
+
+  <target name="compile" depends="init" description="compile the source " >
+    <!-- Compile the java code from ${src} into ${build} -->
+    <javac debug="true" 
+	   srcdir="${src}" 
+	   destdir="${build}"
+	   classpathref="project.classpath"/>
+    <!-- Copy files from ${src} into ${build} -->
+    <copy todir="${build}"> 
+        <fileset dir="${src}">
+          <exclude name="**/*.java"/>
+        </fileset>
+    </copy>
+  </target>
+
+<!-- 
+Broken??? 
+-->
+  <target name="test" depends="compiletest" description="run the tests " >
+    <junit printsummary="yes" fork="yes" haltonfailure="yes">
+      <formatter type="plain"/>
+      <batchtest fork="true">
+        <fileset dir="${test}">
+          <include name="**/*Test*.java"/>
+        </fileset>
+      </batchtest>
+      <classpath refid="${project.classpath}" />
+    </junit>
+  </target>
+
+  <target name="compiletest" depends="compile"
+        description="compile the tests " >
+        <javac debug="true" 
+               srcdir="${test}" 
+               destdir="${build}"
+               classpathref="project.classpath" />
+  </target>
+
+  <target name="dist" depends="compile" description="generate the distribution" >
+    <!-- Create the distribution directory -->
+
+    <!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file -->
+    <jar jarfile="${dist}/${jarname}-${DSTAMP}.jar" basedir="${build}">
+        <manifest>
+        <attribute name="Main-Class"
+                value="${main_class_name}"/>
+        </manifest>
+    </jar>
+    <copy file="${dist}/${jarname}-${DSTAMP}.jar" tofile="./${jarname}.jar" overwrite="true"/>
+  </target>
+
+  <target name="clean"
+        description="clean up" >
+    <!-- Delete the ${build} directory-->
+    <delete dir="${build}"/>
+  </target>
+</project>
+

data/spec/data/ant-super-simple-code/src/mypackage/HW.java

@@ -0,0 +1,15 @@
+package mypackage;
+
+import org.apache.log4j.Logger;
+import org.apache.log4j.BasicConfigurator;
+
+public class HW
+{
+    static Logger logger = Logger.getLogger(HW.class);
+    public static void main(String [] args)
+    {
+        BasicConfigurator.configure();
+        logger.info("Hello World");
+    }
+
+}

data/spec/lib/jar_table_spec.rb

@@ -0,0 +1,66 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Gjp::JarTable do
+  let(:dir) { File.join("spec", "data", "ant-super-simple-code") }
+  let(:jar_table) { Gjp::JarTable.new(dir) }
+
+  describe "#jars" do
+    it "finds jar paths in a directory" do 
+      jar_table.jars.should include(
+        File.join(dir, "dist", "antsimple-20130618.jar"),
+        File.join(dir, "lib", "junit-4.11.jar"),
+        File.join(dir, "lib", "log4j-1.2.13.jar")
+      )
+    end
+  end
+
+  describe "#jar_defined_packages" do
+    it "finds the package names part of a jar file" do 
+      jar_table.jar_defined_packages(File.join(dir, "lib", "junit-4.11.jar")).should include(
+        "junit.framework",
+        "junit.extensions",
+        "org.junit.runner",
+        "org.junit.runners.model"
+      )
+    end
+  end
+
+  describe "#runtime_required?" do
+    it "heuristically determines if a jar file is needed runtime" do 
+      jar_table.runtime_required?(File.join(dir, "lib", "junit-4.11.jar")).should be_false
+      jar_table.runtime_required?(File.join(dir, "lib", "log4j-1.2.13.jar")).should be_true
+    end
+  end
+
+  describe "#sources" do
+    it "finds source paths in a directory" do 
+      jar_table.sources.should include(
+        File.join(dir, "src", "mypackage", "HW.java")
+      )
+    end
+  end
+
+  describe "#source_defined_packages" do
+    it "finds the package names built from this project" do 
+      jar_table.source_defined_packages.should include("mypackage")
+    end
+  end
+
+  describe "#source_required_packages" do
+    it "finds the package names required by this project's sources" do 
+      jar_table.source_required_packages.should include("org.apache.log4j")
+    end
+  end
+
+  describe "#rows" do
+    it "returns jar data" do
+      jar_table.rows.should include(
+        "spec/data/ant-super-simple-code/lib/log4j-1.2.13.jar" => :required,
+        "spec/data/ant-super-simple-code/lib/junit-4.11.jar" => :build_required,
+        "spec/data/ant-super-simple-code/dist/antsimple-20130618.jar" => :produced
+      )
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gjp
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -161,11 +161,19 @@ files:
 - lib/gjp/get_pom.rb
 - lib/gjp/get_source.rb
 - lib/gjp/get_source_address.rb
+- lib/gjp/jar_table.rb
 - lib/gjp/logger.rb
 - lib/gjp/maven_website.rb
 - lib/gjp/pom.rb
 - lib/gjp/version.rb
 - lib/gjp/version_matcher.rb
+- spec/data/ant-super-simple-code/build.xml
+- spec/data/ant-super-simple-code/build/HW.class
+- spec/data/ant-super-simple-code/build/mypackage/HW.class
+- spec/data/ant-super-simple-code/dist/antsimple-20130618.jar
+- spec/data/ant-super-simple-code/lib/junit-4.11.jar
+- spec/data/ant-super-simple-code/lib/log4j-1.2.13.jar
+- spec/data/ant-super-simple-code/src/mypackage/HW.java
 - spec/data/antlr/antlr-2.7.2.jar
 - spec/data/antlr/pom.xml
 - spec/data/commons-logging/commons-logging-1.1.1.jar
@@ -179,6 +187,7 @@ files:
 - spec/lib/get_pom_spec.rb
 - spec/lib/get_source_address_spec.rb
 - spec/lib/get_source_spec.rb
+- spec/lib/jar_table_spec.rb
 - spec/lib/maven_website_spec.rb
 - spec/lib/pom_spec.rb
 - spec/lib/version_matcher_spec.rb
@@ -208,6 +217,13 @@ signing_key:
 specification_version: 3
 summary: Green Java Packager's Tools
 test_files:
+- spec/data/ant-super-simple-code/build.xml
+- spec/data/ant-super-simple-code/build/HW.class
+- spec/data/ant-super-simple-code/build/mypackage/HW.class
+- spec/data/ant-super-simple-code/dist/antsimple-20130618.jar
+- spec/data/ant-super-simple-code/lib/junit-4.11.jar
+- spec/data/ant-super-simple-code/lib/log4j-1.2.13.jar
+- spec/data/ant-super-simple-code/src/mypackage/HW.java
 - spec/data/antlr/antlr-2.7.2.jar
 - spec/data/antlr/pom.xml
 - spec/data/commons-logging/commons-logging-1.1.1.jar
@@ -221,6 +237,7 @@ test_files:
 - spec/lib/get_pom_spec.rb
 - spec/lib/get_source_address_spec.rb
 - spec/lib/get_source_spec.rb
+- spec/lib/jar_table_spec.rb
 - spec/lib/maven_website_spec.rb
 - spec/lib/pom_spec.rb
 - spec/lib/version_matcher_spec.rb