Move logic for temporary directory to util class

Author: kpaulisse

lib/octocatalog-diff/util/scriptrunner.rb

@@ -6,6 +6,8 @@
 require 'open3'
 require 'shellwords'
 
+require_relative 'util'
+
 module OctocatalogDiff
   module Util
     # This is a utility class to execute a built-in script.
@@ -93,20 +95,7 @@ def log(priority, message, logger = @logger)
       # @return [String] Path to tempfile containing script
       def temp_script(script)
         raise Errno::ENOENT, "Script '#{script}' not found" unless File.file?(script)
-        temp_dir = if existing_tempdir
-          Dir.mktmpdir('ocd-scriptrunner-', existing_tempdir)
-        else
-          temp_dir_local = Dir.mktmpdir('ocd-scriptrunner-')
-          at_exit do
-            begin
-              FileUtils.remove_entry_secure temp_dir_local
-            rescue Errno::ENOENT # rubocop:disable Lint/HandleExceptions
-              # OK if the directory doesn't exist since we're trying to remove it anyway
-            end
-          end
-          temp_dir_local
-        end
-
+        temp_dir = OctocatalogDiff::Util::Util.temp_dir('ocd-scriptrunner', existing_tempdir)
         temp_file = File.join(temp_dir, File.basename(script))
         File.open(temp_file, 'w') { |f| f.write(File.read(script)) }
         FileUtils.chmod 0o755, temp_file

lib/octocatalog-diff/util/util.rb

@@ -2,6 +2,8 @@
 
 # Handy methods that are not tied to one particular class
 
+require 'fileutils'
+
 module OctocatalogDiff
   module Util
     # Helper class to construct catalogs, performing all necessary steps such as
@@ -43,6 +45,38 @@ def self.deep_dup(object)
           safe_dup(object)
         end
       end
+
+      # Utility Method!
+      # This creates a temporary directory. If the base directory is specified, then we
+      # do not remove the temporary directory at exit, because we assume that something
+      # else will remove the base directory.
+      #
+      # prefix  - A String with the prefix for the temporary directory
+      # basedir - A String with the directory in which to make the tempdir
+      #
+      # Returns the full path to the temporary directory.
+      def self.temp_dir(prefix = 'ocd-', basedir = nil)
+        # If the base directory is specified, make sure it exists, and then create the
+        # temporary directory within it.
+        if basedir
+          unless File.directory?(basedir)
+            raise Errno::ENOENT, "temp_dir: Base dir #{basedir.inspect} does not exist!"
+          end
+          return Dir.mktmpdir(prefix, basedir)
+        end
+
+        # If the base directory was not specified, then create a temporary directory, and
+        # send the `at_exit` to clean it up at the conclusion.
+        the_dir = Dir.mktmpdir(prefix)
+        at_exit do
+          begin
+            FileUtils.remove_entry_secure the_dir
+          rescue Errno::ENOENT # rubocop:disable Lint/HandleExceptions
+            # OK if the directory doesn't exist since we're trying to remove it anyway
+          end
+        end
+        the_dir
+      end
     end
   end
 end