@philiprehberger/rb-pathname-kit
Pathname extensions for atomic write, safe delete, and common file operations
RubyRubyGems
Capabilities
README
philiprehberger-pathname_kit
Pathname extensions for atomic write, safe delete, and common file operations
Requirements
- Ruby >= 3.1
Installation
Add to your Gemfile:
gem "philiprehberger-pathname_kit"
Or install directly:
gem install philiprehberger-pathname_kit
Usage
require "philiprehberger/pathname_kit"
Philiprehberger::PathnameKit.atomic_write('config.yml') do |f|
f.write('key: value')
end
Atomic Write
Philiprehberger::PathnameKit.atomic_write('/path/to/file.txt') do |f|
f.write('safe content')
end
Directory and File Operations
Philiprehberger::PathnameKit.ensure_directory('/path/to/nested/dir')
Philiprehberger::PathnameKit.touch('/path/to/file.txt')
Philiprehberger::PathnameKit.safe_delete('/path/to/old.txt') # => true or false
Finding and Counting
files = Philiprehberger::PathnameKit.find('/src/**/*.rb')
count = Philiprehberger::PathnameKit.line_count('/path/to/file.rb')
Tempfile Helper
Philiprehberger::PathnameKit.tempfile('.csv') do |path|
File.write(path, 'a,b,c')
# temp file is cleaned up automatically
end
Copy and Move
require "philiprehberger/pathname_kit"
Philiprehberger::PathnameKit.copy("src/config.yml", "backup/config.yml")
Philiprehberger::PathnameKit.move("tmp/upload.csv", "data/upload.csv")
Read and Write
Philiprehberger::PathnameKit.write("config/app.yml", "key: value")
Philiprehberger::PathnameKit.read("config/app.yml") # => "key: value"
Streaming Lines and File Size
Philiprehberger::PathnameKit.each_line("logs/app.log") do |line|
puts line if line.include?("ERROR")
end
Philiprehberger::PathnameKit.size("logs/app.log") # => 4096
Tail
Read the last n lines of a file (defaults to 10). Memory usage is bounded
regardless of file size:
Philiprehberger::PathnameKit.tail("logs/app.log") # => last 10 lines
Philiprehberger::PathnameKit.tail("logs/app.log", 50) # => last 50 lines
Tempdir Helper
Philiprehberger::PathnameKit.with_tempdir do |dir|
File.write(File.join(dir, "scratch.txt"), "ephemeral")
# directory is removed automatically
end
Checksum
require "philiprehberger/pathname_kit"
Philiprehberger::PathnameKit.checksum("data/file.bin") # SHA-256 (default)
Philiprehberger::PathnameKit.checksum("data/file.bin", algorithm: :md5) # MD5
Append
Philiprehberger::PathnameKit.append("logs/app.log", "new entry\n")
File Comparison
Philiprehberger::PathnameKit.identical?("file_a.txt", "file_b.txt") # => true or false
File Inspection
Philiprehberger::PathnameKit.empty?("output.txt") # => true or false
Philiprehberger::PathnameKit.extension("archive.tar.gz") # => ".gz"
Philiprehberger::PathnameKit.expand("~/docs/notes.md") # => "/home/user/docs/notes.md"
Path Queries
Philiprehberger::PathnameKit.exists?("config/app.yml") # => true or false
Philiprehberger::PathnameKit.directory?("config") # => true or false
Philiprehberger::PathnameKit.basename("/path/to/file.txt") # => "file.txt"
Philiprehberger::PathnameKit.dirname("/path/to/file.txt") # => "/path/to"
Philiprehberger::PathnameKit.mtime("config/app.yml") # => 2026-04-14 12:00:00 +0000
Relative Paths
Philiprehberger::PathnameKit.relative_to("/a/b/c.txt", "/a/b") # => "c.txt"
Philiprehberger::PathnameKit.relative_to("/a/foo", "/a/bar") # => "../foo"
API
| Method | Description |
|---|---|
.atomic_write(path) { |f| } | Write to a temp file then rename atomically |
.ensure_directory(path) | Create directory and all parents if needed |
.safe_delete(path) | Delete a file, returning true if deleted |
.find(glob) | Find files matching a glob pattern |
.tempfile(ext) { |path| } | Create a temp file and yield its path |
.touch(path) | Create or update a file's modification time |
.line_count(path) | Count the number of lines in a file |
.tail(path, n = 10) | Return the last n lines of a file as an Array |
.copy(src, dest) | Copy file with parent directory creation |
.move(src, dest) | Move file with parent directory creation |
.checksum(path, algorithm: :sha256) | Compute file digest (md5, sha1, sha256, sha512) |
.read(path) | Read a file's contents |
.write(path, content) | Atomically write content, creating parent directories |
.each_line(path) { |line| } | Stream a file line by line |
.size(path) | File size in bytes |
.with_tempdir { |dir| } | Yield a temporary directory and clean it up afterward |
.append(path, content) | Append content to a file, creating parents if needed |
.identical?(path1, path2) | Compare two files by SHA-256 digest |
.empty?(path) | Check if a file is zero bytes |
.extension(path) | Get the file extension (e.g. ".rb") |
.expand(path) | Expand to absolute path with tilde expansion |
.exists?(path) | Check if a file or directory exists |
.directory?(path) | Check if a path is a directory |
.basename(path) | Get the filename component of a path |
.dirname(path) | Get the directory component of a path |
.mtime(path) | Get the last modification time |
.relative_to(path, base) | Express a path relative to a base path |
Development
bundle install
bundle exec rspec
bundle exec rubocop
Support
If you find this project useful: