tetra 0.46.0 → 0.48.0

data/lib/tetra/ant_runner.rb

@@ -1,27 +0,0 @@
-# encoding: UTF-8
-
-module Tetra
-  # runs Ant with tetra-specific options
-  class AntRunner < KitRunner
-    include Logging
-
-    # runs ant in a subprocess
-    def ant(options)
-      run_executable("#{get_ant_commandline(@project.full_path)} #{options.join(' ')}")
-    end
-
-    # returns a command line for running Ant from the specified
-    # prefix
-    def get_ant_commandline(prefix)
-      executable = find_executable("ant")
-
-      if !executable.nil?
-        ant_path = File.join(prefix, executable)
-
-        "#{ant_path}"
-      else
-        fail ExecutableNotFoundError, "ant"
-      end
-    end
-  end
-end

data/lib/tetra/commands/download_maven_source_jars.rb

@@ -1,29 +0,0 @@
-# encoding: UTF-8
-
-module Tetra
-  # tetra download-maven-source-jars
-  class DownloadMavenSourceJarsCommand < Tetra::BaseCommand
-    def execute
-      checking_exceptions do
-        project = Tetra::Project.new(".")
-        source_getter = Tetra::SourceGetter.new
-
-        ensure_dry_running(false, project) do
-          puts "Getting sources from Maven..."
-          succeeded, failed = source_getter.get_maven_source_jars(project)
-
-          puts "\n**SUMMARY**\n"
-          puts "Sources found for:"
-          succeeded.each do |path|
-            puts " #{format_path(path, project)}"
-          end
-
-          puts "\nSources not found for:"
-          failed.each do |path|
-            puts " #{format_path(path, project)}"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/tetra/commands/dry_run.rb

@@ -1,17 +0,0 @@
-# encoding: UTF-8
-
-module Tetra
-  # tetra dry-run
-  class DryRunCommand < Tetra::BaseCommand
-    def execute
-      checking_exceptions do
-        if Tetra::Project.new(".").dry_run
-          puts "Now dry-running, please start your build."
-          puts "To run a Maven installation from the kit, use \"tetra mvn\"."
-          puts "If the build succeedes end this dry run with \"tetra finish\"."
-          puts "If the build does not succeed use \"tetra finish --abort\" to restore files."
-        end
-      end
-    end
-  end
-end

data/lib/tetra/commands/finish.rb

@@ -1,22 +0,0 @@
-# encoding: UTF-8
-
-module Tetra
-  # tetra finish
-  class FinishCommand < Tetra::BaseCommand
-    option %w(-a --abort), :flag, "abort build, restore files as before dry-run"
-
-    def execute
-      checking_exceptions do
-        if Tetra::Project.new(".").finish(abort?)
-          if abort?
-            puts "Project reverted as before dry-run."
-          else
-            puts "Dry-run finished."
-          end
-        else
-          puts "No dry-run is in progress."
-        end
-      end
-    end
-  end
-end

data/lib/tetra/commands/get_source.rb

@@ -1,30 +0,0 @@
-# encoding: UTF-8
-
-module Tetra
-  # tetra get-source
-  class GetSourceCommand < Tetra::BaseCommand
-    parameter "POM", "a pom file path or URI"
-
-    def execute
-      checking_exceptions do
-        project = Tetra::Project.new(".")
-        source_getter = Tetra::SourceGetter.new
-
-        puts "Attempting to find source through Maven..."
-        if source_getter.get_maven_source_jar(project, pom)
-          puts "Source jar found and added to Maven repository."
-        else
-          effective_pom_path = Tetra::MavenRunner.new(project).get_effective_pom(pom)
-          puts "Source jar not found in Maven. Try looking here:"
-          pom = Tetra::Pom.new(effective_pom_path)
-          puts "Website: #{pom.url}" unless pom.url.empty?
-          puts "SCM connection: #{pom.scm_connection}" unless pom.scm_connection.empty?
-          puts "SCM connection: #{pom.scm_url}" unless pom.scm_url.empty?
-          puts "The effective POM: #{effective_pom_path}"
-          name = !pom.name.empty? ? pom.name : pom.artifact_id
-          puts "Google: http://google.com/#q=#{URI.encode("#{name} sources")}"
-        end
-      end
-    end
-  end
-end

data/lib/tetra/commands/list_kit_missing_sources.rb

