test_temp_file_helper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc79e2ac38d87941a0a08e4edebbd1e92763eafc
+  data.tar.gz: b71bd5e044cc21144eac10859e200586573b1704
+SHA512:
+  metadata.gz: 0ff00fe7c5e03bc28b7aa04ed269ba07844ee558990ef8d5c39cf37c23546561fb92a7d5357f535fc3bcf1222bede028b33c2666a63143d192b4a4a1cb6ab422
+  data.tar.gz: e98c42a8b16eee67d180b650260743064b8d872b8ab3f7b575bc50e527218dce11ae28b3de78e3b40b41247a19152ceec0d2f7b9f44df4129300dc4316c9b342

data/README.md

@@ -0,0 +1,112 @@
+## test_temp_file_helper Gem
+
+[![Gem Version](https://badge.fury.io/rb/test_temp_file_helper.svg)](https://badge.fury.io/rb/test_temp_file_helper)
+[![Build Status](https://travis-ci.org/18F/test_temp_file_helper.svg?branch=master)](https://travis-ci.org/18F/test_temp_file_helper)
+[![Code Climate](https://codeclimate.com/github/18F/test_temp_file_helper/badges/gpa.svg)](https://codeclimate.com/github/18F/test_temp_file_helper)
+[![Test Coverage](https://codeclimate.com/github/18F/test_temp_file_helper/badges/coverage.svg)](https://codeclimate.com/github/18F/test_temp_file_helper)
+
+The `TestTempFileHelper::TempFileHelper` class manages the creation and
+cleanup of temporary files in automated tests.
+
+Downloads and API docs are available on the [test_temp_file_helper RubyGems
+page](https://rubygems.org/gems/test_temp_file_helper). API documentation is
+written using [YARD markup](http://yardoc.org/).
+
+Contributed by the 18F team, part of the United States General Services
+Administration: https://18f.gsa.gov/
+
+### Motivation
+
+Rather than reimplement [Pyfakefs](http://code.google.com/p/pyfakefs) in Ruby,
+in the short-term, I wrote this class to emulate Google's `TEST_DATADIR` and
+`TEST_TMPDIR` convention instead, so that I could test code that works with
+the file system.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'test_temp_file_helper'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ 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
+`TempFileHelper.teardown` in your test's `teardown` method.
+
+```ruby
+require 'minitest/autorun'
+require 'test_temp_file_helper'
+
+class MyTest < ::Minitest::Test
+  def setup
+    @temp_file_helper = TestTempFileHelper::TempFileHelper.new
+  end
+
+  def teardown
+    @temp_file_helper.teardown
+  end
+
+  def test_something_that_handles_files
+    dir_path = @temp_file_helper.mkdir(File.join('path', 'to', 'dir'))
+    file_path = @temp_file_helper.mkfile(File.join('path', 'to', 'file'))
+    ...
+  end
+end
+```
+
+### Contributing
+
+1. Fork the repo ( https://github.com/18F/test_temp_file_helper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Feel free to ping [@mbland](https://github.com/mbland) with any questions you
+may have, especially if the current documentation should've addressed your
+needs, but didn't.
+
+### Public domain
+
+This project is in the worldwide [public domain](LICENSE.md). As stated in
+[CONTRIBUTING](CONTRIBUTING.md):
+
+> This project is in the public domain within the United States, and copyright
+> and related rights in the work worldwide are waived through the
+> [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+>
+> All contributions to this project will be released under the CC0 dedication.
+> By submitting a pull request, you are agreeing to comply with this waiver of
+> copyright interest.

data/lib/test_temp_file_helper.rb

@@ -0,0 +1,65 @@
+# 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 "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.
+  class TempFileHelper
+    # @param tmpdir [String] (optional) if specified, overrides +TEST_TMPDIR+
+    def initialize(tmpdir: nil)
+      @tmpdir = tmpdir || ENV['TEST_TMPDIR']
+      @files = []
+      @dirs = []
+    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 
+    end
+
+    # Creates a temporary file relative to TEST_TMPDIR.
+    # @param relative_path [String] file to create
+    # @param content [String] (optional) content to include in the file
+    # @return [String] File.join(@tmpdir, relative_path)
+    def mkfile(relative_path, content: '')
+      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}
+    end
+  end
+end

data/lib/test_temp_file_helper/rake.rb

@@ -0,0 +1,89 @@
+# 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

data/lib/test_temp_file_helper/version.rb

@@ -0,0 +1,19 @@
+# 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)
+
+module TestTempFileHelper
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: test_temp_file_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Bland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The TestTempFileHelper::TempFileHelper class manages the creation and
+  cleanup of temporary files in automated tests.
+email:
+- michael.bland@gsa.gov
+executables: []
+extensions: []
+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:
+- CC0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Class for managing temporary files in automated tests
+test_files: []
+has_rdoc: