tetra 2.0.7 → 2.0.8

data/lib/tetra/pom_getter.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # attempts to get java projects' pom file
@@ -8,11 +8,13 @@ module Tetra
     # saves a jar poms in <jar_filename>.pom
     # returns filename and status if found, else nil
     def get_pom(filename)
-      content, status = get_pom_from_jar(filename) || get_pom_from_sha1(filename) || get_pom_from_heuristic(filename)
+      content, status = get_pom_from_jar(filename) ||
+                        get_pom_from_sha1(filename) ||
+                        get_pom_from_heuristic(filename)
       return unless content
 
       pom_filename = filename.sub(/(\.jar)?$/, ".pom")
-      File.open(pom_filename, "w") { |io| io.write(content) }
+      File.binwrite(pom_filename, content)
       [pom_filename, status]
     end
 
@@ -21,7 +23,11 @@ module Tetra
       log.debug("Attempting unpack of #{file} to find a POM")
       begin
         Zip::File.foreach(file) do |entry|
-          if entry.name =~ %r{/pom.xml$}
+          # Security check (Zip Slip)
+          next if entry.name.include?("..") || entry.name.start_with?("/")
+
+          # PERFORMANCE: end_with? is much faster than Regexp for simple suffixes
+          if entry.name.end_with?("/pom.xml") || entry.name == "pom.xml"
             log.info("pom.xml found in #{file}##{entry.name}")
             return entry.get_input_stream.read, :found_in_jar
           end
@@ -37,19 +43,22 @@ module Tetra
     # returns a pom from search.maven.org with a jar sha1 search
     def get_pom_from_sha1(file)
       log.debug("Attempting SHA1 POM lookup for #{file}")
+      return unless File.file?(file)
+
       begin
-        if File.file?(file)
-          site = MavenWebsite.new
-          sha1 = Digest::SHA1.hexdigest File.read(file)
-          results = site.search_by_sha1(sha1).select { |result| result["ec"].include?(".pom") }
-          result = results.first
-          unless result.nil?
-            log.info("pom.xml for #{file} found on search.maven.org for sha1 #{sha1}\
-              (#{result['g']}:#{result['a']}:#{result['v']})"
-                    )
-            group_id, artifact_id, version = site.get_maven_id_from result
-            return site.download_pom(group_id, artifact_id, version), :found_via_sha1
-          end
+        site = MavenWebsite.new
+        # PERFORMANCE: Streams the file calculation instead of loading entire file into RAM
+        sha1 = Digest::SHA1.file(file).hexdigest
+
+        results = site.search_by_sha1(sha1)
+        found_doc = results.find { |doc| doc["ec"].include?(".pom") }
+
+        if found_doc
+          log.info("pom.xml for #{file} found on search.maven.org for sha1 #{sha1} " \
+                   "(#{found_doc['g']}:#{found_doc['a']}:#{found_doc['v']})")
+
+          group_id, artifact_id, version = site.get_maven_id_from(found_doc)
+          return site.download_pom(group_id, artifact_id, version), :found_via_sha1
         end
       rescue NotFoundOnMavenWebsiteError
         log.warn("Got a 404 error while looking for #{file}'s SHA1 in search.maven.org")
@@ -59,37 +68,40 @@ module Tetra
 
     # returns a pom from search.maven.org with a heuristic name search
     def get_pom_from_heuristic(filename)
+      log.debug("Attempting heuristic POM search for #{filename}")
       begin
-        log.debug("Attempting heuristic POM search for #{filename}")
         site = MavenWebsite.new
-        filename = cleanup_name(filename)
+        clean_name = cleanup_name(filename)
+
         version_matcher = VersionMatcher.new
-        my_artifact_id, my_version = version_matcher.split_version(filename)
+        my_artifact_id, my_version = version_matcher.split_version(clean_name)
         log.debug("Guessed artifact id: #{my_artifact_id}, version: #{my_version}")
 
-        result = site.search_by_name(my_artifact_id).first
-        log.debug("Artifact id search result: #{result}")
-        unless result.nil?
-          group_id, artifact_id, = site.get_maven_id_from result
-          results = site.search_by_group_id_and_artifact_id(group_id, artifact_id)
-          log.debug("All versions: #{results}")
-          their_versions = results.map { |doc| doc["v"] }
-          best_matched_version = (
-            if !my_version.nil?
-              version_matcher.best_match(my_version, their_versions)
-            else
-              their_versions.max
-            end
-          )
-          best_matched_result = results.select { |r| r["v"] == best_matched_version }.first
-
-          group_id, artifact_id, version = site.get_maven_id_from(best_matched_result)
-          log.warn("pom.xml for #{filename} found on search.maven.org with heuristic search\
-            (#{group_id}:#{artifact_id}:#{version})"
-                  )
-
-          return site.download_pom(group_id, artifact_id, version), :found_via_heuristic
-        end
+        first_result = site.search_by_name(my_artifact_id).first
+        log.debug("Artifact id search result: #{first_result}")
+
+        return unless first_result
+
+        group_id, artifact_id, = site.get_maven_id_from(first_result)
+        results = site.search_by_group_id_and_artifact_id(group_id, artifact_id)
+        log.debug("All versions: #{results}")
+
+        their_versions = results.map { |doc| doc["v"] }
+
+        best_matched_version = if my_version
+                                 version_matcher.best_match(my_version, their_versions)
+                               else
+                                 their_versions.max
+                               end
+
+        best_matched_doc = results.find { |r| r["v"] == best_matched_version }
+        return unless best_matched_doc
+
+        group_id, artifact_id, version = site.get_maven_id_from(best_matched_doc)
+        log.warn("pom.xml for #{filename} found on search.maven.org with heuristic search " \
+                 "(#{group_id}:#{artifact_id}:#{version})")
+
+        return site.download_pom(group_id, artifact_id, version), :found_via_heuristic
       rescue NotFoundOnMavenWebsiteError
         log.warn("Got a 404 error while looking for #{filename} heuristically in search.maven.org")
       end
@@ -98,7 +110,7 @@ module Tetra
 
     # get a heuristic name from a path
     def cleanup_name(path)
-      Pathname.new(path).basename.to_s.sub(/.jar$/, "")
+      Pathname.new(path).basename.to_s.sub(/\.jar$/, "")
     end
   end
 end

data/lib/tetra/project.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # encapsulates a Tetra project directory
@@ -7,7 +7,7 @@ module Tetra
     include Logging
 
     # path of the project template files
-    TEMPLATE_PATH = File.join(File.dirname(__FILE__), "..", "template")
+    TEMPLATE_PATH = File.join(__dir__, "..", "template")
 
     attr_reader :full_path
 
@@ -54,13 +54,14 @@ module Tetra
     def dry_run
       current_directory = Pathname.new(Dir.pwd).relative_path_from(Pathname.new(@full_path))
 
-      @git.commit_directories(%w(src kit), "Dry-run started\n\ntetra: dry-run-started: #{current_directory}")
+      @git.commit_directories(%w[src kit], "Dry-run started\n\ntetra: dry-run-started: #{current_directory}")
     end
 
     # returns true iff we are currently dry-running
     def dry_running?
       latest_comment = @git.latest_comment("tetra: dry-run-")
-      !latest_comment.nil? && !(latest_comment =~ /tetra: dry-run-finished/)
+      # MODERNIZATION: Use match? instead of =~
+      !latest_comment.nil? && !latest_comment.match?(/tetra: dry-run-finished/)
     end
 
     # ends a dry-run assuming a successful build:
@@ -87,7 +88,7 @@ module Tetra
     # ends a dry-run assuming the build went wrong
     # reverts src/ and kit/ directories
     def abort
-      @git.revert_directories(%w(src kit), @git.latest_id("tetra: dry-run-started"))
+      @git.revert_directories(%w[src kit], @git.latest_id("tetra: dry-run-started"))
       @git.undo_last_commit
     end
 
@@ -185,12 +186,9 @@ module Tetra
     # returns the name of the source archive file, if any
     def src_archive
       from_directory do
-        Find.find(File.join("packages", name)) do |file|
-          if File.file?(file) && file.match(/\.(spec)|(sh)|(patch)$/).nil?
-            return File.basename(file)
-          end
-        end
-        nil
+        Dir.glob(File.join("packages", name, "*")).find do |file|
+          File.file?(file) && !file.match?(/\.(spec|sh|patch)$/)
+        end&.then { |f| File.basename(f) }
       end
     end
 
@@ -210,14 +208,15 @@ module Tetra
     def purge_jars
       from_directory do
         result = []
-        Find.find("src") do |file|
-          next unless file =~ /.jar$/ && !File.symlink?(file)
+        Dir.glob("src/**/*.jar").each do |file|
+          next if File.symlink?(file)
 
-          new_location = File.join("kit", "jars", Pathname.new(file).split[1])
+          new_location = File.join("kit", "jars", File.basename(file))
           FileUtils.mv(file, new_location)
 
+          # Calculate relative path for symlink
           link_target = Pathname.new(new_location)
-                        .relative_path_from(Pathname.new(file).split.first)
+                        .relative_path_from(Pathname.new(file).dirname)
                         .to_s
 
           File.symlink(link_target, file)

data/lib/tetra/project_initer.rb

@@ -1,22 +1,26 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
-  # takes care of intiializing a tetra project
+  # takes care of initializing a tetra project
   module ProjectIniter
     include Logging
 
     # path of the project template files
-    TEMPLATE_PATH = File.join(File.dirname(__FILE__), "..", "template")
+    TEMPLATE_PATH = File.join(__dir__, "..", "template")
 
     # includers get class methods defined in ClassMethods
     def self.included(base)
       base.extend(ClassMethods)
     end
+
     # class methods container
     module ClassMethods
       # returns true if the specified directory is a valid tetra project
       def project?(dir)
-        Tetra::Logger.instance.debug "Checking for tetra project: #{dir}, contents: #{Dir.new(dir).to_a}"
+        # Use a block for logging so we don't list files unless debug is on.
+        # Dir.children is faster/cleaner than Dir.new(dir).to_a
+        Tetra::Logger.instance.debug { "Checking for tetra project: #{dir}, contents: #{Dir.children(dir)}" }
+
         File.directory?(File.join(dir, "src")) &&
           File.directory?(File.join(dir, "kit")) &&
           File.directory?(File.join(dir, ".git"))
@@ -25,23 +29,29 @@ module Tetra
       # inits a new project directory structure
       def init(dir, include_bundled_software = true)
         Dir.mkdir(dir)
-        Dir.chdir(dir) do
-          git = Tetra::Git.new(".")
 
-          git.init
+        # Avoid Dir.chdir(dir). Use absolute paths instead.
+        # Initialize Git facade with the full path
+        git = Tetra::Git.new(dir)
+        git.init
 
-          FileUtils.mkdir_p("src")
-          FileUtils.mkdir_p("kit")
+        FileUtils.mkdir_p(File.join(dir, "src"))
+        FileUtils.mkdir_p(File.join(dir, "kit"))
 
-          # populate the project with templates and commit it
-          project = Project.new(".")
+        # Create a project instance (now that the dir structure exists)
+        project = Project.new(dir)
 
-          project.template_files(include_bundled_software).each do |source, destination|
-            FileUtils.cp_r(File.join(TEMPLATE_PATH, source), destination)
-          end
+        project.template_files(include_bundled_software).each do |source, destination|
+          # Source is relative to TEMPLATE_PATH
+          src_path = File.join(TEMPLATE_PATH, source)
+          # Destination is relative to the new project directory
+          dst_path = File.join(dir, destination)
 
-          git.commit_directories(["."], "Template files added")
+          FileUtils.cp_r(src_path, dst_path)
         end
+
+        # Commit "." (Git facade handles context, "." means "all changes in repo")
+        git.commit_directories(["."], "Template files added")
       end
     end
 
@@ -55,10 +65,10 @@ module Tetra
       }
 
       if include_bundled_software
-        Dir.chdir(TEMPLATE_PATH) do
-          Dir.glob(File.join("bundled", "*")).each do |file|
-            result[file] = "kit"
-          end
+        # Use 'base:' argument to avoid unsafe Dir.chdir
+        # This globs files inside TEMPLATE_PATH without changing global state
+        Dir.glob(File.join("bundled", "*"), base: TEMPLATE_PATH).each do |file|
+          result[file] = "kit"
         end
       end
 
