recls-helpers-ruby 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/AUTHORS.md +21 -0
- data/CHANGES.md +20 -0
- data/CONTRIBUTING.md +36 -0
- data/EXAMPLES.md +7 -0
- data/FAQ.md +28 -0
- data/INSTALL.md +41 -0
- data/LICENSE +31 -0
- data/NEWS.md +9 -0
- data/README.md +133 -0
- data/Rakefile +21 -0
- data/SECURITY.md +22 -0
- data/TODO.md +29 -0
- data/lib/recls/helpers/version.rb +71 -0
- data/lib/recls/helpers.rb +59 -0
- data/test/unit/tc_version.rb +37 -0
- data/test/unit/ts_all.rb +11 -0
- metadata +100 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 05fd3f2eea827e2d2449b92949112e3752a3a5dbe72335ce3f35767a71a91169
|
|
4
|
+
data.tar.gz: 8a34ff4b9e363fd4c1998f723a91db6e0dad80e82b76c5f822eb5a3465301a0b
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 5e70e15c15954f5577b2354aeed98238cf5390314961bdff5279c5668a73839d7e00e236a4774b10910f3facba237df8d034e0103d6befe3f102fefce5151054
|
|
7
|
+
data.tar.gz: 79042355a852a9fedd3d62b2d4d60e0b3829ce3d2a6a7dc8d491e3ed792ed4f0fd0f7e4ce008dcda3e2637a64b9a89971a8693015e09ed2088d61f6e081a3e2f
|
data/AUTHORS.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# recls-helpers.Ruby - Authors <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Major Contributors
|
|
5
|
+
|
|
6
|
+
| Name | GitHub |
|
|
7
|
+
| ----------- | --------------------------------- |
|
|
8
|
+
| Matt Wilson | [mwsis](https://github.com/mwsis) |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## Defect reports, fixes and suggestions (for which we are very grateful)
|
|
12
|
+
|
|
13
|
+
| Name | GitHub |
|
|
14
|
+
| ----------- | --------------------------------- |
|
|
15
|
+
| \<none> | |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
Contributions are welcomed.
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<!-- ########################### end of file ########################### -->
|
data/CHANGES.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# recls-helpers.Ruby - Changes <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## 0.0.1 - 19th August 2026
|
|
5
|
+
|
|
6
|
+
* **recls-helpers-ruby.gemspec**: `required_ruby_version` is the range `>= 2.0`; **Gemfile.lock** and **.ruby-version** excluded from `spec.files`; `spec.summary` matches the README tagline; packaged **AUTHORS**, **CHANGES**, **CONTRIBUTING**, **EXAMPLES**, **FAQ**, **INSTALL**, **NEWS**, **SECURITY**, **TODO**;
|
|
7
|
+
* **Gemfile** sets `lockfile false` when Bundler supports it; stop tracking **Gemfile.lock**;
|
|
8
|
+
* CI uses `bundler-cache: false` and explicit `bundle install`; **Warnings** job on Ruby **3.4**;
|
|
9
|
+
* updated **run_all_unit_tests.sh** (from https://github.com/synesissoftware/misc-dev-scripts) to skip **tput** when **$TERM** is unset or stdout is not a TTY;
|
|
10
|
+
* **README.md**: drop extra GitHub-release badge; nested **Dependencies** (Efferent / Afferent);
|
|
11
|
+
* library source **Home:** URLs now use `https`;
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## 0.0.0 - 16th August 2026
|
|
15
|
+
|
|
16
|
+
* added `# frozen_string_literal: true` to all **lib/** sources;
|
|
17
|
+
* initial skeleton;
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
<!-- ########################### end of file ########################### -->
|
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# recls-helpers.Ruby - Contributing <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Table of Contents <!-- omit in toc -->
|
|
5
|
+
|
|
6
|
+
- [Defects and features](#defects-and-features)
|
|
7
|
+
- [Pull requests](#pull-requests)
|
|
8
|
+
- [Tests](#tests)
|
|
9
|
+
- [License](#license)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## Defects and features
|
|
13
|
+
|
|
14
|
+
Open an issue on https://github.com/synesissoftware/recls-helpers.Ruby/issues.
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## Pull requests
|
|
18
|
+
|
|
19
|
+
Pull requests are welcome on https://github.com/synesissoftware/recls-helpers.Ruby. Keep diffs local to the change; match existing indentation (2 spaces in Ruby) and the Synesis markdown set (**README.md**, **CHANGES.md**, **NEWS.md**, **TODO.md**, **INSTALL.md**, **CONTRIBUTING.md**, **SECURITY.md**).
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
## Tests
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
bundle exec rake test
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
or `./run_all_unit_tests.sh`.
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## License
|
|
32
|
+
|
|
33
|
+
Contributions are accepted under the 3-clause BSD license. See [LICENSE](./LICENSE).
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<!-- ########################### end of file ########################### -->
|
data/EXAMPLES.md
ADDED
data/FAQ.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# recls-helpers.Ruby - FAQ <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
The FAQ list is under (constant) development. If you post a question on the
|
|
4
|
+
[Issues](https://github.com/synesissoftware/recls-helpers.Ruby/issues) forum
|
|
5
|
+
it will be used to create one.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Table of Contents <!-- omit in toc -->
|
|
9
|
+
|
|
10
|
+
- [Q1: "How do I install this library?"](#q1-how-do-i-install-this-library)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
# FAQs: <!-- omit in toc -->
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## Q1: "How do I install this library?"
|
|
17
|
+
|
|
18
|
+
Install via **gem**:
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
gem install recls-helpers-ruby
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
See [README.md](./README.md) for usage.
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
<!-- ########################### end of file ########################### -->
|
data/INSTALL.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# recls-helpers.Ruby - Installation and Use <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Table of Contents <!-- omit in toc -->
|
|
5
|
+
|
|
6
|
+
- [Install the gem](#install-the-gem)
|
|
7
|
+
- [From a source checkout](#from-a-source-checkout)
|
|
8
|
+
- [Using the library](#using-the-library)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## Install the gem
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
gem install recls-helpers-ruby
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
or add to a **Gemfile**:
|
|
18
|
+
|
|
19
|
+
```Ruby
|
|
20
|
+
gem 'recls-helpers-ruby'
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
then `bundle install`.
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## From a source checkout
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
bundle install
|
|
30
|
+
bundle exec rake test
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
## Using the library
|
|
35
|
+
|
|
36
|
+
```Ruby
|
|
37
|
+
require 'recls/helpers'
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
<!-- ########################### end of file ########################### -->
|
data/LICENSE
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
recls-helpers.Ruby - BSD 3-Clause License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026, Matthew Wilson and Synesis Information Systems
|
|
4
|
+
All rights reserved.
|
|
5
|
+
|
|
6
|
+
Redistribution and use in source and binary forms, with or without
|
|
7
|
+
modification, are permitted provided that the following conditions are met:
|
|
8
|
+
|
|
9
|
+
1. Redistributions of source code must retain the above copyright notice,
|
|
10
|
+
this list of conditions and the following disclaimer.
|
|
11
|
+
|
|
12
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
13
|
+
this list of conditions and the following disclaimer in the documentation
|
|
14
|
+
and/or other materials provided with the distribution.
|
|
15
|
+
|
|
16
|
+
3. Neither the name of the copyright holder nor the names of its
|
|
17
|
+
contributors may be used to endorse or promote products derived from
|
|
18
|
+
this software without specific prior written permission.
|
|
19
|
+
|
|
20
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
21
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
22
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
23
|
+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
24
|
+
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
25
|
+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
26
|
+
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
27
|
+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
28
|
+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
29
|
+
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
30
|
+
POSSIBILITY OF SUCH DAMAGE.
|
|
31
|
+
|
data/NEWS.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# recls-helpers.Ruby - News <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
| Date | News Item |
|
|
4
|
+
| ---------------- | -------------------------------------------------------------------------------------------------------- |
|
|
5
|
+
| 19th August 2026 | [**recls-helpers.Ruby** 0.0.1](https://github.com/synesissoftware/recls-helpers.Ruby/releases/tag/0.0.1) |
|
|
6
|
+
| 16th August 2026 | [**recls-helpers.Ruby** 0.0.0](https://github.com/synesissoftware/recls-helpers.Ruby/releases/tag/0.0.0) |
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
<!-- ########################### end of file ########################### -->
|
data/README.md
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# recls-helpers.Ruby <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
Helper types and functions for working with **recls.Ruby**
|
|
4
|
+
|
|
5
|
+

|
|
6
|
+
[](https://opensource.org/licenses/BSD-3-Clause)
|
|
7
|
+
[](https://badge.fury.io/rb/recls-helpers-ruby)
|
|
8
|
+
[](https://github.com/synesissoftware/recls-helpers.Ruby/commits/master)
|
|
9
|
+
[](https://github.com/synesissoftware/recls-helpers.Ruby/actions/workflows/ruby.yml)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## Table of Contents <!-- omit in toc -->
|
|
13
|
+
|
|
14
|
+
- [Introduction](#introduction)
|
|
15
|
+
- [Installation](#installation)
|
|
16
|
+
- [Components](#components)
|
|
17
|
+
- [Examples](#examples)
|
|
18
|
+
- [Project Information](#project-information)
|
|
19
|
+
- [Where to get help](#where-to-get-help)
|
|
20
|
+
- [Contribution guidelines](#contribution-guidelines)
|
|
21
|
+
- [Dependencies](#dependencies)
|
|
22
|
+
- [Efferent (fan-out)](#efferent-fan-out)
|
|
23
|
+
- [Runtime Dependencies (aka "Normal Dependencies")](#runtime-dependencies-aka-normal-dependencies)
|
|
24
|
+
- [Development Dependencies](#development-dependencies)
|
|
25
|
+
- [Afferent (fan-in)](#afferent-fan-in)
|
|
26
|
+
- [Runtime dependents](#runtime-dependents)
|
|
27
|
+
- [Development dependents](#development-dependents)
|
|
28
|
+
- [Related projects](#related-projects)
|
|
29
|
+
- [License](#license)
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
## Introduction
|
|
33
|
+
|
|
34
|
+
**recls-helpers.Ruby** provides helper types and functions layered on [**recls.Ruby**](https://github.com/synesissoftware/recls.Ruby) — common patterns for filtering search results, walking directory trees, presenting paths, and related filesystem utilities used across Synesis tooling.
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
## Installation
|
|
38
|
+
|
|
39
|
+
Install via **gem** as in:
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
gem install recls-helpers-ruby
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
or add it to your `Gemfile`.
|
|
46
|
+
|
|
47
|
+
Use via **require**, as in:
|
|
48
|
+
|
|
49
|
+
```Ruby
|
|
50
|
+
require 'recls/helpers'
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
## Components
|
|
55
|
+
|
|
56
|
+
**recls-helpers.Ruby** currently ships the **`Recls::Helpers`** namespace and version metadata (`require 'recls/helpers'`), layered on [**recls.Ruby**](https://github.com/synesissoftware/recls.Ruby). Concrete helper APIs are still landing; the intended first set (see **TODO.md**) includes:
|
|
57
|
+
|
|
58
|
+
* ignore / exclude filtering (`strip_excludes` / `reject_ignored`, `String` + `Regexp`);
|
|
59
|
+
* `each_file_r` (and related flag builders) for recursive file walks with default directory and ignores;
|
|
60
|
+
* path-or-directory search dispatch;
|
|
61
|
+
* `empty_directory?`, `directory_byte_size`, `display_path`, and group-by helpers;
|
|
62
|
+
* optional stock Synesis ignore / pattern presets;
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
## Examples
|
|
66
|
+
|
|
67
|
+
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](./EXAMPLES.md).
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
## Project Information
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
### Where to get help
|
|
74
|
+
|
|
75
|
+
[GitHub Page](https://github.com/synesissoftware/recls-helpers.Ruby "GitHub Page")
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
### Contribution guidelines
|
|
79
|
+
|
|
80
|
+
Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/recls-helpers.Ruby.
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
### Dependencies
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
#### Efferent (fan-out)
|
|
87
|
+
|
|
88
|
+
Libraries upon which **recls-helpers.Ruby** depends:
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
##### Runtime Dependencies (aka "Normal Dependencies")
|
|
92
|
+
|
|
93
|
+
* [**recls.Ruby**](https://github.com/synesissoftware/recls.Ruby);
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
##### Development Dependencies
|
|
97
|
+
|
|
98
|
+
* [**rake**](https://rubygems.org/gems/rake);
|
|
99
|
+
* [**test-unit**](https://rubygems.org/gems/test-unit);
|
|
100
|
+
* [**xqsr3**](https://github.com/synesissoftware/xqsr3);
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
#### Afferent (fan-in)
|
|
104
|
+
|
|
105
|
+
Projects that depend on **recls-helpers.Ruby**:
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
##### Runtime dependents
|
|
109
|
+
|
|
110
|
+
* \<none>;
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
##### Development dependents
|
|
114
|
+
|
|
115
|
+
* \<none>;
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### Related projects
|
|
119
|
+
|
|
120
|
+
* [**recls**](https://github.com/synesissoftware/recls/);
|
|
121
|
+
* [**recls.Go**](https://github.com/synesissoftware/recls.Go/);
|
|
122
|
+
* [**recls.NET**](https://github.com/synesissoftware/recls.NET/);
|
|
123
|
+
* [**recls.Python**](https://github.com/synesissoftware/recls.Python/);
|
|
124
|
+
* [**recls.Ruby**](https://github.com/synesissoftware/recls.Ruby/);
|
|
125
|
+
* [**recls.Rust**](https://github.com/synesissoftware/recls.Rust/);
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
### License
|
|
129
|
+
|
|
130
|
+
**recls-helpers.Ruby** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<!-- ########################### end of file ########################### -->
|
data/Rakefile
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Rakefile for recls-helpers.Ruby
|
|
4
|
+
|
|
5
|
+
require 'rake/testtask'
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
Rake::TestTask.new do |tt|
|
|
9
|
+
|
|
10
|
+
tt.libs << 'lib'
|
|
11
|
+
tt.libs << 'test'
|
|
12
|
+
tt.name = 'test'
|
|
13
|
+
tt.test_files = FileList['test/**/tc_*.rb']
|
|
14
|
+
tt.verbose = true
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
task :default => :test
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
# ############################## end of file ############################# #
|
data/SECURITY.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# recls-helpers.Ruby - Security <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Table of Contents <!-- omit in toc -->
|
|
5
|
+
|
|
6
|
+
- [Reporting a vulnerability](#reporting-a-vulnerability)
|
|
7
|
+
- [Supported versions](#supported-versions)
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## Reporting a vulnerability
|
|
11
|
+
|
|
12
|
+
Please report security issues privately via GitHub Security Advisories on https://github.com/synesissoftware/recls-helpers.Ruby/security, or by opening an issue if an advisory cannot be filed. Do not attach exploit proofs of concept against third-party systems.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## Supported versions
|
|
16
|
+
|
|
17
|
+
| Version | Supported |
|
|
18
|
+
| ------- | --------- |
|
|
19
|
+
| 0.0.x | ✅ |
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
<!-- ########################### end of file ########################### -->
|
data/TODO.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# recls-helpers.Ruby - TODO <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Functional improvements
|
|
5
|
+
|
|
6
|
+
* [ ] Ignore / exclude filtering (`strip_excludes` / `reject_ignored`, String + Regexp);
|
|
7
|
+
* [ ] `each_file_r` (+ flag builder) for recursive file walks with default `.` and ignores;
|
|
8
|
+
* [ ] Path-or-directory search dispatcher;
|
|
9
|
+
* [ ] `empty_directory?`, `directory_byte_size`, `display_path`, group-by helpers;
|
|
10
|
+
* [ ] Stock Synesis ignore / pattern presets (optional);
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## Performance improvements
|
|
14
|
+
|
|
15
|
+
* \<none>
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Packaging improvements
|
|
19
|
+
|
|
20
|
+
* [ ] Examples for first shipped helpers;
|
|
21
|
+
* [ ] Publish gem and GitHub release for **0.0.1**;
|
|
22
|
+
* [x] ~~~updated **run_all_unit_tests.sh** (from **misc-dev-scripts**) to skip `tput` when `$TERM` is unset or stdout is not a TTY~~~;
|
|
23
|
+
* [x] ~~~**Gemfile** `lockfile false`; stop tracking **Gemfile.lock**; CI `bundler-cache: false`~~~;
|
|
24
|
+
* [x] ~~~gemspec polish: README tagline as `spec.summary`, drop `< 4` upper bound, package docs, exclude **Gemfile.lock** / **.ruby-version**~~~;
|
|
25
|
+
* [x] ~~~README canonical structure (tagline before badges; **Dependencies**; CI badge → **ruby.yml**)~~~;
|
|
26
|
+
* [x] ~~~after the packaging/boilerplate/CI baseline: bump **VERSION** and align **CHANGES**/**NEWS**~~~;
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
<!-- ########################### end of file ########################### -->
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
# ######################################################################## #
|
|
3
|
+
# File: recls/helpers/version.rb
|
|
4
|
+
#
|
|
5
|
+
# Purpose: Version for recls-helpers.Ruby library
|
|
6
|
+
#
|
|
7
|
+
# Created: 14th August 2026
|
|
8
|
+
# Updated: 19th August 2026
|
|
9
|
+
#
|
|
10
|
+
# Home: https://github.com/synesissoftware/recls-helpers.Ruby
|
|
11
|
+
#
|
|
12
|
+
# Author: Matthew Wilson
|
|
13
|
+
#
|
|
14
|
+
# Copyright (c) 2026, Matthew Wilson and Synesis Information Systems
|
|
15
|
+
# All rights reserved.
|
|
16
|
+
#
|
|
17
|
+
# Redistribution and use in source and binary forms, with or without
|
|
18
|
+
# modification, are permitted provided that the following conditions are
|
|
19
|
+
# met:
|
|
20
|
+
#
|
|
21
|
+
# * Redistributions of source code must retain the above copyright
|
|
22
|
+
# notice, this list of conditions and the following disclaimer.
|
|
23
|
+
#
|
|
24
|
+
# * Redistributions in binary form must reproduce the above copyright
|
|
25
|
+
# notice, this list of conditions and the following disclaimer in the
|
|
26
|
+
# documentation and/or other materials provided with the distribution.
|
|
27
|
+
#
|
|
28
|
+
# * Neither the names of the copyright holders nor the names of its
|
|
29
|
+
# contributors may be used to endorse or promote products derived from
|
|
30
|
+
# this software without specific prior written permission.
|
|
31
|
+
#
|
|
32
|
+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
|
33
|
+
# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
|
34
|
+
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
35
|
+
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
|
36
|
+
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
37
|
+
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
38
|
+
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
39
|
+
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
40
|
+
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
41
|
+
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
42
|
+
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
43
|
+
#
|
|
44
|
+
# ######################################################################## #
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
=begin
|
|
48
|
+
=end
|
|
49
|
+
|
|
50
|
+
module Recls
|
|
51
|
+
module Helpers
|
|
52
|
+
|
|
53
|
+
# Current version of the recls-helpers.Ruby library
|
|
54
|
+
VERSION = '0.0.1'
|
|
55
|
+
|
|
56
|
+
private
|
|
57
|
+
# @!visibility private
|
|
58
|
+
VERSION_PARTS_ = VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
|
|
59
|
+
public
|
|
60
|
+
# Major version of the recls-helpers.Ruby library
|
|
61
|
+
VERSION_MAJOR = VERSION_PARTS_[0] # :nodoc:
|
|
62
|
+
# Minor version of the recls-helpers.Ruby library
|
|
63
|
+
VERSION_MINOR = VERSION_PARTS_[1] # :nodoc:
|
|
64
|
+
# Revision version of the recls-helpers.Ruby library
|
|
65
|
+
VERSION_REVISION = VERSION_PARTS_[2] # :nodoc:
|
|
66
|
+
|
|
67
|
+
end # module Helpers
|
|
68
|
+
end # module Recls
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
# ############################## end of file ############################# #
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
# ######################################################################## #
|
|
3
|
+
# File: recls/helpers.rb
|
|
4
|
+
#
|
|
5
|
+
# Purpose: Top-level include for recls-helpers.Ruby library
|
|
6
|
+
#
|
|
7
|
+
# Created: 14th August 2026
|
|
8
|
+
# Updated: 19th August 2026
|
|
9
|
+
#
|
|
10
|
+
# Home: https://github.com/synesissoftware/recls-helpers.Ruby
|
|
11
|
+
#
|
|
12
|
+
# Author: Matthew Wilson
|
|
13
|
+
#
|
|
14
|
+
# Copyright (c) 2026, Matthew Wilson and Synesis Information Systems
|
|
15
|
+
# All rights reserved.
|
|
16
|
+
#
|
|
17
|
+
# Redistribution and use in source and binary forms, with or without
|
|
18
|
+
# modification, are permitted provided that the following conditions are
|
|
19
|
+
# met:
|
|
20
|
+
#
|
|
21
|
+
# * Redistributions of source code must retain the above copyright
|
|
22
|
+
# notice, this list of conditions and the following disclaimer.
|
|
23
|
+
#
|
|
24
|
+
# * Redistributions in binary form must reproduce the above copyright
|
|
25
|
+
# notice, this list of conditions and the following disclaimer in the
|
|
26
|
+
# documentation and/or other materials provided with the distribution.
|
|
27
|
+
#
|
|
28
|
+
# * Neither the names of the copyright holders nor the names of its
|
|
29
|
+
# contributors may be used to endorse or promote products derived from
|
|
30
|
+
# this software without specific prior written permission.
|
|
31
|
+
#
|
|
32
|
+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
|
33
|
+
# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
|
34
|
+
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
35
|
+
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
|
36
|
+
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
37
|
+
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
38
|
+
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
39
|
+
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
40
|
+
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
41
|
+
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
42
|
+
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
43
|
+
#
|
|
44
|
+
# ######################################################################## #
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
require 'recls'
|
|
48
|
+
|
|
49
|
+
require 'recls/helpers/version'
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
module Recls
|
|
53
|
+
module Helpers
|
|
54
|
+
|
|
55
|
+
end # module Helpers
|
|
56
|
+
end # module Recls
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
# ############################## end of file ############################# #
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
#! /usr/bin/env ruby
|
|
2
|
+
|
|
3
|
+
$:.unshift File.join(File.dirname(__FILE__), '../../lib')
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
require 'recls/helpers/version'
|
|
7
|
+
|
|
8
|
+
require 'test/unit'
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class Test_version < Test::Unit::TestCase
|
|
12
|
+
|
|
13
|
+
def test_has_VERSION
|
|
14
|
+
|
|
15
|
+
assert defined? Recls::Helpers::VERSION
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
def test_has_VERSION_MAJOR
|
|
19
|
+
|
|
20
|
+
assert defined? Recls::Helpers::VERSION_MAJOR
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
def test_has_VERSION_MINOR
|
|
24
|
+
|
|
25
|
+
assert defined? Recls::Helpers::VERSION_MINOR
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
def test_has_VERSION_REVISION
|
|
29
|
+
|
|
30
|
+
assert defined? Recls::Helpers::VERSION_REVISION
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
def test_VERSION_has_consistent_format
|
|
34
|
+
|
|
35
|
+
assert_equal Recls::Helpers::VERSION.split('.')[0..2].join('.'), "#{Recls::Helpers::VERSION_MAJOR}.#{Recls::Helpers::VERSION_MINOR}.#{Recls::Helpers::VERSION_REVISION}"
|
|
36
|
+
end
|
|
37
|
+
end
|
data/test/unit/ts_all.rb
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
#! /usr/bin/env ruby
|
|
2
|
+
#
|
|
3
|
+
# executes all other tests
|
|
4
|
+
|
|
5
|
+
this_dir = File.expand_path(File.dirname(__FILE__))
|
|
6
|
+
|
|
7
|
+
# all tc_*rb in current directory
|
|
8
|
+
Dir[File.join(this_dir, 'tc_*rb')].each { |file| require file }
|
|
9
|
+
|
|
10
|
+
# all ts_*rb in immediate sub-directories
|
|
11
|
+
Dir[File.join(this_dir, '*', 'ts_*rb')].each { |file| require file }
|
metadata
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: recls-helpers-ruby
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.0.1
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Matt Wilson
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2026-08-20 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: recls-ruby
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '2.13'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '2.13'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: xqsr3
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - ">="
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: 0.39.5
|
|
34
|
+
- - "<"
|
|
35
|
+
- !ruby/object:Gem::Version
|
|
36
|
+
version: '1.0'
|
|
37
|
+
type: :development
|
|
38
|
+
prerelease: false
|
|
39
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
40
|
+
requirements:
|
|
41
|
+
- - ">="
|
|
42
|
+
- !ruby/object:Gem::Version
|
|
43
|
+
version: 0.39.5
|
|
44
|
+
- - "<"
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '1.0'
|
|
47
|
+
description: |
|
|
48
|
+
Helper types and functions for recls.Ruby — common search-result filtering,
|
|
49
|
+
directory walks, path presentation, and related filesystem utility patterns.
|
|
50
|
+
email:
|
|
51
|
+
- matthew@synesis.com.au
|
|
52
|
+
executables: []
|
|
53
|
+
extensions: []
|
|
54
|
+
extra_rdoc_files: []
|
|
55
|
+
files:
|
|
56
|
+
- AUTHORS.md
|
|
57
|
+
- CHANGES.md
|
|
58
|
+
- CONTRIBUTING.md
|
|
59
|
+
- EXAMPLES.md
|
|
60
|
+
- FAQ.md
|
|
61
|
+
- INSTALL.md
|
|
62
|
+
- LICENSE
|
|
63
|
+
- NEWS.md
|
|
64
|
+
- README.md
|
|
65
|
+
- Rakefile
|
|
66
|
+
- SECURITY.md
|
|
67
|
+
- TODO.md
|
|
68
|
+
- lib/recls/helpers.rb
|
|
69
|
+
- lib/recls/helpers/version.rb
|
|
70
|
+
- test/unit/tc_version.rb
|
|
71
|
+
- test/unit/ts_all.rb
|
|
72
|
+
homepage: https://github.com/synesissoftware/recls-helpers.Ruby
|
|
73
|
+
licenses:
|
|
74
|
+
- BSD-3-Clause
|
|
75
|
+
metadata:
|
|
76
|
+
bug_tracker_uri: https://github.com/synesissoftware/recls-helpers.Ruby/issues
|
|
77
|
+
changelog_uri: https://github.com/synesissoftware/recls-helpers.Ruby/blob/master/CHANGES.md
|
|
78
|
+
homepage_uri: https://github.com/synesissoftware/recls-helpers.Ruby
|
|
79
|
+
source_code_uri: https://github.com/synesissoftware/recls-helpers.Ruby
|
|
80
|
+
post_install_message:
|
|
81
|
+
rdoc_options: []
|
|
82
|
+
require_paths:
|
|
83
|
+
- lib
|
|
84
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - ">="
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: '2.0'
|
|
89
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
90
|
+
requirements:
|
|
91
|
+
- - ">="
|
|
92
|
+
- !ruby/object:Gem::Version
|
|
93
|
+
version: '0'
|
|
94
|
+
requirements: []
|
|
95
|
+
rubyforge_project:
|
|
96
|
+
rubygems_version: 2.7.6.3
|
|
97
|
+
signing_key:
|
|
98
|
+
specification_version: 4
|
|
99
|
+
summary: Helper types and functions for working with recls.Ruby
|
|
100
|
+
test_files: []
|