pleasant_path

A fluent API for pleasant file IO, written as extensions to core Ruby objects. See API listing below, or browse the full documentation.

Examples

# Pluck lines from a file
"log.txt".path.read_lines.grep(/^ERROR /).append_to_file("errors.txt")

# Dedup lines in a file
"names.txt".path.edit_lines(&:uniq)

Core API

The following methods are available:

• Pathname
  • ::NULL
  • #^
  • #append_file
  • #append_lines
  • #append_text
  • #available_name
  • #chdir
  • #common_path
  • #copy
  • #copy_as
  • #copy_into
  • #delete!
  • #dir?
  • #dirs
  • #dirs_r
  • #edit_lines
  • #edit_text
  • #existence
  • #files
  • #files_r
  • #find_dirs
  • #find_files
  • #make_dir
  • #make_dirname
  • #make_file
  • #move
  • #move_as
  • #move_into
  • #parentname
  • #read_lines
  • #rename_basename
  • #rename_extname
  • #to_pathname
  • #write_lines
  • #write_text
• String
  • #/
  • #append_to_file
  • #path
  • #to_pathname
  • #write_to_file
• Enumerable
  • #append_to_file
  • #write_to_file
• File
  • .common_path
  • .edit_lines
  • .edit_text
• IO
  • #read_lines
  • #write_lines

JSON-related and YAML-related API

pleasant_path also includes methods for interacting with JSON and YAML files, using the JSON module and YAML module that are part of Ruby's standard library. Because Ruby does not load these modules by default, pleasant_path does not load its JSON-related and YAML-related API by default either. To load these pleasant_path APIs and the relevant standard library modules, use:

require "pleasant_path/json"
require "pleasant_path/yaml"

The following methods are available:

• Object
  • write_to_json
  • write_to_yaml
• Pathname
  • load_json
  • load_yaml
  • read_json
  • read_yaml

Installation

Install the pleasant_path gem.

Contributing

Run rake test to run the tests.

License

MIT License