@@ -75,13 +85,15 @@ module Tetra
         FileUtils.cp(file, result_path)
         @git.commit_file(result_path, "Source archive added")
 
-        unarchiver = if file =~ /\.zip$/
+        unarchiver = if /\.zip$/.match?(file)
                        Tetra::Unzip.new
                      else
                        Tetra::Tar.new
                      end
 
+        # Glob cleaning is safer than rm_rf with wildcards in shell
         Dir.glob(File.join("src", "*")).each { |f| FileUtils.rm_rf(f) }
+
         unarchiver.decompress(file, "src")
         commit_sources(message, true)
       end

data/lib/tetra/ui/change_sources_subcommand.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # tetra change-sources
@@ -9,19 +9,25 @@ module Tetra
            default: false
 
     def execute
-      if source_archive.nil? && no_archive? == false
-        signal_usage_error "please specify a source archive file or use \"--no-archive\" (see SPECIAL_CASES.md)."
-      end
-
       checking_exceptions do
+        # Ensure the user provided an archive OR explicitly opted out
+        if source_archive.nil? && !no_archive?
+          signal_usage_error "please specify a source archive file or use \"--no-archive\" (see SPECIAL_CASES.md)."
+        end
+
         project = Tetra::Project.new(".")
         ensure_dry_running(:is_not_in_progress, project) do
-          if no_archive? == false
-            project.commit_source_archive(File.expand_path(source_archive), message)
+          if !no_archive?
+            # CASE 1: Updating from a new archive file
+            full_archive_path = File.expand_path(source_archive)
+            project.commit_source_archive(full_archive_path, message)
+
             puts "New sources committed."
             puts "Please delete any stale source archives from packages/ before proceeding."
           else
+            # CASE 2: Updating from manual changes in src/
             project.commit_sources(message, true)
+
             puts "New sources committed."
             puts "Please copy source archive(s) corresponding to src/ in packages/ before proceeding."
           end

data/lib/tetra/ui/dry_run_subcommand.rb

@@ -1,9 +1,10 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # tetra dry-run
   class DryRunSubcommand < Tetra::Subcommand
     option ["-s", "--script"], "SCRIPT", "Run these commands to build the project instead of the interactive shell"
+
     def execute
       checking_exceptions do
         project = Tetra::Project.new(".")
@@ -15,14 +16,15 @@ module Tetra
           puts "Dry run not started."
         else
           project.dry_run
+
           if script
             puts "Scripted dry-run started."
           else
             puts "Dry-run started in a new bash shell. Build your project now!"
             puts "Note that:"
             puts " - \"mvn\" and \"ant\" are already bundled by tetra"
-            puts " - you have to use \"gradlew\" instad of \"./gradlew\" to launch a Gradle wrapper"
-            puts "If the build succeedes end this dry run with ^D (Ctrl+D),"
+            puts " - you have to use \"gradlew\" instead of \"./gradlew\" to launch a Gradle wrapper"
+            puts "If the build succeeds end this dry run with ^D (Ctrl+D),"
             puts "if the build does not succeed use ^C^D to abort and undo any change"
           end
 

data/lib/tetra/ui/generate_all_subcommand.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # tetra generate-all

data/lib/tetra/ui/generate_kit_subcommand.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # tetra generate-kit
@@ -8,6 +8,7 @@ module Tetra
         project = Tetra::Project.new(".")
         ensure_dry_running(:has_finished, project) do
           kit = Tetra::KitPackage.new(project)
+
           result_path, conflict_count = kit.to_spec
           print_generation_result(project, result_path, conflict_count)
 

data/lib/tetra/ui/generate_script_subcommand.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # tetra generate-script
@@ -7,8 +7,7 @@ module Tetra
       checking_exceptions do
         project = Tetra::Project.new(".")
         ensure_dry_running(:has_finished, project) do
-          result_path, conflict_count =
-            Tetra::Package.new(project).to_script
+          result_path, conflict_count = Tetra::Package.new(project).to_script
           print_generation_result(project, result_path, conflict_count)
         end
       end

data/lib/tetra/ui/generate_spec_subcommand.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # tetra generate-spec
@@ -19,7 +19,8 @@ module Tetra
 
           result_path, conflict_count = package.to_spec
           print_generation_result(project, result_path, conflict_count)
