philiprehberger-pathname_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d307f3b4309bc786d63332bc60c097aae61cfed960a3a00d0a354435426fdd1
+  data.tar.gz: 2a650ca32af727f254b2a8b0bb44016067e10f975f4510098e713c55299e4c13
+SHA512:
+  metadata.gz: bbd7f36bbf1efc5c9e76a5429d448ad4b132ffe93d7bd727bf74fb9f92f8a0c88ea8513a6b2a41c7f0ed2fc257b419c935ab6670d3c14df3e014bf8dc69a2c69
+  data.tar.gz: 8b6909b94b63402b60255479bf51aa1e2d0acfaf0f57548f778fb6c408832593fdc9b13049447b9ed2b0cce23535a7b0f91fa35ee4f7a4bc9777cc132be34d4d

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-22
+
+### Added
+- Initial release
+- Atomic file writes with temp file and rename
+- Directory creation with ensure_directory
+- Safe file deletion that returns success/failure
+- Glob-based file finding
+- Tempfile helper with automatic cleanup
+- File touch with parent directory creation
+- Line counting for files

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# philiprehberger-pathname_kit
+
+[![Tests](https://github.com/philiprehberger/rb-pathname-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-pathname-kit/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-pathname_kit.svg)](https://rubygems.org/gems/philiprehberger-pathname_kit)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-pathname-kit)](LICENSE)
+
+Pathname extensions for atomic write, safe delete, and common file operations
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'philiprehberger-pathname_kit'
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-pathname_kit
+```
+
+## Usage
+
+```ruby
+require 'philiprehberger/pathname_kit'
+
+Philiprehberger::PathnameKit.atomic_write('config.yml') do |f|
+  f.write('key: value')
+end
+```
+
+### Atomic Write
+
+```ruby
+Philiprehberger::PathnameKit.atomic_write('/path/to/file.txt') do |f|
+  f.write('safe content')
+end
+```
+
+### Directory and File Operations
+
+```ruby
+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
+
+```ruby
+files = Philiprehberger::PathnameKit.find('/src/**/*.rb')
+count = Philiprehberger::PathnameKit.line_count('/path/to/file.rb')
+```
+
+### Tempfile Helper
+
+```ruby
+Philiprehberger::PathnameKit.tempfile('.csv') do |path|
+  File.write(path, 'a,b,c')
+  # temp file is cleaned up automatically
+end
+```
+
+## 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 |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec      # Run tests
+bundle exec rubocop    # Check code style
+```
+
+## License
+
+MIT

data/lib/philiprehberger/pathname_kit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module PathnameKit
+    VERSION = '0.1.0'
+  end
+end

data/lib/philiprehberger/pathname_kit.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative 'pathname_kit/version'
+require 'fileutils'
+require 'tempfile'
+require 'pathname'
+
+module Philiprehberger
+  module PathnameKit
+    class Error < StandardError; end
+
+    # Write content atomically by writing to a temp file then renaming.
+    #
+    # @param path [String] the file path to write to
+    # @yield [IO] the temporary file to write to
+    # @return [void]
+    # @raise [Error] if path is nil or empty
+    def self.atomic_write(path)
+      raise Error, 'path cannot be nil' if path.nil?
+      raise Error, 'path cannot be empty' if path.to_s.empty?
+
+      dir = File.dirname(path)
+      ensure_directory(dir)
+
+      temp = Tempfile.new(['atomic', File.extname(path)], dir)
+      begin
+        yield temp
+        temp.close
+        FileUtils.mv(temp.path, path)
+      rescue StandardError
+        temp.close
+        temp.unlink
+        raise
+      end
+    end
+
+    # Ensure a directory exists, creating it and all parents if needed.
+    #
+    # @param path [String] the directory path
+    # @return [void]
+    # @raise [Error] if path is nil or empty
+    def self.ensure_directory(path)
+      raise Error, 'path cannot be nil' if path.nil?
+      raise Error, 'path cannot be empty' if path.to_s.empty?
+
+      FileUtils.mkdir_p(path)
+    end
+
+    # Safely delete a file, returning true if deleted and false if not found.
+    #
+    # @param path [String] the file path to delete
+    # @return [Boolean] true if the file was deleted
+    # @raise [Error] if path is nil or empty
+    def self.safe_delete(path)
+      raise Error, 'path cannot be nil' if path.nil?
+      raise Error, 'path cannot be empty' if path.to_s.empty?
+
+      return false unless File.exist?(path)
+
+      File.delete(path)
+      true
+    end
+
+    # Find files matching a glob pattern.
+    #
+    # @param glob [String] the glob pattern
+    # @return [Array<String>] matching file paths
+    # @raise [Error] if glob is nil or empty
+    def self.find(glob)
+      raise Error, 'glob cannot be nil' if glob.nil?
+      raise Error, 'glob cannot be empty' if glob.to_s.empty?
+
+      Dir.glob(glob).sort
+    end
+
+    # Create a temporary file with a given extension and yield its path.
+    #
+    # @param ext [String] the file extension (e.g. '.txt')
+    # @yield [String] the temporary file path
+    # @return [Object] the block return value
+    def self.tempfile(ext = '.tmp')
+      temp = Tempfile.new(['tmp', ext])
+      begin
+        yield temp.path
+      ensure
+        temp.close
+        temp.unlink
+      end
+    end
+
+    # Touch a file, creating it if it does not exist and updating its mtime.
+    #
+    # @param path [String] the file path
+    # @return [void]
+    # @raise [Error] if path is nil or empty
+    def self.touch(path)
+      raise Error, 'path cannot be nil' if path.nil?
+      raise Error, 'path cannot be empty' if path.to_s.empty?
+
+      dir = File.dirname(path)
+      ensure_directory(dir)
+      FileUtils.touch(path)
+    end
+
+    # Count the number of lines in a file.
+    #
+    # @param path [String] the file path
+    # @return [Integer] the number of lines
+    # @raise [Error] if path is nil or empty
+    # @raise [Error] if the file does not exist
+    def self.line_count(path)
+      raise Error, 'path cannot be nil' if path.nil?
+      raise Error, 'path cannot be empty' if path.to_s.empty?
+      raise Error, "file not found: #{path}" unless File.exist?(path)
+
+      File.readlines(path).size
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-pathname_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-22 00:00:00.000000000 Z
+dependencies: []
+description: Pathname utility library providing atomic writes, safe deletes, directory
+  creation, glob-based file finding, tempfile helpers, touch, and line counting. All
+  operations handle edge cases and cleanup gracefully.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/pathname_kit.rb
+- lib/philiprehberger/pathname_kit/version.rb
+homepage: https://github.com/philiprehberger/rb-pathname-kit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-pathname-kit
+  source_code_uri: https://github.com/philiprehberger/rb-pathname-kit
+  changelog_uri: https://github.com/philiprehberger/rb-pathname-kit/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/philiprehberger/rb-pathname-kit/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Pathname extensions for atomic write, safe delete, and common file operations
+test_files: []