test_temp_file_helper 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc79e2ac38d87941a0a08e4edebbd1e92763eafc
-  data.tar.gz: b71bd5e044cc21144eac10859e200586573b1704
+  metadata.gz: d4ff9b1bf75dba193364a17c27dff7b374cd4461
+  data.tar.gz: e6e3c1a973382bcc7f9cb6deeb73031a2bebc89e
 SHA512:
-  metadata.gz: 0ff00fe7c5e03bc28b7aa04ed269ba07844ee558990ef8d5c39cf37c23546561fb92a7d5357f535fc3bcf1222bede028b33c2666a63143d192b4a4a1cb6ab422
-  data.tar.gz: e98c42a8b16eee67d180b650260743064b8d872b8ab3f7b575bc50e527218dce11ae28b3de78e3b40b41247a19152ceec0d2f7b9f44df4129300dc4316c9b342
+  metadata.gz: f12e13b1e4ba1c1dab03db9ce81374ed8d8b778f49e7edb03c9b50b1b79a0cd2650d8c27d94c6dfc9fd32fd9af9cfeda43b448bdedcb3599ba21032c7d28fc97
+  data.tar.gz: 1530ea138872e299e88d254842442cb25808a66423dbc7e729efb1ebdb49cc48d8466b5a6f4c4450fcf809107c2c1157100b0a090701f26856debf94c510f83c

data/README.md

@@ -42,27 +42,7 @@ $ gem install test_temp_file_helper
 
 ### Usage
 
-First, add the following to your `Rakefile`:
-
-```ruby
-require 'test_temp_file_helper/rake'
-
-TestTempFileHelper::SetupTestEnvironmentTask.new do |t|
-  t.base_dir = File.dirname __FILE__
-  t.data_dir = File.join('test', 'data')
-  t.tmp_dir = File.join('test', 'tmp')
-end
-```
-The `SetupTestEnvironmentTask` properties:
-- `base_dir`: parent directory used to set the environment variables
-- `data_dir`: directory relative to `base_dir` used to set `TEST_DATADIR`
-- `tmp_dir`: directory relative to `base_dir` used to set `TEST_TMPDIR`
-
-If an environment variable is already set, or if the corresponding property is
-not set on the `SetupTestEnvironmentTask` object, the environment variable
-will not be set or updated.
-
-Then, create a `TempFileHelper` in your test's `setup` method, and call
+Create a `TempFileHelper` in your test's `setup` method, and call
 `TempFileHelper.teardown` in your test's `teardown` method.
 
 ```ruby
@@ -86,6 +66,16 @@ class MyTest < ::Minitest::Test
 end
 ```
 
+The temporary directory containing all generated files and directories is
+set by the first of these items which is not `nil`:
+
+1. the `tmp_dir` argument to `TempFileHelper.new`
+2. the `TEST_TMPDIR` environment variable
+3. `Dir.mktmpdir`
+
+The path to the temporary directory itself can be accessed via
+`TempFileHelper.tmpdir`.
+
 ### Contributing
 
 1. Fork the repo ( https://github.com/18F/test_temp_file_helper/fork )

data/lib/test_temp_file_helper.rb

@@ -18,29 +18,27 @@ require "test_temp_file_helper/version"
 
 module TestTempFileHelper
   # Automatically generates and cleans up temporary files in automated tests.
-  # Performs its operations in the directory specified by the +TEST_TMPDIR+
-  # environment variable.
+  #
+  # The temporary directory containing all generated files and directories is
+  # set by the first of these items which is not +nil+:
+  # - the +tmp_dir+ argument to +TempFileHelper.new+
+  # - the +TEST_TMPDIR+ environment variable
+  # - +Dir.mktmpdir+
   class TempFileHelper
-    # @param tmpdir [String] (optional) if specified, overrides +TEST_TMPDIR+
-    def initialize(tmpdir: nil)
-      @tmpdir = tmpdir || ENV['TEST_TMPDIR']
-      @files = []
-      @dirs = []
+    attr_accessor :tmpdir
+
+    # @param tmpdir [String] (optional) if set, determines the temp dir
+    def initialize(tmp_dir: nil)
+      @tmpdir = tmp_dir || ENV['TEST_TMPDIR'] || Dir.mktmpdir
     end
 
     # Creates a temporary test directory relative to TEST_TMPDIR.
     # @param relative_path [String] directory to create
     # @return [String] File.join(@tmpdir, relative_path)
     def mkdir(relative_path)
-      components = relative_path.split(File::SEPARATOR)
-      components = components.delete_if {|i| i == '.'}
-      current = @tmpdir
-      until components.empty?
-        current = File.join current, components.shift
-        Dir.mkdir current unless File.exists? current
-        @dirs << current
-      end
-      @dirs.last 
+      new_dir = File.join @tmpdir, relative_path
+      FileUtils.mkdir_p new_dir
+      new_dir
     end
 
     # Creates a temporary file relative to TEST_TMPDIR.
@@ -51,15 +49,13 @@ module TestTempFileHelper
       mkdir File.dirname(relative_path)
       filename = File.join(@tmpdir, relative_path)
       File.open(filename, 'w') {|f| f << content}
-      @files << filename
       filename
     end
 
     # Removes all files and directories created by the instance. Should be
     # called from the test's +teardown+ method.
     def teardown
-      @files.sort.uniq.each {|f| File.unlink f}
-      @dirs.sort.uniq.reverse.each {|d| Dir.rmdir d}
+      FileUtils.remove_entry @tmpdir
     end
   end
 end

data/lib/test_temp_file_helper/version.rb

@@ -15,5 +15,5 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 module TestTempFileHelper
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_temp_file_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mike Bland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-18 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -76,7 +76,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/test_temp_file_helper.rb
-- lib/test_temp_file_helper/rake.rb
 - lib/test_temp_file_helper/version.rb
 homepage: https://github.com/18F/test_temp_file_helper
 licenses:

data/lib/test_temp_file_helper/rake.rb

@@ -1,89 +0,0 @@
-# test_temp_file_helper - Generates and cleans up temp files for automated tests
-#
-# Written in 2015 by Mike Bland (michael.bland@gsa.gov)
-# on behalf of the 18F team, part of the US General Services Administration:
-# https://18f.gsa.gov/
-#
-# To the extent possible under law, the author(s) have dedicated all copyright
-# and related and neighboring rights to this software to the public domain
-# worldwide. This software is distributed without any warranty.
-#
-# You should have received a copy of the CC0 Public Domain Dedication along
-# with this software. If not, see
-# <https://creativecommons.org/publicdomain/zero/1.0/>.
-#
-# @author Mike Bland (michael.bland@gsa.gov)
-
-require 'rake/tasklib'
-
-module TestTempFileHelper
-
-  # A Rake task that sets up the +TEST_DATADIR+ and +TEST_TMPDIR+ environment
-  # variables.
-  #
-  # Properties:
-  # - +base_dir+: parent directory used to set the environment variables
-  # - +data_dir+: directory relative to +base_dir+ used to set +TEST_DATADIR+
-  # - +tmp_dir+: directory relative to +base_dir+ used to set +TEST_TMPDIR+
-  #
-  # If an environment variable is already set, or if the corresponding
-  # property is not set on the +SetupTestEnvironmentTask+ object, the
-  # environment variable will not be set or updated.
-  #
-  # Usage (inside a +Rakefile+):
-  #
-  # require 'test_temp_file_helper/rake'
-  #
-  # TestTempFileHelper::SetupTestEnvironmentTask.new do |t|
-  #   t.base_dir = File.dirname __FILE__
-  #   t.data_dir = File.join('test', 'data')
-  #   t.tmp_dir = File.join('test', 'tmp')
-  # end
-  class SetupTestEnvironmentTask < ::Rake::TaskLib
-    def initialize(name='test_temp_file_helper_setup_test_environment')
-      @name = name
-      @base_dir = nil
-      yield self if block_given?
-
-      set_environment_variable 'TEST_DATADIR', @data_dir
-      set_environment_variable 'TEST_TMPDIR', @tmp_dir
-      test_tmpdir = ENV['TEST_TMPDIR']
-
-      if test_tmpdir
-        rm_rf test_tmpdir if File.exists? test_tmpdir
-        directory test_tmpdir
-        task test: test_tmpdir
-      end
-    end
-
-    # Sets +ENV[var_name]+ as the concatenation of +base_dir+ and
-    # +relative_dir+.
-    # @param var_name [String]
-    # @param relative_dir [String]
-    def set_environment_variable(var_name, relative_dir)
-      unless ENV[var_name]
-        ENV[var_name] = File.join @base_dir, relative_dir if relative_dir
-      end
-    end
-    private :set_environment_variable
-
-    # Sets the base directory that serves as the common parent for the
-    # +TEST_DATADIR+ and +TEST_TMPDIR+ environment variables.
-    # @param dirname [String] parent dir of +data_dir+ and +tmp_dir+
-    def base_dir=(dirname)
-      @base_dir = dirname
-    end
-
-    # Sets +TEST_DATADIR+ using a path relative to the +base_dir+.
-    # @param dirname [String] path relative to +base_dir+
-    def data_dir=(dirname)
-      @data_dir = dirname
-    end
-
-    # Sets +TEST_TMPDIR+ using a path relative to the +base_dir+.
-    # @param dirname [String] path relative to +base_dir+
-    def tmp_dir=(dirname)
-      @tmp_dir = dirname
-    end
-  end
-end