@@ -1,21 +0,0 @@
-# encoding: UTF-8
-
-module Tetra
-  # tetra list-kit-missing-sources
-  class ListKitMissingSourcesCommand < Tetra::BaseCommand
-    def execute
-      checking_exceptions do
-        project = Tetra::Project.new(".")
-        kit_checker = Tetra::KitChecker.new(project)
-
-        ensure_dry_running(false, project) do
-          puts "Some source files were not found in these archives:"
-          kit_checker.unsourced_archives.each do |archive|
-            percentage = 100.0 * archive[:unsourced_class_names].length / archive[:class_names].length
-            puts "#{format_path(archive[:archive], project)} (~#{format('%.2f', percentage)}% missing)"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/tetra/kit_checker.rb

@@ -1,104 +0,0 @@
-# encoding: UTF-8
-
-module Tetra
-  # checks kits for errors
-  class KitChecker
-    include Logging
-
-    def initialize(project)
-      @project = project
-    end
-
-    # returns an array of [path, archive] couples found in kit/
-    # archive is not nil if path is inside a zip file
-    def kit_file_paths
-      @project.from_directory("kit") do
-        plain_file_paths = Dir[File.join("**", "*")].select do |path|
-          File.file?(path)
-        end.map do |path|
-          [path, nil]
-        end
-
-        archived_file_paths = plain_file_paths.select do |path, _archive|
-          path. =~ (/\.(zip)|([jwe]ar)$/)
-        end.map do |path, _archive|
-          result = []
-          Zip::File.foreach(path) do |entry|
-            result << [entry.to_s, path] if entry.file?
-          end
-          result
-        end.flatten(1)
-
-        plain_file_paths + archived_file_paths
-      end
-    end
-
-    # returns a list of class names for which
-    # we have source files in kit/
-    def source_class_names(paths)
-      source_paths = paths.select do |path, _archive|
-        path =~ /\.java$/
-      end
-
-      # heuristically add all possible package names, walking
-      # back the directory tree all the way back to root.
-      # This could add non-existent names, but allows not looking
-      # in the file at all
-      class_names = source_paths.map do |path, _archive|
-        class_name = path_to_class(path)
-        parts = class_name.split(".")
-        last_index = parts.length - 1
-        (0..last_index).map do |i|
-          parts[i..last_index].join(".")
-        end
-      end.flatten
-
-      Set.new(class_names)
-    end
-
-    # returns a list of class names for which
-    # we have binary files in kit/
-    def compiled_classes(paths)
-      result = {}
-      paths.select do |path, _archive|
-        path =~ /\.class$/
-      end.each do |path, archive|
-        class_name = path_to_class(path)
-        if result[archive].nil?
-          result[archive] = [class_name]
-        else
-          result[archive] << class_name
-        end
-      end
-
-      result
-    end
-
-    # returns a hash that associates archive names and
-    # the unsourced classes within them
-    def unsourced_archives
-      paths = kit_file_paths
-      source_class_names = source_class_names(paths)
-      archive_paths_to_class_names = compiled_classes(paths)
-
-      archive_paths_to_class_names.map do |archive, class_names|
-        unsourced_class_names = class_names.select do |class_name|
-          source_class_names.include?(class_name) == false
-        end
-        { archive: archive, class_names: class_names, unsourced_class_names: unsourced_class_names }
-      end.select do |archive|
-        archive[:unsourced_class_names].any?
-      end
-    end
-
-    private
-
-    # attempts to turn a .java/.class file name into a class name
-    def path_to_class(path)
-      path
-        .gsub(/\$.+?\./, ".") # remove $InnerClasses
-        .gsub(/\..+?$/, "") # remove .extension
-        .gsub("/", ".") # convert paths in package names
-    end
-  end
-end

data/lib/tetra/maven_runner.rb

