recls-helpers.Ruby

Helper types and functions for working with recls.Ruby

Table of Contents

• Introduction
• Installation
• Components
• Examples
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
    • Efferent (fan-out)
      • Runtime Dependencies (aka "Normal Dependencies")
      • Development Dependencies
    • Afferent (fan-in)
      • Runtime dependents
      • Development dependents
  • Related projects
  • License

Introduction

recls-helpers.Ruby provides helper types and functions layered on recls.Ruby — common patterns for filtering search results, walking directory trees, presenting paths, and related filesystem utilities used across Synesis tooling.

Installation

Install via gem as in:

gem install recls-helpers-ruby

or add it to your Gemfile.

Use via require, as in:

require 'recls/helpers'

Components

recls-helpers.Ruby currently ships the Recls::Helpers namespace and version metadata (require 'recls/helpers'), layered on recls.Ruby. Concrete helper APIs are still landing; the intended first set (see TODO.md) includes:

• ignore / exclude filtering (strip_excludes / reject_ignored, String + Regexp);
• each_file_r (and related flag builders) for recursive file walks with default directory and ignores;
• path-or-directory search dispatch;
• empty_directory?, directory_byte_size, display_path, and group-by helpers;
• optional stock Synesis ignore / pattern presets;

Examples

Examples are provided in the examples directory, along with a markdown description for each. A detailed list TOC of them is provided in EXAMPLES.md.

Project Information

Where to get help

GitHub Page

Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/recls-helpers.Ruby.

Dependencies

Efferent (fan-out)

Libraries upon which recls-helpers.Ruby depends:

Runtime Dependencies (aka "Normal Dependencies")

• recls.Ruby;

Development Dependencies

• rake;
• test-unit;
• xqsr3;

Afferent (fan-in)

Projects that depend on recls-helpers.Ruby:

Runtime dependents

• <none>;

Development dependents

• <none>;

Related projects

• recls;
• recls.Go;
• recls.NET;
• recls.Python;
• recls.Ruby;
• recls.Rust;

License

recls-helpers.Ruby is released under the 3-clause BSD license. See LICENSE for details.