-          puts "Warning: #{pom} not found, some spec fields will be left blank" unless File.file?(pom)
+
+          puts "Warning: #{pom} not found, some spec fields will be left blank" unless File.exist?(pom)
           puts "Warning: source archive not found, package will not build" unless project.src_archive
         end
       end

data/lib/tetra/ui/get_pom_subcommand.rb

@@ -1,4 +1,6 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
+require "uri"
 
 module Tetra
   # tetra get-pom
@@ -10,23 +12,26 @@ module Tetra
         project = Tetra::Project.new(".")
         ensure_dry_running(:is_not_in_progress, project) do
           pom_getter = Tetra::PomGetter.new
-
           path, status = pom_getter.get_pom(name)
+
           if path
-            text_status = (
-              if status == :found_in_jar
-                "was inside the jar"
-              elsif status == :found_via_sha1
-                "found by sha1 search from search.maven.org"
-              elsif status == :found_via_heuristic
-                "found by heuristic search from search.maven.org"
-              end
-            )
+            text_status = case status
+                          when :found_in_jar
+                            "was inside the jar"
+                          when :found_via_sha1
+                            "found by sha1 search from search.maven.org"
+                          when :found_via_heuristic
+                            "found by heuristic search from search.maven.org"
+                          end
 
             puts "#{format_path(path, project)} written, #{text_status}"
           else
             puts "#{name}'s pom not found. Try:"
-            puts "http://google.com/#q=#{URI.encode(pom_getter.cleanup_name(name) + ' pom')}"
+
+            # URI.encode_www_form_component correctly escapes spaces to '+' for query params.
+            clean_name = pom_getter.cleanup_name(name)
+            query = "#{clean_name} pom"
+            puts "http://google.com/#q=#{URI.encode_www_form_component(query)}"
           end
         end
       end

data/lib/tetra/ui/init_subcommand.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # tetra init
@@ -10,10 +10,13 @@ module Tetra
 
     def execute
       checking_exceptions do
-        if source_archive.nil? && no_archive? == false
+        # Ensure the user provided an archive OR explicitly opted out
+        if source_archive.nil? && !no_archive?
           signal_usage_error "please specify a source archive file or use \"--no-archive\" (see SPECIAL_CASES.md)."
         end
-        if !source_archive.nil? && !File.readable?(source_archive)
+
+        # Ensure the file exists if provided
+        if source_archive && !File.readable?(source_archive)
           signal_usage_error "#{source_archive} is not a file or it is not readable."
         end
 
@@ -23,11 +26,16 @@ module Tetra
 
         if source_archive
           puts "Decompressing sources..."
-          project.commit_source_archive(File.expand_path(source_archive), "Inital sources added from archive")
+          # Expand path immediately to ensure we reference the correct file
+          # relative to where the command was run, not inside the new project dir.
+          full_archive_path = File.expand_path(source_archive)
+
+          project.commit_source_archive(full_archive_path, "Initial sources added from archive")
           puts "Sources decompressed in #{package_name}/src/, original archive copied in #{package_name}/packages/."
         else
           puts "Use \"tetra change-sources\" to add sources to this project."
         end
+
         puts "Please add any other precompiled build dependency to kit/."
         puts "When you are ready to test a build, use \"tetra dry-run\" from the project directory"
       end

data/lib/tetra/ui/main.rb

@@ -1,8 +1,13 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # program entry point
   class MainCommand < Clamp::Command
+    option ["-v", "--version"], :flag, "print the version and exit" do
+      puts Tetra::VERSION
+      exit(0)
+    end
+
     subcommand(
       "init",
       "Inits a tetra project in the current directory",

data/lib/tetra/ui/move_jars_to_kit_subcommand.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # tetra move-jars-to-kit
@@ -9,7 +9,7 @@ module Tetra
 
         ensure_dry_running(:is_not_in_progress, project) do
           project.purge_jars.each do |original, final|
-            puts "Replaced #{original} with symlink pointing to to #{final}"
+            puts "Replaced #{original} with symlink pointing to #{final}"
           end
         end
       end

data/lib/tetra/ui/patch_subcommand.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Tetra
   # tetra patch