@@ -1,43 +0,0 @@
-# encoding: UTF-8
-
-module Tetra
-  # runs Maven with tetra-specific options
-  class MavenRunner < KitRunner
-    include Logging
-
-    # runs Maven in a subprocess
-    def mvn(options)
-      run_executable(get_maven_commandline(@project.full_path, options))
-    end
-
-    # runs Maven to attempt getting a source jar
-    # returns true if successful
-    def get_source_jar(group_id, artifact_id, version)
-      mvn(["dependency:get", "-Dartifact=#{group_id}:#{artifact_id}:#{version}:jar:sources", "-Dtransitive=false"])
-    end
-
-    # runs Maven to get the effective POM from an existing POM
-    # returns effective pom path or nil if not found
-    def get_effective_pom(pom_path)
-      effective_pom_path = "#{pom_path}.effective"
-      success = mvn(["help:effective-pom", "-f#{pom_path}", "-Doutput=#{File.split(effective_pom_path)[1]}"])
-      effective_pom_path if success
-    end
-
-    # returns a command line for running Maven from the specified
-    # prefix
-    def get_maven_commandline(prefix, options)
-      executable = find_executable("mvn")
-
-      if !executable.nil?
-        mvn_path = File.join(prefix, executable)
-        repo_path = File.join(prefix, "kit", "m2")
-        config_path = File.join(prefix, "kit", "m2", "settings.xml")
-
-        "#{mvn_path} -Dmaven.repo.local=#{repo_path} -s#{config_path} #{options.join(' ')}"
-      else
-        fail ExecutableNotFoundError, "mvn"
-      end
-    end
-  end
-end

data/lib/tetra/source_getter.rb

@@ -1,41 +0,0 @@
-# encoding: UTF-8
-
-module Tetra
-  # attempts to get java projects' sources
-  class SourceGetter
-    include Logging
-
-    # attempts to download a project's sources
-    def get_maven_source_jar(project, pom_path)
-      maven_runner = Tetra::MavenRunner.new(project)
-      pom = Pom.new(pom_path)
-      maven_runner.get_source_jar(pom.group_id, pom.artifact_id, pom.version)
-    end
-
-    # looks for jars in maven's local repo and downloads corresponding
-    # source jars
-    def get_maven_source_jars(project)
-      maven_runner = Tetra::MavenRunner.new(project)
-
-      project.from_directory do
-        paths = Find.find(".").reject { |path| artifact_from_path(path).nil? }.sort
-
-        succeded_paths = paths.each do |path|
-          group_id, artifact_id, version = artifact_from_path(path)
-          log.info("attempting source download for #{path} (#{group_id}:#{artifact_id}:#{version})")
-          maven_runner.get_source_jar(group_id, artifact_id, version)
-        end
-
-        [succeded_paths, (paths - succeded_paths)]
-      end
-    end
-
-    private
-
-    # if possible, turn path into a Maven artifact name, otherwise return nil
-    def artifact_from_path(path)
-      match = path.match(%r{\./kit/m2/(.+)/(.+)/(.+)/\2-\3.*\.jar$})
-      [match[1].gsub("/", "."), match[2], match[3]] unless match.nil?
-    end
-  end
-end

data/spec/lib/ant_runner_spec.rb

@@ -1,45 +0,0 @@
-# encoding: UTF-8
-
-require "spec_helper"
-
-describe Tetra::AntRunner do
-  it_behaves_like Tetra::KitRunner
-  include Tetra::Mockers
-
-  before(:each) do
-    create_mock_project
-    @kit_runner = Tetra::AntRunner.new(@project)
-  end
-
-  after(:each) do
-    delete_mock_project
-  end
-
-  describe "#get_ant_commandline"  do
-    it "returns commandline options for running Ant" do
-      executable_path = create_mock_executable("ant")
-      @project.from_directory do
-        commandline = @kit_runner.get_ant_commandline(".")
-        expect(commandline).to eq "./#{executable_path}"
-      end
-    end
-    it "doesn't return commandline options if Ant is not available" do
-      expect { @kit_runner.get_ant_commandline(".") }.to raise_error(Tetra::ExecutableNotFoundError)
-    end
-  end
-
-  describe "#ant"  do
-    it "runs Ant" do
-      create_mock_executable("ant")
-      @project.from_directory do
-        @kit_runner.ant(["extra-option"])
-        expect(File.read("test_out").strip).to match(/extra-option$/)
-      end
-    end
-    it "doesn't run Ant if it is not available" do
-      @project.from_directory do
-        expect { @kit_runner.ant([]) }.to raise_error(Tetra::ExecutableNotFoundError)
-      end
-    end
-  end
-end

data/spec/lib/kit_checker_spec.rb

@@ -1,119 +0,0 @@
-# encoding: UTF-8
-
-require "spec_helper"
-require "rubygems"
-require "zip"
-
-describe Tetra::KitChecker do
-  include Tetra::Mockers
-
-  before(:each) do
-    create_mock_project
-    @kit_checker = Tetra::KitChecker.new(@project)
-  end
-
-  after(:each) do
-    delete_mock_project
-  end
-
-  describe "#kit_file_paths"  do
-    it "returns an array of paths found in kit" do
-      @project.from_directory("kit") do
-        FileUtils.touch("top_level")
-        FileUtils.mkdir_p("directory")
-        FileUtils.touch(File.join("directory", "in_directory"))
-        Zip::File.open("zipped.zip", Zip::File::CREATE) do |zipfile|
-          Dir[File.join("directory", "**", "**")].each do |file|
-            zipfile.add(file.sub("/directory", ""), file)
-          end
-        end
-      end
-
-      all_files = @kit_checker.kit_file_paths
-
-      expect(all_files).to include ["top_level", nil]
-      expect(all_files).not_to include ["directory", nil]
-      expect(all_files).to include ["directory/in_directory", nil]
-      expect(all_files).to include ["zipped.zip", nil]
-      expect(all_files).to include ["directory/in_directory", "zipped.zip"]
-    end
-  end
-
-  describe "#source_class_names"  do
-    it "distills source class names in kit" do
-      all_files = [
-        ["path/to/ClassOne.java", nil],
-        ["path/to/ClassTwo.java", "path/to/archive.jar"],
-        ["ClassThree.java", "another_archive.jar"],
-        ["path/to/CompiledClass.class", "yet_another.jar"]
-      ]
-
-      class_names = @kit_checker.source_class_names(all_files)
-
-      expect(class_names).to include "path.to.ClassOne"
-      expect(class_names).to include "path.to.ClassTwo"
-      expect(class_names).to include "ClassThree"
-      expect(class_names).not_to include "path.to.CompiledClass"
-    end
-  end
-
-  describe "#compiled_classes"  do
-    it "distills source class names in kit" do
-      all_files = [
-        ["path/to/ClassOne.class", nil],
-        ["path/to/ClassTwo.class", "path/to/archive.jar"],
-        ["ClassThree.class", "another_archive.jar"],
-        ["path/to/SourceClass.java", "yet_another.jar"]
-      ]
-
-      classes = @kit_checker.compiled_classes(all_files)
-
-      expect(classes[nil]).to include "path.to.ClassOne"
-      expect(classes["path/to/archive.jar"]).to include "path.to.ClassTwo"
-      expect(classes["another_archive.jar"]).to include "ClassThree"
-      expect(classes["yet_another.jar"]).to be_nil
-    end
-  end
-
-  describe "#unsourced_archives" do
-    it "returns a list of jars wich source files are missing" do
-      @project.from_directory("kit") do
-        FileUtils.mkdir_p("package1")
-        FileUtils.touch(File.join("package1", "UnsourcedClass.class"))
-
-        FileUtils.mkdir_p("package2")
-        FileUtils.touch(File.join("package2", "SourcedClass.java"))
-        Zip::File.open("zipped-source-2.jar", Zip::File::CREATE) do |zipfile|
-          Dir[File.join("package2", "**", "**")].each do |file|
-            zipfile.add(file.sub("/package2", ""), file)
-          end
-        end
-        FileUtils.rm(File.join("package2", "SourcedClass.java"))
-        FileUtils.touch(File.join("package2", "SourcedClass.class"))
-        Zip::File.open("zipped-2.jar", Zip::File::CREATE) do |zipfile|
-          Dir[File.join("package2", "**", "**")].each do |file|
-            zipfile.add(file.sub("/package2", ""), file)
-          end
-        end
-
-        FileUtils.mkdir_p("package3")
-        FileUtils.touch(File.join("package3", "SourcedSameArchive.java"))
-        FileUtils.touch(File.join("package3", "SourcedSameArchive.class"))
-        Zip::File.open("zipped-3.zip", Zip::File::CREATE) do |zipfile|
-          Dir[File.join("package3", "**", "**")].each do |file|
-            zipfile.add(file.sub("/package3", ""), file)
-          end
-        end
-      end
-
-      unsourced = @kit_checker.unsourced_archives
-      expect(unsourced.length).to eq 1
-
-      expect(unsourced.first[:archive]).to be_nil
-      expect(unsourced.first[:class_names]).to include "package1.UnsourcedClass"
-      expect(unsourced.first[:class_names]).to include "package2.SourcedClass"
-      expect(unsourced.first[:class_names]).to include "package3.SourcedSameArchive"
-      expect(unsourced.first[:unsourced_class_names]).to include "package1.UnsourcedClass"
-    end
-  end
-end