path-temp 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb460b98c7f3a39822d32e4a256179976cecbd7d4b43844897da4d613f1ddabc
+  data.tar.gz: 226618b575360076071adbb961505944e3f7def34be813ade3c0cd56a3695ca3
+SHA512:
+  metadata.gz: c3cd2ca78ec833d3e4cdf43fd65f2a26e1bb9e5eca4d72dfdf64805f5f2641b6c7a3652c30e2b2eb62dfdc64b2d478bc410d5d2d833866438147614540f43053
+  data.tar.gz: 4be9c4fcfd8eef741d4706a49a54776fd711bbea7e088205979d7aed0ad7b77a9bac5bdc8a2d96861506b58e8ae29f31ef18d7bc670177642405f80e5637e52c

data/README.md

@@ -0,0 +1,72 @@
+# path-temp
+
+`File.path_temp` defines a temporary file path. It does not create the file. If,
+after the do block, a file exists at that path then the file is deleted.
+
+```ruby
+#!/usr/bin/ruby -w
+require 'file/path-temp'
+
+# call File.path_temp
+File.path_temp() do |path|
+  # defines a path in current directory with a bunch of random numbers as
+  # the name e.g. ./18168068873296828
+  puts path 
+  
+  # file is *not* automatically created
+  puts File.exist?(path) # => false
+  
+  # write to the path
+  File.write path, 'whatever'
+  
+  # file now exists
+  puts File.exist?(path) # => true
+end
+
+# at this point, the file no longer exists
+```
+
+## root
+
+To put the path somewhere besides the current directory, use the `root` option:
+
+```ruby
+File.path_temp('root'=>'/tmp') do |path|
+  puts path # => e,g, /tmp/458577463617317
+end
+```
+
+## extension
+
+To give the path an extension, use the `ext` option:
+
+```ruby
+File.path_temp('ext'=>'txt') do |path|
+  puts path # => e,g, ./5314921893963471.txt
+end
+```
+
+# Installation
+
+The usual:
+
+```bash
+sudo gem install path-temp
+```
+Or however you like to install gems. It's just a single file.
+
+
+## License
+
+Open source, MIT license.
+
+## Author
+
+Mike O'Sullivan
+mike@idocs.com
+
+## History
+
+| version | date         | notes                         |
+|---------|--------------|-------------------------------|
+| 1.0     | Jun 29, 2023 | Initial upload.               |

data/lib/file/path-temp.rb

@@ -0,0 +1,32 @@
+class File
+  def self.path_temp(opts={})
+    opts = {'delete'=>true}.merge(opts)
+    
+    # root
+    if opts['root']
+      root = opts['root'].sub(/\/*\z/mu, '/')
+    else
+      root = './'
+    end
+    
+    # full path
+    path = rand.to_s
+    path = path.sub(/\A0\./mu, '')
+    path = root + path
+    
+    # add extension
+    if opts['ext']
+      ext = opts['ext']
+      ext = ext.sub(/\A\.*/mu, '.')
+      path += ext
+    end
+    
+    begin
+      yield path
+    ensure
+      if opts['delete'] and File.exist?(path)
+        File.delete path
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: path-temp
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Mike O'Sullivan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-29 00:00:00.000000000 Z
+dependencies: []
+description: Utility for defining a path that, if the file exists, is deleted at the
+  end of the block.
+email: mike@idocs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/file/path-temp.rb
+homepage: https://github.com/mikosullivan/path-temp
+licenses:
+- MIT
+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: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: path-temp
+test_files: []