file-temp 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75e2f5bc74f512cad14b4b8c48e2d4ec6ea79f581df34bd3d98cf3867f9745e5
-  data.tar.gz: 731f4cbb1c1096ff23d070f06cefde7c3bc93790ad8be7e63ddbbbc5137f434c
+  metadata.gz: 720ea1ce81f51967d708b7cff1756ec572337149a9312f38639654db1cb053ed
+  data.tar.gz: 5e2076ee4cc854a014789b26c1a21a520a1aa83af301de9e0e0677953da2c423
 SHA512:
-  metadata.gz: 3700145f748426eb5770c6e984f35c856c55bd12f3edc3d55fb2c41f45f198ba1925cf5c4a1a2885a92dc9b31e58444464c7d3ad6f4295f71bfd88a8d41aff68
-  data.tar.gz: 523dfae153d35f178178f8f36a9e14c184d2a4c65a75f7c2ce9a8f1ac42a322750506c8c775d277a46f6eeb8a317318bda09e1544fdb2e0aab21895c3007ad34
+  metadata.gz: fe66533b78b824b96cb75e03632ef5dc94ee4df4bedbb1f717d1fdb0c3a00bcd8b768bdc645d6453fd4b8ba5ff5ea739a38d128c472d9da95fc14f1cd5b104ec
+  data.tar.gz: 249034641f45d4523ea15ee6c64195fdae53ec0727305bd11fed655463c2a89dbb92510f1c281bdadd3357039777b15255f35da7d08f756ed6d5241d5689acba

data/CHANGES.rdoc

@@ -1,3 +1,8 @@
+= 1.7.0 - 1-Jul-2020
+* Replaced test-unit with rspec, and updated the tests.
+* Updated ffi dependency to 1.1.x.
+* Removed some archiving options from the Rakefile that I wasn't using.
+
 = 1.6.0 - 9-May-2020
 * Added an +options+ argument that is passed along as options to the the
   underlying File.new constructor.

data/MANIFEST.rdoc

@@ -10,4 +10,4 @@
 * lib/file/java/temp.rb
 * lib/file/unix/temp.rb
 * lib/file/windows/temp.rb
-* test/test_file_temp.rb
+* spec/file_temp_spec.rb

data/README.rdoc

@@ -2,7 +2,7 @@
 The file-temp library is an alternate way to handle tempfile generation.
 
 == Requirements
-* ffi 1.0.0 or later
+* ffi 1.1.0 or later
 
 == Installation
    gem install file-temp

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
 CLEAN.include('**/*.tar', '**/*.zip', '**/*.gz', '**/*.bz2')
 CLEAN.include('**/*.rbc', '**/*.gem', '**/*.tmp')
@@ -21,43 +21,7 @@ namespace 'gem' do
   end
 end
 
-# Export the contents of the library to an archive. Note that this requires
-# presence of the .gitattributes file in order to prevent the .git contents
-# from being included.
-#
-# It also appears that I must add a trailing slash to the prefix manually.
-# As of git 1.6.4.3 it does not automaticaly add it, despite what the docs
-# say.
-#
-namespace 'export' do
-  spec = eval(IO.read('file-temp.gemspec'))
-  file = 'file-temp-' + spec.version.to_s
-  pref = file + '/' # Git does not add the trailing slash, despite what the docs say.
+desc 'Run the test suite for the file-temp library'
+RSpec::Core::RakeTask.new(:spec)
 
-  desc 'Export to a .tar.gz file'
-  task :gzip => [:clean] do
-    file += '.tar'
-    sh "git archive --prefix #{pref} --output #{file} master"
-    sh "gzip #{file}"
-  end
-
-  desc 'Export to a .tar.bz2 file'
-  task :bzip2 => [:clean] do
-    file += '.tar'
-    sh "git archive --prefix #{pref} --output #{file} master"
-    sh "bzip2 -f #{file}"
-  end
-
-  desc 'Export to a .zip file'
-  task :zip => [:clean] do
-    file += '.zip'
-    sh "git archive --prefix #{pref} --output #{file} --format zip master"
-  end
-end
-
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.warning = true
-end
-
-task :default => :test
+task :default => :spec

data/file-temp.gemspec

@@ -2,20 +2,20 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'file-temp'
-  spec.version    = '1.6.0'
+  spec.version    = '1.7.0'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'http://github.com/djberg96/file-temp'
   spec.summary    = 'An alternative way to generate temp files'
-  spec.test_file  = 'test/test_file_temp.rb'
+  spec.test_file  = 'spec/file_temp_spec.rb'
   spec.files      = Dir['**/*'].delete_if{ |item| item.include?('git') }
   spec.cert_chain = Dir['certs/*']
 
   spec.extra_rdoc_files = ['CHANGES.rdoc', 'README.rdoc', 'MANIFEST.rdoc']
 
-  spec.add_dependency('ffi', '>= 1.0.0')
-  spec.add_development_dependency('test-unit')
+  spec.add_dependency('ffi', '~> 1.1')
+  spec.add_development_dependency('rspec', '~> 3.9')
   spec.add_development_dependency('rake')
 
   spec.metadata = {

data/lib/file/temp.rb

@@ -1,6 +1,6 @@
 class File::Temp < File
   # The version of the file-temp library
-  VERSION = '1.6.0'.freeze
+  VERSION = '1.7.0'.freeze
 end
 
 if RUBY_PLATFORM == 'java'

data/spec/file_temp_spec.rb

@@ -0,0 +1,159 @@
+######################################################################
+# file_temp_spec.rb
+#
+# Test suite for the file-temp library. These tests should be run
+# via the 'rake spec' task.
+######################################################################
+require 'rspec'
+require 'file/temp'
+
+RSpec.describe File::Temp do
+  let(:windows) { File::ALT_SEPARATOR }
+  let(:osx) { RbConfig::CONFIG['host_os'] =~ /darwin/i }
+
+  before do
+    @dir = File::Temp::TMPDIR
+    @template = 'file-temp-test-XXXXX'
+    @fh = nil
+
+    # Because Dir[] doesn't work right with backslashes
+    @dir = @dir.tr("\\", "/") if windows
+  end
+
+  context "constants" do
+    example "library version is set to expected value" do
+      expect( File::Temp::VERSION).to eq('1.7.0')
+      expect(File::Temp::VERSION).to be_frozen
+    end
+
+    example "TMPDIR constant is defined" do
+      expect(File::Temp::TMPDIR).to be_kind_of(String)
+      expect(File::Temp::TMPDIR.size).to be > 0
+    end
+  end
+
+  context "threads" do
+    example "library works as expected with multiple threads" do
+      threads = []
+      expect{ 100.times{ threads << Thread.new{ File::Temp.new }}}.not_to raise_error
+      expect{ threads.each{ |t| t.join }.not_to raise_error }
+    end
+  end
+
+  context "constructor" do
+    example "constructor works as expected with default auto delete option" do
+      expect{
+        @fh = File::Temp.new
+        @fh.print "hello"
+        @fh.close
+      }.not_to raise_error
+    end
+
+    example "constructor works as expected with false auto delete option" do
+      expect{
+        @fh = File::Temp.new(:delete => false)
+        @fh.print "hello"
+        @fh.close
+      }.not_to raise_error
+    end
+
+    example "constructor accepts and uses an optional template as expected" do
+      expect{ File::Temp.new(:delete => false, :template => 'temp_foo_XXXXXX').close }.not_to raise_error
+      expect(Dir["#{@dir}/temp_foo*"].length).to be >= 1
+    end
+
+    example "constructor with false auto delete and block works as expected" do
+      expect{
+        File::Temp.open(:delete => false, :template => 'temp_foo_XXXXXX'){ |fh| fh.puts "hello" }
+      }.not_to raise_error
+      expect(Dir["#{@dir}/temp_foo*"].length).to be >= 1
+    end
+
+    example "constructor accepts a maximum of three arguments" do
+      expect{
+        @fh = File::Temp.new(
+          :delete     => true,
+          :template   => 'temp_bar_XXXXX',
+          :directory  => Dir.pwd,
+          :bogus      => 1
+        )
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "template" do
+    example "template argument must be a string" do
+      expect{ @fh = File::Temp.new(:delete => false, :template => 1) }.to raise_error(TypeError)
+    end
+
+    example "an error is raised if a custom template is invalid" do
+      skip "skipped on OSX" if osx
+      expect{ File::Temp.new(:delete => false, :template => 'xx') }.to raise_error(Errno::EINVAL)
+    end
+  end
+
+  context "temp_name" do
+    example "temp_name basic functionality" do
+      expect(File::Temp).to respond_to(:temp_name)
+      expect{ File::Temp.temp_name }.not_to raise_error
+      expect(File::Temp.temp_name).to be_kind_of(String)
+    end
+
+    example "temp_name returns expected value" do
+      if windows
+        expect( File.extname(File::Temp.temp_name)).to match(/^.*?\d*?tmp/)
+      else
+        expect( File.extname(File::Temp.temp_name)).to eq('.tmp')
+      end
+    end
+  end
+
+  context "path" do
+    example "temp path basic functionality" do
+      @fh = File::Temp.new
+      expect(@fh).to respond_to(:path)
+    end
+
+    example "temp path is nil if delete option is true" do
+      @fh = File::Temp.new
+      expect(@fh.path).to be_nil
+    end
+
+    example "temp path is not nil if delete option is false" do
+      @fh = File::Temp.new(delete: false)
+      expect(@fh.path).not_to be_nil
+    end
+  end
+
+  context "ffi" do
+    example "ffi functions are private" do
+      methods = File::Temp.methods(false).map(&:to_s)
+      expect(methods).not_to include('_fileno')
+      expect(methods).not_to include('mkstemp')
+      expect(methods).not_to include('_umask')
+      expect(methods).not_to include('fclose')
+      expect(methods).not_to include('strerror')
+      expect(methods).not_to include('tmpnam')
+      expect(methods).not_to include('CloseHandle')
+      expect(methods).not_to include('CreateFileA')
+      expect(methods).not_to include('DeleteFileA')
+      expect(methods).not_to include('GetTempPathA')
+      expect(methods).not_to include('GetTempFileNameA')
+    end
+  end
+
+  after do
+    @dir = nil
+    @template = nil
+    @fh.close if @fh && !@fh.closed?
+    @fh = nil
+
+    Dir["temp_*"].each{ |f| File.delete(f) }
+    Dir["rb_file_temp_*"].each{ |f| File.delete(f) }
+
+    Dir.chdir(File::Temp::TMPDIR) do
+      Dir["temp_*"].each{ |f| File.delete(f) }
+      Dir["rb_file_temp_*"].each{ |f| File.delete(f) }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file-temp
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -41,30 +41,30 @@ dependencies:
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,9 +92,9 @@ extra_rdoc_files:
 - MANIFEST.rdoc
 files:
 - LICENSE
-- test
-- test/test_file_temp.rb
 - file-temp.gemspec
+- spec
+- spec/file_temp_spec.rb
 - Rakefile
 - certs
 - certs/djberg96_pub.pem
@@ -141,4 +141,4 @@ signing_key:
 specification_version: 4
 summary: An alternative way to generate temp files
 test_files:
-- test/test_file_temp.rb
+- spec/file_temp_spec.rb

data/test/test_file_temp.rb

@@ -1,138 +0,0 @@
-######################################################################
-# test_file_temp.rb
-#
-# Test suite for the file-temp library. These tests should be run
-# via the 'rake test' task.
-######################################################################
-require 'rubygems'
-require 'test-unit'
-require 'file/temp'
-
-class TC_File_Temp < Test::Unit::TestCase
-  WINDOWS = File::ALT_SEPARATOR
-  OSX = RbConfig::CONFIG['host_os'] =~ /darwin/i
-
-  def setup
-    @dir = File::Temp::TMPDIR
-    @template = 'file-temp-test-XXXXX'
-    @fh = nil
-
-    # Because Dir[] doesn't work right with backslashes
-    @dir = @dir.tr("\\", "/") if WINDOWS
-  end
-
-  test "library version is set to expected value" do
-    assert_equal('1.6.0', File::Temp::VERSION)
-    assert_true(File::Temp::VERSION.frozen?)
-  end
-
-  # Fails with JRuby, not sure why.
-  test "library works as expected with multiple threads" do
-    threads = []
-    assert_nothing_raised{ 100.times{ threads << Thread.new{ File::Temp.new }}}
-    assert_nothing_raised{ threads.each{ |t| t.join } }
-  end
-
-  test "TMPDIR constant is defined" do
-    assert_not_nil(File::Temp::TMPDIR)
-    assert_kind_of(String, File::Temp::TMPDIR)
-  end
-
-  test "constructor works as expected with default auto delete option" do
-    assert_nothing_raised{
-      @fh = File::Temp.new
-      @fh.print "hello"
-      @fh.close
-    }
-  end
-
-  test "constructor works as expected with false auto delete option" do
-    assert_nothing_raised{
-      @fh = File::Temp.new(:delete => false)
-      @fh.print "hello"
-      @fh.close
-    }
-  end
-
-  test "constructor accepts and uses an optional template as expected" do
-    assert_nothing_raised{ File::Temp.new(:delete => false, :template => 'temp_foo_XXXXXX').close }
-    assert_true(Dir["#{@dir}/temp_foo*"].length >= 1)
-  end
-
-  test "constructor with false auto delete and block works as expected" do
-    assert_nothing_raised{ File::Temp.open(:delete => false, :template => 'temp_foo_XXXXXX'){ |fh| fh.puts "hello" } }
-    assert_true(Dir["#{@dir}/temp_foo*"].length >= 1)
-  end
-
-  test "template argument must be a string" do
-    assert_raise(TypeError, ArgumentError){ @fh = File::Temp.new(:delete => false, :template => 1) }
-  end
-
-  test "an error is raised if a custom template is invalid" do
-    omit_if(OSX)
-    assert_raise(Errno::EINVAL){ File::Temp.new(:delete => false, :template => 'xx') }
-  end
-
-  test "constructor accepts a maximum of three arguments" do
-    assert_raise(ArgumentError){ @fh = File::Temp.new(:delete => true, :template => 'temp_bar_XXXXX', :directory => Dir.pwd, :bogus => 1) }
-  end
-
-  test "temp_name basic functionality" do
-    assert_respond_to(File::Temp, :temp_name)
-    assert_nothing_raised{ File::Temp.temp_name }
-    assert_kind_of(String, File::Temp.temp_name)
-  end
-
-  test "temp_name returns expected value" do
-    if File::ALT_SEPARATOR
-      assert_match(/^.*?\d*?tmp/, File.extname(File::Temp.temp_name))
-    else
-      assert_equal('.tmp', File.extname(File::Temp.temp_name))
-    end
-  end
-
-  test "temp path basic functionality" do
-    @fh = File::Temp.new
-    assert_respond_to(@fh, :path)
-  end
-
-  test "temp path is nil if delete option is true" do
-    @fh = File::Temp.new
-    assert_nil(@fh.path)
-  end
-
-  test "temp path is not nil if delete option is false" do
-    @fh = File::Temp.new(delete: false)
-    assert_not_nil(@fh.path)
-  end
-
-  test "ffi functions are private" do
-    methods = File::Temp.methods(false).map{ |e| e.to_s }
-    assert_false(methods.include?('_fileno'))
-    assert_false(methods.include?('mkstemp'))
-    assert_false(methods.include?('_umask'))
-    assert_false(methods.include?('fclose'))
-    assert_false(methods.include?('strerror'))
-    assert_false(methods.include?('tmpnam'))
-    assert_false(methods.include?('CloseHandle'))
-    assert_false(methods.include?('CreateFileA'))
-    assert_false(methods.include?('DeleteFileA'))
-    assert_false(methods.include?('GetTempPathA'))
-    assert_false(methods.include?('GetTempFileNameA'))
-  end
-
-  def teardown
-    @dir = nil
-    @template = nil
-    @fh.close if @fh && !@fh.closed?
-    @fh = nil
-
-    Dir["temp_*"].each{ |f| File.delete(f) }
-    Dir["rb_file_temp_*"].each{ |f| File.delete(f) }
-
-    Dir.chdir(File::Temp::TMPDIR) do
-      Dir["temp_*"].each{ |f| File.delete(f) }
-      Dir["rb_file_temp_*"].each{ |f| File.delete(f) }
-    end
-  end
-end