gjp 0.16.1 → 0.17.0

data/README.md

@@ -75,7 +75,7 @@ Ceate a new `gjp` project, in this example named "galaxy":
     unzip commons-collections-3.2.1-src.zip
     rm commons-collections-3.2.1-src.zip
 
-Now let's move to the kit (which, unsurprisingly, should be placed in the `kit` folder). commons-lang needs Maven 3 to build, so we should simply unzip a copy in `kit`:
+Now let's move to the kit (which, unsurprisingly, should be placed in the `kit` folder). commons-collections needs Maven 3 to build, so we should simply unzip a copy in `kit`:
 
     cd ../../kit
     wget http://apache.fastbull.org/maven/maven-3/3.1.0/binaries/apache-maven-3.1.0-bin.zip
@@ -211,7 +211,7 @@ The Fedora community is experimenting with another set of tools, [XMvn](http://m
 
 Building software from a binary blob is unusual for Linux distros, and it surely has some drawbacks. It is anyway believed that benefits outweigh them, in fact using prebuilt software:
 
-* drastically reduces packaging efforts. A very basic and relatively simple package like [commons-lang](http://commons.apache.org/proper/commons-lang/) needs about [150 jars](https://build.opensuse.org/package/show/home:SilvioMoioli/galaxy-kit) just to be compiled and tested. Those should be packaged, roughly, one-by-one!
+* drastically reduces packaging efforts. A very basic and relatively simple package like [commons-collections](http://commons.apache.org/proper/commons-collections/) needs about [150 jars](https://build.opensuse.org/package/show/home:SilvioMoioli/galaxy-kit) just to be compiled and tested. Those should be packaged, roughly, one-by-one!
 * is just the way all Java developers out there build, test and use their software — this is how they expect it to work. Any different approach is necessarily error-prone and could result in unexpected bugs;
 * does not affect the ability of providing patches to Java projects, as only build time requirements are in the kit. In virtually all cases patching a piece of software does not require to patch its build toolchain;
 * does not affect the ability of complying to software licenses like the GPL. In fact those licenses only require to redistribute a project's source code - not the whole toolchain needed to build it. [Sources can be added](#kit-sources) for GPL'd parts of the kit, if any.

data/integration-tests/commons-io.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+# A crude integration test that builds commons-lang
+
+mkdir galaxy
+cd galaxy
+gjp init
+
+cd src
+mkdir commons-collections
+cd commons-collections
+wget http://archive.apache.org/dist/commons/collections/source/commons-collections-3.2.1-src.zip
+unzip commons-collections-3.2.1-src.zip
+rm commons-collections-3.2.1-src.zip
+
+cd ../../kit
+wget http://apache.fastbull.org/maven/maven-3/3.1.0/binaries/apache-maven-3.1.0-bin.zip
+unzip apache-maven-3.1.0-bin.zip
+rm apache-maven-3.1.0-bin.zip
+cd ..
+
+gjp dry-run
+cd src/commons-collections/commons-collections-3.2.1-src/
+gjp mvn package
+
+gjp gather
+cat >../build.sh << "EOF"
+#!/bin/sh
+cd src/commons-collections/commons-collections-3.2.1-src/
+../../../kit/apache-maven-3.1.0/bin/mvn -Dmaven.repo.local=`readlink -e ../../../kit/m2` -s`readlink -e ../../../kit/m2/settings.xml` package
+EOF
+gjp finish
+cd ../../..
+
+gjp generate-kit-spec
+gjp generate-kit-archive
+
+gjp generate-package-spec commons-collections src/commons-collections/commons-collections-3.2.1-src/pom.xml
+gjp generate-package-archive commons-collections
+
+echo "All Done"

data/lib/gjp.rb

@@ -5,7 +5,6 @@ require "gjp/project"
 require "gjp/pom"
 require "gjp/version_matcher"
 require "gjp/maven_website"
-require "gjp/jar_table"
 require "gjp/limited_network_user"
 require "gjp/pom_getter"
 require "gjp/source_address_getter"

data/lib/gjp/cli.rb

@@ -218,14 +218,5 @@ module Gjp
         puts Gjp::SourceGetter.new.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 => "."
-      option ["--include-all"], :flag, "include tests and samples in produced jars", :default => false
-
-      def execute
-        puts Gjp::JarTable.new(directory, include_all?).to_s
-      end    
-    end
   end
 end

data/lib/gjp/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gjp
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.0
   prerelease: 
 platform: ruby
 authors:
@@ -155,10 +155,10 @@ files:
 - Rakefile
 - bin/gjp
 - gjp.gemspec
+- integration-tests/commons-io.sh
 - lib/gjp.rb
 - lib/gjp/archiver.rb
 - lib/gjp/cli.rb
-- lib/gjp/jar_table.rb
 - lib/gjp/limited_network_user.rb
 - lib/gjp/logger.rb
 - lib/gjp/maven_runner.rb
@@ -200,7 +200,6 @@ files:
 - spec/data/struts-apps/pom.xml
 - spec/data/tomcat/pom.xml
 - spec/lib/archiver_spec.rb
-- spec/lib/jar_table_spec.rb
 - spec/lib/limited_network_user_spec_interactive.rb
 - spec/lib/maven_runner_spec.rb
 - spec/lib/maven_website_spec.rb
@@ -256,7 +255,6 @@ test_files:
 - spec/data/struts-apps/pom.xml
 - spec/data/tomcat/pom.xml
 - spec/lib/archiver_spec.rb
-- spec/lib/jar_table_spec.rb
 - spec/lib/limited_network_user_spec_interactive.rb
 - spec/lib/maven_runner_spec.rb
 - spec/lib/maven_website_spec.rb

data/lib/gjp/jar_table.rb

@@ -1,160 +0,0 @@
-# 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
-    include Logger
-
-    attr_reader :rows, :runtime_required_packages, :source_defined_packages
-
-    # builds a JarTable from a directory (paths relative to the current directory)
-    def initialize(dir, include_all)
-      jars = get_jars(dir)
-      sources = get_sources(dir)
-      statements = get_statements(sources)
-      @runtime_required_packages = get_runtime_required_packages(statements)
-      @source_defined_packages = get_source_defined_packages(statements)
-
-      log.debug "Runtime required packages are:\n#{@runtime_required_packages.join("\n")}"
-      log.debug "Source defined packages are:\n#{@source_defined_packages.join("\n")}"
-
-      @rows = Hash[
-        jars.map do |jar|
-          [jar, get_type(jar, include_all)]
-        end
-      ]
-    end
-
-    def to_s
-      "# Key: \n" +
-      "# b - jar is required for building the project\n" +
-      "# r - jar is required runtime by the project\n" +
-      "# p - jar is produced by the project\n" +
-      "# i - jar is ignored\n" +
-
-      (
-        rows = @rows.map do |key, value|
-          pathname = Pathname.new(key)
-          [value.to_s[0], pathname.basename.to_s, pathname.dirname.to_s]
-        end
-
-        max_field_lengths = (0..2).map do |i|
-          rows.map { |row| row[i].length  }.max
-        end
-
-        rows.map do |row|
-          row.each_with_index.map do |element, i|
-           "%-#{max_field_lengths[i]+1}s" % element
-          end.join
-        end.sort.join("\n")
-      )
-    end
-
-    # jar files in the project's directory
-    def get_jars(dir)
-      Dir["#{dir}/**/*.jar"]
-    end
-
-    # java source files in the project's directory
-    def get_sources(dir)
-      Dir["#{dir}/**/*.java"]
-    end
-
-    # java statements in java source files
-    def get_statements(sources)
-      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 get_runtime_required_packages(statements)
-      get_statement_fragments_from(statements, /^import[ \t]+(?:static[ \t]+)?(.+)\..+?$/)
-    end
-
-    # heuristically determined package names that the sources define
-    def get_source_defined_packages(statements)
-      get_statement_fragments_from(statements, /^package[ \t]+(.+)$/)
-    end
-
-    # matches a regex against all source statements
-    def get_statement_fragments_from(statements, regex)
-      statements.map do |statement|
-        if statement =~ regex
-          $1
-        end
-      end.select {|package| package != nil}.flatten.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, include_all)
-      if not include_all and (jar =~ /(test)|(sample)/)
-        :ignored
-      else
-        jar_defined_packages = get_jar_defined_packages(jar)
-
-        if source_defined?(jar, jar_defined_packages)
-          :produced
-        elsif runtime_required?(jar, jar_defined_packages)
-          :required
-        else
-          :build_required
-        end
-      end
-    end
-
-    # returns true if a jar is produced from source code in the project's directory
-    def source_defined?(jar, jar_defined_packages)
-      log.debug "Determining if #{jar} is defined in the sources"
-      log.debug "#{jar} contains:\n#{jar_defined_packages.join("\n")}"
-
-      result = jar_defined_packages.all? { |package| @source_defined_packages.include?(package)  }
-
-      log.debug "result is:#{result}"
-
-      return result
-    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)
-      log.debug "Determining if #{jar} is required at runtime"
-      log.debug "#{jar} contains:\n#{jar_defined_packages.join("\n")}"
-
-      result = jar_defined_packages.any? { |package| @runtime_required_packages.include?(package)  }
-
-      log.debug "result is:#{result}"
-
-      return result
-    end
-
-    # returns packages defined in a jar file
-    def get_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 "#{jar} does not seem to be a valid jar archive, skipping"
-      rescue TypeError
-        log.info "#{jar} seems to be a valid jar archive but is corrupt, skipping"
-      end
-
-      return result.sort.uniq
-    end
-  end
-end

data/spec/lib/jar_table_spec.rb

@@ -1,59 +0,0 @@
-# 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, true) }
-
-  describe "#get_jars" do
-    it "finds jar paths in a directory" do 
-      jar_table.get_jars(dir).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 "#get_jar_defined_packages" do
-    it "finds the package names part of a jar file" do 
-      jar_table.get_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 "#sources" do
-    it "finds source paths in a directory" do 
-      jar_table.get_sources(dir).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 "#runtime_required_packages" do
-    it "finds the package names required by this project's sources" do 
-      jar_table.runtime_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